onboard_beneficiary


POST  -- Démarrage de l’onboarding du bénéficiaire

Argument Description Type - Taille Exemple Obligatoire
social_reference Raison sociale String - 64 OUI
trade_name Nom commercial String - 64 OUI
tva_number Numéro de Tva intercommunautaire String - OUI *
siren SIREN de la société String - 9 OUI *
nic NIC du bénéficiaire String - 5 OUI *
email Email du bénéficiaire String - 70 OUI
url_callback URL de retour String - 128 OUI
phone_number Téléphone portable du bénéficiaire String - 32 NON
address Numéro et nom de la rue du bénéficiaire String - 120 NON
zip_code Code postal du bénéficiaire Integer - 16 NON
city Ville du bénéficiaire String - 35 NON
legal_form Forme juridique (voir annexe) Number - 1 NON
business_sector Le secteur d’activité du bénéficiaire (voir annexe) Number - 2 NON
sales_channel Canal de vente du bénéficiaire (voir annexe) Number - 1 NON
client_topology Topologie des clients (voir annexe) Number - 1 NON
company_capital Capital de la société Number - NON


Requête

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"}
Si le bénéficiaire a été initié avec succès

Réponse

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


{
    "result": true,
    "status": "x",
    "beneficiary_reference": "xxxxxxxx"
}
Si l’initiation du bénéficiaire a échoué

Réponse

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


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

Argument Description
result true ou false :
true : action réalisée avec succès
false : action échouée
beneficiary_reference La référence du bénéficiaire initiée avec succès
status Statut actuel du bénéficiaire
0 : INITIAL (nouveau bénéficiaire)
1 : WAITING (formulaire rempli et compte en attente de validation KYB)
2 : OK
3 : KO
4 : WAITING DATA (données bénéficiaires en cours de saisie)
5 : WAITING KYB (modification des documents nécessaires après un premier contrôle refusé)
code Voir codes d'erreur en annexe.
Merci de remplir tous les champs obligatoires
Requête

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