onboard_beneficiary


POST  -- Start beneficiary onboarding

Argument Description Type - Length Example Mandatory
social_reference Corporate name String - 64 YES
trade_name Trade name String - 64 YES
tva_number Intercommunity VAT number String - YES *
siren Company's SIREN String - 9 YES *
nic Beneficiary NIC String - 5 YES *
email Beneficiary email String - 70 YES
url_callback Callback URL String - 128 YES
phone_number Beneficiary mobile phone number String - 32 NO
address Beneficiary's road number and road name String - 120 NO
zip_code Beneficiary zip code Integer - 16 NO
city Beneficiary town/place String - 35 NO
legal_form Legal form (see annex) Number - 1 NO
business_sector The beneficiary's sector of activity (see annex) Number - 2 NO
sales_channel Beneficiary's sales channel (see annex) Number - 1 NO
client_topology Client topology (see annex) Number - 1 NO
company_capital Company's capital Number - NO


Request

POST /xxxx/onboard_beneficiary HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json 


{
"social_reference": "xxxxxxxx",
"trade_name": "xxxxxxxx",
"tva_number": "xxxxxxxx",
"siren": "xxxxxxxx",
"nic": "xxxxx",
"email": "xxxxxxxx",
"url_callback": "https://callback.com",
"address": "xxxxxxxx",
"zip_code": "xxxxxxxx",
"city": "xxxxxxxx",
"legal_form": "x",
"business_sector": "x",
"sales_channel": "x",
"client_topology": "x",
"company_capital": "xxxxxxx"}
If beneficiary successfully initiated

Response

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


{
    "result": true,
    "status": "x",
    "beneficiary_reference": "xxxxxxxx"
}
If beneficiary initiation 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
beneficiary_reference Beneficiary reference successfully initiated
status Current beneficiary status
0 : INITIAL (new beneficiary)
1 : WAITING (form filled and account awaiting KYB validation)
2 : OK
3 : KO
4 : WAITING DATA (benficiary data are being input)
5 : WAITING KYB (document modification is required after a first refused check)
code See (error codes in annex).
Thanks to fill-in all the mandatory fields
Request

HTTP/1.1 200 OK
POST /xxxx/onboard_beneficiary HTTP/1.1
Host: xxx.xxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json