Identities

Get identity

Retrieve an identity by its ID with the TypeScript SDK.

GET/identities/{identity_id}

Use blnk.Identity.get to fetch a single identity by its identity id.

Call the method

const response = await blnk.Identity.get(
  'idt_3b63c8da-af29-4cc3-ad38-df17d87456e6',
);

Field	Type	Description
`id`	`string`	Identity ID to retrieve.

Use the identity details

Read response.data for profile fields, metadata, and creation time. Use the identity ID when linking balances or updating profile data.

Response

{
  "identity_id": "idt_3b63c8da-af29-4cc3-ad38-df17d87456e6",
  "identity_type": "individual",
  "first_name": "Alice",
  "last_name": "Smith",
  "email_address": "alice.smith@example.com",
  "phone_number": "+1234567890",
  "nationality": "Canadian",
  "category": "customer",
  "created_at": "2024-11-26T08:36:36.238244338Z",
  "meta_data": {
    "customer_id": "CUST123456"
  }
}

Field	Type	Description
`identity_id`	`string`	Unique ID for the identity.
`identity_type`	`string`	`individual` or `organization`.
`created_at`	`string`	Date and time the identity was created.
`meta_data`	`Record<string, unknown>`	Metadata stored with the identity.

The response includes every profile field set on the identity.