Skip to main content

Response

You'll receieve webhooks once you've submitted a bank statement

Set Webhook​

To set your credit assessment webhook:

  • Login to the Sigma dashboard
  • Go to My Account page
  • Click on Api Keys & Webhooks link, then click on webhooks tab
  • Click on the Enter webhook url for Credit Assessment
  • Enter webhook url and save 👌

Response​

  • When a submission has started processing
{
    "message" : "Bank statement processing is on-going"
    "data" : {
        "submissionId": [ID OF THE SUBMISSION],
    }
}
  • When a submission has finished processings
{
  "message" : "Bank statement processing is completed"
    "data" : {
        "submissionId": [ID OF THE SUBMISSION],
    }
}

Bank Statement Reports​

After submitting a bank statement, you can retrieve various reports using the submissionID. These reports provide valuable insights into the financial activities captured in the statement.

APIMethodPaginationDescription
api/v1/credit-assessment/report/[SUBMISSION_ID]/transactionsGETtrueGet all transactions from a bank statement. The response is paginated and limited to 20 per page
api/v1/credit-assessment/report/[SUBMISSION_ID]/credit-summaryGETfalseGet insights such as: reasons for credit, reasons against credit, top senders, gambling records etc.
api/v1/credit-assessment/report/[SUBMISSION_ID]/spending-patternsGETfalseGet the various categories/classification of the transactions in the bank statement.
api/v1/credit-assessment/report/[SUBMISSION_ID]/locationGETfalseGet the various locations detected from transactions.
api/v1/credit-assessment/report/[SUBMISSION_ID]/balanceGETfalseGet all balances from the statement including opening balance, closing balance, average daily balance etc.
api/v1/credit-assessment/report/[SUBMISSION_ID]/infoGETfalseGet credit score percentage and also all general info about the bank statement.
api/v1/credit-assessment/report/[SUBMISSION_ID]/credit-historyGETfalseGet credit history of the submitted BVN.