INintellicheck
End a Transaction

End Transaction

Changed on

Signifies the data capture session is complete. Call /get-results within 10 minutes. After 10 minutes, /get-results returns 400 Bad Request for the transaction.

post/api/v1/end

Request

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

Headers

signaturestring required

Encrypted Request Body

customer-idstring required

Your provided customer ID.

Request body

public_dataobject required

May not contain personally identifiable information (PII). A public_data object is required even if it is empty, for example, public_data: {}.

Response

Successfully ended the capture session.

Example response

{
  "public_data": {
    "version": "3.1.1",
    "endpoint": "end"
  },
  "private_data": {
    "transaction_id": "1ae2c7f8-9fad-45cd-83dd-71bbe608421a"
  }
}

Changes

  • b8ce40c90417Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status