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.

Endpoints

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}/rules

---

Get Identities

get

Lists identities with optional filters and pagination.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

typestring · enumOptional

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

Possible values:

emailstring · emailOptional

identity email

documentNumberstringOptional

identity document number

phonestringOptional

identity phone number

countrystringOptional

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.

statusstringOptional

identity status

limitstringOptional

Specifies the maximum number of items to return in a single request.

nextstringOptional

A cursor indicating the position of the last retrieved item.

Header parameters

x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Example: ConomyApp

Responses

200

Request processed successfully.

application/json

400

Invalid request parameters or payload.

application/json

500

Unexpected internal server error.

application/json

get

/identities

HTTPcURLJavaScriptPython

GET /identities HTTP/1.1
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": "2026-03-19T19:29:07.607Z",
        "updatedAt": "2026-03-19T19:29:07.607Z"
      },
      "rules": {},
      "gender": "text",
      "kyc": {},
      "watchList": {},
      "extendedData": [
        "text"
      ],
      "createdAt": "2026-03-19T19:29:07.607Z",
      "updatedAt": "2026-03-19T19:29:07.607Z",
      "address": {
        "administrativeAreaLevel1": "text",
        "administrativeAreaLevel2": "text",
        "administrativeAreaLevel3": "text",
        "street": "text",
        "streetNumber": "text",
        "optionalAddress": "text",
        "country": "text",
        "zipcode": "text"
      }
    }
  ],
  "pagination": {
    "pagination": {
      "count": 1,
      "next": 1,
      "previous": 1,
      "total": 1
    },
    "results": [
      {}
    ]
  }
}

Get Identity

get

Retrieves a single identity by ID.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Unique identifier for the identity.

Header parameters

x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Example: ConomyApp

Responses

200

Request processed successfully.

application/json

Identity entity (user or organization) including profile, compliance, and access-control fields.

idstringOptional

Unique identifier for the entity.

typestring · enumOptional

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

Possible values:

namestringOptional

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

nicknamestringOptional

An alternative or preferred name for the entity.

emailstring · emailOptional

The email address associated with the entity.

phonestringOptional

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

documentNumberstringOptional

The document number associated with the entity for identification purposes.

documentTypestringOptional

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.

idvstringOptional

Identity verification reference

countrystringOptional

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.

statusstringOptional

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

externalIdstringOptional

External reference ID (client purpose).

lastnamestringOptional

The last name of the user (if applicable).

rulesobjectOptional

Custom rules or policies applicable to the entity.

genderstringOptional

Gender information (if applicable

kycobjectOptional

Information related to Know Your Customer (KYC) compliance

watchListobjectOptional

Watchlist information for compliance or fraud detection.

extendedDatastring[]Optional

Additional data.

createdAtstring · date-timeOptional

Creation date UTC format.

updatedAtstring · date-timeOptional

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

400

Invalid request parameters or payload.

application/json

500

Unexpected internal server error.

application/json

get

/identities/{id}

HTTPcURLJavaScriptPython

GET /identities/{id} HTTP/1.1
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": "2026-03-19T19:29:07.607Z",
    "updatedAt": "2026-03-19T19:29:07.607Z"
  },
  "rules": {},
  "gender": "text",
  "kyc": {},
  "watchList": {},
  "extendedData": [
    "text"
  ],
  "createdAt": "2026-03-19T19:29:07.607Z",
  "updatedAt": "2026-03-19T19:29:07.607Z",
  "address": {
    "administrativeAreaLevel1": "text",
    "administrativeAreaLevel2": "text",
    "administrativeAreaLevel3": "text",
    "street": "text",
    "streetNumber": "text",
    "optionalAddress": "text",
    "country": "text",
    "zipcode": "text"
  }
}

Create Identity

post

Creates a new identity (user or organization).

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Example: ConomyApp/2.1.1

Body

application/json

typestring · enumOptional

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

Possible values:

namestringRequired

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

nicknamestringOptional

An alternative or preferred name for the entity.

emailstring · emailRequired

