Account verification
Account verification⚓
The API allows you to compare the bank details provided by your customer to the information that the bank holding the account has. The API asks the bank if the account is opened and performs account's holder name and birthdate checks.
This service works for now only for French bank accounts (also known as SEPAMail service) and is an asynchronous process. You will need to wait a few minutes to get the check result from the account holder bank.
To perform an account verification, you need to POST
both the Customer and the SEPA objects. Please note that existing objects can be replaced by their respective ids.
The SEPA check object is defined as follows:
Parameter | Field | Type |
---|---|---|
id | SEPA Check object id | String |
customer | The Customer object containing the name, birthdate and email (or mobile phone number) | Object |
sepa | The SEPA object contains both IBAN and Customer's name | Object |
created | Creation timestamp | Int |
score_name | String distance score comparaison: 0 means no match, 100 means string matches exaclty | Int |
date_birth_valid | If true means the birthdate provided is correct | Boolean |
iban_type | If true means the IBAN type provided is correct | Boolean |
iban_valid | If true means the IBAN is valid | Boolean |
verified | If true means the customer and SEPA objects are correct | Boolean |
status | Evolution of request status: check_error , check_sent , checked | String |
response | response code | String |
Ask for validation check⚓
You can initiate a validation check by posting a SEPA object or by passing an already know SEPA object id.
HTTP request⚓
Data parameters⚓
Parameter | Field |
---|---|
customer | Required |
sepa | Required |
1 2 3 4 5 6 7 8 9 10 11 |
|
The above command returns a JSON structured as follows:
1 2 3 4 5 6 7 8 9 10 11 |
|
Return parameters⚓
The API will returns the following fields:
Parameter | Field |
---|---|
id | SEPA Check object id |
created | Creation timestamp |
score_name | String distance score comparaison: 0 means no match, 100 means string matches exactly |
date_birth_valid | If true means the birthdate provided is correct |
iban_type | If true means the IBAN type provided is correct |
iban_valid | If true means the IBAN is valid |
verified | If true means the customer and SEPA objects are correct |
status | Evolution of request status: check_error , check_sent , checked |
response | response code |
If the bank holding the account does not accept IBAN checks, the API returns a HTTP 400 Error. For testing purposes, all the IBAN samples work. However, bear in mind that so far, only French banks allow IBAN checks.
Get account verification check⚓
1 |
|
The above command returns JSON structured as follows:
1 2 3 4 5 6 7 8 9 10 |
|
HTTP request⚓
Query parameters⚓
Parameter | Description |
---|---|
id_chck | The ID of the SEPA check |
Return parameters⚓
It will return the IBAN checked data asssociated with the id_chck
you provided. If the id_chck
does not exist, the API will return a 404 HTTP response code.
Parameter | Field |
---|---|
id | SEPA object id |
created | Creation timestamp |
score_name | String distance score comparison: 0 means no match, 100 means string match exaclty |
date_birth_valid | If true means the birthdate provided is correct |
iban_type | If true means the IBAN type provided is correct |
iban_valid | If true means the IBAN is valid |
verified | If true means the customer and SEPA objects are correct |
status | Evolution of request status: check_error , check_sent , checked |
response | response code |