Sign in

v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

Get a list of CP+ profiles

get/kyc/customer_profiles

Query parameters

page[size]integer

Number of items per page(Must be greater than 0)<br>Regex: /^0*[1-9][0-9]*$/

page[number]integer

Page number(Must be greater than 0)<br>Regex: /^0*[1-9][0-9]*$/

sortstring

Sorted by:<br>- Creation Date: Ascending (created_at) / Descending (-created_at)<br>- Updated Date: Ascending (updated_at) / Descending (-updated_at)

filter[created_after]string

ISO8601 format<br>Regex: /^(\d{4})(-(0[1-9]|1[0-2])(-(0[1-9]|[12]\d|3[01])(T([01]\d|2[0-3]):([0-5]\d):([0-5]\d)(\.\d+)?(Z|([+-]([01]\d|2[0-3]):([0-5]\d)))?)?)?)?$/i

filter[created_before]string

ISO8601 format<br>Regex: /^(\d{4})(-(0[1-9]|1[0-2])(-(0[1-9]|[12]\d|3[01])(T([01]\d|2[0-3]):([0-5]\d):([0-5]\d)(\.\d+)?(Z|([+-]([01]\d|2[0-3]):([0-5]\d)))?)?)?)?$/i

filter[updated_after]string

ISO8601 format<br>Regex: /^(\d{4})(-(0[1-9]|1[0-2])(-(0[1-9]|[12]\d|3[01])(T([01]\d|2[0-3]):([0-5]\d):([0-5]\d)(\.\d+)?(Z|([+-]([01]\d|2[0-3]):([0-5]\d)))?)?)?)?$/i

filter[updated_before]string

ISO8601 format<br>Regex: /^(\d{4})(-(0[1-9]|1[0-2])(-(0[1-9]|[12]\d|3[01])(T([01]\d|2[0-3]):([0-5]\d):([0-5]\d)(\.\d+)?(Z|([+-]([01]\d|2[0-3]):([0-5]\d)))?)?)?)?$/i

filter[registration_id]string

NRIC/Passport No./Business Registration ID (4 to 35 alphanumeric)<br>Regex: %r{\A[a-zA-Z0-9/\-?:().,'+ ]{4,35}\z}

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.

Response

200

Example response

[
  {
    "data": {
      "id": "customer_profile_099d4fd1-34a0-4310-a562-77402438bfda",
      "type": "customer_profile",
      "attributes": {
        "customerName": "ABC Pte Ltd",
        "registrationType": "business",
        "registrationId": "20123231SA",
        "verificationStatus": "pending",
        "address": {
          "city": "Singapore",
          "state": "Singapore",
          "street": "Northside 18th",
          "country": "SG",
          "postalCode": "8809"
        },
        "operatingAddress": {
          "city": "Singapore",
          "state": "Singapore",
          "street": "Northside 18th",
          "country": "SG",
          "postalCode": "8809"
        },
        "registrationIdCountry": "SG",
        "countryOfIncorporation": "SG",
        "dateOfIncorporation": "1999-09-19",
        "registrationIdType": "business_reg_no",
        "entityLegalForm": "PUBLIC_COMPANY",
        "businessContact": "0365109217",
        "intermediaries": true,
        "natureOfBusiness": "PERSONAL_INVESTMENT_COMPANIES",
        "usOwnership": true,
        "monthlyTransactionVolume": "80001_TO_100000",
        "sourceOfFunds": [
          "PERSONAL_SAVINGS"
        ],
        "otherSourceOfFunds": "other source of funds",
        "directors": [
          {
            "lastName": "Doe",
            "firstName": "John",
            "nationality": "SG",
            "dateOfBirth": "1950-01-01",
            "registrationId": "A12321321",
            "countryOfResidence": "SG",
            "registrationIdType": "passport",
            "registrationIdCountry": "SG"
          }
        ],
        "beneficialOwners": [
          {
            "lastName": "Doe",
            "firstName": "John",
            "nationality": "SG",
            "dateOfBirth": "1950-01-01",
            "registrationId": "A12321321",
            "countryOfResidence": "SG",
            "registrationIdType": "passport",
            "registrationIdCountry": "SG"
          }
        ],
        "trader": {
          "lastName": "Doe",
          "firstName": "John",
          "nationality": "SG",
          "dateOfBirth": "1950-01-01",
          "livenessResult": true,
          "registrationId": "A12321321",
          "countryOfResidence": "SG",
          "registrationIdType": "identity_card",
          "registrationIdCountry": "SG"
        },
        "createdAt": "2024-12-26T08:35:54Z",
        "updatedAt": "2024-12-26T08:36:05Z"
      }
    }
  }
]