Evaluate creditworthiness

Credit Check service analyzes customer banking activity across one or more accounts to provide insights that can support lending decisions, affordability assessments, risk evaluations, and customer profiling.

By combining transaction activity, balance history, account conduct, income patterns, expenses, loan obligations, and credit utilization metrics, the service helps organizations evaluate a customer's financial stability and ability to meet future credit obligations.

Credit Check service provides a consolidated financial assessment derived from customer-permissioned banking data.

Using this service, you can:

Evaluate customer creditworthiness.
Assess affordability and repayment capacity.
Analyze income and spending behavior.
Review account conduct and transaction patterns.
Support underwriting and lending decisions.
Improve fraud and risk assessments.
Generate customer financial profiles.

The service aggregates information across customer accounts and produces analytical reports that can be incorporated into credit scoring and decisioning workflows.

Access to this API requires a valid consent that has been authorized by the customer.

Important information

The consentId must refer to an active and authorized consent
A valid access token must be included in the Authorization: Bearer header

This API can only be accessed using a valid and active consent. Before accessing this service, ensure that a consent has been created and authorized with the required useCaseType and permissions.

The consent must include the appropriate useCaseType and permission values that allow access to the corresponding financial data services.

If you do not already have a consent with the required configuration, you must first create one using the Create Consent API and ensure that it is successfully authorized. Once the consent becomes active, the generated consentId can be used to access this API service.

Scope	useCaseType	Permissions
To access Credit Check service under Data Use Case APIs	`CREDITCHECK`	`"ReadAccountsBasic",` `"ReadAccountsDetail",` `"ReadBalances",` `"ReadTransactionsBasic",` `"ReadTransactionsDetail",` `"ReadTransactionsCredits",` `"ReadTransactionsDebits",`

Scope

useCaseType

Permissions

To access Credit Check service under Data Use Case APIs

CREDITCHECK

"ReadAccountsBasic",

"ReadAccountsDetail",

"ReadBalances",

"ReadTransactionsBasic",

"ReadTransactionsDetail",

"ReadTransactionsCredits",

"ReadTransactionsDebits",

Assess Basic Credit Check

This service requires consentId to return all transactions of accounts associated with that consent. Basic credit check provides only the transactional information of all the incomes and expenses observed in the accounts and creditworthiness.

Endpoint

Endpoint URL	Method
`/v2/api/observice/creditCheckBasic`	GET

Header

The following headers must be included when calling the Basic Credit Check API.

Header parameter	Description
`Authorization: Bearer`	Access token used to authenticate the API request

Sample request

Example to initiate request to retrieve transactions for basic credit check

curl --request GET \
     --url 'https://obsandbox.onesingleview.com/v2/api/observice/creditCheckBasic?dateTimeStamp=2023-06-14T17%3A51%3A03&requestID=db35902b-806a-4141-b1e2-e93f60c82f62&merchantId=APIU-300356&fromDate=2016-01-01T10%3A40%3A00%2B02%3A00&toDate=2025-12-31T10%3A40%3A00%2B02%3A00&creditCheck=true&bankCode=SVMOB1&consentId=urn%3ASABBSARI%3Akac-cd3b9a37-eb97-4a70-b268-38af9f2950b1' \
     --header 'accept: application/json'

Request parameters

Parameters	Requirement	Description	Data type	Data validation
dateTimeStamp	Mandatory	Indicates the date and time when the request is created	Date	ISO 8601 format YYYY-MM-DDTHH:MM:SS
requestID	Mandatory	Unique identifier for the request used for tracking and traceability	Alphanumeric	UUID format
merchantID	Mandatory	Identifier assigned to the merchant or client application initiating the request	String
fromDate	Mandatory	Start date of the analysis period	Date	ISO 8601 format YYYY-MM-DDTHH:MM:SS
toDate	Mandatory	End date of the analysis period	Date	ISO 8601 format YYYY-MM-DDTHH:MM:SS
creditCheck	Mandatory	Specification of data use case API		`true` or `false`
bankCode	Mandatory	Unique bank identifier code	Enum
consentId	Mandatory	Unique identifier of the consent	String

Sample response

Example response for a successfully retrieved transactions for basic credit check

