Skip to content

Scoring

Scoring⚓

Our API can provide you the credit score of one of your clients. This score is based on the credit settings you are going to allow to your customer, such as credit's amount, credit's duration and its potential upfront.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
    "amount": 120000,
    "currency": "eur",
    "customer": {
        "email": "pierre@martin.fr",
        "name": "Pierre Martin"
    },
    "duration": 12,
    "return_url": "https://www.example.com/",
    "sepa": {
        "iban": "FR1420041010050500013M02606",
        "name": "Pierre Martin"
    },
    "upfront": 40000
}

The scoring object is defined as follows:

Parameter Description Type
id Score id String, fixed size = 29
duration The duration is expressed in months Int, =< to 24 months
amount The total amount the the credit Int
upfront The upfront amount that your customer will pay at the begining of the credit Int, have to be < to the total amount of the credit
currency Processed currency Enum EUR
status Scoring status See scoring status codes
score Solvency rate of your customer, based upon the credit's parameters you provided Int 0-100
customer The customer object or id It will link this scoring to this customer
sepa The sepa object or id If present, will link the SEPA object to this scoring
redirect_url An HTTPS URL where you will redirect your customer to this bank for him to authenticate String, max = 2048
Given by the API
return_url An HTTPS URL to redirect back your customer after his authentication String, max = 2048
live_mode Whatever if the scoring is in live mode Boolean
created Scoring creation's timestamp Int

Ask for scoring⚓

HTTP request⚓

/v1/scoring/

Data parameters⚓

Parameter Field
duration Required
amount Required
upfront Optional
currency Required
customer Required email, mobile optional
sepa Optional
return_url Required

Return parameters⚓

The request returns a scoring object as previously defined.

Get scoring data⚓

1
curl "https://api.stancer.com/v1/scoring/scor_o6Y1oZinbl9lErB24OSQCAKl"

The above command returns JSON structured as follows:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
{
    "amount": 120000,
    "created": 1637331933,
    "customer": {
        "country": null,
        "created": 1637331933,
        "date_birth": null,
        "email": "pierre@martin.fr",
        "external_id": null,
        "id": "cust_qERiocJJifCpwDudCSlPjwf0",
        "live_mode": false,
        "mobile": null,
        "name": "Pierre Martin"
    },
    "duration": 12,
    "id": "scor_MAoC42Ty04AkDZBrALABE2K5",
    "live_mode": false,
    "redirect_url": "https://dsp2.iliad78.net/v1/redirect/81165472-f093-4d88-8666-face06af6b9a",
    "return_url": "https://www.example.com/",
    "score": null,
    "sepa": {
        "bic": "TESTFRPP",
        "check": null,
        "created": 1637331933,
        "date_mandate": null,
        "id": "sepa_T19nGh86Iu2W2oKlOC91Fkpo",
        "last4": "2606",
        "live_mode": false,
        "mandate": null,
        "name": "Pierre Martin"
    },
    "status": "requested",
    "upfront": 40000
}

HTTP request⚓

/v1/scoring/
id_scoring

Query parameters⚓

Parameter Field
id_scoring Required

Return parameters⚓

The request returns a scoring object as previously defined.