STstraitsx

Get a list of customer profiles

Changed on
get/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

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> <b>Creation Date:</b> Ascending (created_at) / Descending (-created_at) <br><b>Updated Date:</b>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

idempotency_idstring

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

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

Success

Changes

  • d17239d67150Revision changes
    • breaking

      for the query request parameter page[number], default value was changed from 1 to 1

    • breaking

      for the query request parameter page[size], default value was changed from 10 to 10

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      api operation id h removed and replaced with get-list-of-customer-profiles

    • info

      added the new optional query request parameter idempotency_id

    • info

      the response property / became required for the status

    • info

      the response property // became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status