Skip to main content
GET
/
identities
/
{identity_id}
Get identity
curl --request GET \
  --url http://localhost:5001/identities/{identity_id} \
  --header 'X-blnk-key: <api-key>'
Use blnk.Identity.get to fetch a single identity by its identity id.
blnk.Identity.get
const response = await blnk.Identity.get(
  'idt_3b63c8da-af29-4cc3-ad38-df17d87456e6',
);
FieldDescription
idIdentity ID to retrieve.

​
Response shape

200 OK
{
  "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"
  }
}
FieldDescription
identity_idUnique ID for the identity.
identity_typeindividual or organization.
created_atDate and time the identity was created.
meta_dataMetadata stored with the identity.
The response includes every profile field set on the identity.

How identities work

Linking balances and handling profile data.

View identity details

HTTP request and response schema.

​
Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.