Identities

Get Identities List

get
Authorizations
Query parameters
typestringOptional

USER | ORGANIZATION

emailstringOptional

identity email

documentNumberstringOptional

identity document number

phonestringOptional

identity phone number

countrystringOptional

identity country

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-keystringOptionalExample: {{x-api-key}}
User-AgentstringRequiredExample: ConomyApp
Responses
200Success
application/json
get
GET /identities HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
User-Agent: text
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "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-06-22T15:55:55.368Z",
        "updatedAt": "2025-06-22T15:55:55.368Z"
      },
      "rules": {},
      "gender": "text",
      "kyc": {},
      "watchList": {},
      "extendedData": [
        "text"
      ],
      "createdAt": "2025-06-22T15:55:55.368Z",
      "updatedAt": "2025-06-22T15:55:55.368Z",
      "address": {
        "administrativeAreaLevel1": "text",
        "administrativeAreaLevel2": "text",
        "administrativeAreaLevel3": "text",
        "street": "text",
        "streetNumber": "text",
        "optionalAddress": "text",
        "country": "text"
      }
    }
  ],
  "pagination": {
    "pagination": {
      "count": null,
      "next": null,
      "previous": null,
      "total": null
    },
    "results": [
      {}
    ]
  }
}

Create Identity

post
Authorizations
Header parameters
x-api-keystringRequiredExample: {{x-api-key}}
User-AgentstringRequiredExample: ConomyApp/2.1.1
Body
typestringRequired
namestringRequired
nicknamestringOptional
emailstringRequired
phonestringRequired
documentTypestringRequired
documentNumberstringRequired
statusstringOptional
idvstringRequired
countrystringRequired
childrenstring[]Optional
Responses
200Success
application/json
post
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: 945

"{\n    \"type\": \"USER\", // types: USER, ORGANIZATION\n    \"name\": \"Juan Pérez\",\n    \"nickname\": \"juanp\",\n    \"email\": \"[email protected]\",\n    \"phone\": \"+56912345674\", // including +(CountryCode)\n    \"documentType\": \"RUT\", // types: RUT, CURP, DNI\n    \"documentNumber\": \"123125\",\n    \"status\": \"ACTIVE\", // statuses: ACTIVE, PENDING_VALIDATION, BLOCKED\n    \"idv\": \"iv-23123\", // \n    \"country\": \"CHL\", // ISO 3166-1. ex: CHL, USA, ARG, ESP...\n    \"securityOptions\": {\n        \"twoFactorEnabled\": false,\n        \"accessControl\": { // Access to perform actions on behalf of an other identity of the same client ID\n            \"scopes\": [{\n                \"resource\": \"IDENTITY\",\n                \"reference\": \"6808d26af21dc6b97c1cc12a\", \n                \"permissions\": [\"account:write\", \"account:read\"]\n            }]\n        }\n    },\n    \"children\": []\n}"
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "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-06-22T15:55:55.368Z",
    "updatedAt": "2025-06-22T15:55:55.368Z"
  },
  "rules": {},
  "gender": "text",
  "kyc": {},
  "watchList": {},
  "extendedData": [
    "text"
  ],
  "createdAt": "2025-06-22T15:55:55.368Z",
  "updatedAt": "2025-06-22T15:55:55.368Z",
  "address": {
    "administrativeAreaLevel1": "text",
    "administrativeAreaLevel2": "text",
    "administrativeAreaLevel3": "text",
    "street": "text",
    "streetNumber": "text",
    "optionalAddress": "text",
    "country": "text"
  }
}

Get Identity

get
Authorizations
Path parameters
idstringRequired
Header parameters
x-api-keystringOptionalExample: {{x-api-key}}
User-AgentstringRequiredExample: ConomyApp
Responses
200Success
application/json
get
GET /identities/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
User-Agent: text
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "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-06-22T15:55:55.368Z",
    "updatedAt": "2025-06-22T15:55:55.368Z"
  },
  "rules": {},
  "gender": "text",
  "kyc": {},
  "watchList": {},
  "extendedData": [
    "text"
  ],
  "createdAt": "2025-06-22T15:55:55.368Z",
  "updatedAt": "2025-06-22T15:55:55.368Z",
  "address": {
    "administrativeAreaLevel1": "text",
    "administrativeAreaLevel2": "text",
    "administrativeAreaLevel3": "text",
    "street": "text",
    "streetNumber": "text",
    "optionalAddress": "text",
    "country": "text"
  }
}

Delete Identity