{
  "success": true,
  "payload": [
    {
      "code": "SVMOB1",
      "consentId": "urn:SVMOB:kac-35234830-aa97-474a-a5bc-0ee6ab91e00a",
      "data": {
        "account": [
          {
            "accountId": "100004000000000000000001",
            "accountHolderName": "Mohammad Alhajri",
            "accountHolderShortName": "Alhajri",
            "status": "Active",
            "currency": "SAR",
            "nickname": "Mohammad",
            "accountType": "KSAOB.Corporate",
            "accountSubType": "Business Current Account",
            "accountIdentifiers": [
              {
                "identificationType": "KSAOB.IBAN",
                "identification": "SA5678907654334454445601",
                "name": "Mohammad Alhajri"
              }
            ],
            "servicer": {
              "identificationType": "KSAOB.BICFI",
              "identification": "10000109010101"
            },
            "statusUpdateDateTime": "2023-02-01T16:37:00.980Z",
            "description": "Account sub-type description",
            "openingDate": "2022-04-08T16:37:00.980Z",
            "maturityDate": "2023-11-29T16:37:00.980Z",
            "firstTxnsDate": "2025-11-04T15:13:00.000Z",
            "lastTxnsDate": "2025-12-03T04:10:00.000Z",
            "creditAnalysis": [
              {
                "date": "Nov 25",
                "noOfCredit": 2563,
                "valueOfCredit": 779112.259999999,
                "noOfCashDeposits": 0,
                "valueOfCashDeposits": 0,
                "noOfExceptionalCredits": 0,
                "valueOfExceptionalCredits": 0,
                "noOfInwardTransferFromOwnAccounts": 0,
                "valueOfInwardTransferFromOwnAccounts": 0,
                "noOfInwardTransferFromGroupAccounts": 0,
                "valueOfInwardTransferGroupOwnAccounts": 0,
                "noOfOutwardReturn": 0,
                "valueOfOutwardReturn": 0,
                "noOfNetCredits": 0,
                "valueOfNetCredits": 0,
                "noOutwardReturnPercentOfTotalCredits": 0,
                "valueOutwardReturnPercentOfTotalCredits": 0
              }
            ],
            "debitAnalysis": [
              {
                "date": "Nov 25",
                "noOfDebit": 2563,
                "valueOfDebit": 779112.259999999,
                "noOfCashWithdrawls": 0,
                "valueOfCashWithdrawls": 0,
                "noOfInwardReturn": 0,
                "valueOfInwardReturn": 0,
                "noOfNetDebits": 0,
                "valueOfNetDebits": 0,
                "noInwardReturnPercentOfTotalCredits": 0,
                "valueInwardReturnPercentOfTotalCredits": 0
              }
            ],
            "balanceReport": [
              {
                "date": "Nov 25",
                "avgBalanceOn5th10th15th20th25thLastDayOfMonth": 6002.945,
                "avgBalanceOn4th6th7th10th15th25thOfMonth": 8004.578333333332,
                "monthendBalance": 2690.27,
                "avgBalanceOfMonth": 5871.430333333334
              }
            ],
            "otherConductAnalysis": [
              {
                "date": "Nov 25",
                "noOfOverdrawingInTheMonth": 0,
                "noOfEmiReturn": 0,
                "valueOfEmiReturn": 0,
                "noOfPosTransactions": 0,
                "valueOfPosTransactions": 0,
                "drawing": 0,
                "noOfEmiChequeReturn": 0
              }
            ],
            "incomeReport": [
              {
                "date": "Nov 25",
                "categories": [
                  {
                    "category": "KSAOB.DomesticTransfer",
                    "value": 0,
                    "count": 0
                  }
                ],
                "totalIncome": 0,
                "noOfTxns": 0
              }
            ],
            "expenseReport": [
              {
                "date": "Nov 25",
                "categories": [
                  {
                    "category": "KSAOB.DomesticTransfer",
                    "value": 62097.19999999999,
                    "count": 215
                  }
                ],
                "totalExpense": null,
                "noOfTxns": null
              }
            ],
            "creditCardReport": [
              {
                "date": "Nov 25",
                "avgOutstandingOn5th10th15th20th25thLastDayOfMonth": 0,
                "avgOutstandingOn4th6th7th10th15th25thOfMonth": 0,
                "avgPercentUsageLimit": 0,
                "totalCreditLine": 0,
                "totalOutstanding": 0
              }
            ],
            "loanReport": [
              {
                "date": "Nov 25",
                "noOfConsumerLoans": 0,
                "valueOfConsumerLoans": 0,
                "noOfPrincipalPaymentConsumerLoans": 0,
                "valueOfPrincipalPaymentConsumerLoans": 0,
                "noOfFixedTermLoans": 0,
                "valueOfFixedTermLoans": 0,
                "noOfPrincipalPaymentFixedTermLoans": 0,
                "valueOfPrincipalPaymentFixedTermLoans": 0,
                "noOfMortgageLoans": 0,
                "valueOfMortgageLoans": 0,
                "noOfPrincipalPaymentMortgageLoans": 0,
                "valueOfPrincipalPaymentMortgageLoans": 0,
                "noOfNoticeLoans": 0,
                "valueOfNoticeLoans": 0,
                "noOfPrincipalPaymentNoticeLoans": 0,
                "valueOfPrincipalPaymentNoticeLoans": 0,
                "noOfSyndications": 0,
                "valueOfSyndications": 0,
                "noOfPrincipalPaymentSyndications": 0,
                "valueOfPrincipalPaymentSyndications": 0,
                "totalNoOfLoans": 0,
                "totalValueOfLoans": 0,
                "totalNoOfPrincipalPayments": 0,
                "totalValueOfPrincipalPayments": 0
              }
            ]
          }
        ]
      },
      "links": {
        "self": ""
      },
      "meta": {
        "totalPages": 1
      },
      "bankBalanceReport": [
        {
          "date": "Nov 25",
          "avgBalanceOn5th10th15th20th25thLastDayOfMonth": 6002.945,
          "avgBalanceOn4th6th7th10th15th25thOfMonth": 8004.578333333332,
          "monthendBalance": 2690.27,
          "avgBalanceOfMonth": 5871.430333333334
        }
      ],
      "bankCreditCardReport": [
        {
          "date": "Nov 25",
          "avgOutstandingOn5th10th15th20th25thLastDayOfMonth": 0,
          "avgOutstandingOn4th6th7th10th15th25thOfMonth": 0,
          "totalCreditLine": 0,
          "totalOutstanding": 0,
          "avgPercentUsageLimit": 0
        }
      ],
      "bankDebitAnalysis": [
        {
          "date": "Nov 25",
          "noOfDebit": 2563,
          "valueOfDebit": 779112.259999999,
          "noOfCashWithdrawls": 0,
          "valueOfCashWithdrawls": 0,
          "noOfInwardReturn": 0,
          "valueOfInwardReturn": 0,
          "noOfNetDebits": 0,
          "valueOfNetDebits": 0,
          "noInwardReturnPercentOfTotalCredits": 0,
          "valueInwardReturnPercentOfTotalCredits": 0
        }
      ],
      "bankExpenseReport": [
        {
          "date": "Nov 25",
          "categories": [
            {
              "category": "KSAOB.DomesticTransfer",
              "count": 215,
              "value": 62097.19999999999
            }
          ],
          "totalExpense": null,
          "noOfTxns": null
        }
      ],
      "bankIncomeReport": [
        {
          "date": "Nov 25",
          "categories": [
            {
              "category": "KSAOB.DomesticTransfer",
              "count": 0,
              "value": 0
            }
          ],
          "totalIncome": 0,
          "noOfTxns": 0
        }
      ],
      "bankLoanReport": [
        {
          "date": "Nov 25",
          "noOfConsumerLoans": 0,
          "valueOfConsumerLoans": 0,
          "noOfPrincipalPaymentConsumerLoans": 0,
          "valueOfPrincipalPaymentConsumerLoans": 0,
          "noOfFixedTermLoans": 0,
          "valueOfFixedTermLoans": 0,
          "noOfPrincipalPaymentFixedTermLoans": 0,
          "valueOfPrincipalPaymentFixedTermLoans": 0,
          "noOfMortgageLoans": 0,
          "valueOfMortgageLoans": 0,
          "noOfPrincipalPaymentMortgageLoans": 0,
          "valueOfPrincipalPaymentMortgageLoans": 0,
          "noOfNoticeLoans": 0,
          "valueOfNoticeLoans": 0,
          "noOfPrincipalPaymentNoticeLoans": 0,
          "valueOfPrincipalPaymentNoticeLoans": 0,
          "noOfSyndications": 0,
          "valueOfSyndications": 0,
          "noOfPrincipalPaymentSyndications": 0,
          "valueOfPrincipalPaymentSyndications": 0,
          "totalNoOfLoans": 0,
          "totalValueOfLoans": 0,
          "totalNoOfPrincipalPayments": 0,
          "totalValueOfPrincipalPayments": 0
        }
      ]
    }
  ],
  "overAllBalanceReport": {
    "monthlyReport": [
      {
        "date": "Nov 25",
        "avgBalanceOn5th10th15th20th25thLastDayOfMonth": 6002.945,
        "avgBalanceOn4th6th7th10th15th25thOfMonth": 8004.578333333332,
        "monthendBalance": 2690.27,
        "avgBalanceOfMonth": 5871.430333333334
      }
    ],
    "totalMonthEndBalance": {
      "totalAmount": 2690.27
    },
    "avgBalance": {
      "totalAmount": 62.0793791218638
    }
  },
  "overAllCreditCardReport": {
    "monthlyReport": [
      {
        "date": "Nov 25",
        "avgOutstandingOn5th10th15th20th25thLastDayOfMonth": 0,
        "avgOutstandingOn4th6th7th10th15th25thOfMonth": 0,
        "totalCreditLine": 0,
        "totalOutstanding": 0,
        "avgPercentUsageLimit": 0
      }
    ],
    "totalCreditLine": {
      "totalAmount": 0
    },
    "totalOutStanding": {
      "totalAmount": 0
    },
    "avgPercentUsageLimit": {
      "percentage": 0
    }
  },
  "overAllCreditsReport": {
    "totalAmount": 0,
    "totalCount": 0,
    "topFiveCredits": [
      {
        "count": 0,
        "identification": 0,
        "amount": 0,
        "identificationType": "",
        "name": ""
      }
    ],
    "cashDeposits": {
      "totalAmount": 0,
      "totalCount": 0
    },
    "exceptionalCredits": {
      "totalAmount": 0,
      "totalCount": 0
    },
    "inwardTransfer": {
      "totalAmount": 0,
      "totalCount": 0
    },
    "outwardReturn": {
      "totalAmount": 0,
      "totalCount": 0
    },
    "monthlyReport": [
      {
        "date": "Jan 16",
        "noOfCredit": 0,
        "valueOfCredit": 0,
        "noOfCashDeposits": 0,
        "valueOfCashDeposits": 0,
        "noOfExceptionalCredits": 0,
        "valueOfExceptionalCredits": 0,
        "noOfInwardTransferFromOwnAccounts": 0,
        "valueOfInwardTransferFromOwnAccounts": 0,
        "noOfInwardTransferFromGroupAccounts": 0,
        "valueOfInwardTransferGroupOwnAccounts": 0,
        "noOfOutwardReturn": 0,
        "valueOfOutwardReturn": 0,
        "noOfNetCredits": 0,
        "valueOfNetCredits": 0,
        "noOutwardReturnPercentOfTotalCredits": 0,
        "valueOutwardReturnPercentOfTotalCredits": 0
      }
    ],
    "incomeReport": [
      {
        "date": "Nov 25",
        "categories": [
          {
            "category": "KSAOB.DomesticTransfer",
            "count": 0,
            "value": 0
          }
        ],
        "totalIncome": 0,
        "noOfTxns": 0
      }
    ]
  },
  "overAllDebitsReport": {
    "totalAmount": 1531229.5300000005,
    "totalCount": 5000,
    "topFiveDebits": [
      {
        "count": 5000,
        "identification": "",
        "amount": 1531229.5300000005,
        "identificationType": "",
        "name": ""
      }
    ],
    "cashWithDrawls": {
      "totalAmount": 0,
      "totalCount": 0
    },
    "inwardReturn": {
      "totalAmount": 0,
      "totalCount": 0
    },
    "monthlyReport": [
      {
        "date": "Nov 25",
        "noOfDebit": 2563,
        "valueOfDebit": 779112.259999999,
        "noOfCashWithdrawls": 0,
        "valueOfCashWithdrawls": 0,
        "noOfInwardReturn": 0,
        "valueOfInwardReturn": 0,
        "noOfNetDebits": 0,
        "valueOfNetDebits": 0,
        "noInwardReturnPercentOfTotalCredits": 0,
        "valueInwardReturnPercentOfTotalCredits": 0
      }
    ],
    "expenseReport": [
      {
        "date": "Nov 25",
        "categories": [
          {
            "category": "KSAOB.DomesticTransfer",
            "count": 215,
            "value": 62097.19999999999
          }
        ],
        "totalExpense": 752117.2699999983,
        "noOfTxns": 2437
      }
    ]
  },
  "overAllLoanReport": {
    "monthlyReport": [
      {
        "date": "Nov 25",
        "avgBalanceOn5th10th15th20th25thLastDayOfMonth": 6002.945,
        "avgBalanceOn4th6th7th10th15th25thOfMonth": 8004.578333333332,
        "monthendBalance": 2690.27,
        "avgBalanceOfMonth": 5871.430333333334
      }
    ],
    "totalMonthEndBalance": {
      "totalAmount": 2690.27
    },
    "avgBalance": {
      "totalAmount": 62.0793791218638
    }
  },
  "overAllOtherConductReport": {
    "monthlyReport": [
      {
        "date": "Jan 16",
        "noOfOverdrawingInTheMonth": 0,
        "noOfEmiReturn": 0,
        "valueOfEmiReturn": 0,
        "noOfPosTransactions": 0,
        "valueOfPosTransactions": 0,
        "drawing": 0,
        "noOfEmiChequeReturn": 0
      }
    ],
    "overDrawing": {
      "totalCount": 0
    },
    "drawing": {
      "totalCount": 0
    },
    "emiReturn": {
      "totalAmount": 0,
      "totalCount": 0
    },
    "emiChequeReturn": {
      "totalCount": 0
    },
    "posTransactions": {
      "totalAmount": 0,
      "totalCount": 0
    }
  }
}

