conomy_hq
  1. Identities
conomy_hq
  • Quickstart
    • Introduction
    • Obtain an Access Token
    • Create an Organization
    • Create users
    • Create accounts
    • Create your first top-up
    • Create your first withdrawal
    • Create your first purchase
    • Create your first p2p payment
    • Create your first collect payment
    • Supported Identity Document Types
  • Payments
    • Transaction types
    • Transaction status
    • Origins and Destinations
    • Creating a payment
    • Add & remove Fees
  • API reference
    • Auth
      • Auth
    • Identities
      • Create Identity
        POST
      • Get Identity
        GET
      • Update Identity
        PATCH
      • Delete Identity
        DELETE
      • Get Identities List
        GET
      • Add Child to Identity Children
        POST
      • Remove Child from Children
        DELETE
      • Add Rule to Identity
        POST
      • Remove Rule to Identity
        DELETE
    • Accounts
      • Create Account
      • Get Account
      • Update Account
      • Delete Account
      • Get multiple accounts
    • Payment-methods
      • Get payment-origins
      • Get payment-destinations
    • Payment-attempts
      • Create Attempt
      • Get payment-attempts list
      • Get payment-attempt
    • Payments
      • Create Payment
      • Authorize Payment
      • Capture Payment
      • Get Payment List
      • Get Payment List paginated
      • Get Payment
      • Receive Payment Provider Notification
      • Client Transaction's Notification Webhook
  1. Identities

Update Identity

