Skip to content

Verify Transaction Authentication Key ​

Redeems the authentication key produced by a product's verification step and moves the transaction to VERIFIED. This is the step that turns a face match or chip read into a transaction your backend can trust.

Endpoint ​

http
POST /v1/verify_transaction_key
Content-Type: application/json
json
{
  "user_id": "user_00000001",
  "ref_id": "ref_00000001",
  "authentication_key": "<AUTHENTICATION_KEY>"
}

Parameters:

ParamTypeRequiredDefaultDescription
user_idstringYes—The user ID.
ref_idstringYes—The transaction reference ID.
authentication_keystringYes—The authentication key generated by the product verification step that preceded this call.

Returns: VerifyTransactionKeyResponse

Sample Request ​

bash
curl --location '<BASE_URL>/v1/verify_transaction_key' \
  --header 'Authorization: ATV <ACCESS_ID>:<SIGNATURE>' \
  --header 'X-TV-Timestamp: <TIMESTAMP>' \
  --header 'Content-Type: application/json' \
  --data '{
    "user_id": "user_00000001",
    "ref_id": "ref_00000001",
    "authentication_key": "<AUTHENTICATION_KEY>"
  }'

Response ​

json
{
  "data": {
    "id": "69306e8a-68e3-43f6-97ae-02b8e7c356f7",
    "ref_id": "ref_00000001",
    "user_id": "user_00000001",
    "status": "VERIFIED"
  },
  "errors": []
}
FieldTypeDescription
data.idstringThe transaction unique ID.
data.ref_idstringThe transaction reference ID.
data.user_idstringThe user ID.
data.statusstringVERIFIED on success.
errorsarrayDetail of each failure. Empty on success.

WARNING

Redeem the key from your backend, never from the app. The authentication key is the single artefact that proves the user passed the biometric check — call this endpoint server-to-server only.

Errors ​

CodeMessage
2001010Access ID not found.
2001020Transaction lock failed.
2001021Invalid transaction request.
2001023Invalid transaction key.
401100You are not authorized to perform the action.
4001000Input parameter violates a constraint.
4001001The X-TV-Timestamp header is expired, need a newer one.
5001000Some unexpected error occurs while processing the request.
CodeDescription
access_id_not_foundThe API key is incorrect.
transaction_invalid_requestInvalid transaction request.
internal_server_errorSome unexpected error occurs while processing the request.
CodeError codeDescription
401access_denied_exceptionYou are not authorized to perform the action.
500internal_server_errorSome unexpected error occurs while processing the request.

Next Steps ​

Developers