v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

Update a personal CP+

patch/kyc/customer_profiles/:customer_profile_id

Headers

X-XFERS-APP-API-KEYstring required

You can retrieve this from your Dashboard Developer Tools. Note: The X-XFERS-APP-API-KEY is a mandatory header for all authentication methods, including standard API key usage and HTTP Request Signing mode.

X-PUBLIC-KEY-IDstring

The Key ID, can be retrieved from your StraitsX Dashboard. Note: This header attribute is required when HTTP Request Signing is enabled for your account.

X-TIMESTAMPstring

Current Unix epoch time in seconds. Must be within ±300 seconds of server time. Note: This header attribute is required when HTTP Request Signing is enabled for your account.

X-NONCEstring

A unique UUID string per request, used for replay protection. Must not be reused within the timestamp window. Regex: /\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i Note: This header attribute is required when HTTP Request Signing is enabled for your account.

X-SIGNATUREstring

Base64-encoded digital signature of the canonical request string. Note: This header attribute is required when HTTP Request Signing is enabled for your account.

Request body

customerNamestring

Customer's full name (50 alphanumeric with spaces) Regex: /^(?=.{1,50}$)[a-zA-Z0-9 ]+$/

customerFirstNamestring

Customer's first name (50 SWIFT characters) Regex: /^(?=.{1,50}$)[a-zA-Z0-9 ]+$/

customerLastNamestring

Customer's last name (50 SWIFT characters) Regex: /^(?=.{1,50}$)[a-zA-Z0-9 ]+$/

customerNativeNamestring

Must be within 191 characters Regex: /^\s*.{1,191}\s*$/

phoneNostring

Regex: /^\+?[1-9]\d{0,3}[\s\-]?$?\d{1,4}$?[\s\-]?\d{1,4}[\s\-]?\d{1,4}[\s\-]?\d{0,4}$/

countryOfResidencestring

Customer's country of residence reflected in ID(Country Name or 2/3 digit ISO country code) from https://www.iban.com/country-codes Regex: /^[A-Z]{2}$/

dateOfBirthstring

Customer's date of birth (YYYY-MM-DD) Regex: /^\d{4}-\d{2}-\d{2}$/

emailstring

Customer's email address Regex: %r{^[\w!#$%&'*+/=?`{|}~^-]+(?:\.[\w!#$%&'*+/=?`{|}~^-]+)*@(?:[a-z0-9-]+\.)+[a-z]{2,24}$}i

genderstring

Customer's gender. Must be either MALE or FEMALE.

nationalitystring

Customer's nationality (Country Name or 2/3 digit ISO country code) from https://www.iban.com/country-codes Regex: /^\s*.{1,191}\s*$/

registrationIdstring

Must be within 4-35 characters Regex: %r{\A[a-zA-Z0-9/\-?:().,'+ ]{4,35}\z}

registrationIdCountrystring

Customer's registration ID country (2 digit ISO country code) from https://www.iban.com/country-codes Regex: /^[A-Z]{2}$/

registrationIdTypestring

Accepts either passport or identity_card

registrationIdExpiryDatestring date

Must be in 'yyyy-MM-dd' format Regex: /^\d{4}-\d{2}-\d{2}$/

businessIndustrystring

Please input 1 value only Refer to "Business Industry Accepted Values" code block for the list of accepted values

occupationstring

Please input 1 value only Refer to "Occupation Accepted Values" code block for the list of accepted values

expectedAnnualTransactionAmountstring

Please input 1 value only Accepted values: 0_TO_1000, 1001_TO_5000, 5001_TO_10000, 10001_TO_30000, GT_30000

expectedTransactionSizestring

Please input 1 value only Accepted values: 0_TO_1000, 1001_TO_5000, 5001_TO_10000, 10001_TO_20000, GT_20000

expectedTransactionFrequencystring

Please input 1 value only Accepted values: AT_LEAST_ONCE_EVERY_2_WEEKS, AT_LEAST_ONCE_A_MONTH, AT_LEAST_ONCE_EVERY_6_MONTHS, AT_LEAST_ONCE_A_YEAR

annualIncomestring

Please input 1 value only Accepted values: 0_TO_30000, 30001_TO_50000, 50001_TO_100000, 100001_TO_500000, GT_500000

totalWealthstring

Accepted values: 0_TO_500000, 500001_TO_2000000, 2000001_TO_5000000, 5000001_TO_10000000, GT_10000000

ipAddressesstring

Example: ["8.8.8.8"]

Response

Success

Example response

{
  "data": {
    "id": "customer_profile_2eeb5db4-ceaf-4f1f-9cf9-7222ca635be2",
    "type": "customer_profile",
    "attributes": {
      "customerName": "STRAITSX PATCH",
      "registrationType": "personal",
      "registrationId": "S9823457DEU",
      "countryOfResidence": "ID",
      "verificationStatus": "verified",
      "dateOfBirth": "2000-02-14",
      "gender": "MALE",
      "nationality": "ID",
      "email": "nastiti-patch@gmail.com",
      "phoneNo": "659510921700",
      "address": {
        "city": "SINGAPORE",
        "state": "SINGAPORE",
        "street": "NORTH 17TH",
        "country": "SINGAPORE",
        "postalCode": "18555"
      },
      "registrationIdCountry": "SG",
      "registrationIdType": "passport",
      "registrationIdExpiryDate": "2050-12-30",
      "businessIndustry": "PERSONAL_SERVICES",
      "occupation": "SELF_EMPLOYED",
      "expectedAnnualTransactionAmount": "GT_30000",
      "expectedTransactionSize": "GT_20000",
      "expectedTransactionFrequency": "AT_LEAST_ONCE_EVERY_6_MONTHS",
      "annualIncome": "GT_500000",
      "identityDocuments": {
        "livenessResult": true
      },
      "totalWealth": "GT_10000000",
      "ipAddresses": [
        "10.0.1.2"
      ],
      "customerNativeName": "铁集团",
      "customerFirstName": "LEON",
      "customerLastName": "KENNEDY",
      "createdAt": "2025-07-10T10:23:06Z",
      "updatedAt": "2025-07-10T11:02:28Z",
      "riskRating": {
        "status": "verified"
      }
    }
  }
}