The email address associated with the entity.

phonestringRequired

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

documentNumberstringRequired

The document number associated with the entity for identification purposes.

documentTypestringRequired

The type of document (e.g., PASSPORT, NATIONAL_ID, RUT, CURP, etc).

idvstringRequired

Identity verification reference

countrystringOptional

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.

externalIdstringOptional

External reference ID (client purpose).

lastnamestringOptional

The last name of the user (if applicable).

rulesobjectOptional

Custom rules or policies applicable to the entity.

Responses

200

Request processed successfully.

application/json

Identity entity (user or organization) including profile, compliance, and access-control fields.

idstringOptional

Unique identifier for the entity.

typestring · enumOptional

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

Possible values:

namestringOptional

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

nicknamestringOptional

An alternative or preferred name for the entity.

emailstring · emailOptional

The email address associated with the entity.

phonestringOptional

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

documentNumberstringOptional

The document number associated with the entity for identification purposes.

documentTypestringOptional

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.

idvstringOptional

Identity verification reference

countrystringOptional

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.

statusstringOptional

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

externalIdstringOptional

External reference ID (client purpose).

lastnamestringOptional

The last name of the user (if applicable).

rulesobjectOptional

Custom rules or policies applicable to the entity.

genderstringOptional

Gender information (if applicable

kycobjectOptional

Information related to Know Your Customer (KYC) compliance

watchListobjectOptional

Watchlist information for compliance or fraud detection.

extendedDatastring[]Optional

Additional data.

createdAtstring · date-timeOptional

Creation date UTC format.

updatedAtstring · date-timeOptional

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

400

Invalid request parameters or payload.

application/json

500

Unexpected internal server error.

application/json

post

/identities

HTTPcURLJavaScriptPython

POST /identities HTTP/1.1
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": "[phone]",
  "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": "2026-03-19T19:29:07.607Z",
    "updatedAt": "2026-03-19T19:29:07.607Z"
  },
  "rules": {},
  "gender": "text",
  "kyc": {},
  "watchList": {},
  "extendedData": [
    "text"
  ],
  "createdAt": "2026-03-19T19:29:07.607Z",
  "updatedAt": "2026-03-19T19:29:07.607Z",
  "address": {
    "administrativeAreaLevel1": "text",
    "administrativeAreaLevel2": "text",
    "administrativeAreaLevel3": "text",
    "street": "text",
    "streetNumber": "text",
    "optionalAddress": "text",
    "country": "text",
    "zipcode": "text"
  }
}

Delete Identity

delete

Deletes an identity by ID.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Unique identifier for the identity.

Header parameters

x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Example: ConomyApp

Responses

204

Request processed successfully. No response body is returned.

application/json

400

Invalid request parameters or payload.

application/json

500

Unexpected internal server error.

application/json

delete

/identities/{id}

HTTPcURLJavaScriptPython

