Skip to main content
POST
/
identities
Create identity
curl --request POST \
  --url http://localhost:5001/identities \
  --header 'X-blnk-key: <api-key>'
Use blnk.Identity.create to create an identity for an individual or organization.
blnk.Identity.create
const response = await blnk.Identity.create({
  identity_type: 'individual',
  first_name: 'Alice',
  last_name: 'Smith',
  email_address: 'alice.smith@example.com',
});
FieldDescription
identity_typeindividual or organization.
identity_idOptional ID you can set yourself. Blnk generates one if you omit it.
organization_nameName of the organization.
first_nameFirst name of the individual.
last_nameLast name of the individual.
other_namesAny other names for the individual.
genderGender of the individual.
dobDate of birth (ISO 8601, for example 1990-01-15T00:00:00Z).
email_addressEmail address.
phone_numberContact number.
nationalityNationality of the individual.
categoryYour own customer category.
streetStreet address.
countryCountry of residence.
stateState of residence.
post_codePostal code.
cityCity of residence.
meta_dataOptional metadata.

​
Response shape

201 Created
{
  "identity_id": "idt_11111111-1111-4111-8111-111111111111",
  "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. Use it to link balances.
identity_typeType you passed in the request.
created_atDate and time the identity was created.
meta_dataMetadata stored with the identity.
The response echoes every field you sent.

How identities work

Linking balances and handling profile data.

Create new identity

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.