Create a session

URL

POST https://api.complycube.com/v1/flow/sessions

Creates a session.

Headers

NameTypeDescription

Content-Type*

string

The content-type must always be set to application/json.

Authorization*

string

The API live or test key

Body

NameTypeDescription

clientId*

string

The ID of the client.

checkTypes*

string

An array of check types. Valid values include: 1. standard_screening_check 2. extensive_screening_check 3. document_check 4. identity_check 5. enhanced_identity_check 6. proof_of_address_check

7. face_authentication_check 8. age_estimation_check

successUrl*

array

The URL to which ComplyCube should send clients when KYC and identity verification is complete.

cancelUrl*

array

The URL the client will be directed to if they decide to cancel and return to your website.

enableMonitoring

boolean

Determines whether continuous monitoring is enabled for selected check types. When not provided, it defaults to false.

language

string

The UI language. Valid values include:

  1. en (default)

  2. ar

  3. de

  4. es

  5. fr

  6. hi

  7. hk

  8. id

  9. it

  10. ja

  11. ko

  12. nl

  13. no

  14. pl

  15. pt

  16. sv

  17. th

  18. vi

  19. zh

theme

string

The UI theme to apply. Valid values include:

  1. light (default)

  2. dark

allowDocumentUpload

boolean

Indicates whether to force users to capture their documents using their phones. This removes the document upload option. When not provided, it defaults to true.

supportEmail

string

The support email address that appears on the UI for your clients. When not provided, no email address will be displayed.

messages

object

The custom messages to display on the UI for your users. Also, see the messages object below.

documentTypes

object

The list of ID document types the client can select. When not provided, your client can select any of the types we support.

The checkTypes attribute

The checkTypes attribute represents the check types you would like to perform on your client. ComplyCube will generate the relevant UI capture screens based on the check types provided.

The documentTypes object

Attribute

Type

Description

passport

boolean

Enable or disable passport selection. (Optional)

driving_license

boolean

Enable or disable driving license selection. (Optional)

residence_permit

boolean

Enable or disable residence permit selection. (Optional)

national_identity_card

boolean

Enable or disable national identity card selection. (Optional)

The messages object

Attribute

Type

Description

intro

object

The intro screen message content. See the content object below. (Optional)

completion

object

The completion screen message content. See the content object below. (Optional)

The content object

Attribute

Type

Description

heading

string

The heading of the page. (Optional)

message

string

The message body of the page. (Optional)

Example request

curl -X POST https://api.complycube.com/v1/flow/sessions \
     -H 'Authorization: <YOUR_API_KEY>' \
     -H 'Content-Type: application/json' \
     -d '{
          "clientId": "CLIENT_ID",
          "checkTypes": ["extensive_screening_check", "identity_check", "document_check"],
          "successUrl": "https://www.yoursite.com/success",
          "cancelUrl": "https://www.yoursite.com/cancel",
          "documentTypes": {
               "passport": true,
               "driving_license": false,
               "residence_permit": true,
               "national_identity_card": true
          },
          "messages": {
                "intro": {
                    "heading": "Customized header",
                    "message": "Customized message body"
                },
                "completion": {
                    "heading": "Customized header",
                    "message": "Customized message body"
                }
          }
        }'

Example response

{
    "redirectUrl": "https://flow.complycube.com/test_ODdkNjhiOTU0MzY4YmE5NjRmMDMyY2E5MWYwZjgxNjMzZTcyMWJmNzU2YjZmNDQ4NmFjMTU0ZGZhYTU5MmNhY2NiNjI3ZDE4YWJkYmU2M2M3ZWYzZTlmM2M3MzgxMmM3NzZhMjVlYmQyNDI0ODdkOWQ3M2JiMjkxZTYxNzdhYmExMGEzOGRhYmM2OTIwMjgyYmEzZGY3ZDY0NWZhMjcwN2RlMTFkOTcxZWNhOWI2Zjg0NjllZGNkODVjYzMzMDA5YjdlMWY5OGIwMmZjY2UzNGI2YTMxOGQxNGZmNGFhYjczNzU0YmYwMjFkMzU1M2FjMjQ4ZDQ2ZjJjZTY4YWY0MzIxNjVlMDRjOTIyYTExMTlmMWU3YTYwMDY1NGJmYWM0NTA2MDE5NTg5NTkxYzA4MzYyYTUyM2I0NDM4OGExNWIyMTIzYTBhNDc0NDA4NWM2ZTQwMmNjMGVjMTk2YW?theme=light"
}

Last updated