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

For more details, please refer to this documentation.

Stage environment

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

File name starts with 01_: the document will be refused because it is unrecognized.
File name starts with 02_: the document will be refused because it is falsified.
File name starts with 03_: the document will be refused because it is unreadable.
File name starts with 06_: the document will be refused because it is inconsistent.
File name starts with 07_: the document will be refused because it is expired.
Any other name: the 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

The following information can be sent 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 - Creating a UBO declaration

This is the first step of the UBO declaration submission. A UBO declaration is a list of UBOs (Ultimate Beneficial Owners).
Make sure to have all the information before starting a UBO declaration.
1 UBO = 1 shareholder with >25% of capital or voting rights

Step 2 - Submitting the UBO declaration

The document uploaded can't exceed 15 MB.

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

1 UBO = 1 shareholder with >25% of capital or voting rights.
The document uploaded can't exceed 15 MB.
Civility, address and position information will be retrieved from the user space's professional information.
ID document (with back side, if needed) will be retrieved from the uploaded KYC (identification) documents for the user space. Otherwise, they can be uploaded here and handled like a KYC document, identifying both the user space and this UBO.
As there can only be one legal representative per user space, only one UBO/legal representative can be declared.

Step 3 - Deleting the UBO declaration

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

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

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

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

HiPay Marketplace - Identification of the seller's account (KYB documents + UBO declaration)