Response parameters

Parameter	Description
success	Process success status represented as `True` or `False`
payload	Payload tag carrying response information
code	Unique bank code identification
data	Tag carrying accounts and transactions data included in the response
accountId	Unique account identification
transactions	Tag carrying account transactions information
transactionId	Unique transaction identification
transactionDateTime	Time and date of the transaction executed
transactionReference	Unique transaction reference details
transactionType	Type of transaction
subTransactionType	Sub-type of the transaction
paymentModes	Mode of the payment
creditDebitIndicator	Credit or debit indicator for the transaction
status	Status of the transaction
transactionMutability	Mutability factor of the transaction
bookingDateTime	Date and time of booking the transaction
valueDateTime	Date and time of transaction value
amount	Tag carrying transaction amount information
amount	Transaction amount
currency	Default currency of the account in which the transaction amount is indicated
chargeAmount	Tag carrying transaction charges information
amount	Total amount charged for the transaction
currency	Default currency of account in which the transaction charge amount is indicated
chargeIncluded	Indicates if the charge amount is included in transaction amount as `true` or `false`
balance	Balance info after the transaction
creditDebitIndicator	Indicates whether the balance is a credit or a debit balance
type	Indicator type details
amount	Tag carrying balance amount information
amount	Available amount balance
currency	Currency in which the balance is indicated
merchantDetails	Tag carrying merchant details
merchantName	Name of the merchant
merchantCategoryCode	Assigned merchant category code
merchantId	Unique merchant identification
localTimeZone	Local time zone information
terminalId	Unique terminal identification
chargeAmountVat	Tag carrying VAT amount charges and details
amount	VAT amount charged
currency	Currency of VAT amount charged indicated
flags	Tag carrying flags as array of strings
cardInstrument	Tag carrying card details
cardSchemeName	Scheme name description of the card
instrumentType	Type of instrument used for the card payment
name	Name on the card
identification	Unique card identification
creditorAccount	Tag carrying creditor account information
debtorAccount	Tag carrying debtor account information
identificationType	Type of identification of the account
identification	Account identification details
name	Name of the account holder
transactionInformation	Details of the transaction information
bankTransactionCode	Tag carrying transaction bank codes
domain	Domain details
domainCode	Domain code
family	Domain family details
familyCode	Domain family code
subFamily	Domain sub-family details
subFamilyCode	Domain sub-family code
proprietaryBankTransactionCode	Tag representing proprietary bank transaction code and details
code	Unique proprietary transaction code
issuer	Name of the issuer of the code
creditorAgent	Tag carrying creditor agent information
debtorAgent	Tag carrying debtor agent information
identificationType	Type of identification of the creditor/debtor account
identification	Unique identification details of the creditor/debtor account
postalAddress	Postal address of the creditor/debtor account
addressType	Address type on the creditor/debtor account
streetName	Street name on the creditor/debtor account
buildingNumber	Building number of the creditor/debtor account
postalCode	Postal code on the creditor/debtor
city	City of the creditor/debtor
country	Country of the creditor/debtor
shortAddress	Short address of the creditor/debtor
unitNumber	Unit number of the creditor/debtor
secondaryNumber	Secondary number of the creditor/debtor
district	District of the creditor/debtor
name	Name of the creditor/debtor
billDetails	Tag carrying bill details
billerId	Unique biller identification
billNumber	Bill number
billPaymentType	Payment type for the bill
links	Redirect link
self	Own link/URL details
meta	Meta tag
totalPages	Information displayed in terms of pages
insights	Tag providing aggregated income analysis for the specified period
startDate	Beginning of the analysis period
endDate	End of the analysis period
currency	Currency used for the analysis results
cashIn	Tag summarizing all incoming funds identified during the analysis period
amount	Total incoming funds received
currency	Currency associated with the incoming funds
count	Total number of incoming transactions identified
yesterDayCashIn	Tag providing a summary of incoming transactions received during the previous day
amount	Total incoming funds received during the previous day
currency	Currency associated with the transactions
count	Number of incoming transactions received during the previous day
cashInTimeLine	Tag providing a chronological breakdown of incoming funds
date	Timeline period
count	Number of income transactions within the period
amount	Total income amount received during the period
currency	Currency associated with the transactions
cashInCategories	Tag providing grouped income by transaction category
category	Transaction category identified as a source of income
count	Number of transactions within the category
amount	Total income amount attributed to the category
currency	Currency associated with the category
overAllTxns	Tag providing consolidated income metrics across all accounts included in the consent
count	Total number of incoming transactions across all accounts
amount	Total incoming funds across all accounts
currency	Currency associated with the transactions

