apiKey
onFinish: (identityAccessKey: string) => void
identityAccessKey
: UUID of the completed verification. You can use this to query our API.onSubmitted: (identityAccessKey: string) => void
identityAccessKey
: UUID of the completed verification. You can use this to query our API.onError: (errorCode: string, context: { step: StepID }) => void
errorCode:
The reason why the flow failed. Can be one of the following:"CANCELLED_BY_USER" | "BIOMETRIC_AUTHENTICATION_FAILED" | "UNSUPPORTED_BROWSER"
context:
Additional error context information (contains the step where the error occurred)StepID:
"START" | "CONSENT" | "EMAIL" | "COUNTRY" | "RESOURCE CHOICE" | "RESOURCE | "SUMMARY" | "FINISHED"
onStart: () => void
hidden
start()
method to create a custom button UI.<div id="passbase-button"></div>
element.prefillAttributes
email:
Your user's email. This will enable skipping the email step.country:
An ISO-3166 compliant country code. This will set the default dropdown selection of the country selection screen.VERIFICATION_REVIEWED
webhook event, it is time to call the Passbase Get Identity endpoint. Using this API endpoint, you will see the new metaData object returned.darkMode
attribute, which supersedes the effects of any customization selected within the developer dashboard. This is especially useful if your website has a dark UI or you simply want to spare your users' eyes at night. You can activate the darkmode via the theme
attribute.theme
darkMode:
A boolean value indicating whether or not to enable the dark themeenableSystemDarkMode:
A boolean value indicating whether the dark mode setting of the users OS should be applied (see https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)