Skip to content

Suggested
API Dashboard
Sandbox Production
Identities

Identities represent any entity — person, organization, or system actor — that can own accounts, perform transactions, or be subject to permissions.

Objects

Identity object

Unique identifier for the internal service.

USERORGANIZATION

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

An alternative or preferred name for the entity.

The email address associated with the entity.

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

The document number associated with the entity for identification purposes.

Documeny type of the entity (e.g., RUT, CURP, CURL). Go to the Supported Identity document types page for the complete list of supported values.

Identity verification reference

twoFactorAuthboolean

Indicates whether two-factor authentication is enabled

signTrxboolean

Determines if the entity is required to sign transactions

signAccountsOperationsboolean

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

accessControlobject

Dashboard access control assigned to the identity

Country of operations for the entity, specified using the ISO 3166-1 alpha-3 standard (e.g., CHL, USA, MEX). Go to the countries page for the complete list of supported values.

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

idstringrequired

ID

namestringrequired
emailstringrequired

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

External reference ID (client purpose).

The last name of the user (if applicable).

Schema representing a bank account, including essential details about the account holder and financial institution.

idstring

Unique identifier for the bank account.

externalIdstring

External reference identifier for integrations.

accountNumberstringrequired

The bank account number.

nicknamestring

A friendly name assigned to the bank account.

bankstringrequired

The name of the bank where the account is held.

currencystringrequired

Specifies the currency used, following the ISO 4217 standard for fiat currencies (e.g., CLP, ARS, MXN). Go to the currencies page for the complete list of supported values.

typeAccountstring

The type of bank account. CHECKING_ACOUNT, SAVINGS

accountHolderstringrequired

The full name of the account holder.

accountHolderDnistringrequired

The national identification number or tax ID of the account holder.

countrystringrequired

Country of operations for the entity, specified using the ISO 3166-1 alpha-3 standard (e.g., CHL, USA, MEX). Go to the countries page for the complete list of supported values.

createdAtstringdate-time

Timestamp indicating when the account was created.

updatedAtstringdate-time

Timestamp indicating the last update to the account details.

Custom rules or policies applicable to the entity.

Gender information (if applicable

Information related to Know Your Customer (KYC) compliance

Watchlist information for compliance or fraud detection.

Additional data.

Creation date UTC format.

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

The entity’s address information.

administrativeAreaLevel1string

The first-level administrative division.

administrativeAreaLevel2string

The second-level administrative division.

administrativeAreaLevel3string

The third-level administrative division.

streetstring

The name of the street.

streetNumberstring

The street number.

optionalAddressstring

Additional address details.

countrystring

Country of operations for the entity, specified using the ISO 3166-1 alpha-3 standard (e.g., CHL, USA, MEX). Go to the countries page for the complete list of supported values.

zipcodestring

Zipcode f the address

Permission scope object

Kind of resource we are giving access to (e.g., IDENTITY)

Reference which identificates the resource

Permissions allowed to perform on behalf of the resource