Get Identity

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

string <uuid>

optional

Unique identifier for the entity.

type

string

optional

Specifies whether the entity is an ORGANIZATION or an individual USER.

name

string

optional

The name of the entity (for users) or the official name (for organizations).

nickname

string

optional

An alternative or preferred name for the entity.

string <email>

optional

The email address associated with the entity.

phone

string

optional

he phone number linked to the entity. Include +(phone country code)

documentNumber

string

optional

The document number associated with the entity for identification purposes.

documentType

string

optional

The type of document PASSPORT, RFC, RUT, CED_CIU, CED_EXT, NIT, DNI, CE, RUC, DNI, CUIT

idv

string

optional

Identity verification reference

securityOptions

object

optional

twoFactorAuth

boolean

optional

Indicates whether two-factor authentication is enabled

signTrx

boolean

optional

Determines if the entity is required to sign transactions

signAccountsOperations

boolean

optional

Determines if the entity is required to sign account-related operations

country

string

optional

he country of operations of the entity CHL, PER, COL, ARG, MEX, USA, CAD

children

array [object {3}]

optional

A list of related entities (e.g., subsidiaries for organizations or dependent users

string

required

name

string

required

string

required

status

string

optional

The current status of the entity. PENDING, PENDING_EMAIL_VALIDATION, PENDING_PHONE_VALIDATION, SCREENING, ACTIVE

externalId

string

optional

External reference ID (client purpose).

lastname

string

optional

The last name of the user (if applicable).

bankAccount

object (bankAccount)

optional

A reference to the associated bank account

string

optional

Unique identifier for the bank account.

externalId

string

optional

External reference identifier for integrations.

accountNumber

string

required

The bank account number.

nickname

string

optional

A friendly name assigned to the bank account.

bank

string

required

The name of the bank where the account is held.

currency

string

required

The currency in which the account operates. USD, EUR, CLP, ARS, COP, PER, SOL_USDC

typeAccount

string

optional

The type of bank account. CHECKING_ACOUNT, SAVINGS, ASSET

accountHolder

string

required

The full name of the account holder.

accountHolderDni

string

required

The national identification number or tax ID of the account holder.
he country of operations of the entity

country

string

optional

The country where the bank account is registered. CHL, PER, COL, ARG, MEX, USA, CAD

createdAt

string <date-time>

optional

Timestamp indicating when the account was created.

updatedAt

string <date-time>

optional

Timestamp indicating the last update to the account details.

rules

object

optional

Custom rules or policies applicable to the entity.

gender

string

optional

Gender information (if applicable

kyc

object

optional

Information related to Know Your Customer (KYC) compliance

watchList

object

optional

Watchlist information for compliance or fraud detection.

extendedData

array[string]

optional

Additional data.

createdAt

string <date-time>

optional

Creation date UTC format.

updatedAt

string <date-time>

optional

Time of last update made to the entity, UTC format.

address

object

optional

The entity’s address information.

administrativeAreaLevel1

string

optional

The first-level administrative division.

administrativeAreaLevel2

string

optional

The second-level administrative division.

administrativeAreaLevel3

string

optional

The third-level administrative division.

street

string

optional

The name of the street.

streetNumber

string

optional

The street number.

optionalAddress

string

optional

Additional address details.

country

string

optional

The country of the address.

Request

Responses