CTOS

Request CTOS reports

post/api/v1/Integrations/Ctos

Request

  • Base URL: https://api.payex.io
  • URL: https://api.payex.io/api/v1/Integrations/Ctos
  • Auth: HTTP bearer

Request body

id_type'I' | 'F' | 'P' | 'A' | 'C' | 'B' | 'L' | 'O'

Accepted values for 'id_type' are: I - IC number, F - Old IC number, P - Police number, A - Army number, C - Company, B - Business, L - LLP, O - Others

id_numberstring
namestring
basic_group_codestring
phone_numberstring
purpose_codestring
statestring
countrystring
refreshboolean

set 'refresh' to 'true' to submit new request to CTOS, instead of getting previously stored report from Payex

consentboolean

set 'consent' to 'false' if consent to report is not provided by requested entity

Response

Success

status'00' | '99'
messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.