Response

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

Set Webhook

To set your credit assessment webhook:

1. Login to your Sigma Dashboard.
2. Go to the My Account page.
3. Click on API Keys & Webhooks, then select the webhooks tab.
4. Update the URL for the Credit Assessment product.
5. Enter the 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.

API	Method	Pagination	Description
api/v1/credit-assessment/report/[SUBMISSION_ID]/transactions	GET	true	Get all transactions from a bank statement. The response is paginated and limited to 20 per page
api/v1/credit-assessment/report/[SUBMISSION_ID]/credit-summary	GET	false	Get insights such as: reasons for credit, reasons against credit, top senders, gambling records etc.
api/v1/credit-assessment/report/[SUBMISSION_ID]/spending-patterns	GET	false	Get the various categories/classification of the transactions in the bank statement.
api/v1/credit-assessment/report/[SUBMISSION_ID]/location	GET	false	Get the various locations detected from transactions.
api/v1/credit-assessment/report/[SUBMISSION_ID]/balance	GET	false	Get all balances from the statement including opening balance, closing balance, average daily balance etc.
api/v1/credit-assessment/report/[SUBMISSION_ID]/info	GET	false	Get credit score percentage and also all general info about the bank statement.
api/v1/credit-assessment/report/[SUBMISSION_ID]/credit-history	GET	false	Get credit history of the submitted BVN.