Complete user data

Update the request sending additional client data.

Request

Endpoint

Sandbox: http://api.sandbox.soisy.it/api/shops/{shopId}/requests/{fiscalCode}
Production: https://api.soisy.it/api/shops/{shopId}/requests/{fiscalCode}

Accepted Methods

PATCH

Authentication

This API requires authorization with shopId and X-Auth-Token header .

Prerequisites

A call to POST /api/shops/{shopId}/requests/{fiscalCode}/documents is required.

Parameters

Parameter Mandatory Type Format Description
documentOfType String Type of identity document: identity_card, driving_license, passport
documentCode String Identity document code
documentCity String City where identity document was issued
documentIssueDate String YYYY-MM-DD Document issue date
documentExpirationDate String YYYY-MM-DD Document expiration date
iban No String Iban
politicallyExposed Boolean True if the user is a politically exposed person
usPerson Boolean True if the user is a US citizen
marketing Boolean True if the user allows the use of info for marketing
paymentDayOfMonth No Integer Payment day of month
profession No String A profession

Response

This API returns a JSON object.

Response codes

Code Description
200 Returned when successful
400 A domain error occurred
403 Forbidden
500 System error

Valid response

{
    "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

{
 "errors": {
     "domain": [
         0: "Invalid fiscalCode."
         ]
     }
}

Validation error sample response:

{
    "errors": {
        "documentCity": [
            "Questo valore non dovrebbe essere vuoto."
        ],
        "documentExpirationDate": [
            "Questo valore non è una data valida."
        ]
    }
}