Events

Widget events are implemented using the browser API Custom Events and are directly dispatched to the window object. Smart UI events will carry special data in the event object detail property. Keep reading to find more information about that data.

Listening for events:

1
window.addEventListener(EVENT_NAME, (e: CustomEvent) => {
2
  console.log(e.detail);
3
});

The events were extended on v4.2 to include all the current information contained in the Smart UI. All event objects will now contain at least the following information in the “detail” property.

This isn’t a complete API description, but among other properties, Applicant and Document objects carry the following information:

1
Applicant {
2
  name: { givernName, middleName, familyName },
3
  addresses: array of { country, postalCode, state, streetNumber, streetName, town, suburb, unitNumber  }
4
  dateOfBirth: "yyyy-mm-dd",
5
  profile: "checkProfile/recipe" string
6
	...
7
}

1
Document {
2
	idType: string of DOCUMENT_TYPE, as defined in our documentation
3
  idNumber: string,
4
  idSubType: optional string,
5
  data: { extra information specific to this idType }
6
  ...
7
}

For FF_CHECK_RESULT, e.detail is

• checkSummary: object with check results and issues found,
• resultSlug: one of
  • success // final
  • pending-success // final
  • too-many-tries // final
  • no-match // will loop
  • partial-match // will loop
• nextViewSlug: might be the same values as “resultSlug”, but also “external-idv” if widget is configured for it,
• applicant: applicant object with personal information, including the applicant’s entity id which can be used with our API calls,
• documents: array with all documents and document checks for this applicant,
• attemptCount: how many times has the user attempted checks on this instance of the widget so far,
• maxAttemptCount: max attempt count configured,
• externalIdv: is external idv activated per configuration,
• isCheckingAddress: are addresses activated per configuration,
• isCheckingIDs: are documents activated per configuration,

For FF_EXTERNAL_IDV_CHECK_COMPLETED, e.detail is much simpler. It only includes:

• applicant: applicant object with personal information, including the applicant’s entity id which can be used with our API calls,
• documents: array with all documents and document checks for this applicant,