GET
/
identities
/
{identity_id}
curl --request GET \
  --url http://localhost:5001/identities/{identity_id} \
  --header 'X-blnk-key: <api-key>'

{
  "identity_id": "idt_3b63c8da-af29-4cc3-ad38-df17d87456e6",
  "identity_type": "individual",
  "organization_name": "",
  "first_name": "Alice",
  "last_name": "Smith",
  "other_names": "Marie",
  "gender": "female",
  "dob": "1985-05-15T00:00:00Z",
  "email_address": "alice.smith@example.com",
  "phone_number": "+1234567890",
  "nationality": "Canadian",
  "category": "customer",
  "street": "789 Elm St",
  "country": "Canada",
  "state": "Ontario",
  "post_code": "M4B 1B3",
  "city": "Toronto",
  "created_at": "2024-11-26T08:36:36.238244338Z",
  "meta_data": {
    "customer_id": "CUST123456",
    "membership_level": "Gold",
    "preferred_language": "English",
    "verification_data": {
        "verified_by": "ThirdPartyService",
        "verification_date": "2024-07-01T10:00:00Z",
        "verification_status": "verified"
    }
  }
}

​
Authorization

If set, the API uses an API key for authentication. Include the following header in your requests: X-blnk-key: <api-key>. Replace <api-key> with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code. See also: Secure your Blnk server

​
Path

​
identity_id
string
Specifies the unique ID of the identity being retrieved. Leave empty to view all identities in your Blnk Ledger.
curl --request GET \
  --url http://localhost:5001/identities/{identity_id} \
  --header 'X-blnk-key: <api-key>'

{
  "identity_id": "idt_3b63c8da-af29-4cc3-ad38-df17d87456e6",
  "identity_type": "individual",
  "organization_name": "",
  "first_name": "Alice",
  "last_name": "Smith",
  "other_names": "Marie",
  "gender": "female",
  "dob": "1985-05-15T00:00:00Z",
  "email_address": "alice.smith@example.com",
  "phone_number": "+1234567890",
  "nationality": "Canadian",
  "category": "customer",
  "street": "789 Elm St",
  "country": "Canada",
  "state": "Ontario",
  "post_code": "M4B 1B3",
  "city": "Toronto",
  "created_at": "2024-11-26T08:36:36.238244338Z",
  "meta_data": {
    "customer_id": "CUST123456",
    "membership_level": "Gold",
    "preferred_language": "English",
    "verification_data": {
        "verified_by": "ThirdPartyService",
        "verification_date": "2024-07-01T10:00:00Z",
        "verification_status": "verified"
    }
  }
}

​
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.