Identities

Create identity

Create a new identity with the TypeScript SDK.

POST/identities

Use blnk.Identity.create to create an identity for an individual or organization.

Call the method

const response = await blnk.Identity.create({
  identity_type: 'individual',
  first_name: 'Alice',
  last_name: 'Smith',
  email_address: 'alice.smith@example.com',
});

Field	Type	Description
`identity_type`	`string`	`individual` or `organization`.

Optional parameters

Field	Type	Description
`identity_id`	`string`	Optional ID you can set yourself. Blnk generates one if you omit it.
`organization_name`	`string`	Name of the organization.
`first_name`	`string`	First name of the individual.
`last_name`	`string`	Last name of the individual.
`other_names`	`string`	Any other names for the individual.
`gender`	`string`	Gender of the individual.
`dob`	`string`	Date of birth (ISO 8601, for example `1990-01-15T00:00:00Z`).
`email_address`	`string`	Email address.
`phone_number`	`number`	Contact number.
`nationality`	`string`	Nationality of the individual.
`category`	`string`	Your own customer category.
`street`	`string`	Street address.
`country`	`number`	Country of residence.
`state`	`string`	State of residence.
`post_code`	`string`	Postal code.
`city`	`string`	City of residence.
`meta_data`	`Record<string, unknown>`	Optional metadata.

Save the identity ID

Use response.data.identity_id to link balances or update profile details later.

Response

{
  "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"
  }
}

Field	Type	Description
`identity_id`	`string`	Unique ID for the identity. Use it to link balances.
`identity_type`	`string`	Type you passed in the request.
`created_at`	`string`	Date and time the identity was created.
`meta_data`	`Record<string, unknown>`	Metadata stored with the identity.

The response echoes every field you sent.