INintellicheck
Start a Transaction

Start Transaction

Changed on

Starts a transaction. For Capture, you begin and end the transaction with a single call to the /start endpoint. For Direct, you begin the transaction with a call to the /start endpoint, and then continue the transaction with subsequent calls to additional endpoints, such as /submit-back, /end, and /get-results.

post/api/v1/start

Request

  • Base URL
    https://apiexample.intellicheck.com
  • URL
    https://apiexample.intellicheck.com/api/v1/start
  • Auth
    none declared. Required headers: signature, customer-id

Headers

signaturestring required

Encrypted Request Body

customer-idstring required

Your provided customer ID.

Request body

Response

Transaction successfully started. The response body varies based on the integration and request parameters. The body is base64-encoded and signed (media type application/octet-stream), not plain JSON. Your integration must base64-decode the body and verify the response signature header. The examples show the decoded bodies for readability.

Changes

  • b8ce40c90417Revision changes
    • breaking

      added to the response body oneOf list for the response status

    • breaking

      removed the media type application/json for the response with the status

    • info

      removed from the response body oneOf list for the response status

    • info

      added the media type application/octet-stream for the response with the status