DELETE /identities/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Accept: */*

{}

Update Identity

patch

Updates mutable fields of an existing identity.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Unique identifier for the identity.

Header parameters

x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Body

application/json

namestringOptional

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

nicknamestringOptional

An alternative or preferred name for the entity.

countrystringOptional

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.

externalIdstringOptional

External reference ID (client purpose).

lastnamestringOptional

The last name of the user (if applicable).

rulesobjectOptional

Custom rules or policies applicable to the entity.

genderstringOptional

Gender information (if applicable

Responses

200

Request processed successfully.

application/json

idstringOptional

Unique identifier for the entity.

typestring · enumOptional

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

Possible values:

namestringOptional

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

nicknamestringOptional

An alternative or preferred name for the entity.

emailstring · emailOptional

The email address associated with the entity.

phonestringOptional

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

documentNumberstringOptional

The document number associated with the entity for identification purposes.

documentTypestringOptional

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.

idvstringOptional

Identity verification reference

countrystringOptional

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.

statusstringOptional

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

externalIdstringOptional

External reference ID (client purpose).

lastnamestringOptional

The last name of the user (if applicable).

rulesobjectOptional

Custom rules or policies applicable to the entity.

genderstringOptional

Gender information (if applicable

kycobjectOptional

Information related to Know Your Customer (KYC) compliance

watchListobjectOptional

Watchlist information for compliance or fraud detection.

extendedDatastring[]Optional

Additional data.

createdAtstring · date-timeOptional

Creation date UTC format.

updatedAtstring · date-timeOptional

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

400

Invalid request parameters or payload.

application/json

500

Unexpected internal server error.

application/json

patch

/identities/{id}

HTTPcURLJavaScriptPython

PATCH /identities/{id} HTTP/1.1
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": "2026-03-19T19:29:07.607Z",
    "updatedAt": "2026-03-19T19:29:07.607Z"
  },
  "rules": {},
  "gender": "text",
  "kyc": {},
  "watchList": {},
  "extendedData": [
    "text"
  ],
  "createdAt": "2026-03-19T19:29:07.607Z",
  "updatedAt": "2026-03-19T19:29:07.607Z",
  "address": {
    "administrativeAreaLevel1": "text",
    "administrativeAreaLevel2": "text",
    "administrativeAreaLevel3": "text",
    "street": "text",
    "streetNumber": "text",
    "optionalAddress": "text",
    "country": "text",
    "zipcode": "text"
  }
}

Remove Child from Children

delete

Removes one or more child identities from a parent identity.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Unique identifier for the identity.

Header parameters

x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Body

application/json

childrenstring[]Required

Identity Ids of those identities that are going to be removed from the list of children of that specific father

Responses

200

Request processed successfully.

application/json

Identity entity (user or organization) including profile, compliance, and access-control fields.

idstringOptional

Unique identifier for the entity.

typestring · enumOptional

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

Possible values:

namestringOptional

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

nicknamestringOptional

An alternative or preferred name for the entity.

emailstring · emailOptional

The email address associated with the entity.

phonestringOptional

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

documentNumberstringOptional

The document number associated with the entity for identification purposes.

documentTypestringOptional

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.

idvstringOptional

Identity verification reference

countrystringOptional

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.

statusstringOptional

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

externalIdstringOptional

External reference ID (client purpose).

lastnamestringOptional

The last name of the user (if applicable).

rulesobjectOptional

Custom rules or policies applicable to the entity.

genderstringOptional

Gender information (if applicable

kycobjectOptional

Information related to Know Your Customer (KYC) compliance

watchListobjectOptional

Watchlist information for compliance or fraud detection.

extendedDatastring[]Optional

Additional data.

createdAtstring · date-timeOptional

Creation date UTC format.

updatedAtstring · date-timeOptional

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

400

Invalid request parameters or payload.

application/json

500

Unexpected internal server error.

application/json

delete

/identities/{id}/children

HTTPcURLJavaScriptPython

DELETE /identities/{id}/children HTTP/1.1
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": "2026-03-19T19:29:07.607Z",
    "updatedAt": "2026-03-19T19:29:07.607Z"
  },
  "rules": {},
  "gender": "text",
  "kyc": {},
  "watchList": {},
  "extendedData": [
    "text"
  ],
  "createdAt": "2026-03-19T19:29:07.607Z",
  "updatedAt": "2026-03-19T19:29:07.607Z",
  "address": {
    "administrativeAreaLevel1": "text",
    "administrativeAreaLevel2": "text",
    "administrativeAreaLevel3": "text",
    "street": "text",
    "streetNumber": "text",
    "optionalAddress": "text",
    "country": "text",
    "zipcode": "text"
  }
}

Remove Permissions over another identity

delete

Permissons allows an identity to operate in behalf of an other from the same client id, this endpoint removes an specific permission

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Identity that has permissions over another identity

toremoveIdstringRequired

Identity id to be removed

Header parameters

x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Responses

204

Request processed successfully. No response body is returned.

application/json

400

Invalid request parameters or payload.

application/json

500

Unexpected internal server error.

application/json

delete

/identities/{id}/permissions/{toremoveId}

HTTPcURLJavaScriptPython

DELETE /identities/{id}/permissions/{toremoveId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Accept: */*

