Mobile SDK Quick Guide

Our smart mobile SDKs provide assisted guidance to your clients.
Our Mobile SDKs come with intelligent, user-friendly user interfaces that walk your clients through a configurable verification process.
By passing custom configuration to the SDK on launch, you can define the flow you would like your clients to complete at runtime.

Integration at a glance

1. Generate an SDK Token

Tokens enable clients to send personal data to ComplyCube via our SDKs securely. Use the generate token endpoint to obtain an SDK token and initialize the SDK.
curl -X POST \
-H 'Authorization: <YOUR_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"referrer": "APPLICATION_ID"
const { ComplyCube } = require("@complycube/api");
const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });
const token = await complycube.token.generate("CLIENT_ID", {
referrer: "APPLICATION_ID"
from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')
token = cc_api.tokens.create('CLIENT_ID','APPLICATION_ID')
use ComplyCube\ComplyCubeClient;
$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');
$token = $ccapi->tokens()->generate('CLIENT_ID', 'APPLICATION_ID');
using ComplyCube.Net;
using ComplyCube.Net.Resources.SDKTokens;
var sdkTokenApi = new SDKTokenApi(new ComplyCubeClient("YOUR_API_KEY"));
var sdkTokenRequest = { clientId = "CLIENT_ID", referrer = "APPLICATION_ID" }
var sdkToken = await sdkTokenApi.GenerateToken(sdkTokenRequest);

2. Configure the SDK

Initialize the SDK with the previously generated token and your Client ID. This enables the SDK to securely send your clients information directly to their client record.
sdk.token = "SDK_TOKEN"
sdk.clientId = "CLIENT_ID"
let documentStage = DocumentStageBuilder()
.setAllowedDocumentTypes(types: [ .passport,
.useLiveCaptureOnly(enable: false)
let selfieStage = BiometricStageBuilder()
sdk.availableScreens = [selfieStage, documentStage]
sdk.start(with: self)
val sdk = setupComplyCubeSdkLauncher("SDK_TOKEN",
Document(Passport(), NationalIdentityCard()),
}, callback = this::callbackHandler)

3. Perform Checks

Using theSDKResult object returned by the SDK, you can trigger your backend to run the necessary checks on your client. For example, use;
  • SDKResult.Success.DocumentId to run a document check
  • SDKResult.Success.DocumentId and SDKResult.Success.LivePhotoId to run an identity check