Create a business customer profile+ API

Changed on

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

post/kyc/customer_profiles

Request

  • Base URL
    https://api-sandbox.straitsx.com/v1
  • URL
    https://api-sandbox.straitsx.com/v1/kyc/customer_profiles
  • Auth
    API key in header X-XFERS-APP-API-KEY

Headers

X-XFERS-APP-API-KEYstring required

You can retrieve this from your Dashboard Developer Tools.<br><br><strong>Note:</strong> 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.<br><br><strong>Note:</strong> 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.<br><br><strong>Note:</strong> 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.<br>Regex: /\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i<br><br><strong>Note:</strong> 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.<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

Request body

customerNamestring required

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

customerNativeNamestring

Regex: /^\s*.{1,191}\s*$/

tradingNamestring

The brand or trading name of the business, if different from the legal entity name (customerName).<br>Length: 1 - 50 characters.<br>Regex: /\A[\x20-\x3B\x3D\x3F-\x7E]{1,50}\z/<br><br><strong>Note:</strong> 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.

merchantRefstring

Your own reference identifier for this customer profile. Must be within 191 characters.<br>Regex: /^\s*.{1,191}\s*$/

registrationTypestring required

Business

registrationIdTypestring required

<code>business_reg_no<code>

registrationIdstring required

Business Registration Number of the customer.<br>4-35 alphanumeric chars.<br>Regex: /\A[a-zA-Z0-9\- ]{4,35}\z/

entityLegalFormstring required

Accepted values: PRIVATE_COMPANYorPUBLIC_COMPANY

businessContactstring required

Provide the string in a valid format.<br>Regex: ^\+?[1-9]\d{0,3}[\s\-]?\(?\d{1,4}\)?[\s\-]?\d{1,4}[\s\-]?\d{1,4}[\s\-]?\d{0,4}$

websitestring

Provide a valid URL.<br>Regex: /^(https?:\/\/)?(([0-9]{1,3}(\.[0-9]{1,3}){3,5})|(([-\p{L}0-9]{1,256}\.)+[-\p{L}]{2,6}))(:[0-9]+)?([\/?].*)?$/i

countryOfIncorporationstring required

Customer's country of incorporation.<br>2 digit ISO country code - https://www.iban.com/country-codes<br><br>List of accepted countries, Refer to Other Info > Accepted Countries

dateOfIncorporationstring required

yyyy-MM-dd format

natureOfBusinessstring required

Accepted Values:<br>PERSONAL_INVESTMENT_COMPANIES<br> SUPERANNUATION_FUND<br> CRYPTO_MINING<br> PROPRIETARY_TRADING<br> ALGORITHM_CRYPTO_TRADERS<br> P2P_MERCHANTS<br> OTHER_WEB3_SERVICES_NON_VASP<br> ACCOMMODATION_AND_FOOD_SERVICES<br> WASTE_MANAGEMENT_AND_REMEDIATION_SERVICES<br> AGRICULTURE_FORESTRY_FISHING_AND_HUNTING<br> ARTS_ENTERTAINMENT_AND_RECREATION<br> EDUCATIONAL_SERVICES<br> GAMING<br> HEALTHCARE_AND_SOCIAL_ASSISTANCE<br> INFORMATION<br> GENERAL_MANUFACTURING<br> PROFESSIONAL_SERVICES<br> SCIENTIFIC_AND_TECHNICAL_SERVICES<br> RETAIL_ELECTRONICS<br> RETAIL_FOOD_AND_BEVERAGE<br> RETAIL_JEWELRY<br> RETAIL_OTHERS<br> SALE_OF_DRUGS_AND_PHARMACEUTICAL_PRODUCTS<br> TRANSPORTATION_AND_WAREHOUSING<br> FAMILY_OFFICE<br> SOVEREIGN_WEALTH_FUND<br> INVESTMENT_FUNDS<br> CRYPTO_EXCHANGE_BROKER<br> CRYPTO_ATM<br> OTHER_DIGITAL_ASSET_SERVICE_PROVIDERS_VASP<br> BANK<br> NON_BANK_FINANCIAL_INSTITUTION<br> MONEY_SERVICES_BUSINESS_PAYMENT_SERVICE_PROVIDERS<br> CONSTRUCTION<br> GENERAL_WHOLESALERS<br> MANAGEMENT_OF_COMPANIES<br> PRECIOUS_STONES_METALS_DEALERS<br> CRUDE_OIL_NATURAL_GAS_DEALERS<br> PAWN_SHOPS<br> PUBLIC_ADMINISTRATION<br> REAL_ESTATE_RENTAL_LEASING<br> UTILITIES<br> OTHERS<br>

otherNatureOfBusinessstring

*Required field if natureOfBusiness is OTHERS<br>Format: Free text

usOwnershipboolean required

true / false

intermediariesboolean required

true / false - Refers to this onboarding question: “Is your company owned by any intermediary companies/legal arrangement (at least 10% or more)?

monthlyTransactionVolumestring required

In USD.<br>Accepted Values: 0_TO_100000, 100001_TO_500000, 500001_TO_1000000, 100001_TO_10000000, GT_10000000

sourceOfFundsstring[] required

Accepted Values:<br>LOAN_FROM_PARENT_COMPANY<br> LOAN_FROM_DIRECTORS_SHAREHOLDERS<br> INVESTOR_FUNDS<br> BUSINESS_LOANS<br> BUSINESS_REVENUE<br> CUSTOMER_FUNDS_FOR_INVESTMENT<br> ARBITRAGE_TRADING<br> EMPLOYMENT_INCOME<br> BUSINESS_OWNERSHIP_INCOME<br> PROPERTY_OWNERSHIP<br> INVESTMENT_HOLDINGS_RETURNS<br> GIFTS_INHERITANCE<br> CASH_SAVINGS<br> OTHERS