{}

Add Child to Identity Children

post

Add children to an identity. The _id as path param is the identityId.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Unique identifier for the identity.

Header parameters

x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Body

application/json

childrenstring[]Required

Array of identity ids (strings) that are going to be linked as child to the identityId father

Responses

200

Request processed successfully.

application/json

Identity entity (user or organization) including profile, compliance, and access-control fields.

idstringOptional

Unique identifier for the entity.

typestring · enumOptional

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

Possible values:

namestringOptional

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

nicknamestringOptional

An alternative or preferred name for the entity.

emailstring · emailOptional

The email address associated with the entity.

phonestringOptional

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

documentNumberstringOptional

The document number associated with the entity for identification purposes.

documentTypestringOptional

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.

idvstringOptional

Identity verification reference

countrystringOptional

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.

statusstringOptional

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

externalIdstringOptional

External reference ID (client purpose).

lastnamestringOptional

The last name of the user (if applicable).

rulesobjectOptional

Custom rules or policies applicable to the entity.

genderstringOptional

Gender information (if applicable

kycobjectOptional

Information related to Know Your Customer (KYC) compliance

watchListobjectOptional

Watchlist information for compliance or fraud detection.

extendedDatastring[]Optional

Additional data.

createdAtstring · date-timeOptional

Creation date UTC format.

updatedAtstring · date-timeOptional

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

400

Invalid request parameters or payload.

application/json

500

Unexpected internal server error.

application/json

post

/identities/{id}/children

HTTPcURLJavaScriptPython

POST /identities/{id}/children HTTP/1.1
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": "2026-03-19T19:29:07.607Z",
    "updatedAt": "2026-03-19T19:29:07.607Z"
  },
  "rules": {},
  "gender": "text",
  "kyc": {},
  "watchList": {},
  "extendedData": [
    "text"
  ],
  "createdAt": "2026-03-19T19:29:07.607Z",
  "updatedAt": "2026-03-19T19:29:07.607Z",
  "address": {
    "administrativeAreaLevel1": "text",
    "administrativeAreaLevel2": "text",
    "administrativeAreaLevel3": "text",
    "street": "text",
    "streetNumber": "text",
    "optionalAddress": "text",
    "country": "text",
    "zipcode": "text"
  }
}

Get Permissions of an identity

get

Permissons allows an identity to operate in behalf of an other from the same client id, this endpoint retrieves the list of permissions an identity has

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Unique identifier for the identity.

Header parameters

x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Responses

200

Request processed successfully.

application/json

Access-control scope definition for dashboard/resource permissions.

resourcestringRequired

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

referencestringRequired

Reference which identificates the resource

permissionsstring[]Required

Permissions allowed to perform on behalf of the resource

400

Invalid request parameters or payload.

application/json

500

Unexpected internal server error.

application/json

get

/identities/{id}/permissions

HTTPcURLJavaScriptPython

GET /identities/{id}/permissions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Accept: */*

[
  {
    "resource": "text",
    "reference": "text",
    "permissions": [
      "text"
    ]
  }
]

Add Permissions over another identity

post

Allows an identity to operate in behalf of an other from the same client id

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Unique identifier for the identity that is receiving permissions

Header parameters

x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Bodyobject[]

application/json

Access-control scope definition for dashboard/resource permissions.

resourcestringRequired

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

referencestringRequired

Reference which identificates the resource

permissionsstring[]Required

Permissions allowed to perform on behalf of the resource

Responses

201

Resource created successfully.

application/json

400

Invalid request parameters or payload.

application/json

500

Unexpected internal server error.

application/json

post

/identities/{id}/permissions

HTTPcURLJavaScriptPython

POST /identities/{id}/permissions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Content-Type: application/json
Accept: */*
Content-Length: 100

[
  {
    "resource": "IDENTITY",
    "reference": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "permissions": [
      "admin"
    ]
  }
]

{}