Create a session (via workflows)

URL

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

Creates a session.

This enables you to create a session using workflows, which is the recommended integration approach.

Headers

Name	Type	Description
Content-Type*	string	The content-type must always be set to application/json.
Authorization*	string	The API live or test key

Body

Name	Type	Description
clientId*	string	The ID of the client.
workflowTemplateId*	string	The ID of the workflow template. This automatically invokes its active version. If no version is active, the request will fail.
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.
theme	string	The UI theme to apply. Valid values include: light (default) dark
supportEmail	string	The support email address that appears on the UI for your clients. When not provided, no email address will be displayed.
shortUrl	boolean	Indicates whether the generated URL should be shortened. Short URLs are useful for specific use cases, such as sending links via SMS. When not provided, this defaults to false. It is recommended to keep the default unless you have a specific need for a short URL.

Example request

cURL

curl -X POST https://api.complycube.com/v1/flow/sessions \
     -H 'Authorization: <YOUR_API_KEY>' \
     -H 'Content-Type: application/json' \
     -d '{
          "clientId": "CLIENT_ID",
          "workflowTemplateId": "WORKFLOW_TEMPLATE_ID",
          "successUrl": "https://www.yoursite.com/success",
          "cancelUrl": "https://www.yoursite.com/cancel"
        }'

Node.js

Python

PHP

.NET

Example response

Success (200)

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

Invalid Request (400)