add_person_beneficiary


POST  -- Add physical person

Argument Description Type - Length Example Mandatory
beneficiary_reference Beneficiary reference String - 64 YES
person_reference Person reference already in KYC folder String - 64 YES
main_person 1: the person is the legal representative
0: the person is not the legal representative		 Boolean - 1 YES
firstname Person's first name String - 16 YES
lastname Person's last name String - 16 YES
birth_date Person's date of birth (Y-m-d) Date - 10 YES
function_in_the_company Function in the company String - 32 YES
city_of_birth City of birth String - 16 YES
country_of_birth Country of birth
For example France will be FR		 String - 2 YES
country_of_residence Country of residence
For example France will be FR		 String - 2 YES
address Address String - 120 YES
zip_code Zip code String - 16 YES
city Town/place String - 70 YES
phone_number Person mobile phone number String - 32 YES
email Person email String - 32 YES
is_be The person is a beneficial owner Boolean - 1 YES *
representant_benef_has_responsability This person is an officer or senior executive with significant responsibilities in the management of the company. Boolean - 1 YES *
representant_is_member_administration This person is a member of the Board of Directors Boolean - 1 YES *
representant_pourcent_greater_than This person owns at least 25% of the business Boolean - 1 YES *
country_of_tax_residence Country of tax residence String - 2 YES *
tax_identification Tax Identification Number String - YES *
vote_held Percentage (%) of vote rights held Number - 3 YES *
held_capital Percentage (%) of capital held Number - 3 YES *
verso 1: the person must upload the document on the back of their identity document
0: no need for a file on the back		 Boolean - 1 YES


Request

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


{
"beneficiary_reference": "xxxxxxxx",
"person_reference": "xxxxxxxx",
"main_person": "xxxxxxxx",
"firstname": "xxxxxxxx",
"lastname": "xxxxxxxx",
"birth_date": "xxxxxxxx",
"function_in_the_company": "xxxxxxxx",
"city_of_birth": "xxxxxxxx",
"country_of_birth": "xxxxxxxx",
"country_of_residence": "xxxxxxxx",
"address": "xxxxxxxx",
"zip_code": "xxxxxxxx",
"city": "xxxxxxxx",
"phone_number": "xxxxxxxx",
"email": "xxxxxxxx",
"is_be": "xxxxxxxx",
"representant_benef_has_responsability": "xxxxxxxx",
"representant_is_member_administration": "xxxxxxxx",
"representant_pourcent_greater_than": "xxxxxxxx",
"country_of_tax_residence": "xxxxxxxx",
"tax_identification": "xxxxxxxx",
"vote_held": "xxxxxxxx",
"held_capital": "xxxxxxxx",
"verso": "xxxxxxxx"}
If parameters are valid

Response

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


{
    "result": true,
    "person_reference": "xxxxxxxx"
}
If parameters are erroneous

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
code See (error codes in annex).
Thanks to fill-in all the mandatory fields
Request

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