Skip to main content
POST
/
identities
curl -X POST https://YOUR_BLNK_INSTANCE_URL/identities \
  -H "Content-Type: application/json" \
  -H "X-Blnk-Key: YOUR_API_KEY" \
  -d '{
    "identity_type": "individual",
    "first_name": "John",
    "last_name": "Doe",
    "email_address": "[email protected]",
    "phone_number": "+1234567890",
    "nationality": "US",
    "category": "individual",
    "street": "123 Main St",
    "country": "United States",
    "state": "California",
    "post_code": "90210",
    "city": "Beverly Hills",
    "dob": "1990-01-15T00:00:00Z",
    "meta_data": {
      "customer_tier": "premium"
    }
  }'

{
  "identity_id": "idt_1234567890",
  "identity_type": "individual",
  "first_name": "John",
  "last_name": "Doe",
  "other_names": "",
  "gender": "",
  "email_address": "[email protected]",
  "phone_number": "+1234567890",
  "nationality": "US",
  "organization_name": "",
  "category": "individual",
  "street": "123 Main St",
  "country": "United States",
  "state": "California",
  "post_code": "90210",
  "city": "Beverly Hills",
  "dob": "1990-01-15T00:00:00Z",
  "created_at": "2024-01-15T10:30:00Z",
  "meta_data": {
    "customer_tier": "premium"
  }
}
Creates a new identity record to store customer or organizational information. Identities can represent individuals, organizations, or any entity that transacts within your ledger system.

​
Request Body

​
identity_type
string
Type of identity (e.g., “individual”, “organization”)
​
first_name
string
First name of the individual
​
last_name
string
Last name of the individual
​
other_names
string
Middle names or other names
​
gender
string
Gender of the individual
​
dob
string
Date of birth in ISO 8601 format (e.g., “2000-01-15T00:00:00Z”)
​
email_address
string
Email address (can be tokenized for PII protection)
​
phone_number
string
Phone number (can be tokenized for PII protection)
​
nationality
string
Nationality or citizenship
​
organization_name
string
Name of the organization (for organizational identities)
​
category
string
Category classification (e.g., “individual”, “corporate”, “merchant”)
​
street
string
Street address (can be tokenized for PII protection)
​
country
string
Country of residence
​
state
string
State or province
​
post_code
string
Postal or ZIP code (can be tokenized for PII protection)
​
city
string
City of residence
​
meta_data
object
Additional metadata as key-value pairs

​
Response

​
identity_id
string
Unique identifier for the created identity
​
identity_type
string
Type of identity
​
first_name
string
First name
​
last_name
string
Last name
​
other_names
string
Other names
​
gender
string
Gender
​
email_address
string
Email address
​
phone_number
string
Phone number
​
nationality
string
Nationality
​
organization_name
string
Organization name
​
category
string
Category
​
street
string
Street address
​
country
string
Country
​
state
string
State
​
post_code
string
Postal code
​
city
string
City
​
dob
string
Date of birth in ISO 8601 format
​
created_at
string
Timestamp when the identity was created
​
meta_data
object
Additional metadata
curl -X POST https://YOUR_BLNK_INSTANCE_URL/identities \
  -H "Content-Type: application/json" \
  -H "X-Blnk-Key: YOUR_API_KEY" \
  -d '{
    "identity_type": "individual",
    "first_name": "John",
    "last_name": "Doe",
    "email_address": "[email protected]",
    "phone_number": "+1234567890",
    "nationality": "US",
    "category": "individual",
    "street": "123 Main St",
    "country": "United States",
    "state": "California",
    "post_code": "90210",
    "city": "Beverly Hills",
    "dob": "1990-01-15T00:00:00Z",
    "meta_data": {
      "customer_tier": "premium"
    }
  }'

{
  "identity_id": "idt_1234567890",
  "identity_type": "individual",
  "first_name": "John",
  "last_name": "Doe",
  "other_names": "",
  "gender": "",
  "email_address": "[email protected]",
  "phone_number": "+1234567890",
  "nationality": "US",
  "organization_name": "",
  "category": "individual",
  "street": "123 Main St",
  "country": "United States",
  "state": "California",
  "post_code": "90210",
  "city": "Beverly Hills",
  "dob": "1990-01-15T00:00:00Z",
  "created_at": "2024-01-15T10:30:00Z",
  "meta_data": {
    "customer_tier": "premium"
  }
}

​
Webhook Event

After successful creation, the identity.created webhook event is triggered with the identity object as the payload.

​
PII Protection

Certain fields can be tokenized after creation to protect personally identifiable information (PII):
  • first_name
  • last_name
  • other_names
  • email_address
  • phone_number
  • street
  • post_code
Use the tokenization endpoints to protect sensitive data.
See Also: Tokenize Field, Get Identity

Build docs developers (and LLMs) love

Get started for freeTalk to us