Create a personal customer profile+ API

post

https://api-sandbox.straitsx.com/v1/kyc/customer_profiles

[Available in Sandbox/Production environment] Create a personal CP+ profile on our platform.

Body Params

customerName

string

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

customerFirstName

string

required

Customer's first name(Must be within 191 characters)
Regex: /^\s*.{1,191}\s*$/

customerLastName

string

required

Customer's last name(Must be within 191 characters)
Regex: /^\s*.{1,191}\s*$/

customerNativeName

string

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

phoneNo

string

Must follow international format with country code
Regex: /^\+?[1-9]\d{0,3}[\s\-]?$?\d{1,4}$?[\s\-]?\d{1,4}[\s\-]?\d{1,4}[\s\-]?\d{0,4}$/

address

object

required

Customer's residency address

countryOfResidence

string

required

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}$/

dateOfBirth

date

required

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

string

required

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

gender

string

required

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

nationality

string

required

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

registrationId

string

required

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

registrationType

string

required

Please input personal only

registrationIdCountry

string

required

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

registrationIdType

string

required

Accepts either passport or identity_card

registrationIdExpiryDate

date

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

businessIndustry

string

required

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

occupation

string

required

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

expectedAnnualTransactionAmount

string

required

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

expectedTransactionSize

string

required

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

expectedTransactionFrequency

string

required

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

annualIncome

string

required

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

identityDocuments

object

required

totalWealth

string

required

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

sourceOfWealth

object

ipAddresses

array of strings

required

Example: ["8.8.8.8"]

ipAddresses*

purposeOfAccount

string

required

Accepts only INVESTMENT, TRADING, REMITTANCES and OTHERS

otherPurposeOfAccount

string

Required if OTHERS is selected for purposeOfAccount field.

Headers

X-XFERS-APP-API-KEY

string

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-ID

string

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-TIMESTAMP

string

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-NONCE

string

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-SIGNATURE

string

Base64-encoded digital signature of the canonical request string.

Note: This header attribute is required when HTTP Request Signing is enabled for your account.

Response

200Success