Upload Bank Statement PDF

This endpoint allows you to upload a bank statement pdf and returns the transactions associated with the pdf to your webhook url.

Any bank statement currently supported by our system can be analyzed through our PDF Reader.We currently don't support all banks but they would all be available soon. Some PDF's generated through Mono are also accepted and they include: United Bank for Africa, First City Monument Bank and Guaranty Trust Bank

Endpoint to upload pdf and get insight on the pdf
POST: https://api.creditchek.africa/v1/income/api/pdf-parser

You can simulate sample webhooks and response by using BVN: 12345678901 and 98765432101

Request Parameters

Name	Position	Required	Description
token	Headers	True	app public key
bvn	body	True	borrower's bvn
accountName	body	True	account name
accountNumber	body	True	account number
accountType	body	True	account type
bankName	body	True	bank name
bankCode	body	True	bank short code
password	body	False	pdf password
statement	body	True	pdf file

Example Request

---
curl --location --request POST 'https://api.creditchek.africa/v1/income/api/pdf-parser' \
--header 'token: w5BNzmL8ypY6mumPtqXc72yk0Ksz6aI9A+K9wiO6oQipnlmCSTClvgl6vHdZqWBv' \
--form 'bankName="fidelity bank"' \
--form 'bankCode="070"' \
--form 'accountName="Tet Jorm"' \
--form 'accountNumber="7160010613"' \
--form 'accountType="savings"' \
--form 'bvn="22357999900"' \
--form 'statement=@"/Users/josh/Downloads/mybankstatement-fidelity.pdf"'
---

Sample webhook Data

{
  "event": "income_transaction",
  "data": {
    "success": true,
    "accountNumber": "7160010613",
    "accountName": "Tet Jorm",
    "bvn": "22357999900",
    "appId": "62877574ae22f30012b03091",
    "borrowerId": "64c8b66302ed6ac59be6fa44",
    "businessId": "6287757348cc6c0013f4d0a0",
    "balance": 612445,
    "bankCode": "044",
    "bankName": "fidelity bank",
    "pdfUrl": "https://res.cloudinary.com/creditchek-africa/image/upload/pdfStatement/62877574ae22f30012b03091_044_savings_fidelity%20bank.pdf",
    "lastTransactionDate": "2022-05-23T00:00:00Z",
    "trans": [
      {
        "type": "debit",
        "narration": "FIP:MB:GTB/CONSULTINGPLUS SER/FBNMOBILE:CONSULTING",
        "amount": 1900000,
        "date": "2022-05-23T00:00:00Z",
        "balance": 612445,
        "bankCode": "044"
      },
      {
        "type": "debit",
        "narration": "FIP CHARGES",
        "amount": 2688,
        "date": "2022-05-23T00:00:00Z",
        "balance": 2512445,
        "bankCode": "044"
      },
      {
        "type": "credit",
        "narration": "FIP:MMB/POS Agent Gausu ve/Gausu ventur POS Trf fo",
        "amount": 2000000,
        "date": "2022-05-23T00:00:00Z",
        "balance": 2515133,
        "bankCode": "044"
      },
      {
        "type": "credit",
        "narration": "FBNMOBILE:FIDELS COUTURE/Delivery",
        "amount": 300000,
        "date": "2022-05-23T00:00:00Z",
        "balance": 515133,
        "bankCode": "044"
      },
      {
        "type": "debit",
        "narration": "QS894:101300004753105426/2348085329427",
        "amount": 10000,
        "date": "2021-04-01T00:00:00Z",
        "balance": 157810,
        "bankCode": "044"
      },
      {
        "type": "debit",
        "narration": "ATM WITHDRAWAL-SWTGTBsnk/lkeja Lagos/539923",
        "amount": 200000,
        "date": "2021-04-01T00:00:00Z",
        "balance": 167810,
        "bankCode": "044"
      },
      {
        "type": "credit",
        "narration": "FIP:GTB/AJAYI ELIZABETH O/Deliverfee",
        "amount": 150000,
        "date": "2021-04-01T00:00:00Z",
        "balance": 367810,
        "bankCode": "044"
      },
      {
        "type": "credit",
        "narration": "FIP:KMB/KOLAWOLE EMMANUE/SENT FROM KUDA",
        "amount": 120000,
        "date": "2021-04-01T00:00:00Z",
        "balance": 217810,
        "bankCode": "044"
      },
      {
        "type": "debit",
        "narration": "FIP CHARGES",
        "amount": 1075,
        "date": "2021-04-01T00:00:00Z",
        "balance": 97810,
        "bankCode": "044"
      },
      {
        "type": "debit",
        "narration": "FIP:USSD:GTB/ADESANYA ADEREMI A/USSD_ADEYEMI ABUBA",
        "amount": 110000,
        "date": "2021-04-01T00:00:00Z",
        "balance": 98885,
        "bankCode": "044"
      }
    ]
  }
}