v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

Update a business customer profile

[Available in Sandbox/Production environment] Update a business customer profile on our platform.

patch/kyc/customer_profiles/{customer_profile_id}

Path parameters

customer_profile_idstring required

Customer Profile ID is retrieved from the response id of Create Customer Profile API Regex: /^\s*.{1,191}\s*$/

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 ]+$/

tradingNamestring

The brand or trading name of the business, if different from the legal entity name (customerName). Length: 1 - 50 characters. Regex: /\A[\x20-\x3B\x3D\x3F-\x7E]{1,50}\z/ Note: If provided, this name will be used for PayNow registration instead of the legal entity name. If absent, the PayNow registration falls back to customerName.

registrationIdCountrystring

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

registrationIdTypestring

Customer's registration ID type Only accepts business_reg_no

registrationIdstring

UEN of company (4 to 35 alphanumeric) Regex: %r{\A[a-zA-Z0-9/\-?:().,'+ ]{4,35}\z}

placeOfBizstring

Customer's principal place of business if it is different from registered address. Otherwise, provide registered address. Regex: /^\s*.{1,255}\s*$/

placeOfBizCountrystring

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

countryOfIncorporationstring

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

dateOfIncorporationstring date

Date must be in 'YYYY-MM-DD' format Regex: /^\d{4}-\d{2}-\d{2}$/

Response

200

Example response

{
  "data": {
    "id": "customer_profile_8bcef957-74a5-4c07-bcaa-0b377c02ca13",
    "type": "customer_profile",
    "attributes": {
      "customerName": "Xfers Pte. Ltd.",
      "tradingName": "Xfers & Co.",
      "registrationType": "business",
      "registrationIdType": "business_reg_no",
      "registrationIdCountry": "SG",
      "registrationId": "201411660R",
      "address": {
        "street": "10 Albert Street",
        "city": "Singapore",
        "postalCode": "000000",
        "state": "Singapore",
        "country": "SG"
      },
      "placeOfBiz": "10 Albert Street, 000000 Singapore",
      "placeOfBizCountry": "SG",
      "countryOfIncorporation": "SG",
      "dateOfIncorporation": "2020-11-14T00:00:00.000Z",
      "verificationStatus": "verified"
    }
  }
}