Skip to main content
GET
/
customers
/
{id}
/
identifications
Get all customer Identifications
curl --request GET \
  --url https://api.sandbox.iron.xyz/api/customers/{id}/identifications \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "Pending",
      "updated_at": "2023-11-07T05:31:56Z",
      "step_status": {
        "company_beneficiaries": {
          "result": "Pending",
          "retry": true
        },
        "company_data": {
          "result": "Pending",
          "retry": true
        },
        "company_documents": {
          "result": "Pending",
          "retry": true
        },
        "questionnaire": {
          "result": "Pending",
          "retry": true
        }
      },
      "url": "<string>"
    }
  ],
  "cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prev_cursor": null
}

Authorizations

X-API-Key
string
header
required

API Key

Headers

X-SUB-PARTNER-ID
string

Optional sub-partner UUID, if provided, the identifications will be filtered for the sub-partner

Path Parameters

id
string<uuid>
required

the ID of the Customer to get Identifications for

Query Parameters

cursor
string<uuid>

Paging: the cursor field from previous page

page_size
integer<uint32>
default:10

Paging: the requested page size (max 100)

Response

GET ALL Identification Succeeded

PagedList

A list of items with cursors used to fetch the next or previous page

items
Identification · object[]
required

The list of items

cursor
string<uuid>

The cursor used to fetch the next page

prev_cursor
string<uuid>

The cursor used to fetch the previous page