delete
Authorizations
Path parameters
idstringRequired
Header parameters
x-api-keystringRequiredExample: {{x-api-key}}
User-AgentstringRequiredExample: ConomyApp
Responses
204Success
application/json
Responseobject
delete
DELETE /identities/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Accept: */*

{}

Update Identity

patch
Authorizations
Path parameters
idstringRequired
Header parameters
x-api-keystringRequiredExample: {{x-api-key}}
User-AgentstringOptionalExample: {{userAgent}}
Body
objectOptional
Responses
200Success
application/json
patch
PATCH /identities/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "nickname": "Thomas"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "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-06-22T15:55:55.368Z",
    "updatedAt": "2025-06-22T15:55:55.368Z"
  },
  "rules": {},
  "gender": "text",
  "kyc": {},
  "watchList": {},
  "extendedData": [
    "text"
  ],
  "createdAt": "2025-06-22T15:55:55.368Z",
  "updatedAt": "2025-06-22T15:55:55.368Z",
  "address": {
    "administrativeAreaLevel1": "text",
    "administrativeAreaLevel2": "text",
    "administrativeAreaLevel3": "text",
    "street": "text",
    "streetNumber": "text",
    "optionalAddress": "text",
    "country": "text"
  }
}

Add Child to Identity Children

post

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

Authorizations
Path parameters
idstringRequired
Body
childrenstring · uuid[]Required

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

Responses
200Success
application/json
post
POST /identities/{id}/children HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "children": [
    "1a5925ac-4629-f7bf-db28-ac0f655e3eef",
    "3cbf2e28-ff31-804c-829e-bf97ed3d44a2"
  ]
}
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "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-06-22T15:55:55.368Z",
    "updatedAt": "2025-06-22T15:55:55.368Z"
  },
  "rules": {},
  "gender": "text",
  "kyc": {},
  "watchList": {},
  "extendedData": [
    "text"
  ],
  "createdAt": "2025-06-22T15:55:55.368Z",
  "updatedAt": "2025-06-22T15:55:55.368Z",
  "address": {
    "administrativeAreaLevel1": "text",
    "administrativeAreaLevel2": "text",
    "administrativeAreaLevel3": "text",
    "street": "text",
    "streetNumber": "text",
    "optionalAddress": "text",
    "country": "text"
  }
}

Remove Child from Children

delete
Authorizations
Path parameters
idstringRequired
Body
childrenstring · uuid[]Required

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

Responses
200Success
application/json
delete
DELETE /identities/{id}/children HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "children": [
    "67fee5eb0bfde89026114369"
  ]
}
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "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-06-22T15:55:55.368Z",
    "updatedAt": "2025-06-22T15:55:55.368Z"
  },
  "rules": {},
  "gender": "text",
  "kyc": {},
  "watchList": {},
  "extendedData": [
    "text"
  ],
  "createdAt": "2025-06-22T15:55:55.368Z",
  "updatedAt": "2025-06-22T15:55:55.368Z",
  "address": {
    "administrativeAreaLevel1": "text",
    "administrativeAreaLevel2": "text",
    "administrativeAreaLevel3": "text",
    "street": "text",
    "streetNumber": "text",
    "optionalAddress": "text",
    "country": "text"
  }
}

Add Rule to Identity

post

Add fee to an identity, if added to an ORGANIZATION the fee is going to be charged to all its children too.

Authorizations
Path parameters
idstringRequired
Body
typestringRequired
transactionTypestringRequired
amountstringRequired
currencystringRequired
descriptionstringRequired
namestringRequired
Responses
200Success
application/json
post
POST /identities/{id}/rules HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "type": "PERCENTAGE",
  "transactionType": "P2P",
  "amount": "10.00",
  "currency": "USD",
  "description": "Fee por servicio",
  "name": "SERVICE FEE"
}
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "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-06-22T15:55:55.368Z",
    "updatedAt": "2025-06-22T15:55:55.368Z"
  },
  "rules": {},
  "gender": "text",
  "kyc": {},
  "watchList": {},
  "extendedData": [
    "text"
  ],
  "createdAt": "2025-06-22T15:55:55.368Z",
  "updatedAt": "2025-06-22T15:55:55.368Z",
  "address": {
    "administrativeAreaLevel1": "text",
    "administrativeAreaLevel2": "text",
    "administrativeAreaLevel3": "text",
    "street": "text",
    "streetNumber": "text",
    "optionalAddress": "text",
    "country": "text"
  }
}

Remove Rule to Identity

delete

Remove a specific fee to an identity.

Authorizations
Path parameters
idstringRequired
rule-idstringRequired
Responses
200Success
application/json
delete
DELETE /identities/{id}/rules/{rule-id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "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-06-22T15:55:55.368Z",
    "updatedAt": "2025-06-22T15:55:55.368Z"
  },
  "rules": {},
  "gender": "text",
  "kyc": {},
  "watchList": {},
  "extendedData": [
    "text"
  ],
  "createdAt": "2025-06-22T15:55:55.368Z",
  "updatedAt": "2025-06-22T15:55:55.368Z",
  "address": {
    "administrativeAreaLevel1": "text",
    "administrativeAreaLevel2": "text",
    "administrativeAreaLevel3": "text",
    "street": "text",
    "streetNumber": "text",
    "optionalAddress": "text",
    "country": "text"
  }
}
PreviousAuthNextPayments