KYC Details

KYC Details API

POST: https://api.creditchek.africa/v1/telco/v1/ng/mtn/kyc-details

Request Parameters

Name	Position	Required	Description
token	Headers	True	app secret key
msisdn	Body	True	customer phone number
webhookUrl	Body	True	The URL where the final KYC details should be sent upon completion.

Sample request

{
  "msisdn": "2347062021000",
  "webhookUrl": "https://your-domain.com/creditchek-callback"
}

Sample Response

Success response requesting consent from the customer

Sample Response

{
  "status": true,
  "data": {
    "type": "ASYNC",
    "msisdn": "2347062021000",
    "transactionId": "rrt-8712907420097953922-c-geu1-1653527-39304482-2",
    "consentStatus": "PENDING_CONSENT",
    "note": "Result will be sent to your callback url once the customer responds",
    "requestTime": "2026-03-02T12:41:07.413Z"
  },
  "message": "KYC Response fetched successfully",
  "error": false
}

Webhook (Async Response)

Because this endpoint involves prompting the user for consent on their device, the final KYC details are delivered asynchronously.

Once the customer approves the consent request, CreditChek will POST the final KYC details to the Webhook URL you configured in your CreditChek dashboard.

Sample Webhook Payload

{
  "event": "telco_kyc_details",
  "data": {
    "status": true,
    "data": {
      "type": "SYNC",
      "msisdn": "2348135429260",
      "transactionId": "rrt-696293431024534450-a-geu2-1273091-51490521-2",
      "customerInfo": {
        "firstName": "AISHAT",
        "middleName": "",
        "lastName": "SALIHU",
        "phoneNumber": "2348135429260",
        "city": "MUNICIPAL AREA COUNCIL",
        "dateOfBirth": "19730707",
        "gender": "F",
        "registrationDate": "10/05/2014",
        "stateOfOrigin": "KOGI",
        "streetAddress": "463, CHIKAKOLELAYOUT, ABUJA"
      }
    },
    "message": "KYC details retrieved successfully",
    "error": false
  }
}