You will find hereafter the necessary technical information to send sellers’ KYB and UBO.   

For more details, please refer to this documentation.

Stage environment

You can choose if the document will be accepted or not by changing the 3 first characters of the uploaded file name.

• Filename starts with 01_: document will be refused because unrecognized

• Filename starts with 02_: document will be refused because falsified

• Filename starts with 03_: document will be refused because unreadable

• Filename starts with 06_: document will be refused because inconsistent

• Filename starts with 07_: document will be refused because expired

• Any other name : document will be automatically accepted

KYB service endpoints

There are two endpoints (base URLs) to which you can make your API calls:

• Stage, if you are testing your integration,
• and Production, when you have finished testing and want your application to go live.

Parameters

Headers

You can send either of the following information in the header.

Form parameters

Request example

The authorization is done with the API login and API password of the HiPay technical account.

files = {'file': open('Carte_identite.png','rb')}

headers = {
"php-auth-subaccount-id":"760667",
"Authorization": "Basic YWE5YmVhODg5ZxxxxxxxxMTQ2MjRhOWVmZTJhY2UyM2UwYjE="
}

params = {
"type":"1",
}

API response example

{
"code":0,
"message":"Document uploaded","user_space":286521,"type":1
}

Please note: The fact that HiPay has received the document does not mean that it has been validated.

To make sure that it has been validated, please refer to the notification server.

UBO service endpoints

Step 1 - Create a UBO statement

This is the first step of UBO statement submission. An UBO statement is a list of UBO (Ultimate Beneficial Owners).
Be sure to have all the data before starting an UBO statement.
1 UBO = 1 shareholder with >25% of capital or voting rights

Step 2 - Send the UBO

The document uploaded can't exceed 15MO.

The following endpoint is only in case the legal representative declared for the user space is also a UBO.

• 1 UBO = 1 shareholders with >25% of capital or voting rights
• The document uploaded can't exceed 15MO.
• Civility, address and position informations will be retrieved from the user space's professional informations.
• ID Document (and its backside if it is needed) will be retrieved from the uploaded KYC (identification) documents for the user space. if they are already uploaded. Otherwise, they can be uploaded here and handled like a KYC, both identifying the user space and this UBO.
• As there can only be one legal representive per user space, only one UBO/legal representative can be declared.

Step 3 - Delete the UBO

If you initiate an UBO statement with a wrong number of UBO, and if you don't send all the UBO, you can delete this UBO statement and start a new one.

If an UBO statement has been submitted (status WAITING or UPDATED), you can't delete it.

Step 4 - Get the list of all UBOs for a HiPay seller account

 If an UBO is refused, you should send us a new UBO.