---
updatedAt: 2026-06-14T06:16:18.000Z
agentTools:
projectIndex: https://docs.straitsx.com/llms.txt
---
# Update a personal customer profile
[Available in Sandbox/Production environment] Update a personal customer profile on our platform.
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "straitsx-sandbox-base-url",
"version": "1.7.0"
},
"servers": [
{
"url": "https://api-sandbox.straitsx.com/v1"
}
],
"components": {
"securitySchemes": {
"sec0": {
"type": "apiKey",
"in": "header",
"name": "X-XFERS-APP-API-KEY"
}
}
},
"security": [
{
"sec0": []
}
],
"paths": {
"/kyc/customer_profiles/{customer_profile_id}": {
"patch": {
"summary": "Update a personal customer profile",
"description": "[Available in Sandbox/Production environment] Update a personal customer profile on our platform.",
"operationId": "update-a-customer-profile-1",
"parameters": [
{
"name": "X-XFERS-APP-API-KEY",
"in": "header",
"description": "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.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-PUBLIC-KEY-ID",
"in": "header",
"description": "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.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "X-TIMESTAMP",
"in": "header",
"description": "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.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "X-NONCE",
"in": "header",
"description": "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.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "X-SIGNATURE",
"in": "header",
"description": "Base64-encoded digital signature of the canonical request string.
Note: This header attribute is required when HTTP Request Signing is enabled for your account.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "customer_profile_id",
"in": "path",
"description": "Customer Profile ID is retrieved from the response id of Create Customer Profile API
Regex: `/^\\s*.{1,191}\\s*$/`",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"customerName": {
"type": "string",
"description": "Customer's full name (50 alphanumeric with spaces)
Regex: `/^(?=.{1,50}$)[a-zA-Z0-9 ]+$/`"
},
"registrationIdCountry": {
"type": "string",
"description": "Customer's registration ID country (2 digit ISO country code) from https://www.iban.com/country-codes
Regex: `/^[A-Z]{2}$/`"
},
"registrationIdType": {
"type": "string",
"description": "Customer's registration ID type
Accepts either `passport` or `identity_card`"
},
"registrationId": {
"type": "string",
"description": "NRIC/Passport No. (4 to 35 alphanumeric)
Regex: `%r{\\A[a-zA-Z0-9/\\-?:().,'+ ]{4,35}\\z}`"
},
"countryOfResidence": {
"type": "string",
"description": "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: `/^\\s*.{1,191}\\s*$/`"
},
"dateOfBirth": {
"type": "string",
"description": "Customer's date of birth (YYYY-MM-DD)
Regex: `/^\\d{4}-\\d{2}-\\d{2}$/`",
"format": "date"
},
"nationality": {
"type": "string",
"description": "Customer's nationality (Country Name or 2/3 digit ISO country code) from https://www.iban.com/country-codes
Regex: `/^\\s*.{1,191}\\s*$/`"
},
"gender": {
"type": "string",
"description": "Customer's gender. Must be either `MALE` or `FEMALE`."
},
"email": {
"type": "string",
"description": "Customer's email address
Regex: `` %r{^[\\w!#$%&’*+/=?`{|}~^-]+(?:\\.[\\w!#$%&’*+/=?`{|}~^-]+)*@(?:[a-z0-9-]+\\.)+[a-z]{2,24}$}i ``"
},
"phoneNo": {
"type": "string",
"description": "Customer's phone number
Regex: `/^\\+?[1-9]\\d{0,3}[\\s\\-]?\\(?\\d{1,4}\\)?[\\s\\-]?\\d{1,4}[\\s\\-]?\\d{1,4}[\\s\\-]?\\d{0,4}$/`"
},
"address": {
"type": "object",
"description": "Customer's residency address",
"properties": {
"street": {
"type": "string",
"description": "Regex: `/^(?=.{1,180}$)[a-zA-Z0-9\\-?:().,' +]+$/`"
},
"city": {
"type": "string",
"description": "Regex: `/^(?=.{1,20}$)[a-zA-Z0-9\\-?:().,' +]+$/`"
},
"postalCode": {
"type": "string",
"description": "Regex: `/^[A-Za-z0-9\\- ]{2,20}$/`"
},
"state": {
"type": "string",
"description": "Regex: `/^(?=.{1,15}$)[a-zA-Z0-9\\-?:().,' +]+$/`"
},
"country": {
"type": "string",
"description": "Must be an alpha-2 country code. Please refer to the following document for the accepted values: https://www.iban.com/country-codes
Regex: `/^[A-Z]{2}$/`"
}
}
}
}
},
"examples": {
"Sample Request": {
"value": {
"customerName": "Jane Doe",
"registrationType": "personal",
"registrationIdType": "identity_card",
"registrationIdCountry": "SG",
"registrationId": "S1234567A",
"countryOfResidence": "SG",
"dateOfBirth": "1990-01-21",
"nationality": "SINGAPOREAN",
"customerNativeName": "Jane",
"gender": "FEMALE",
"email": "jane.doe.test@example.com",
"phoneNo": "6591234567",
"address": {
"street": "100 Orchard Road, Unit #01-01",
"city": "Singapore",
"postalCode": "238840",
"state": "Singapore",
"country": "SG"
}
},
"summary": "Sample Request"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"data\": {\n \"id\": \"customer_profile_08d5ffe5-8a02-4dc2-aabb-9057b8ab3c65\",\n \"type\": \"customer_profile\",\n \"attributes\": {\n \"customerName\": \"John Ng\",\n \"registrationType\": \"personal\",\n \"registrationIdType\": \"identity_card\",\n \"registrationIdCountry\": \"SG\",\n \"registrationId\": \"S1234567J\",\n \"countryOfResidence\": \"Singapore\",\n \"address\": {\n \"street\": \"10 Albert Street\",\n \"city\": \"Singapore\",\n \"postalCode\": \"000000\",\n \"state\": \"Singapore\",\n \"country\": \"SG\"\n },\n \"verificationStatus\": \"verified\",\n \"dateOfBirth\": \"1983-11-14T00:00:00.000Z\",\n \"gender\": \"MALE\",\n \"nationality\": \"SINGAPOREAN\",\n \"email\": \"test@gmail.com\",\n \"phoneNo\": 6587654321\n }\n }\n}"
}
},
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "customer_profile_08d5ffe5-8a02-4dc2-aabb-9057b8ab3c65",
"description": "Unique customer profile ID."
},
"type": {
"type": "string",
"example": "customer_profile",
"description": "Request type."
},
"attributes": {
"type": "object",
"properties": {
"customerName": {
"type": "string",
"example": "John Ng",
"description": "Customer's full name."
},
"registrationType": {
"type": "string",
"example": "personal",
"description": "Customer's registration type."
},
"registrationIdType": {
"type": "string",
"example": "identity_card",
"description": "Customer's registration ID type."
},
"registrationIdCountry": {
"type": "string",
"example": "SG",
"description": "Country that registration ID was issued."
},
"registrationId": {
"type": "string",
"example": "S1234567J",
"description": "NRIC/Passport No."
},
"address": {
"type": "object",
"properties": {
"street": {
"type": "string",
"example": "10 Albert Street",
"description": "Street address."
},
"city": {
"type": "string",
"example": "Singapore",
"description": "City name."
},
"postalCode": {
"type": "string",
"example": "000000",
"description": "Postal or ZIP code."
},
"state": {
"type": "string",
"example": "Singapore",
"description": "State or region."
},
"country": {
"type": "string",
"example": "SG",
"description": "Country code."
}
},
"description": "Customer's residency address."
},
"verificationStatus": {
"type": "string",
"example": "verified",
"description": "Customer profile's verification status."
},
"dateOfBirth": {
"type": "string",
"example": "1983-11-14T00:00:00.000Z",
"description": "Customer's date of birth."
},
"gender": {
"type": "string",
"example": "MALE",
"description": "Customer's gender."
},
"nationality": {
"type": "string",
"example": "SINGAPOREAN",
"description": "Customer's nationality."
},
"phoneNo": {
"type": "string",
"example": "test@gmail.com",
"description": "Customer's phone number."
},
"email": {
"type": "integer",
"example": 6587654321,
"default": 0,
"description": "Customer's email address."
}
}
}
}
}
}
}
}
}
}
},
"deprecated": false,
"x-readme": {
"code-samples": [
{
"code": "{\n \"customerName\": \"Jane Doe\",\n \"registrationType\": \"personal\", \n \"registrationIdType\": \"identity_card\", \n \"registrationIdCountry\": \"SG\", \n \"registrationId\": \"S1234567A\", \n \"countryOfResidence\": \"SG\",\n \"dateOfBirth\": \"1990-01-21\", \n \"nationality\": \"SINGAPOREAN\", \n \"customerNativeName\": \"Jane\", \n \"gender\": \"FEMALE\", \n \"email\": \"jane.doe.test@example.com\",\n \"phoneNo\": \"6591234567\", \n\n \"address\": {\n \"street\": \"100 Orchard Road, Unit #01-01\",\n \"city\": \"Singapore\",\n \"postalCode\": \"238840\",\n \"state\": \"Singapore\",\n \"country\": \"SG\"\n }\n}",
"language": "json",
"name": ""
}
],
"samples-languages": [
"json"
]
}
}
}
},
"x-readme": {
"headers": [],
"explorer-enabled": true,
"proxy-enabled": true
},
"x-readme-fauxas": true
}
```