Identities
Identities represent any entity that can own accounts, perform transactions, or be subject to permissions within the platform.
Each identity can be a person, organization, or system-level actor. You can create, update, delete, and retrieve identities, as well as define hierarchical relationships and attach rules.
GET /identities
POST /identities
GET /identities/:id
PATCH /identities/:id
DELETE /identities/:id
POST /identities/:id/children
DELETE /identities/:id/children
POST /identities/{id}/rules
DELETE /identities/{id}/rulesUnique identifier for the entity.
Specifies whether the entity is an ORGANIZATION or an individual USER.
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
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.
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).
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 identity object
{
"id": "text",
"type": "USER",
"name": "text",
"nickname": "text",
"email": "[email protected]",
"phone": "text",
"documentNumber": "text",
"documentType": "text",
"idv": "text",
"securityOptions": {
"twoFactorAuth": true,
"signTrx": true,
"signAccountsOperations": true,
"accessControl": {
"scopes": [
{
"resource": "text",
"reference": "text",
"permissions": [
"text"
]
}
]
}
},
"country": "text",
"children": [
{
"id": "text",
"name": "text",
"email": "text"
}
],
"status": "text",
"externalId": "text",
"lastname": "text",
"bankAccount": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-07-17T06:31:33.198Z",
"updatedAt": "2025-07-17T06:31:33.198Z"
},
"rules": {},
"gender": "text",
"kyc": {},
"watchList": {},
"extendedData": [
"text"
],
"createdAt": "2025-07-17T06:31:33.198Z",
"updatedAt": "2025-07-17T06:31:33.198Z",
"address": {
"administrativeAreaLevel1": "text",
"administrativeAreaLevel2": "text",
"administrativeAreaLevel3": "text",
"street": "text",
"streetNumber": "text",
"optionalAddress": "text",
"country": "text"
}
}Schema representing a bank account, including essential details about the account holder and financial institution.
Unique identifier for the bank account.
External reference identifier for integrations.
The bank account number.
A friendly name assigned to the bank account.
The name of the bank where the account is held.
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.
The type of bank account. CHECKING_ACOUNT, SAVINGS
The full name of the account holder.
The national identification number or tax ID of the account holder.
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.
Timestamp indicating when the account was created.
Timestamp indicating the last update to the account details.
The bank-account object
{
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-07-17T06:31:33.198Z",
"updatedAt": "2025-07-17T06:31:33.198Z"
}Specifies whether the entity is an ORGANIZATION or an individual USER.
identity email
identity document number
identity phone number
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.
identity status
Specifies the maximum number of items to return in a single request.
A cursor indicating the position of the last retrieved item.
The API key used for authentication when making requests to the API Gateway.
Identifies the application making the request.
ConomyAppGET /identities HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Accept: */*
{
"data": [
{
"id": "text",
"type": "USER",
"name": "text",
"nickname": "text",
"email": "[email protected]",
"phone": "text",
"documentNumber": "text",
"documentType": "text",
"idv": "text",
"securityOptions": {
"twoFactorAuth": true,
"signTrx": true,
"signAccountsOperations": true,
"accessControl": {
"scopes": [
{
"resource": "text",
"reference": "text",
"permissions": [
"text"
]
}
]
}
},
"country": "text",
"children": [
{
"id": "text",
"name": "text",
"email": "text"
}
],
"status": "text",
"externalId": "text",
"lastname": "text",
"bankAccount": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-07-17T06:31:33.198Z",
"updatedAt": "2025-07-17T06:31:33.198Z"
},
"rules": {},
"gender": "text",
"kyc": {},
"watchList": {},
"extendedData": [
"text"
],
"createdAt": "2025-07-17T06:31:33.198Z",
"updatedAt": "2025-07-17T06:31:33.198Z",
"address": {
"administrativeAreaLevel1": "text",
"administrativeAreaLevel2": "text",
"administrativeAreaLevel3": "text",
"street": "text",
"streetNumber": "text",
"optionalAddress": "text",
"country": "text"
}
}
],
"pagination": {
"pagination": {
"count": 1,
"next": 1,
"previous": 1,
"total": 1
},
"results": [
{}
]
}
}The API key used for authentication when making requests to the API Gateway.
Identifies the application making the request.
ConomyApp/2.1.1Specifies whether the entity is an ORGANIZATION or an individual USER.
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.
he phone number linked to the entity. Include +(phone country code)
The document number associated with the entity for identification purposes.
The type of document (e.g., PASSPORT, NATIONAL_ID, RUT, CURP, etc).
Identity verification reference
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.
External reference ID (client purpose).
The last name of the user (if applicable).
Custom rules or policies applicable to the entity.
POST /identities HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Content-Type: application/json
Accept: */*
Content-Length: 409
{
"type": "USER",
"name": "Juan Pérez",
"nickname": "juanp",
"email": "[email protected]",
"phone": "+56912345674",
"documentType": "RUT",
"documentNumber": "123125",
"status": "ACTIVE",
"idv": "iv-23123",
"country": "CHL",
"securityOptions": {
"twoFactorEnabled": false,
"accessControl": {
"scopes": [
{
"resource": "IDENTITY",
"reference": "6808d26af21dc6b97c1cc12a",
"permissions": [
"account:write",
"account:read"
]
}
]
}
},
"children": []
}{
"id": "text",
"type": "USER",
"name": "text",
"nickname": "text",
"email": "[email protected]",
"phone": "text",
"documentNumber": "text",
"documentType": "text",
"idv": "text",
"securityOptions": {
"twoFactorAuth": true,
"signTrx": true,
"signAccountsOperations": true,
"accessControl": {
"scopes": [
{
"resource": "text",
"reference": "text",
"permissions": [
"text"
]
}
]
}
},
"country": "text",
"children": [
{
"id": "text",
"name": "text",
"email": "text"
}
],
"status": "text",
"externalId": "text",
"lastname": "text",
"bankAccount": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-07-17T06:31:33.198Z",
"updatedAt": "2025-07-17T06:31:33.198Z"
},
"rules": {},
"gender": "text",
"kyc": {},
"watchList": {},
"extendedData": [
"text"
],
"createdAt": "2025-07-17T06:31:33.198Z",
"updatedAt": "2025-07-17T06:31:33.198Z",
"address": {
"administrativeAreaLevel1": "text",
"administrativeAreaLevel2": "text",
"administrativeAreaLevel3": "text",
"street": "text",
"streetNumber": "text",
"optionalAddress": "text",
"country": "text"
}
}Unique identifier for the identity.
The API key used for authentication when making requests to the API Gateway.
Identifies the application making the request.
ConomyAppGET /identities/{id} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Accept: */*
{
"id": "text",
"type": "USER",
"name": "text",
"nickname": "text",
"email": "[email protected]",
"phone": "text",
"documentNumber": "text",
"documentType": "text",
"idv": "text",
"securityOptions": {
"twoFactorAuth": true,
"signTrx": true,
"signAccountsOperations": true,
"accessControl": {
"scopes": [
{
"resource": "text",
"reference": "text",
"permissions": [
"text"
]
}
]
}
},
"country": "text",
"children": [
{
"id": "text",
"name": "text",
"email": "text"
}
],
"status": "text",
"externalId": "text",
"lastname": "text",
"bankAccount": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-07-17T06:31:33.198Z",
"updatedAt": "2025-07-17T06:31:33.198Z"
},
"rules": {},
"gender": "text",
"kyc": {},
"watchList": {},
"extendedData": [
"text"
],
"createdAt": "2025-07-17T06:31:33.198Z",
"updatedAt": "2025-07-17T06:31:33.198Z",
"address": {
"administrativeAreaLevel1": "text",
"administrativeAreaLevel2": "text",
"administrativeAreaLevel3": "text",
"street": "text",
"streetNumber": "text",
"optionalAddress": "text",
"country": "text"
}
}Unique identifier for the identity.
The API key used for authentication when making requests to the API Gateway.
Identifies the application making the request.
ConomyAppDELETE /identities/{id} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Accept: */*
{}Unique identifier for the identity.
The API key used for authentication when making requests to the API Gateway.
Identifies the application making the request.
The name of the entity (for users) or the official name (for organizations).
An alternative or preferred name for the entity.
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.
External reference ID (client purpose).
The last name of the user (if applicable).
Custom rules or policies applicable to the entity.
Gender information (if applicable
PATCH /identities/{id} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"nickname": "Thomas"
}{
"id": "text",
"type": "USER",
"name": "text",
"nickname": "text",
"email": "[email protected]",
"phone": "text",
"documentNumber": "text",
"documentType": "text",
"idv": "text",
"securityOptions": {
"twoFactorAuth": true,
"signTrx": true,
"signAccountsOperations": true,
"accessControl": {
"scopes": [
{
"resource": "text",
"reference": "text",
"permissions": [
"text"
]
}
]
}
},
"country": "text",
"children": [
{
"id": "text",
"name": "text",
"email": "text"
}
],
"status": "text",
"externalId": "text",
"lastname": "text",
"bankAccount": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-07-17T06:31:33.198Z",
"updatedAt": "2025-07-17T06:31:33.198Z"
},
"rules": {},
"gender": "text",
"kyc": {},
"watchList": {},
"extendedData": [
"text"
],
"createdAt": "2025-07-17T06:31:33.198Z",
"updatedAt": "2025-07-17T06:31:33.198Z",
"address": {
"administrativeAreaLevel1": "text",
"administrativeAreaLevel2": "text",
"administrativeAreaLevel3": "text",
"street": "text",
"streetNumber": "text",
"optionalAddress": "text",
"country": "text"
}
}Add children to an identity. The _id as path param is the identityId.
Unique identifier for the identity.
The API key used for authentication when making requests to the API Gateway.
Identifies the application making the request.
Array of identity ids (strings) that are going to be linked as child to the identityId father
POST /identities/{id}/children HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Content-Type: application/json
Accept: */*
Content-Length: 92
{
"children": [
"1a5925ac-4629-f7bf-db28-ac0f655e3eef",
"3cbf2e28-ff31-804c-829e-bf97ed3d44a2"
]
}{
"id": "text",
"type": "USER",
"name": "text",
"nickname": "text",
"email": "[email protected]",
"phone": "text",
"documentNumber": "text",
"documentType": "text",
"idv": "text",
"securityOptions": {
"twoFactorAuth": true,
"signTrx": true,
"signAccountsOperations": true,
"accessControl": {
"scopes": [
{
"resource": "text",
"reference": "text",
"permissions": [
"text"
]
}
]
}
},
"country": "text",
"children": [
{
"id": "text",
"name": "text",
"email": "text"
}
],
"status": "text",
"externalId": "text",
"lastname": "text",
"bankAccount": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-07-17T06:31:33.198Z",
"updatedAt": "2025-07-17T06:31:33.198Z"
},
"rules": {},
"gender": "text",
"kyc": {},
"watchList": {},
"extendedData": [
"text"
],
"createdAt": "2025-07-17T06:31:33.198Z",
"updatedAt": "2025-07-17T06:31:33.198Z",
"address": {
"administrativeAreaLevel1": "text",
"administrativeAreaLevel2": "text",
"administrativeAreaLevel3": "text",
"street": "text",
"streetNumber": "text",
"optionalAddress": "text",
"country": "text"
}
}Unique identifier for the identity.
The API key used for authentication when making requests to the API Gateway.
Identifies the application making the request.
Identity Ids of those identities that are going to be removed from the list of children of that specific father
DELETE /identities/{id}/children HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"children": [
"67fee5eb0bfde89026114369"
]
}{
"id": "text",
"type": "USER",
"name": "text",
"nickname": "text",
"email": "[email protected]",
"phone": "text",
"documentNumber": "text",
"documentType": "text",
"idv": "text",
"securityOptions": {
"twoFactorAuth": true,
"signTrx": true,
"signAccountsOperations": true,
"accessControl": {
"scopes": [
{
"resource": "text",
"reference": "text",
"permissions": [
"text"
]
}
]
}
},
"country": "text",
"children": [
{
"id": "text",
"name": "text",
"email": "text"
}
],
"status": "text",
"externalId": "text",
"lastname": "text",
"bankAccount": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-07-17T06:31:33.198Z",
"updatedAt": "2025-07-17T06:31:33.198Z"
},
"rules": {},
"gender": "text",
"kyc": {},
"watchList": {},
"extendedData": [
"text"
],
"createdAt": "2025-07-17T06:31:33.198Z",
"updatedAt": "2025-07-17T06:31:33.198Z",
"address": {
"administrativeAreaLevel1": "text",
"administrativeAreaLevel2": "text",
"administrativeAreaLevel3": "text",
"street": "text",
"streetNumber": "text",
"optionalAddress": "text",
"country": "text"
}
}Last updated