API ReferenceCustomersAPI IntegrationThird Parties

Update Third-Party Customer

Beta

Perform comprehensive updates to existing third-party customer profiles using their unique reference identifier. This endpoint empowers partners to modify third-party customer records spanning personal information, contact details, address information, employment data, financial particulars, and property details.

Authentication: Bearer token required

Path parameters

customer_idstringRequired

Unique identifier of the partner platform updating the third-party customer

client_customer_refstringRequired

Partner’s internal reference/ID for this customer. This is the customer reference that was provided during customer creation via Create Partner Customer.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
first_namestringOptional
Third party customer's first name for personal identification and account management
last_namestringOptional
Third party customer's last name for personal identification and account management
emailstringOptionalformat: "email"
Third party customer's primary email address for communication and account notifications
mobile_phonestringOptional

Third party customer’s primary contact phone number with international country code in E.164 international format (e.g., +14155552671)

countrystringOptional

ISO 3166-1 alpha-3 country code representing the third party customer’s legal nationality or citizenship status. See ISO 3166-1 alpha-3 for the complete list of country codes.

currencystringOptional

3-letter ISO currency code for the third party customer’s preferred currency. See ISO 4217 for the complete list of currency codes.

date_of_birthstringOptional

Third party customer’s date of birth in [ISO 8601 format] (https://en.wikipedia.org/wiki/ISO_8601)

addressobjectOptional
occupationstringOptional
Third party customer's professional occupation.
employer_namestringOptional
Name of the third party customer's current employer
income_rangeobjectOptional
Third party customer's income range in the given currency
property_detailslist of objectsOptional

Array of property details for the third-party customer.

Multiple Properties Support: This endpoint supports updating multiple properties associated with a third-party customer. Properties can be added or modified based on the property_ref identifier. Existing properties will be updated if the property_ref matches, while new properties will be created if the property_ref is not found.

Response

Third-party customer updated successfully

client_customer_refstring<=50 characters

Partner’s internal reference/ID for this customer.

statusenum

Status of the third party customer.

  • APPROVED: Compliance check has passed successfully.
  • REJECTED: Compliance check has failed due to validation or regulatory issues.
  • PENDING: Compliance check is still in progress.
Allowed values:

Errors