KYC SDKs

The SDK provides a set of screens for capturing identity documents, face photos, profile data, and for performing the liveness check. After capturing the data, the SDK uploads it to the IDscan server.

To use the SDK, you will have to GET multiple information depending of your Enduser. To do so, you can use this endpoint :

KYC successfully created

Response Schema: application/json

Any of:

Gives KYC validation url.

id required	string <uuid> The identifier of the KYC application created. When making a request with the KYC SDK: you will need to add this ID in the 'externalId' payload field (in 'metadata').
token required	string The KYC SDK JWT that you will need to use to authorize your request with the KYC SDK.
kycApiUrl required	string The base URL you will need to use to create your request with the KYC SDK.
flowName required	string The KYC flow name you will need to use to create your request with the KYC SDK.
ttl required	string Default: "PT24H" The KYC SDK token time to live duration in ISO 8601.

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"token": "string",
"kycApiUrl": "string",
"flowName": "string",
"ttl": "string"
}

1. iOS Integration

Type	Link
iOS SDK Integration Documentation :	Click here
iOS SDK Flutter Integration Documentation :	Click here
iOS SDK React Native Documentation :	Click here
iOS SDK Ionic Documentation :	Click here

2. Android Integration

Type	Link
Android SDK Integration Documentation :	Click here
Android SDK Flutter Integration Documentation :	Click here
Android SDK React Native Documentation :	Click here
Android SDK Ionic Documentation :	Click here

3. Web Integration

This SDK provides a configurable widget that will allow your users to capture their personal data and/or face/id documents photos in order to verify their identity. You can integrate a verification flow inside your website or personal area. A user will not be redirected from your website.

Type	Link
SDK Integration:	Click here

SDK in an iframe :

You can provide us the whitelist of allowed domains, wildcards are supported. IDscan will only allow redirects or embed for domains in this list.

You will be also able to generate a one time SDK verification link generated generic or enriched. Contact us for this option.

Example of iframe :

Copy

Copied

<iframe src="generated url"
  width="100%"
  height="750"
  frameBorder="0"
  allow="camera; microphone">
</iframe>