Credit Insight

API Specification

Introduction

Credit Insight, is an Open Banking Product which relies on an AIS collection of transaction data for the selected client.

The prerequisites to provide a Credit Insight analysis are :

  • At least one CHECKING account provided
  • At least 20 transactions within the last 90 days
  • Transactions must be in EURO
  • A callback URL must be provided beforehand.

The workflow goes as follows :

  1. The Initiating Party posts and initiates a registration for the client, and chooses the relevant product option.
  2. Worldline responds with the appropriate URL for the consent and AIS session, and the client is then redirected to the AIS Bank selection pages.
  3. Once the client has selected its bank(s) and accounts, Worldline collects the transactions and balances for the last three months from the bank(s).
  4. The Credit Insight analysis is performed, and once the results are available, they are sent to the Initiating Party's callback URL.

Details

For the Credit Insight usecase the relevant and usable endpoints are within the Account Information extended service:

  • POST /register : initiates the process
  • POST /register/{registrationId}/initialisation/{psuId} : used to retrieve the URL to the AIS consent page for the PSU (client)
  • GET /register/{registrationId}/status : allows the Initiating Party to know the status of the process (optional)

After the process is initiated and the client has consented to give access to his account(s), the processing begins on the Credit Insight engine.

Once it has completed, the Initiating Party receives the response on the callback URL they provided during the onboarding.

Sequence diagram Credit Insight

 

The initial POST /register call should be as follows:

 

POST /register
{
    "RegistrationId": "<registration_id>",
    "Psus": [
        {
            "PsuId": "<psu_id>"
        },
    ],
    "Parameter":[
        {
            "Key":"option",
            "Value":"NONE||CS||PS||CSPS"
        }
    ]
}

The Product options need to be specified, in the "Parameter" field. Depending on the items the Initiating party needs returned. In any case, the base response will comprise the Credit Insights, which are further detailed below. The Product options are :

  • CS : Credit Score
  • PS : Payment Score
  • CSPS : Both
  • NONE : No scores, only the insights

Credit Insights: The Credit Insights service takes the raw balance and transaction data from the bank and transforms this into an insightful financial report.

All of the transactions are categorized with a specific focus credit, important data is flagged (such as existing loans, payment rejections, etc…) and useful metrics are calculated.

All of this is delivered by API to provide you an instant analysis based on data retrieved directly from the consumer’s bank.

 

Credit Score: The Credit Score is a number score out of 1000 (a consumer with a score of 0 is the most risky and 1000 the least risky). This number provides a highly accurate predictive assessment of the risk of default within 12 months of the scoring.

 

Payment score: The payment score is designed for use with short-term credit (repayment period of around 3 months). This is provided as a score out of 10 (a consumer with a score of 0 is the most risky and 10 the least risky).

The second call (POST /register/<registration_id>/initialisation/<psu_id>) is meant to provide a base country for the initiation screens that will be shown to the client.

POST /register/<registration_id>/initialisation/<psu_id>
{
  "PsuData":{
    "Country": "FR||DE||XY.."
  }
}

 

After the client has consented to the AIS process, the transactions are fetched and processed in the WL Credit Insight engine.

 

Once the analysis is performed, the following insights are sent within the response to the Initiating Party :

Object name

In Object

Description of the items
Balances

balance

balanceDate

Balances of the client's accounts.
Incomes

totalAmount
monthlyAmount

incomesDetails (object)

Summary of the client's sources of incomes. Details show a breakdown in types and temporality of incomes.
Expenses

totalAmount
monthlyAmount

 

expensesDetails (object)

fixedCharges

otherExpenses

Summary of the client's expenses. Details show a breakdown of the expenses, notably the fixed charges.
Loans

loanRepaymentsCount

loanRepayments (object)
totalAmount

monthlyAmount

loanProviders

drawdownsCount

totalDrawdownAmount

monthlyDrawdownAmount

Summary of the loan repayment transactions on the client's account.
Risks

gamblingTotalAmount

gamblingTransactionsCount

gamblingTransactions

paymentRejectionsCount

paymentRejections

paymentRejectionsTotalAmount

checkRejectionsCount

checkRejections

checkRejectionsTotalAmount

interventionFeesCount

interventionFees

interventionFeesTotalAmount

overdraftReachedAmount

overdraftDuration

overdraftFeesCount

overdraftFees

wageAdvancesCount

wageAdvances

wageAdvancesTotalAmount

directRecoveriesOfDebtCount

directRecoveriesOfDebt

directRecoveriesOfDebtTotalAmount

bankAccountSeizuresCount

bankAccountSeizures

bankAccountSeizuresTotalAmount

Detailed list of all identified transactions that fit a risky behavior.

 

Enable "on this page" menu on doc section
On