Menu
API complete the documents
API complete the documents
This endpoint is used to complete the request by adding additional customer data written in their personal documents.
Endpoint
Sandbox: https://api.sandbox.soisy.it/api/shops/{shopId}/requests/{fiscalCode}
Produzione: https://api.soisy.it/api/shops/{shopId}/requests/{fiscalCode}
Accepted methods
PATCH
Authentication
This API requires authentication viashopId and headerX-Auth-Token .Prerequisites
To access this endpoint, you must have successfully submitted customer documents.Parameters
| Parameter | Obligatory | Type | Format | Description |
|---|---|---|---|---|
| documentOfType | Yes | String | Type of document. Allowed values:identity_card ,driving_license , passport | |
| documentCode | Yes | String | Document number | |
| documentCity | Yes | String | City where the document was issued | |
| documentIssueDate | Yes | String | YYYY-MM-DD | Document issue date |
| documentExpirationDate | Yes | String | YYYY-MM-DD | Expiry date of the document |
| iban | Yes | String | Iban | |
| politicallyExposed | Yes | Boolean | Specifies if the user is a Politically Exposed Person (EPP) | |
| usPerson | Yes | Boolean | Specifies whether the user is a US citizen | |
| marketing | Yes | Boolean | Specifies whether the user would like to receive information on commercial offers and news from Soisy | |
| profession | No | String | User profession |
Answer
The API returns a JSON object containing the newly entered values.HTTP response codes
| Code | Description |
|---|---|
| 200 | Request completed successfully |
| 400 | Syntax or domain error |
| 403 | Failed to authenticate the request |
| 500 | System error |
Valid answer
{
"documentOfType": "identity_card",
"documentCode": "AR123456",
"documentCity": "Milano",
"documentIssueDate": "2010-04-23",
"documentExpirationDate": "2020-04-22",
"iban": "IT60X0542811101000000123456",
"politicallyExposed": false,
"usPerson": false,
"marketing": true,
"profession": "carpenter",
"paymentDayOfMonth": 15,
}
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.
{
"errors": {
{parametro}: [
{messaggio}
]
}
}
Possible errors are listed below:
| Parameter | Message |
|---|---|
| documentOfType | This value should not be empty. |
| documentCode | This value should not be empty. |
| documentCity | This value should not be empty. |
| documentIssueDate | This value is not a valid date. |
| documentExpirationDate | This value is not a valid date. |
| iban | This value is not a valid International Bank Account Number (IBAN). |
| politicallyExposed | This value should not be null. |
| usPerson | This value should not be null. |
| marketing | This value should not be null. |
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"
]
}
}