Assess Advanced Income Check

This service requires consentId to return all income transactions of accounts associated with that consent. Advanced income check provides detailed insights of all the incomes observed in the accounts.

Endpoint

Endpoint URL	Method
`/v2/api/observice/incomeCheckAdvanced`	GET

Header

The following headers must be included when calling the Advanced Income Check API.

Header parameter	Description
`Authorization: Bearer`	Access token used to authenticate the API request

Sample request

Example to initiate request to retrieve transactions information for advanced income check

curl --request GET \
     --url 'https://obsandbox.onesingleview.com/v2/api/observice/incomeCheckAdvanced?dateTimeStamp=2023-06-14T17%3A51%3A03&requestID=db35902b-806a-4141-b1e2-e93f60c82f62&merchantId=APIU-300356&insights=true&incomeCheckAdvanced=true&fromDate=2016-01-01T10%3A40%3A00%2B02%3A00&toDate=2025-12-31T10%3A40%3A00%2B02%3A00&timeLine=byDay&bankCode=SVMOB1&consentId=urn%3ASVMOB%3Akac-cd3b9a37-eb97-4a70-b268-38af9f2950b1' \
     --header 'accept: application/json'

Request parameters

Parameters	Requirement	Description	Data type	Data validation
dateTimeStamp	Mandatory	Indicates the date and time when the request is created	Date	ISO 8601 format YYYY-MM-DDTHH:MM:SS
requestID	Mandatory	Unique identifier for the request used for tracking and traceability	Alphanumeric	UUID format
merchantID	Mandatory	Identifier assigned to the merchant or client application initiating the request	String
insights	Mandatory	Indicates that analytical insights should be included in the response		`true` or `false`
incomeCheckAdvanced	Mandatory	Specification of data use case API		`true` or `false`
fromDate	Mandatory	Start date of the analysis period	Date	ISO 8601 format YYYY-MM-DDTHH:MM:SS
toDate	Mandatory	End date of the analysis period	Date	ISO 8601 format YYYY-MM-DDTHH:MM:SS
timeLine	Mandatory	Timeline aggregation interval	Enum	`byDay` or `byWeek` or `byMonth`
bankCode	Mandatory	Unique bank identifier code	Enum
consentId	Mandatory	Unique identifier of the consent	String

