Upload a Merchant payment account Document Copy section link Copied!
How it works Copy section link Copied!
The /accountHolder/uploadDocument API allows you to send the documents required to validate your Merchant payment account.
This is the API to use to transfer each document, specifying the RequestId (ID of the initial request) and the ID of the expected document. This is a multipart API.
This means that there is
- a first part in JSON :
-------=BOUNDARY
Content-Disposition: form-data; name="json"
Content-Type: application/json; charset=UTF-8
{
"requestId":"CAPS202401260VFAI1",
"requirements":
[{
"id":"1446511",
"fileType":"HOUSING_TAX"
}]}
- And there is a 2nd part which contains only the document encoded in base 64 :
-------=BOUNDARY
Content-Disposition: form-data; name="file"; filename="file.jpg"
Content-Type: image/png Content-Transfer-Encoding: base64 /9j/4AAQSkZJRgABAQEAkACQAAD/4QBaRXhpZgAATU0AKgAAAAgABQMBAAUAAAABAAAASgMDAAEAAAABAAAAAFEQAAEAAAABAQAAAFERAA QAAAABAAAWJVESAAQAAAABAAAWJQAAAAAAAYagAACxj//b...
-------=BOUNDARY--
Each document must be sent in a single UploadDocument API request: it is not possible to send all documents in a single API request.
Each upload is checked by a virus scanner.
As long as the request is in the Pending status, it is possible to resend a document for a given ID and the last document received will be kept. When all documents are received, the request changes to the "To check" status and it is no longer possible to send new documents, just aswhen the request is validated (Validated status).
Once all the documents are received, they are analyzed and then validated (or rejected).
Accepted file formats are :
image/jpeg: JPEG
image/png: PNG
application/pdf: PDF
application/msword:DOC
application/vnd.ms-excel:XLS
application/vnd.openxmlformats officedocument.spreadsheetml.sheet: XLSX
Maximum file size : 5Mo
Below is a list of possible legal forms for API input. This list is managed by one of the AgoraPay components and is subject to change :
- SARL
- SA
- SNC
- SCA
- GIE
- SCS
- EURL
- SCP
- SC
- Coopérative
- Entrepreneur individuel
- Professionnel
- Association
- Société de droit étranger
- SAS
- EARL
- Syndicat de copropriété
Type : string of 50 characters max
Documents status codes Copy section link Copied!
Status code
Label
Description
0
Missing
Document not transmitted
1
Incomplete
Incomplete document (example : front identity card only, back missing)
2
to validate
Document awaiting validation by AgoraPay
3
To read
Document pending RAD/LAD
4
Validated
Document validated
5
To sign
Document awaiting signature
6
Forced
Mandatory document validated by AgoraPay but not uploaded