Skip to main content
POST
/
proxy
/
identities
curl -X POST "https://api.cloud.blnkfinance.com/proxy/identities?instance_id=YOUR_INSTANCE_ID" \
  -H "Authorization: Bearer blnk_at_YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "John",
    "last_name": "Doe",
    "email_address": "john.doe@example.com",
    "phone_number": "+1234567890",
    "nationality": "US",
    "gender": "male",
    "dob": "1990-01-01",
    "street": "123 Main St",
    "city": "New York",
    "state": "NY",
    "post_code": "10001",
    "country": "US",
    "category": "individual",
    "identity_type": "customer",
    "meta_data": {
      "myApp": {
        "segment": "premium",
        "kyc_status": "verified"
      }
    }
  }'

{
  "identity_id": "idt_3b63c8da-af29-4cc3-ad38-df17d87456e6",
  "first_name": "John",
  "last_name": "Doe",
  "other_names": "",
  "email_address": "john.doe@example.com",
  "phone_number": "+1234567890",
  "nationality": "US",
  "gender": "male",
  "dob": "1990-01-01",
  "street": "123 Main St",
  "city": "New York",
  "state": "NY",
  "post_code": "10001",
  "country": "US",
  "organization_name": "",
  "category": "individual",
  "identity_type": "customer",
  "created_at": "2024-11-26T08:36:36.238244338Z",
  "meta_data": {
    "myApp": {
      "segment": "premium",
      "kyc_status": "verified"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://guide.cloud.blnkfinance.com/llms.txt

Use this file to discover all available pages before exploring further.

Create a new identity record (for example, a customer or vendor) in your Blnk Core instance.
For in-depth information about Blnk’s ledger, balance, transaction, and identity APIs, see the Blnk Core docs.

​
Request structure

curl -X POST "https://api.cloud.blnkfinance.com/proxy/identities?instance_id=YOUR_INSTANCE_ID" \
  -H "Authorization: Bearer blnk_at_YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "John",
    "last_name": "Doe",
    "email_address": "john.doe@example.com",
    "phone_number": "+1234567890",
    "nationality": "US",
    "gender": "male",
    "dob": "1990-01-01",
    "street": "123 Main St",
    "city": "New York",
    "state": "NY",
    "post_code": "10001",
    "country": "US",
    "category": "individual",
    "identity_type": "customer",
    "meta_data": {
      "myApp": {
        "segment": "premium",
        "kyc_status": "verified"
      }
    }
  }'
​
Authorization
string
required
Bearer token for authentication. Format: Bearer <access_token>. Your OAuth key must include proxy:write scope (or *).
​
first_name
string
First name for the identity.
​
last_name
string
Last name for the identity.
​
other_names
string
Other names or aliases for the identity.
​
email_address
string
Email address for the identity.
​
phone_number
string
Phone number for the identity.
​
nationality
string
Nationality code for the identity (for example, US).
​
gender
string
Gender for the identity (for example, male).
​
dob
string
Date of birth for the identity in YYYY-MM-DD format.
​
street
string
Street address for the identity.
​
city
string
City for the identity.
​
state
string
State or province for the identity.
​
post_code
string
Postal code for the identity.
​
country
string
Country code for the identity (for example, US).
​
organization_name
string
Organization name, if the identity represents an organization.
​
category
string
Category for the identity (for example, individual or organization).
​
identity_type
string
Type of identity (for example, customer or vendor).
​
meta_data
object
Optional metadata object for custom key-value data. Use a top-level key (e.g., your app name) to avoid conflicts.

​
Query parameters

​
instance_id
string
required
The Blnk Core instance ID to target. Find this in Blnk Cloud under Instances.

​
Response structure

{
  "identity_id": "idt_3b63c8da-af29-4cc3-ad38-df17d87456e6",
  "first_name": "John",
  "last_name": "Doe",
  "other_names": "",
  "email_address": "john.doe@example.com",
  "phone_number": "+1234567890",
  "nationality": "US",
  "gender": "male",
  "dob": "1990-01-01",
  "street": "123 Main St",
  "city": "New York",
  "state": "NY",
  "post_code": "10001",
  "country": "US",
  "organization_name": "",
  "category": "individual",
  "identity_type": "customer",
  "created_at": "2024-11-26T08:36:36.238244338Z",
  "meta_data": {
    "myApp": {
      "segment": "premium",
      "kyc_status": "verified"
    }
  }
}
​
identity_id
string
required
Unique identifier for the created identity.
​
created_at
timestamp
required
ISO 8601 formatted timestamp of when the identity was created.
​
meta_data
object
Metadata object attached to the identity, if any.

​
Need help?

If you’re having trouble with Blnk Cloud, don’t hesitate to send us a message via email at support@blnkfinance.com or send us a message here.