Get Status

May not contain personally identifiable information (PII).

200

Successfully retrieved status.

Response body

object

public_data

object

version

string

Version of the API.

endpoint

string

The requested endpoint.

private_data

object

required

transaction_id

string

ID issued at the beginning of a transaction to associate all subsequent processes within the transaction until ended.

status

array of objects

Array of status updates during the customer journey.

status

object

event

integer

Status event code. See Status Event Codes.

sequence

string

Time-stamped indication of when Capture logged the event. Format is yyyy-mm-dd hh:mm:ss.%f.

timestamp

string

Time-stamped indication of when the server received the event. Format is yyyy-mm-dd hh:mm:ss.%f

message

string

Message describing the event code.

url

string

The Capture URL from which the event was logged.

user_agent

string

A description of the device and browser that is running the Capture experience.

xxxxxxxxxx
curl --request POST \
     --url https://apiexample.intellicheck.com/api/v1/get-status \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'customer-id: <customer_id>' \
     --header 'signature: <calculated_signature>' \
     --data '
{
  "private_data": {
    "transaction_id": "<transaction_id>"
  }
}
'

xxxxxxxxxx
 
[
  {
    "public_data": {
      "version": "3.1.0",
      "endpoint": "get-status"
    },
    "private_data": {
      "transaction_id": "3fb21ac1-eb92-4705-8fcb-40eed01cb369"
    }
  }
]

200Successfully retrieved status.

401Unauthorized