SSP-API

search_consumer

GET - Search for a customer

Description
SandBox

Search parameter	Description	Type - Length	Example	Mandatory
safedebit_consumer_reference	Safedebit consumer reference	String - 35		NO
consumer_reference	Consumer reference	String - 64		YES
consumer_store	Safedebit store reference	String - 32		NO
consumer_gender	Gender	Char- 1	M : Male F : Female	NO
consumer_first_name	Consumer first name	String - 70		NO
consumer_use_name	Usual name	String - 70		NO
consumer_pseudonyme	Pseudonym	String - 70		NO
consumer_last_name	Consumer last name	String - 70		NO
consumer_other_last_name	Other names	String - 70		NO
identity_type	Identification type	Char - 1	1 : ID Card 2 : driving licence 3 : passport 4 : residence card 5 : work permit	NO
id_number	ID number	String - 18		NO
emission_date	Identification issuance date	String - 10	DD/MM/YYYY	NO
emission_date_min	Issuance minimum date for part/document	String - 10	DD/MM/YYYY	NO
emission_date_max	Issuance maximum date for part/document	String - 10	DD/MM/YYYY	NO
expire_date	Identification expiration date	String - 10	DD/MM/YYYY	NO
expire_date_min	Minimum expiration date for part/document	String - 10	DD/MM/YYYY	NO
expire_date_max	Maximum expiration date for part/document	String - 10	DD/MM/YYYY	NO
consumer_birth_day	Birth date	String - 10	DD/MM/YYYY	NO
consumer_birth_day_min	Minimum birth day	String - 10	DD/MM/YYYY	NO
consumer_birth_day_max	Maximum birth day	String - 10	DD/MM/YYYY	NO
consumer_birth_city	City/place of birth	String - 35		NO
nationality	Nationality	String - 3	FR,ES,IT...	NO
consumer_address_street_number	Consumer address: number	String - 16		NO
consumer_address_street_type	Consumer address: road type	String - 16		NO
consumer_address_street_name	Consumer address: road name	String - 70		NO
consumer_address_complement	Consumer address: additional information	String - 70		NO
consumer_zip_code	Zip code	String - 16		NO
consumer_city	Town/place	String - 35		NO
consumer_country	Country	String - 35		NO
consumer_email	Consumer e-mail	String - 70		NO
consumer_phone_number	Consumer phone	String - 16		NO
consumer_ip	Consumer's IP address	String - 16		NO
iban	Consumer's IBAN bank account	String - 34		NO
consumer_type	Consumer type	String - 1	0 : Physical person 1 : Company 2 : Non-profit organization	NO
social_reference	Corporate name	String - 32		NO
siren	Company's SIREN	String - 9		NO
nic	Company's NIC	String - 5		NO
naf	Company's NAF	String - 32		NO
tva_interco	International VAT number	String - 32		NO
waldec	Unique national number of NPO	String - 16		NO
beneficiary_reference	Unique reference of beneficiary	String - 32		NO

Request

GET /xxxx/search_consumer?consumer_reference=XXXXX HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json

If consumer data was successfully fetched

Response

HTTP/1.1 200 OK
Content-Type: application/json


{
    "result": true,
    "datas": [
        {
            "safedebit_consumer_reference": "XXXXXXXXXXXXXXX",
            "consumer_reference": "XXXXXX",
            "consumer_first_name": "Nom",
            "consumer_last_name": "Prenom",
            "consumer_use_name": null,
            "consumer_pseudonyme": null,
            "consumer_other_last_name": null,
            "id_number": "92017410",
            "emission_date": "01/01/2010",
            "expire_date": "01/01/2020",
            "consumer_birth_city": "Paris",
            "consumer_birth_day": "01/01/1990",
            "identity_type": "1",
            "consumer_gender": "M",
            "nationality": "FR",
            "consumer_address_street_number": 1,
            "consumer_address_street_type": "Rue",
            "consumer_address_street_name": "du test",
            "consumer_address_complement": "5ème étage",
            "consumer_zip_code": "00000",
            "consumer_city": "Ville",
            "consumer_country": "FR",
            "consumer_email": "test@test.com",
            "consumer_phone_number": "0000000000",
            "consumer_ip": "127.0.0.1",
            "iban": "FR76-3006-6100-4100-0105-7380-116",
            "bic": "PSSTFRPPLYO",
            "social_reference": "Safedebit",
            "siren": "123456789",
            "nic": "001",
            "naf": "3600Z",
            "tva_interco": "FR31439800040",
            "waldec": "W784000090",
            "consumer_store": null,
            "consumer_data": "null"
        }
    ]
}

If consumer data fetching failed

Response

HTTP/1.1 200 OK
Content-Type: application/json



{
    "result" : false,
    "code" : "XXXX"
}

Argument	Description
result	true or false : true : action succeeded false : action failed
datas	Json array of records responding to search arguments
code	See (error codes in annex).

Safedebit consumer reference

Consumer reference

Safedebit store reference

Gender

Last name

First name

Other names

Usual name

Pseudonym

City/place of birth

Nationality

Minimum birth date

Date of birth

Minimum birth date

Number

Road type

Road name

Consumer address: additional information

Zip code

Town/place

Country

Consumer e-mail Invalid Email address

Consumer phone

Consumer's IP

Identification type

Part number

Minimum issuance date

Date of issue

Maximum issuance date

Minimum expiration date

Expiration date of the part

Maximum expiration date

IBAN

Corporate name

SIREN

NIC

NAF

International VAT number

Unique national number of NPO

Consumer type

Unique reference of beneficiary

Thanks to fill-in all the mandatory fields

Request

GET /ssp/search_consumer? HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Accept: application/json

API Documentation

search_consumer

GET - Search for a customer

Request

Response

Response

Request