Menu
API upload documents
API upload documents
This endpoint is for uploading customer documents. Our application will store the documents and respond with a success code in case everything went well or with a code and an error message if not.
Endpoint
Sandbox: https://api.sandbox.soisy.it/api/shops/{shopId}/requests/{fiscalCode}/documents
Produzione: https://api.soisy.it/api/shops/{shopId}/requests/{fiscalCode}/documents
Accepted methods
POST
Authentication
This API requires authentication viashopId and headerX-Auth-Token .Prerequisites
To access this endpoint, you must have successfully requested approval of a request.Parameters
| Parameter | Obligatory | Guy | Format | Description |
|---|---|---|---|---|
| identityFrontFile | Yup | Image | Jpg, Png, Pdf | Front image of the ID card |
| identityBackFile | Yup | Image | Jpg, Png, Pdf | Image of the back of the ID card |
| fiscalCodeFrontFile | Yup | Image | Jpg, Png, Pdf | Front image of the tax code |
| fiscalCodeBackFile | Yup | Image | Jpg, Png, Pdf | Image of the back of the tax code |
| selfieFile | Yup | Image | Jpg, Png, Pdf | User selfie |
| incomeDeclarationFile | No* | Image | Jpg, Png, Pdf | A user income document. Required ifadditionalDataNeeded istrue . The pay slip, the CUD, the 730 or the Unico model are valid |
| residencePermitFile | No* | Image | Jpg, Png, Pdf | Residency permit. Mandatory for users outside the European Community. |
Answer
The API returns a JSON array.HTTP response codes
| Code | Description |
|---|---|
| 201 | Resource created |
| 400 | Syntax or domain error |
| 403 | Failed to authenticate the request |
| 500 | System error |
Valid answer
[
{"fileName: "identityFrontFile", "id": <UUID>},
{"fileName: "identityBackFile", "id": <UUID>},
{"fileName: "fiscalCodeFrontFile", "id": <UUID>},
{"fileName: "fiscalCodeBackFile", "id": <UUID>},
{"fileName: "selfieFile", "id": <UUID>},
{"fileName: "incomeDeclarationFile", "id": <UUID>},
{"fileName: "residencePermitFile", "id": <UUID>},
]
Error response
The JSON object returned in the event of an error varies depending on the HTTP response code.
Error 400
Responses with this HTTP code indicate a client-side error. The submitted request contained a formally incorrect parameter.
The following errors are possible for each parameter :
Failure to send the parameter
{
"errors": {
{parametro}: [
"Questo valore non dovrebbe essere vuoto."
]
}
}
- Empty file
{
"errors": {
"file": [
"Un file vuoto non è consentito."
]
}
}
- File sent larger than allowed
{
"errors": {
"file": [
"Il file è troppo grande ({size} MB). La dimensione massima consentita è 15 MB."
]
}
}
- File sent with Media Type other than
application/pdf,application/x-pdf,image/jpeg,image/pjpegorimage/png
{
"errors": {
"file": [
"Puoi caricare solo file pdf, immagini jpg o png"
]
}
}
Error 403
The sent request contains invalid credentials. Check the shopId and headerX-Auth-Token . Find more info on credentials in the authentication paragraph.
{
"error": "Access denied"
}
Error 500
Responses with this HTTP code indicate that a system error has occurred.
{
"errors": {
"system": [
"System error"
]
}
}
