Contract Signatures
List of valid attributes:
| Attribute | Description | Specifics |
|---|---|---|
| signature_level | One of advanced, qualified, simple | Must be set, currently only simple supported |
| signed_at | Null or timestamp of signature | Cannot be set |
Example response:
{ "data": [ { "id": "1e9f83a6-51a7-445a-bd6e-5e0350f24c93", "type": "contract_signature", "attributes": { ... } }, { ... } ]}This endpoint returns contract signatures of an account.
HTTP Request
Section titled “HTTP Request”GET /api/v1/contracts/:contract_id/contract_signatures
Update
Section titled “Update”Example request:
{ "data": { "type": "contract_signature", "attributes": { "otp": "123456" } }}Example response:
{ "data": { "id": "1e9f83a6-51a7-445a-bd6e-5e0350f24c93", "type": "contract_signature", "attributes": { ... } }}This endpoint signs a contract by updating the contract signature and automatically setting the signed_at time. Updating the contract signature is possible only with valid OTP attribute. If this is the final contract signature, the contract’s status is updated to ‘completed’.
HTTP Request
Section titled “HTTP Request”PUT /api/v1/contracts/:contract_id/contract_signatures/:contract_signature_id
URL Parameters
Section titled “URL Parameters”| Parameter | Description |
|---|---|
| contract_id | The ID of the contract to sign |
| contract_signature_id | The ID of the contract signature to update |
Sending OTP
Section titled “Sending OTP”Example response:
{ "data": { "id": "1e9f83a6-51a7-445a-bd6e-5e0350f24c93", "type": "contract_signature", "attributes": { ... } }}This endpoint sends One-Time-Password to the user’s email to sign the contract.
HTTP Request
Section titled “HTTP Request”POST /api/v1/contract_signatures/:contract_signature_id/otp
URL Parameters
Section titled “URL Parameters”| Parameter | Description |
|---|---|
| contract_signature_id | The ID of the contract signature for which to request an OTP |