Creditinfo

# Request Parameters

The following parameters are expected:

Field Description Type
search_type The Search type you want to do. Examples: CREDITINFO String
report_type The Report type you want to do. Examples: CreditReport String
document_type The identity document you will use to query.Examples: NationalID String
client_name The client name whose CRB you want to query. Examples: John Doe String
identifier This is the search parameter. E.g. ID Number String
consent Indicates if consent has been given. Examples: true Boolean
consent_given_by Name of the person giving consent. Examples: Jane Doe String

Please find sample implementation on the left


# Response Parameters

Below is a sample response

'search_type' is CREDITINFO and identifier is the client's ID Number

Search details on a customer's creditinfo using their ID Number. As sample response is as follows:

{
  "code": "200.001",
  "data": {}
}