Sample response

Example response for a successfully retrieved transactions for basic income check

{
  "success": true,
  "payload": [
    {
      "code": "SVMOB1",
      "consentId": "dd11ad81-e172-4121-b6fe-2461a5cfff52",
      "data": {
        "account": [
          {
            "accountId": "dd11ad81-e172-4121-b6fe-2461a5cfff52",
            "accountHolderName": "Habib Al-Sagga",
            "accountHolderShortName": "Habib Al-Sagga",
            "status": "Active",
            "currency": "SAR",
            "nickname": "Habib Al-Sagga",
            "accountType": "Personal",
            "accountSubType": "",
            "accountIdentifiers": [
              {
                "identificationType": "KSAOB.IBAN",
                "identification": "00000250000002",
                "name": "Habib Al-Sagga"
              }
            ],
            "servicer": {
              "identificationType": "KSAOB.BICFI",
              "identification": "10000109010101"
            },
            "statusUpdateDateTime": "2023-07-11T07:48:38.115Z",
            "description": "Account sub-type description",
            "openingDate": "2022-09-15T07:48:38.115Z",
            "maturityDate": "2024-05-07T07:48:38.115Z"
          }
        ]
      },
      "links": {
        "self": "https://rs1.sandbox.sabb.com/open-banking/account-information/2022.11.01-final-errata2/accounts"
      },
      "meta": {
        "totalPages": 1
      },
      "incomeInsights": {
        "incomeSourceList": [
          {
            "label": "Salary",
            "value": {
              "lastThreeMonths": {
                "count": 3,
                "value": 5163,
                "currency": "SAR",
                "totalCount": 3,
                "monthlyList": [
                  {
                    "count": 1,
                    "value": 2395,
                    "currency": "SAR",
                    "month": "Nov 25"
                  }
                ]
              },
              "lastSixMonths": {
                "count": 6,
                "value": 13463,
                "currency": "SAR",
                "totalCount": 6,
                "monthlyList": [
                  {
                    "count": 1,
                    "value": 2395,
                    "currency": "SAR",
                    "month": "Nov 25"
                  }
                ]
              },
              "lastNineMonths": {
                "count": 9,
                "value": 20031,
                "currency": "SAR",
                "totalCount": 9,
                "monthlyList": [
                  {
                    "count": 1,
                    "value": 2395,
                    "currency": "SAR",
                    "month": "Nov 25"
                  }
                ]
              },
              "lastTweleveMonths": {
                "count": 12,
                "value": 22344,
                "currency": "SAR",
                "totalCount": 12,
                "monthlyList": [
                  {
                    "count": 1,
                    "value": 2395,
                    "currency": "SAR",
                    "month": "Nov 25"
                  }
                ]
              }
            }
          }
        ],
        "incomeScore": 5,
        "periodOfMonths": 119,
        "applicantType": "Subprime",
        "creditLendRisk": "Moderate",
        "description": "User generally exhibits behviour which suggest an inability to repay credit, but also some postive behaviours",
        "incomeCategories": [
          {
            "code": "SLRYFREQ",
            "weightage": 1,
            "weightagePercentage": 16.6666,
            "attributeDetails": "Salary Frequency"
          }
        ],
        "attibutesStatistics": {
          "salaryRegularity": {
            "weightage": 1,
            "weightagePercentage": 16.6666,
            "maxScoreValue": 3,
            "attributeDetails": "Salary Frequency",
            "attributeScore": 0,
            "weightedAttributeScore": 0,
            "percentAgeOfMaxScore": 0,
            "percentage": 8.403361344537814,
            "attributeName": "SLRYFREQ"
          },
          "salaryOrIncomeConsistency": {
            "weightage": 1,
            "weightagePercentage": 16.6666,
            "maxScoreValue": 3,
            "attributeDetails": "Salary/Income Consistency",
            "attributeScore": 0,
            "weightedAttributeScore": 0,
            "percentAgeOfMaxScore": 0,
            "percentage": 0,
            "attributeName": "SLRYCONS"
          },
          "otherRegularIncome": {
            "weightage": 1,
            "weightagePercentage": 16.6666,
            "maxScoreValue": 3,
            "attributeDetails": "Other Regular Income",
            "attributeScore": 1,
            "weightedAttributeScore": 1,
            "percentAgeOfMaxScore": 33.33333333333333,
            "amount": 158.7983193277311,
            "attributeName": "OTHRINCM"
          },
          "avgMonthSalary": {
            "weightage": 1,
            "weightagePercentage": 16.6666,
            "maxScoreValue": 5,
            "attributeDetails": "Avg Month Salary Amount",
            "attributeScore": 1,
            "weightedAttributeScore": 1,
            "percentAgeOfMaxScore": 20,
            "amount": 187.76470588235293,
            "attributeName": "AVGSALRY"
          },
          "avgMonthlyEndBalance": {
            "weightage": 1,
            "weightagePercentage": 16.6666,
            "maxScoreValue": 3,
            "attributeDetails": "Average Monthly End Balance",
            "attributeScore": 4,
            "weightedAttributeScore": 4,
            "percentAgeOfMaxScore": 133.33333333333331,
            "amount": 0,
            "attributeName": "AVGMNENDBAL"
          },
          "avgMonthlyAvailableToSpend": {
            "weightage": 1,
            "weightagePercentage": 16.6666,
            "maxScoreValue": 3,
            "attributeDetails": "Avg Monthly Available to Spend",
            "attributeScore": 4,
            "weightedAttributeScore": 4,
            "percentAgeOfMaxScore": 133.33333333333331,
            "amount": 0,
            "attributeName": "AVGAVTOSP"
          }
        },
        "rankedPositiveAttributeList": [
          {
            "rankingValue": 5.333333333333333,
            "ranking": "POSITIVE",
            "attributeDetails": "Avg Monthly Available to Spend",
            "value": 0,
            "rank": 1,
            "tie": true
          }
        ],
        "rankedNegativeAttributeList": [
          {
            "rankingValue": 0,
            "ranking": "NEGATIVE",
            "attributeDetails": "Salary/Income Consistency",
            "percentage": 0,
            "rank": 1,
            "tie": true
          }
        ],
        "eachMonthIncomeList": [
          {
            "month": "Nov 25",
            "amount": 2484
          }
        ],
        "eachMonthSalaryList": [
          {
            "month": "Dec 24",
            "amount": 0
          }
        ],
        "incomeAnalysis": [
          {
            "month": "Nov 25",
            "data": {
              "salary": 2395,
              "freelance": 0,
              "others": 0
            }
          }
        ],
        "percentage": {
          "salary": 54.18,
          "freeLance": 0,
          "others": 45.82
        },
        "currency": "SAR",
        "noOfAccounts": 1,
        "avgIncomeValues": {
          "highestValue": {
            "month": "Mar 25",
            "amount": 9938
          },
          "lowestValue": {
            "month": "May 25",
            "amount": 834
          },
          "avgValue": 346.56302521008405
        },
        "avgSalaryValues": {
          "highestValue": {
            "month": "Mar 25",
            "amount": 3943
          },
          "lowestValue": {
            "month": "Dec 24",
            "amount": 0
          },
          "avgValue": 187.76470588235293
        },
        "avgFreeLanceValues": {
          "highestValue": {
            "month": "Nov 25",
            "amount": 0
          },
          "lowestValue": {
            "month": "Nov 25",
            "amount": 0
          },
          "avgValue": 0
        },
        "avgOthersValues": {
          "highestValue": {
            "month": "Nov 25",
            "amount": 5995
          },
          "lowestValue": {
            "month": "Nov 25",
            "amount": 0
          },
          "avgValue": 158.7983193277311
        },
        "incomeFrequency": {
          "lastMonth": {
            "one": 0,
            "eight": 41241,
            "sixteen": 0,
            "twentyFour": 0
          },
          "last3MonthAvg": {
            "one": 0,
            "eight": 0,
            "sixteen": 0,
            "twentyFour": 0
          }
        }
      }
    }
  ]
}

