Complete user data

This endpoint is used to complete the request by adding additional customer and previously sent document data.

Request

Endpoint

Sandbox: https://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 authentication via shopId and headerX-Auth-Token.

Prerequisites

To access this endpoint, it is necessary to have successfully sent customer documents.

Parameters

Parameter Required Type Format Description
documentOfType Yes String Document type. Values allowed: 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 Date of issue of the document
documentExpirationDate Yes String YYYY-MM-DD Document expiration date
iban No String Iban
politicallyExposed Yes Boolean Specify if the user is a Politically Exposed Person (PEP)
usPerson Yes Boolean Specifies whether the user is a US citizen
marketing Yes Boolean Specifies whether the user likes to receive information about commercial offers and news from Soisy
paymentDayOfMonth No Total Day of the month ion which the installment payment will be made
profession No String User profession

Response

The API returns a JSON object containing the newly entered values.

HTTP Error codes

Code Description
200 Request completed successfully
400 Syntax or domain error
403 The request could not be authenticated
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,
    "redirectUrl": "http:\/\/shops.soisy.it\/SCOREP85R02C521Z\/randomstring",
}

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 request sent contained a formally incorrect parameter.

 {
     "errors": {
         {parameter}: [
             {message}
         ]
      }
 }

Possible errors are listed below:

Parameter Message
documentOfType This value should not be blank.
documentCode This value should not be blank.
documentCity This value should not be blank.
documentIssueDate This value is not a valid date.
documentExpirationDate This value is not a valid date.
iban This value is not a valid IBAN (International Bank Account Number).
politicallyExposed This value should not be null.
usPerson This value should not be null.
marketing This value should not be null.

Error 403

The request sent contains invalid credentials. Check the shopId and the X-Auth-Token header. Find more info on credentials in the paragraph about authentication.

 {
     "error": "Access denied"
 }

Error 500

Replies with this HTTP code indicate that a system error has occurred.

{
    "errors": {
        "system": [
            "System error"
        ]
    }
}

Redirect chance

In this phase you can decide whether to continue integration or redirect the user to our webapp. Redirect the requestor to Soisy using the redirectUrl field, which you will find in the response payload.