Accounts

Accounts represent financial containers used to hold and manage funds.

Each account can store balances, receive or send funds, and be associated with a specific user or organization. Accounts can be created, updated, and deleted via the API, and are identified by a unique ID.

Use the Accounts API to list all accounts, create new ones, retrieve details of a specific account, update metadata, or delete an account when it’s no longer needed.

Endpoints

GET /accounts
POST /accounts
GET /accounts/:id
PATCH /accounts/:id
DELETE /accounts/:id

Get Account

get

Endpoint to get the accounts by a certain filter, could be the id, identityId, accountNumber.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Unique identifier for the account.

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

Schema representing an internal account used for handling financial operations within the system.

idstringRequired

Unique identifier for the internal account.

identityIdstringRequired

Identifier linking the internal account to an organization or user.

externalIdstringRequired

External reference identifier for integrations.

typestring · enumRequired

The type of internal account.

Possible values:

custodystringRequired

Indicates the custody type managing the internal account.

balancestringRequired

Total balance available in the internal account.

Pattern: ^\d+(\.\d+)?$

availableFundsstringRequired

Amount of funds available for transactions.

Pattern: ^\d+(\.\d+)?$

currencystringRequired

The currency in which the internal account operates. Please check "currencies" page.

namestringRequired

A friendly name assigned to the internal account.

accountNumberstringRequired

Internal reference number for the account.

accountHolderstringRequired

Name of the entity or user owning the internal account.

statusstringRequired

The current status of the account (e.g., PENDING, ACTIVE, BLOCKED).

parentIdstringRequired

Identifier of the parent account if this is a sub-account.

400

Invalid request parameters or payload.

application/json

500

Unexpected internal server error.

application/json

get

/accounts/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "identityId": "text",
  "externalId": "text",
  "type": "CHECKING",
  "custody": "text",
  "balance": "text",
  "availableFunds": "text",
  "currency": "text",
  "name": "text",
  "accountNumber": "text",
  "accountHolder": "text",
  "status": "text",
  "parentId": "text",
  "subAccounts": {
    "balance": "text",
    "availableFunds": "text"
  },
  "custodyBankAccount": {
    "accountNumber": "text",
    "bank": "text",
    "currency": "text",
    "typeAccount": "text",
    "country": "text"
  }
}

Update Account

patch

Updates mutable fields of an existing account.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Unique identifier for the account.

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

externalIdstringOptional

namestringOptional

Responses

200

Request processed successfully.

application/json

Schema representing an internal account used for handling financial operations within the system.

idstringRequired

Unique identifier for the internal account.

identityIdstringRequired

Identifier linking the internal account to an organization or user.

externalIdstringRequired

External reference identifier for integrations.

typestring · enumRequired

The type of internal account.

Possible values:

custodystringRequired

Indicates the custody type managing the internal account.

balancestringRequired

Total balance available in the internal account.

Pattern: ^\d+(\.\d+)?$

availableFundsstringRequired

Amount of funds available for transactions.

Pattern: ^\d+(\.\d+)?$

currencystringRequired

The currency in which the internal account operates. Please check "currencies" page.

namestringRequired

A friendly name assigned to the internal account.

accountNumberstringRequired

Internal reference number for the account.

accountHolderstringRequired

Name of the entity or user owning the internal account.

statusstringRequired

The current status of the account (e.g., PENDING, ACTIVE, BLOCKED).

parentIdstringRequired

Identifier of the parent account if this is a sub-account.

400

Invalid request parameters or payload.

application/json

500

Unexpected internal server error.

application/json

patch

/accounts/{id}

HTTPcURLJavaScriptPython

PATCH /accounts/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "status": "BLOCKED"
}

{
  "id": "text",
  "identityId": "text",
  "externalId": "text",
  "type": "CHECKING",
  "custody": "text",
  "balance": "text",
  "availableFunds": "text",
  "currency": "text",
  "name": "text",
  "accountNumber": "text",
  "accountHolder": "text",
  "status": "text",
  "parentId": "text",
  "subAccounts": {
    "balance": "text",
    "availableFunds": "text"
  },
  "custodyBankAccount": {
    "accountNumber": "text",
    "bank": "text",
    "currency": "text",
    "typeAccount": "text",
    "country": "text"
  }
}

Create Account

post

Creates a new account for an identity.

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

identityIdstringRequired

Identifier linking the internal account to an organization or user.

externalIdstringOptional

External reference identifier for integrations.

typestring · enumRequired

The type of internal account.

Possible values:

custodystringRequired

Indicates the custody type managing the internal account.

currencystringRequired

The currency in which the internal account operates. Please check "currencies" page.

namestringRequired

A friendly name assigned to the internal account.

parentIdstringOptional

Identifier of the parent account if this is a sub-account.