Response parameters

Parameter	Description
success	Process success status represented as `True` or `False`
payload	Payload tag carrying response information
code	Unique bank code identification
data	Tag carrying accounts and transactions data included in the response
accountId	Unique account identification
transactions	Tag carrying account transactions information
transactionId	Unique transaction identification
transactionDateTime	Time and date of the transaction executed
transactionReference	Unique transaction reference details
transactionType	Type of transaction
subTransactionType	Sub-type of the transaction
paymentModes	Mode of the payment
creditDebitIndicator	Credit or debit indicator for the transaction
status	Status of the transaction
transactionMutability	Mutability factor of the transaction
bookingDateTime	Date and time of booking the transaction
valueDateTime	Date and time of transaction value
amount	Tag carrying transaction amount information
amount	Transaction amount
currency	Default currency of the account in which the transaction amount is indicated
chargeAmount	Tag carrying transaction charges information
amount	Total amount charged for the transaction
currency	Default currency of account in which the transaction charge amount is indicated
chargeIncluded	Indicates if the charge amount is included in transaction amount as `true` or `false`
balance	Balance info after the transaction
creditDebitIndicator	Indicates whether the balance is a credit or a debit balance
type	Indicator type details
amount	Tag carrying balance amount information
amount	Available amount balance
currency	Currency in which the balance is indicated
merchantDetails	Tag carrying merchant details
merchantName	Name of the merchant
merchantCategoryCode	Assigned merchant category code
merchantId	Unique merchant identification
localTimeZone	Local time zone information
terminalId	Unique terminal identification
chargeAmountVat	Tag carrying VAT amount charges and details
amount	VAT amount charged
currency	Currency of VAT amount charged indicated
flags	Tag carrying flags as array of strings
cardInstrument	Tag carrying card details
cardSchemeName	Scheme name description of the card
instrumentType	Type of instrument used for the card payment
name	Name on the card
identification	Unique card identification
creditorAccount	Tag carrying creditor account information
debtorAccount	Tag carrying debtor account information
identificationType	Type of identification of the account
identification	Account identification details
name	Name of the account holder
transactionInformation	Details of the transaction information
bankTransactionCode	Tag carrying transaction bank codes
domain	Domain details
domainCode	Domain code
family	Domain family details
familyCode	Domain family code
subFamily	Domain sub-family details
subFamilyCode	Domain sub-family code
proprietaryBankTransactionCode	Tag representing proprietary bank transaction code and details
code	Unique proprietary transaction code
issuer	Name of the issuer of the code
creditorAgent	Tag carrying creditor agent information
debtorAgent	Tag carrying debtor agent information
identificationType	Type of identification of the creditor/debtor account
identification	Unique identification details of the creditor/debtor account
postalAddress	Postal address of the creditor/debtor account
addressType	Address type on the creditor/debtor account
streetName	Street name on the creditor/debtor account
buildingNumber	Building number of the creditor/debtor account
postalCode	Postal code on the creditor/debtor
city	City of the creditor/debtor
country	Country of the creditor/debtor
shortAddress	Short address of the creditor/debtor
unitNumber	Unit number of the creditor/debtor
secondaryNumber	Secondary number of the creditor/debtor
district	District of the creditor/debtor
name	Name of the creditor/debtor
billDetails	Tag carrying bill details
billerId	Unique biller identification
billNumber	Bill number
billPaymentType	Payment type for the bill
links	Redirect link
self	Own link/URL details
meta	Meta tag
totalPages	Information displayed in terms of pages
incomeInsights	Tag providing an analytical assessment of a customer's income patterns, earning stability, affordability indicators, and creditworthiness based on transaction activity within the selected analysis period
incomeSourceList	List of identified income sources and their income performance across different time periods
label	Name or classification of the income source, such as Salary, Freelance, Pension, or Other Income
value	Tag carrying income statistics associated with the identified income source
lastThreeMonths	Tag carrying information on income summary for the previous three months
lastSixMonths	Tag carrying information on income summary for the previous six months
lastNineMonths	Tag carrying information on income summary for the previous nine months
lastTwelveMonths	Tag carrying information on income summary for the previous twelve months
count	Number of months included in the analysis period
value	Total income amount received during the period
currency	Currency associated with the income values
totalCount	Total number of income transactions identified
monthlyList	Tag carrying information on monthly breakdown of income received during the period
month	Month included in the analysis period
count	Number of income transactions identified during the month
value	Total income amount received during the month
currency	Currency associated with the income amount
incomeScore	Overall income score calculated from income stability, consistency, affordability, and financial behavior indicators. Higher values generally indicate stronger income characteristics
periodOfMonths	Total number of months analyzed when calculating income insights
applicantType	Risk classification assigned to the customer based on income and financial behavior patterns
creditLendRisk	Lending risk assessment derived from income and transaction analysis
description	Summary explaining the customer's income profile and lending risk characteristics
incomeCategories	Tag carrying list of scoring attributes used to calculate the income score
code	Unique identifier for the scoring attribute
weightage	Numerical importance assigned to the attribute during score calculation
weightagePercentage	Percentage contribution of the attribute to the overall score
attributeDetails	Description of the scoring attribute
attributeStatistics	Tag providing detailed scoring information for each income assessment factor
weightage	Importance assigned to the attribute
weightagePercentage	Percentage contribution of the attribute to the overall income score
maxScoreValue	Maximum score available for the attribute
attributeDetails	Description of the attribute being evaluated
attributeScore	Score achieved for the attribute
weightedAttributeScore	Weighted score contribution after applying attribute importance
percentAgeOfMaxScore	Percentage of the maximum possible score achieved
percentage	Analytical percentage calculated for the attribute
amount	Monetary value associated with the attribute, where applicable
attributeName	Unique attribute identifier SLRYFREQ - Salary Frequency SLRYCONS - Salary/Income Consistency OTHRINCM - Other Regular Income AVGSALRY - Average Monthly Salary AVGMNENDBAL - Average Monthly End Balance AVGAVTOSP - Average Monthly Available to Spend
rankedPositiveAttributeList	Tag carrying information on factors that positively influence the customer's income profile
rankingValue	Calculated positive impact score
ranking	Positive assessment indicator
attributeDetails	Description of the positively ranked attribute
value	Value associated with the attribute
rank	Relative ranking position
tie	Indicates whether multiple attributes share the same rank
rankedNegativeAttributeList	Tag carrying information on factors that negatively influence the customer's income profile
rankingValue	Calculated negative impact score
ranking	Negative assessment indicator
attributeDetails	Description of the negatively ranked attribute
percentage	Percentage value associated with the attribute
rank	Relative ranking position
tie	Indicates whether multiple attributes share the same rank
eachMonthIncomeList	Total income received each month during the analysis period.
month	Reporting month.
amount	Income amount received during the month.
eachMonthSalaryList	Salary income received each month during the analysis period.
month	Reporting month.
amount	Income amount received during the month.
incomeAnalysis	Tag providing a breakdown of income sources by month
month	Reporting month
data	Tag carrying information on the income analysis for the month
salary	Income identified as salary payments
freelance	Income identified as freelance or self-employed earnings
others	Income identified from other sources
percentage	Tag showing the proportional contribution of each income type
salary	Percentage of total income derived from salary payments
freeLance	Percentage of total income derived from freelance income
others	Percentage of total income derived from other income sources
currency	Currency used for all income calculations
noOfAccounts	Total number of accounts analyzed
avgIncomeValues	Tag providing statistics for total monthly income
highestValue	Highest monthly income identified during the analysis period.
lowestValue	Lowest monthly income identified during the analysis period.
avgValue	Average monthly income calculated across the analysis period.
avgSalaryValues	Tag providing statistics specifically for salary income
highestValue	Highest monthly salary identified
lowestValue	Lowest monthly salary identified
avgValue	Average monthly salary amount
avgFreeLanceValues	Tag providing statistics for freelance income
highestValue	Highest monthly freelance income.
lowestValue	Lowest monthly freelance income.
avgValue	Average monthly freelance income.
avgOthersValues	Tag providing statistics for other income sources
highestValue	Highest monthly income from other sources.
lowestValue	Lowest monthly income from other sources.
avgValue	Average income from other sources.
incomeFrequency	Tag providing insight into when income is typically received during a month
lastMonth	Distribution of income transactions during the most recent month analyzed
last3MonthAvg	Average income distribution across the last three months
one	Income received during days 1–7 of the month
eight	Income received during days 8–15 of the month
sixteen	Income received during days 16–23 of the month
twentyFour	Income received during days 24–31 of the month

Categories

GENERAL INFORMATION

GETTING STARTED

CONSENT MANAGEMENT

Raw Data APIs

DATA USE CASE APIS

Plug-and-Play Integrations

RESOURCES

API Archives

Assess Basic Credit Check

Endpoint

Header

Sample request

Sample response

Assess Advanced Income Check

Endpoint

Header

Sample request

Sample response

Categories

GENERAL INFORMATION

GETTING STARTED

CONSENT MANAGEMENT

Raw Data APIs

DATA USE CASE APIS

Plug-and-Play Integrations

RESOURCES

API Archives

Consent information

Assess Basic Credit Check

Endpoint

Header

Sample request

Sample response

Assess Advanced Income Check

Endpoint

Header

Sample request

Sample response