HTML + JavaScript
This document explains how to integrate the verification flow into your web application
This document explains how to integrate the verification flow directly into your web application through our JavaScript component to verify the identity of your users. This stage might be at the signup page of your application, or at a later point to enrich the profiles of your users. The guide assumes the preliminary steps have already been completed as explained in the initial setup section of the documentation.
You can either follow the integration guide or watch the integration tutorial that shows the same steps. Please be aware that some property or function names might have slightly changed with newer versions. Make sure to compare your implementation with the latest code snippets here in the documentation.
Start by adding the minified code to your webpage from the unpkg CDN in the header of your HTML file:
<script
type="text/javascript"
src="https://unpkg.com/@passbase/button"
></script>
Place the new HTML element where you want the component to render inside the body of your HTML file:
<div id="passbase-button"></div>
In order for the button to render correctly, you'll need to pass your apiKey as an argument to the rendering function. Optionally you can also pass in different handler functions like the onFinish, onStart, or onError method to handle different events of the button flow.
Argument | Description |
apiKey | The public API Key you obtained from the developer dashboard |
onFinish: (identityAccessKey: string) => void | Method that is being called once a user clicks the "Finish" button identityAccessKey: UUID of the completed verification. You can use this to query our API. |
onSubmitted: (identityAccessKey: string) => void | Method that is being called once verification data is submitted to Passbase 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: The step where the error occurred, can be one of the following "START" | "CONSENT" | "EMAIL" | "COUNTRY" | "RESOURCE CHOICE" | "RESOURCE | "SUMMARY" | "FINISHED" |
onStart: () => void | Method that is being called once a user starts the verification flow |
hidden | A boolean value used to visually hide the verification button. Can be used in tandem with start() method to create a custom button UI. |
<script type="text/javascript">
const element = document.getElementById("passbase-button")
const apiKey = "YOUR_API_KEY"
Passbase.renderButton(element, apiKey, {
onSubmitted: (identityAccessKey) => {},
onFinish: (identityAccessKey) => {},
onError: (errorCode) => {},
onStart: () => {}
})
</script>
Make sure you're using your public API key for this client-side SDK
Add this part below your
<div id="passbase-button"></div> element.The button should now render as shown here:
During the verification flow, your users will be asked to provide some information which you might already have in your application e.g. the user's email. In this case, you can use the prefillAttributes object to skip the email step.
When the Biometric Authentication feature is enabled and the email is prefilled, Passbase will check if the user is already verified on our platform. If yes, the flow will enter the Biometric Authentication mode. If not, the user enters the normal verification flow and has to provide all required documents selected in your developer dashboard's customization section.
| Value |
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. |
Passbase.renderButton(element, apiKey,
{
prefillAttributes: {
email: "[email protected]",
country: "de"
}
}
)
In order for your application to interoperate with Passbase, you will need to add a reference to your users once the Verification is completed.
For that, you will need to keep track of the identityAccessKey returned by the onFinish or onSubmitted callbacks and associate it in your backend with your end users' id. We recommend saving this key after the onSubmitted method from your user's completed verification, or listen for the incoming webhooks to make a call to the Passbase API linking back the email address of the user.
<script type="text/javascript">
const element = document.getElementById("passbase-button")
const apiKey = "YOUR_API_KEY"
Passbase.renderButton(element, apiKey, {
onSubmitted: (identityAccessKey) => {
console.log(identityAccessKey)
// Make a request to your backend/db and save the key
},
onFinish: (identityAccessKey) => {
// Open new window for end user to prevent duplicate verifications
window.location.href =("https://passbase.com/")
},
onError: (errorCode) => {},
onStart: () => {}
})
</script>
If you are tracking end users in your backend through an internal UUID, transaction number, stripe ID, etc., you can use the metaData object to securely pass encrypted end user information to identify completed verifications.
The metaData object allows you to pass an encrypted JSON string via a private key encoded in base64 on the client-side, and then Passbase will use your public key to return the data on the Passbase API.
Encryption should be completed on the server-side. Once you have completed the encryption, please enter the public encryption keys for each individual project within the developer dashboard.
After adding the public encryption keys within the developer dashboard, you will need to pass the private key encoded in base64 to Passbase through the client-side.
| Value |
metaData | Encrypted JSON string via the private key encoded in base64 |
<script type="text/javascript">
const element = document.getElementById("passbase-button")
const apiKey = "YOUR_API_KEY"
Passbase.renderButton(element, apiKey, {
{
prefillAttributes: {
email: "[email protected]",
country: "de"
}
},
// Signed and Armored Metadata, which contain {"email": "[email protected]", "country": "de", ...}
metaData: "AJIZZDIZJADIOAJDOIZJAOIZJDOIAJIODZJIAJDIOZJAIOZDJALANLIKESJIZZOIZDJAOIZJDOZIAJDOIAZJDAZD"
onFinish: (identityAccessKey) => {
console.log(identityAccessKey)
// Open new window for end user to prevent duplicate verifications
window.location.href =("https://passbase.com/")
}
})
</script>
After a user completes a verification and you receive the
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.If the public encryption key is not added to the developer dashboard, you will not see the metaData information returned on the API.
{
id: "1234-1234-1234-1234",
resources: [...],
metadata: { internal_customer_id: "XYZ" }
}
If you wish to start the verification programmatically you can do so by invoking the start method with code.
<div id="passbase-button"></div>
<script type="text/javascript">
const element = document.getElementById("passbase-button")
const apiKey = "YOUR_API_KEY"
Passbase.renderButton(element, apiKey, {
onSubmitted: (identityAccessKey) => {},
onFinish: (identityAccessKey) => {},
onError: (errorCode) => {},
onStart: () => {},
});
// Example: Start the verification flow after 5s
setTimeout(() => {
Passbase.start()
}, 5000);
</script>
Our component currently supports a set of customization options which will influence the appearance of the modal, once opened. The preferred way to customize this is via the developer dashboard's customization section.
Here you can choose amongst a variety of colors, fonts, accepted countries & much more.
Customization Section
The modal also supports a
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 theme |
| enableSystemDarkMode: 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) |
Passbase.renderButton(element, apiKey,
{
theme: {
darkMode: true,
enableSystemDarkMode: true
}
}
)
Dark Mode
We support a variety of different languages for the verification flow. As of this writing more than 10 including (English, Spanish, German & many more). If one is missing and you want us to add support for it, please reach out to our customer support.
The Verification flow automatically detects the language of the user's browser settings. If we support the language, the verification flow will be set to it. Otherwise the default is English.
If you wish to customize the appearance of the Verification button you may do so by following the example:
<button type="button" onclick="onClick()">
Your Customized Button
</button>
<div id="passbase-button"></div>
<script type="text/javascript">
const element = document.getElementById("passbase-button")
const apiKey = "YOUR_API_KEY"
Passbase.renderButton(element, apiKey, {
// ...your configuration,
hidden: true, // NOTE: this is important
});
function onClick() {
Passbase.start();
};
</script>
If you've followed this integration guide, you have successfully integrated Passbase in your Website. You can also check out the code below that shows a working example and compare it with your own solution. To run the code press the Open Sandbox button in the lower right corner.
The demo needs to be in an window in order for the Javascript to work & render the Passbase verification flow. Hence open the Sandbox and then click the Open in New Window button in the top right corner to open the rendered page in a new tab.
You have successfully completed the Passbase HTML + JS integration! 🎉
Last modified 1yr ago