Get EnterpriseOpen Dashboard

Identities

View identity details

See the details of one identity, or list every identity.

GET/identities/{identity_id}

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: Core API key.

Path

identity_idstringrequiredpath

Id of the identity to retrieve. Leave identity_id out to return every identity, newest first.

Response

[]array of identity objects

Each item is an identity and uses the same fields as a single identity.

Returns one identity.

identity_idstringrequired

Id of the identity.

identity_typestring

individual or organization.

organization_namestring

Name of the organization.

first_namestring

First name of the individual.

last_namestring

Last name of the individual.

other_namesstring

Other names linked to the individual.

genderstring

Gender of the individual.

dobstring

Date of birth.

email_addressstring

Email address of the identity.

phone_numberstring

Contact number of the identity.

nationalitystring

Nationality of the individual.

categorystring

Label stored for this customer.

streetstring

Street address of the identity.

countrystring

Country of the identity.

statestring

State or region of the identity.

post_codestring

Postal code of the identity.

citystring

City of the identity.

created_atstringrequired

When Blnk created the identity.

meta_dataobject

Custom metadata linked to the identity.