PATCH
/identities/{id}
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH '/identities/' \
--header 'x-api-key: {{x-api-key}}' \
--header 'User-Agent: {{userAgent}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "nickname": "Thomas"   
}'
Response Response Example
200 - Example 1
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "string",
  "name": "string",
  "nickname": "string",
  "email": "user@example.com",
  "phone": "string",
  "documentNumber": "string",
  "documentType": "string",
  "idv": "string",
  "securityOptions": {
    "twoFactorAuth": true,
    "signTrx": true,
    "signAccountsOperations": true
  },
  "country": "string",
  "children": [
    {
      "id": "string",
      "name": "string",
      "email": "string"
    }
  ],
  "status": "string",
  "externalId": "string",
  "lastname": "string",
  "bankAccount": {
    "id": "string",
    "externalId": "string",
    "accountNumber": "string",
    "nickname": "string",
    "bank": "string",
    "currency": "string",
    "typeAccount": "string",
    "accountHolder": "string",
    "accountHolderDni": "string",
    "country": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "rules": {},
  "gender": "string",
  "kyc": {},
  "watchList": {},
  "extendedData": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "address": {
    "administrativeAreaLevel1": "string",
    "administrativeAreaLevel2": "string",
    "administrativeAreaLevel3": "string",
    "street": "string",
    "streetNumber": "string",
    "optionalAddress": "string",
    "country": "string"
  }
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
id
string 
required
Header Params
x-api-key
string 
required
Example:
{{x-api-key}}
User-Agent
string 
optional
Example:
{{userAgent}}
Body Params application/json
name
string 
optional
The name of the entity (for users) or the official name (for organizations).
nickname
string 
optional
An alternative or preferred name for the entity.
securityOptions
object 
optional
twoFactorAuth
boolean 
optional
Indicates whether two-factor authentication is enabled
signTrx
boolean 
optional
Determines if the entity is required to sign transactions
signAccountsOperations
boolean 
optional
Determines if the entity is required to sign account-related operations
country
string 
optional
he country of operations of the entity CHL, PER, COL, ARG, MEX, USA, CAD
children
array [object {3}] 
optional
A list of related entities (e.g., subsidiaries for organizations or dependent users
id
string 
required
ID
name
string 
required
email
string 
required
externalId
string 
optional
External reference ID (client purpose).
lastname
string 
optional
The last name of the user (if applicable).
bankAccount
object  | null 
optional
externalId
string 
optional
External reference identifier for integrations.
accountNumber
string 
required
The bank account number.
nickname
string 
optional
A friendly name assigned to the bank account.
bank
string 
required
The name of the bank where the account is held.
currency
string 
required
The currency in which the account operates. USD, EUR, CLP, ARS, COP, PER, SOL_USDC
typeAccount
string 
optional
The type of bank account. CHECKING_ACOUNT, SAVINGS, ASSET
accountHolder
string 
required
The full name of the account holder.
accountHolderDni
string 
required
The national identification number or tax ID of the account holder.
he country of operations of the entity
country
string 
required
rules
object 
optional
Custom rules or policies applicable to the entity.
gender
string 
optional
Gender information (if applicable
address
object 
optional
The entity’s address information.
administrativeAreaLevel1
string 
optional
The first-level administrative division.
administrativeAreaLevel2
string 
optional
The second-level administrative division.
administrativeAreaLevel3
string 
optional
The third-level administrative division.
street
string 
optional
The name of the street.
streetNumber
string 
optional
The street number.
optionalAddress
string 
optional
Additional address details.
country
string 
optional
The country of the address.
Examples

Responses

🟢200Success
application/json
Body
id
string <uuid>
optional
Unique identifier for the entity.
type
string 
optional
Specifies whether the entity is an ORGANIZATION or an individual USER.
name
string 
optional
The name of the entity (for users) or the official name (for organizations).
nickname
string 
optional
An alternative or preferred name for the entity.
email
string <email>
optional
The email address associated with the entity.
phone
string 
optional
he phone number linked to the entity. Include +(phone country code)
documentNumber
string 
optional
The document number associated with the entity for identification purposes.
documentType
string 
optional
The type of document PASSPORT, RFC, RUT, CED_CIU, CED_EXT, NIT, DNI, CE, RUC, DNI, CUIT
idv
string 
optional
Identity verification reference
securityOptions
object 
optional
twoFactorAuth
boolean 
optional
Indicates whether two-factor authentication is enabled
signTrx
boolean 
optional
Determines if the entity is required to sign transactions
signAccountsOperations
boolean 
optional
Determines if the entity is required to sign account-related operations
country
string 
optional
he country of operations of the entity CHL, PER, COL, ARG, MEX, USA, CAD
children
array [object {3}] 
optional
A list of related entities (e.g., subsidiaries for organizations or dependent users
id
string 
required
ID
name
string 
required
email
string 
required
status
string 
optional
The current status of the entity. PENDING, PENDING_EMAIL_VALIDATION, PENDING_PHONE_VALIDATION, SCREENING, ACTIVE
externalId
string 
optional
External reference ID (client purpose).
lastname
string 
optional
The last name of the user (if applicable).
bankAccount
object (bankAccount) 
optional
A reference to the associated bank account
id
string 
optional
Unique identifier for the bank account.
externalId
string 
optional
External reference identifier for integrations.
accountNumber
string 
required
The bank account number.
nickname
string 
optional
A friendly name assigned to the bank account.
bank
string 
required
The name of the bank where the account is held.
currency
string 
required
The currency in which the account operates. USD, EUR, CLP, ARS, COP, PER, SOL_USDC
typeAccount
string 
optional
The type of bank account. CHECKING_ACOUNT, SAVINGS, ASSET
accountHolder
string 
required
The full name of the account holder.
accountHolderDni
string 
required
The national identification number or tax ID of the account holder.
he country of operations of the entity
country
string 
optional
The country where the bank account is registered. CHL, PER, COL, ARG, MEX, USA, CAD
createdAt
string <date-time>
optional
Timestamp indicating when the account was created.
updatedAt
string <date-time>
optional
Timestamp indicating the last update to the account details.
rules
object 
optional
Custom rules or policies applicable to the entity.
gender
string 
optional
Gender information (if applicable
kyc
object 
optional
Information related to Know Your Customer (KYC) compliance
watchList
object 
optional
Watchlist information for compliance or fraud detection.
extendedData
array[string]
optional
Additional data.
createdAt
string <date-time>
optional
Creation date UTC format.
updatedAt
string <date-time>
optional
Time of last update made to the entity, UTC format.
address
object 
optional
The entity’s address information.
administrativeAreaLevel1
string 
optional
The first-level administrative division.
administrativeAreaLevel2
string 
optional
The second-level administrative division.
administrativeAreaLevel3
string 
optional
The third-level administrative division.
street
string 
optional
The name of the street.
streetNumber
string 
optional
The street number.
optionalAddress
string 
optional
Additional address details.
country
string 
optional
The country of the address.
🟠400Bad request
🔴500Internal server error
Modified at 2025-02-02 13:31:20
Previous
Get Identity
Next
Delete Identity
Built with