Skip to main content
POST
/
identities
curl --request POST \
  --url http://localhost:5001/identities \
  --header 'X-blnk-key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "identity_id": "idt_11111111-1111-4111-8111-111111111111",
    "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",
    "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"
      }
    }
  }'

{
  "identity_id": "idt_11111111-1111-4111-8111-111111111111",
  "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"
    }
  }
}
If you’re using the auto-provisioned Enterprise Core instance included with your Production License deployment, set the base URL to: https://ENTERPRISE_PUBLIC_URL/core.If you’re connecting to a different Core instance, use the publicly accessible base URL for that instance instead.

​
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

​
Body

​
identity_id
string
Optional caller-supplied identity id. When provided, it must start with idt_ followed by a valid UUID, for example idt_11111111-1111-4111-8111-111111111111. Use this for deterministic identity creation from an external holder id. Duplicate values return a conflict response.
​
identity_type
string
required
Specifies the identity type. Options are "individual" or "organization"
​
organization_name
string
Name of the organization.
​
first_name
string
First name of individual.
​
last_name
string
Last name of individual.
​
other_names
string
Any other names linked to individual.
​
gender
string
Gender of the individual.
​
dob
string
Date of birth.
​
email_address
string
Email address of the identity.
​
phone_number
string
Contact number of the identity.
​
nationality
string
Nationality of the individual.
​
category
string
Type of customer depending on your use case.
​
street
string
Street address of the identity.
​
country
string
Residential country of the identity.
​
state
string
State of residence of the identity.
​
post_code
string
Postal code related to the identity.
​
city
string
City of residence of the identity.
​
meta_data
object
Custom metadata linked to the identity.

​
Response

All parameters from the request body also mean the same in the corresponding response JSON.
​
identity_id
string
required
Unique id of the created identity.
​
created_at
string
Specified the date and time the identity was created.
curl --request POST \
  --url http://localhost:5001/identities \
  --header 'X-blnk-key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "identity_id": "idt_11111111-1111-4111-8111-111111111111",
    "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",
    "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"
      }
    }
  }'

{
  "identity_id": "idt_11111111-1111-4111-8111-111111111111",
  "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.