Identities

Create identity

Create a new identity with the Java SDK.

POST/identities

Use blnk.identity().create for this operation.

Call the method

ApiResponse<JsonNode> response = blnk.identity().create(
    IdentityData.create()
        .identityType("individual")
        .firstName("Jane")
        .lastName("Doe")
        .emailAddress("[email protected]")
        .category("customer"));

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`	`String`	Contact number.
`nationality`	`String`	Nationality of the individual.
`category`	`String`	Your own customer category.
`street`	`String`	Street address.
`country`	`String`	Country of residence.
`state`	`String`	State of residence.
`post_code`	`String`	Postal code.
`city`	`String`	City of residence.
`meta_data`	`Map<String, Object>`	Optional metadata.

Save the identity ID

Use response.data().get("identity_id").asText() 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": "[email protected]",
  "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`	`JsonNode`	Metadata stored with the identity.

The response echoes every field you sent.