secure_consumer
POST -- Check consumer data
| Argument | Description | Type - Length | Example | Mandatory |
|---|---|---|---|---|
| consumer_last_name | Consumer last name | String - 70 | YES ** | |
| consumer_first_name | Consumer first name | String - 70 | YES ** | |
| consumer_address_street_number | Consumer address: number | String - 16 | YES ** | |
| consumer_address_street_type | Consumer address: road type | String - 16 | YES ** | |
| consumer_address_street_name | Consumer address: road name | String - 70 | YES ** | |
| consumer_address_complement | Consumer address: additional information | String - 70 | NO | |
| consumer_zip_code | Zip code | String - 16 | YES ** | |
| consumer_city | Town/place | String - 35 | YES ** | |
| consumer_country | Country | String - 2 | YES ** | |
| consumer_email | Consumer e-mail | String - 70 | YES ** | |
| consumer_phone_number | Consumer phone | String - 16 | YES ** | |
| iban | Consumer's IBAN bank account | String - 34 | YES * | |
| social_reference | Corporate name | String - 32 | YES *** | |
| siren | Company's SIREN | String - 9 | YES *** |
** Mandatory for consumer identity check.
*** Mandatory for company check.
=> It's possible to send all data for a global check.
Request
POST /ssp/secure_consumer HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json
{
"consumer_last_name": "Prenom",
"consumer_first_name": "Nom",
"consumer_address_street_number": "1",
"consumer_address_street_type": "Rue",
"consumer_address_street_name": "du test",
"consumer_address_complement": "",
"consumer_zip_code": "00000",
"consumer_city": "Ville",
"consumer_country": "FR",
"consumer_email": "test@test.com",
"consumer_phone_number": "0000000000",
"iban": "FR76XXXXXXXXXXXXXXXXXXXXXXX",
"social_reference": "TEST",
"siren": "123456789"}
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"result" : true,
"score":"100"
}
Response
POST /ssp/secure_consumer HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json
{
"result" : false,
"code" : "XXXX"
}
| Argument | Description |
|---|---|
| result | true or false : true : action succeeded false : action failed |
| score | Score from 0 to 100 - Note < 20 : « red » response, - Note > 20 and < 70 : « orange » response, - Note > 80 : « green » response. |
| code | See (error codes in annex). |
Request
HTTP/1.1 200 OK
POST /xxxx/secure_consumer HTTP/1.1
Host: xxx.xxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json