Create a check
Please refer to the check type respective pages for a more detailed breakdown of request and response structures:
URL
POST https://api.complycube.com/v1/checks
Creates a new check.
Headers
Name | Type | Description |
---|---|---|
| string | The content-type must always be set to |
| string | The API |
Body
Name | Type | Description |
---|---|---|
| string | The ID of the client. |
| string | The type of check. Valid values include:
1. 8. 9. |
| boolean | Determines whether continuous monitoring is enabled. When not provided, it defaults to false. |
| string | The ID of the document. This is required when the type of check is |
| string | The ID of the live photo. This is required when the type of check is |
| string | The ID of the live video. This is required when the type of check is |
| object | The advanced optional configuration associated with the check. Also, see the options object defined under each |
| boolean | Where required, you must collect the client's consent before creating a check. |
Example request
Example response
Last updated