API - signature certificate
API - signature certificate
In the previous call, we returned you a series of clauses to show to the user. In this call you can communicate your acceptance of these clauses. We will pass these choices to the Certification Authority which will issue a certificate that will be used to digitally sign the contract.
Don’t worry, we take care of managing the certificate and authority, so you can focus on writing the code that will add value to your platform.
Once this call is made, the user will receive a confirmation code on the mobile number provided (called OTP, which stands for One Time Password). This code will be used to confirm the signature in the next API call.
Endpoint
Sandbox: https://api.sandbox.soisy.it/api/shops/{shopId}/requests/{fiscalCode}/request-signature-certificate
Produzione: https://api.soisy.it/api/shops/{shopId}/requests/{fiscalCode}/request-signature-certificate
Accepted methods
POST
Authentication
This API requires authentication viashopId and headerX-Auth-Token .
Prerequisites
To access this endpoint, you must have requested the terms of the agreement.
Parameters
| Parameter | Mandatory | Type | Format | Description |
|---|---|---|---|---|
| clauses | Yes | Subject | The clauses accepted by the user. See example. |
With the request you will have to transmit all the clauses retrieved with the previous call. The value true indicates that the customer has accepted the various clauses.
{
"clauses": {
"termAndCondition": true,
"misleadingClaims": true,
}
}
Answer
The API returns a JSON object containing a list of contracts to be signed. Each contract contains a list of clauses that the customer must expressly accept.
Clauses returned by this API will need to be explicitly sent, with a valuetrue , in the next call to sign the contract.
HTTP response codes
| Code | Description |
|---|---|
| 201 | Resource created |
| 400 | Syntax or domain error |
| 403 | Failed to authenticate the request |
| 500 | System error |
Valid answer
{
"contracts": [
{
"contractId": "ABC-1234-DEF",
"type": "soisy",
"version": "v4",
"clauses": {
"termsAndConditions": "Termini e condizioni",
"privacyPolicy": "Informativa privacy",
"sddStatement": "Modulo SDD",
}
}
]
}
Error response
The JSON object returned in the event of an error varies depending on the HTTP response code.
Error 400
The description of the errormessaggio it will change according to the error generated by the Certification Authority.
{
"errors": {
"domain": [
{messaggio}
]
}
}
Error 403
The sent request contains invalid credentials. Check the shopId and header X-Auth-Token. Find more info on credentials in the authentication paragraph.
{
"errors": {
"domain": [
"The user has no access to this resource"
]
}
}
Error 500
Responses with this HTTP code indicate that a system error has occurred.
{
"errors": {
"system": [
{messaggio}
]
}
}