Responses

201

Resource created successfully.

application/json

400

Invalid request parameters or payload.

application/json

500

Unexpected internal server error.

application/json

post

/accounts

HTTPcURLJavaScriptPython

POST /accounts HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Content-Type: application/json
Accept: */*
Content-Length: 178

{
  "identityId": "069b63ba-a8cd-4b0e-bb2f-ffc7d71f2dac",
  "externalId": "1",
  "type": "real",
  "currency": "PKR",
  "name": "Auto Loan Account",
  "parentId": "a3f87719-1dd7-46c7-9953-e0f3a71542a3"
}

{
  "id": "text",
  "identityId": "text",
  "externalId": "text",
  "type": "CHECKING",
  "custody": "text",
  "balance": "text",
  "availableFunds": "text",
  "currency": "text",
  "name": "text",
  "accountNumber": "text",
  "accountHolder": "text",
  "status": "text",
  "parentId": "text",
  "subAccounts": {
    "balance": "text",
    "availableFunds": "text"
  },
  "custodyBankAccount": {
    "accountNumber": "text",
    "bank": "text",
    "currency": "text",
    "typeAccount": "text",
    "country": "text"
  }
}

Get multiple accounts

get

Lists accounts with filtering and pagination options.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

parentIdstringOptional

Parent's account Id

accountNumberstringOptional

Account number of the specific account

externalIdstringOptional

External Id of the specific account

identityIdstringOptional

Identity Id owner of the account

typestring · enumOptional

The type of internal account.

Possible values:

currencystringOptional

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

Status of the account

startDatestringOptional

Created at start (DD/MM/YYYY)

endDatestringOptional

Created at end (DD/MM/YYYY)

limitintegerOptional

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

nextintegerOptional

A cursor indicating the position of the last retrieved item.

offsetintegerOptional

A cursor indicating how many items to skip from the request

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

400

Invalid request parameters or payload.

application/json

500

Unexpected internal server error.

application/json

get

/accounts

HTTPcURLJavaScriptPython

GET /accounts HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Accept: */*

{
  "pagination": {
    "pagination": {
      "count": 1,
      "next": 1,
      "previous": 1,
      "total": 1
    },
    "results": [
      {
        "id": "text",
        "identityId": "text",
        "externalId": "text",
        "type": "CHECKING",
        "custody": "text",
        "balance": "text",
        "availableFunds": "text",
        "currency": "text",
        "name": "text",
        "accountNumber": "text",
        "accountHolder": "text",
        "status": "text",
        "parentId": "text",
        "subAccounts": {
          "balance": "text",
          "availableFunds": "text"
        },
        "custodyBankAccount": {
          "accountNumber": "text",
          "bank": "text",
          "currency": "text",
          "typeAccount": "text",
          "country": "text"
        }
      }
    ]
  }
}

Delete Account

delete

Deletes an account by ID.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Unique identifier for the account.

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

/accounts/{id}

HTTPcURLJavaScriptPython

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

{}

Patch customer

patch

Create customer

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

customer-idstringRequired

Unique identifier of the customer to update.

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

idstringOptional

Unique identifier for the internal service.

firstNamestringOptional

Payer's name

emailstringOptional

Payer's email

lastNamestringOptional

Payer's last name

phoneNumberstringOptional

Payer's phone number without prefix

phoneNumberPrefixstringOptional

Phone number prefix (e.g., +57)

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.

documentNumberstringOptional

The document number associated with the documentType

Responses

201

Resource created successfully.

application/json

400

Invalid request parameters or payload.

application/json

500

Unexpected internal server error.

application/json

patch

/customers/{customer-id}

HTTPcURLJavaScriptPython

PATCH /customers/{customer-id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Content-Type: application/json
Accept: */*
Content-Length: 370

{
  "id": "text",
  "firstName": "text",
  "email": "text",
  "lastName": "text",
  "phoneNumber": "text",
  "phoneNumberPrefix": "text",
  "documentType": "text",
  "documentNumber": "text",
  "address": {
    "administrativeAreaLevel1": "text",
    "administrativeAreaLevel2": "text",
    "administrativeAreaLevel3": "text",
    "street": "text",
    "streetNumber": "text",
    "optionalAddress": "text",
    "country": "text",
    "zipcode": "text"
  }
}

{
  "id": "6866e078f18185b6af8d0eff",
  "owner": "CLIENT",
  "target": "TRANSACTION",
  "type": "FEE",
  "identityId": "679d2a134a21df7584b38e13",
  "overwrites": true,
  "createdAt": "2025-07-03T19:56:40Z",
  "updatedAt": "2025-07-03T19:56:40Z",
  "feeRule": {
    "description": "Service fee",
    "type": "FIXED",
    "value": "0.5"
  }
}

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