Skip to main content

Obtain an API Key

After you have created a developer account, you must obtain an API key to authenticate your requests. To obtain an API key, follow the steps below:

Integration Types​

Based on your use case, you can choose the appropriate integration type from the following options:​

  • Web: For web-based applications
  • Mobile: For mobile applications that handle the KYC process natively (with own UI)
  • Mobile Embedded: For mobile applications that will run the KYC process in a webview

We will cover what each integration type means in the following sections.​

Web Integration​

The Web Integration is the most common type of integration. It is used for web-based applications that will handle the KYC process in a browser. To create a Web Integration, you need to set the following specific fields:

  • The Trusted Origin that will only allow the KYC process to start from the specified domain.
  • The Redirect URL will be used to redirect the user after the KYC process is completed with the validation Id in the query params.

Web Integration

Each account starts with a web Playground Integration, for testing purposes, that is limited to web use only from the developer portal. For real use, you will want to create and use your own Integrations.

Mobile Integration​

The Mobile Integration is used for mobile applications that handle the KYC process natively (with their own UI). To create a Mobile Integration, you don't have to set any specific fields, just create the integration and use the API key generated.

Mobile Integration

Mobile Embedded Integration​

The Mobile Embedded Integration is used for mobile applications that will run the KYC process in a webview. To create a Mobile Embedded Integration, you need to set the following specific fields:

  • The Deeplink callback URL will be used to redirect the user after the KYC process is completed. This URL will be opened in the mobile application, with the validation Id in the query params, so you can handle the response.

Mobile Embedded Integration

Refreshing an API Key​

Periodically, you may need to refresh your API key. To do so, simply click the Refresh API Key button on the Integration page. Ensure that the new API key is promptly updated in your application to avoid any disruptions.

Deleting an integration​

All integrations, with the exception of the Playground Integration, can be deleted. To delete an integration, click the Delete button on the Integration page. Once deleted, the integration will no longer be available for use.