---
title: "Get Status"
method: POST
path: "/api/v1/get-status"
tags: ["Get Data"]
---

# Get Status

`POST /api/v1/get-status`

Use this endpoint to poll for status updates during the Capture process. This endpoint is an alternative to the postback status results sent to the `status_url` provided in the `/start` request body.

## Headers

- `signature` string, required — Encrypted Request Body
- `customer-id` string, required — Your provided customer ID.

## Request body

- AppRoutesRoutesMvpV1SwaggerSwaggerDocModelsGetStatusRouteRequest
  - `public_data` object, required — May **not** contain personally identifiable information (PII).
  - `private_data` object, required — May contain personally identifiable information (PII).
    - `transaction_id` string, required — ID issued at the beginning of a transaction to associate all subsequent processes within the transaction until ended.

## Response `200`

Successfully retrieved status.

- AppRoutesRoutesMvpV1SwaggerSwaggerDocModelsGetStatusRouteResponse
  - `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` object[] — Array of status updates during the customer journey.
      - `transaction_id` string — ID issued at the beginning of a transaction to associate all subsequent processes within the transaction until ended.
      - `customer_id` string — Your provided customer ID.
      - `client_time` string, date-time — A value of `null` or `None` means means no event occurred on the client. Else, a time-stamped indication of when Capture logged the event. Typically identical to `sequence`. Format is yyyy-mm-dd hh:mm:ss.%f.
      - `server_time` string, date-time — Time-stamped indication of when the server received the event. Typically identical to `timestamp`. Format is yyyy-mm-dd hh:mm:ss.%f
      - `event` integer — Status event code. See _Status Event Codes_ for [Direct](https://idn-direct-api.readme.io/v0.0.1/docs/status-event-codes) or [Capture](https://idn-capture.readme.io/docs/status-event-codes) depending on your implementation.
      - `message` string — Message describing the event code.
      - `sequence` string, date-time — A value of `null` or `None` means means no event occurred on the client. Else, a time-stamped indication of when Capture logged the event. Typically identical to `client_time`. Format is yyyy-mm-dd hh:mm:ss.%f.
      - `timestamp` string, date-time — Time-stamped indication of when the server received the event. Typically identical to `server_time`. Format is yyyy-mm-dd hh:mm:ss.%f

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.net/intellicheck/apis/idn-direct-api.md) · [All operations](https://skmtc.net/intellicheck/apis/idn-direct-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/intellicheck/idn-direct-api/versions/9ce4fb734b46/schema)