Developer Docs

Creditinfo Score

# Request Parameters

The following parameters are expected:

Field Description Type
search_type The Search type you want to do. Examples: CREDITINFOCREDITSCORE String
document_type The identity document you will use to query.Examples: NationalID String
client_name The client sname whose CRB you want to query. Examples: John Doe String
identifier This is the search parameter. E.g. ID Number String
consent Indicates whether the data owner has consented to identity verification 1 if yes 0 if no.1 if yes 0 if no. Boolean
consent_collected_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": {
    "extract": {
      "Data": {
        "response": {
          "status": "ok",
          "Strategy": {
            "Id": "XXXXXXX",
            "Name": "5. Spin Mobile - Credit Score",
            "BeeStrategy": "CBS.CreditScore",
            "TemplateName": "2025_Consumer_CreditReport",
            "SubscriberId": "XXXXXXXX",
            "ReturnOutputDataInSteps": "false"
          },
          "ConsolidatedReport": {
            "General": {
              "DocumentID": "XXXXXXXX",
              "ReportDate": "2025-11-26T10:55:27.9552298Z",
              "FullName": "XXXXXXX",
              "ReferenceNumber": "XXXXXXX"
            },
            "ScoringAnalysis": {
              "CIPScore": "588",
              "CIPRiskGrade": "D3"
            },
            "ReasonandRecommendations": {
              "ReasonList": [
                {
                  "ReasonCode": "MSS",
                  "Description": "Subject has missed at least 1 payment in the last 1 year.",
                  "Recommendation": "Please update payment profile and keep payments up to date.",
                  "ReasonStatement": "Missed Payments"
                },
                {
                  "ReasonCode": "DPM",
                  "Description": "Subject has missed payments on mobile loan(s) for the last 6 months.",
                  "Recommendation": "Please update payment profile on mobile loan(s) and keep payments up to date.",
                  "ReasonStatement": "Outstanding Mobile Loan(s)"
                }
              ]
            }
          }
        },
        "Timestamp": "2025-11-26T10:55:29.7794956Z",
        "transaction_ref": "[TX-REF]",
        "amount_paid": "50"
      }
    }
  }
}

← Creditinfo Report →