Step 1: Initialize consent

Step 1: Initialize consent

POST: https://api.creditchek.africa/v1/income/open-banking/intialize/api-consent

An OTP is sent to the customer's phone number with the bank to give consent.

Contact [email protected] if you encounter any error responses at this stage.

Request Parameters

Sample request

{
  "borrowerId": "6540b8b447d3da35a0ec121c",
  "appId": "62877574ae22f30012b03091",
  "bankId": 6,
  "accountType": "Personal",
  "accountNumber": "8513586020",
  "statementDuration": 6, // 3, 6 OR 12
  "bankName": "FCMB Bank",
  "accountName": "Ndaka Joshua Hassan"
};

Response

{
  "status": "success",
  "message": "success",
  "data": {
    "consentId": "f54894c8-82f6-498a-8da5-3bf0c69c056e",
    "consentStatus": "Created",
    "consentPrice": 0,
    "additionalInfo": { "hintMessage": "OTP Sent to 0815*****83" },
    "bankReferenceExpiry": "2024-07-24T10:09:36.753Z",
    "referenceId": "r1021895675813"
  }
}