Events
Listening for events:
form.on("<EVENT_NAME>, (message) => {
console.log(message);
// Do next step
});
In the Form module, we have mapped SmartUI legacy events to the new events. Please refer to the following table.
Event Name | OneSDK Events | Versioning |
---|---|---|
INIT | ready | v3 |
SCREEN:WELCOME | form:welcome:ready | v3 |
SCREEN:DOCUMENT_TYPE_SELECT | form:document_type_select:ready | |
SCREEN:DRIVERS_LICENCE_INPUT | form:drivers_license_input:ready | |
SCREEN:NATIONAL_ID | form:national_id:ready | |
SCREEN:MEDICARE_INPUT | form:medicare_input:ready | |
SCREEN:PASSPORT_INPUT | form:passport_input:ready | |
SCREEN:NAME_INPUT | form:name_input:ready | |
SCREEN:DOB_INPUT | form:dob_input:ready | |
SCREEN:ADDRESS_INPUT | form:address_input:ready | |
SCREEN:DETAILS_SUMMARY | form:details_summary:ready | |
SCREEN:FAILURE | form:failure:ready | |
SCREEN:SUCCESS | form:success:ready | |
SCREEN:NO_MATCH | form:no_match:ready | |
SCREEN:PENDING_VERIFICATION | form:pending_verification:ready | |
SCREEN:ERROR | form:error:ready | |
DESTROY | destroy | v3 |
FF_SAVE_RESULT | results | v3 |
FF_CHECK_RESULT | results | v3 |
FF_SAVE_ERROR FF_CHECK_ERROR | error | v3 |
FF_EXTERNAL_IDV_CHECK_COMPLETED | Not applicable anymore (IDV will be triggered separately) | v3 |
For FF_CHECK_RESULT
, the results event will return:
checkSummary
: object with check results and issues foundresultSlug
: one ofsuccess
// finalpending-success
// finaltoo-many-tries
// finalno-match
// will looppartial-match
// will loop
nextViewSlug
: might be the same values as "resultSlug", but also "external-idv" if widget is configured for itapplicant
: applicant object with personal information, including the applicant's entity id which can be used with our API callsdocuments
: array with all documents and document checks for this applicantattemptCount
: how many times has the user attempted checks on this instance of the widget so farmaxAttemptCount
: max attempt count configuredexternalIdv
: is external IDV activated per configurationisCheckingAddress
: are addresses activated per configurationisCheckingIDs
: are documents activated per configuration
This is not a complete API description, but among other properties, Applicant and Document objects carry the following information:
Applicant {
name: { givernName, middleName, familyName },
addresses: array of { country, postalCode, state, streetNumber, streetName, town, suburb, unitNumber }
dateOfBirth: "yyyy-mm-dd",
profile: "checkProfile/recipe" string
...
}
Document {
idType: string of DOCUMENT_TYPE, as defined in our documentation
idNumber: string,
idSubType: optional string,
data: { extra information specific to this idType }
...
}
Note on Biometrics and Smart UI
Our current biometrics offering is asynchronous and can take up to 5 mins, we do recommend the following:
- Have a warm offboard when the customer finishes biometrics, use the event FF_EXTERNAL_IDV_CHECK_COMPLETED which indicates that Biometrics has been submitted successfully; however, it does NOT indicate biometrics results are finished.
- Wait for notification via your webhook endpoint for the final outcome of this entity including biometrics results (this can take up to 5 mins)
- Notify the customer of the next step based on the result...
Updated 6 months ago