otherSourceOfFundsstring

*Required field if sourceOfFunds includes OTHERS<br>Free text.

licensingStatusstring

Accepts: FULLY_LICENSED, EXEMPT_FROM_LICENSING, IN_PRINCIPLE_APPROVAL_GRANTED, LICENSE_APPLICATION_IN_PROGRESS, NOT_SUBJECTED_TO_LICENSING_REQUIREMENTS<br><br>documents.operatingLicense field becomes mandatory if any option is selected apart from NOT_SUBJECTED_TO_LICENSING_REQUIREMENTS

purposeOfAccountstring

Declared purpose of the account.<br>Accepts only INVESTMENT, TRADING, REMITTANCES, TREASURY MANAGEMENT, BUSINESS USAGE and OTHERS

otherPurposeOfAccountstring

Required if OTHERS is selected for purposeOfAccount field.

Response

200

Example response

{
  "data": {
    "id": "customer_profile_91689f61-ab6f-4126-af18-35a906046d72",
    "type": "customer_profile",
    "attributes": {
      "customerName": "ABC Pte Ltd",
      "tradingName": "ABC's Brand",
      "registrationType": "business",
      "registrationIdCountry": "SG",
      "registrationIdType": "business_reg_no",
      "registrationId": "20123231SA",
      "entityLegalForm": "PUBLIC_COMPANY",
      "businessContact": "0365109217",
      "countryOfIncorporation": "SG",
      "dateOfIncorporation": "1999-09-09",
      "address": {
        "street": "Northside 18th",
        "city": "Singapore",
        "postalCode": "8809",
        "state": "Singapore",
        "country": "SG"
      },
      "operatingAddress": {
        "street": "Northside 18th",
        "city": "Singapore",
        "postalCode": "8809",
        "state": "Singapore",
        "country": "SG"
      },
      "natureOfBusiness": "PERSONAL_INVESTMENT_COMPANIES",
      "usOwnership": true,
      "intermediaries": true,
      "intermediariesDocuments": [
        {
          "certificateOfIncorporation": "https://xyz.com/download-link",
          "memorandum": "https://xyz.com/download-link",
          "registerOfMembers": "https://xyz.com/download-link",
          "certificateOfIncumbency": "https://xyz.com/download-link"
        }
      ],
      "monthlyTransactionVolume": "80001_TO_100000",
      "sourceOfWealth": {
        "investorFunds": {
          "document": "https://xyz.com/download-link"
        },
        "businessLoans": {
          "document": "https://xyz.com/download-link"
        },
        "others": {
          "details": "other source of wealth",
          "document": "https://xyz.com/download-link"
        }
      },
      "sourceOfFunds": [
        "PERSONAL_SAVINGS"
      ],
      "otherSourceOfFunds": "other source of funds",
      "directors": [
        {
          "firstName": "John",
          "lastName": "Doe",
          "dateOfBirth": "1950-01-01",
          "registrationId": "A12321321",
          "registrationIdType": "passport",
          "registrationIdCountry": "SG",
          "identityDocuments": {
            "passport": "https://xyz.com/download-link"
          },
          "nationality": "SG",
          "countryOfResidence": "SG"
        }
      ],
      "beneficialOwners": [
        {
          "firstName": "John",
          "lastName": "Doe",
          "dateOfBirth": "1950-01-01",
          "registrationId": "A12321321",
          "registrationIdType": "passport",
          "registrationIdCountry": "SG",
          "identityDocuments": {
            "passport": "https://xyz.com/download-link"
          },
          "nationality": "SG",
          "countryOfResidence": "SG",
          "address": {
            "street": "Northside 18th",
            "city": "Singapore",
            "postalCode": "8809",
            "state": "Singapore",
            "country": "SG"
          },
          "proofOfAddress": "https://xyz.com/download-link"
        }
      ],
      "trader": {
        "firstName": "John",
        "lastName": "Doe",
        "dateOfBirth": "1950-01-01",
        "registrationId": "A12321321",
        "registrationIdType": "identity_card",
        "registrationIdCountry": "SG",
        "identityDocuments": {
          "idFront": "https://xys.com/download-link",
          "idBack": "https://xys.com/download-link"
        },
        "selfie": "https://xyz.com/download-link",
        "livenessSnapshot": "https://xyz.com/download-link",
        "livenessResult": true,
        "nationality": "SG",
        "countryOfResidence": "SG",
        "address": {
          "street": "Northside 18th",
          "city": "Singapore",
          "postalCode": "8809",
          "state": "Singapore",
          "country": "SG"
        },
        "proofOfAddress": "https://xyz.com/download-link"
      },
      "documents": {
        "certificateOfIncorporation": "https://xys.com/download-link",
        "memorandum": "https://xys.com/download-link",
        "registerOfDirectors": "https://xys.com/download-link",
        "registerOfMembers": "https://xys.com/download-link",
        "sanctionQuestionnaire": "https://xys.com/download-link",
        "amlQuestionnaire": "https://xys.com/download-link",
        "operatingLicense": "https://xys.com/download-link",
        "proofOfAddress": "https://xys.com/download-link"
      },
      "verificationStatus": "pending",
      "createdAt": "2025-01-16T09:52:52Z",
      "updatedAt": "2025-01-16T09:52:52Z"
    }
  }
}

Changes