API Reference

Create a transaction

post
https://api.cm.com/id-scan/v1/transactions

Create a new transaction. For the webhook callback structure see the Callbacks tab.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
3600 to 86400
Defaults to 3600

The time in seconds after which a transaction should expire.

tasks
array of objects
required

The tasks to be performed by the user. The face_liveness task can only be performed when the document_scan task is added. For the face_match task both the document_scan task and face_liveness task must be added.

tasks*
settings
object
string
enum
Defaults to en-US

The language of the ID Scan process. Currently supports English, Dutch, French, and Italian.

Allowed:
boolean
Defaults to false

When this is set to true, the user must complete the transaction on their mobile device.

string
Defaults to null

The URL to redirect the user to after the transaction is completed. The trxid, state and resultid will be added as a query parameter. If the URL is not set a default page is shown.

string
Defaults to null

The URL to redirect the user to in case the transaction is transferred to a mobile device (by scanning the QR code) and the transaction is completed. The trxid and state will be added as a query parameter. If the URL is not set a default page is shown.

Responses

Callback

Updated over 3 years ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 3 years ago