Service used to delete already created signatureRequestId. DELETE method / signatureRequest/{signatureRequestId} is used to delete the signature request.
Service specification: #
| URL | https://apidev.okdokument.com/JSON/signatureRequest/{{signatureRequestId}} |
| Method | DELETE |
| Authentication | Header x-api-key |
| Response Type | application/json |
Request description #
Request path variable:
| Key | Type | Description |
| signatureRequestId | path | The signatureRequestId retrieved from the response body of the Create signature request service |
HTTP- Click to view HTTP code snippet
DELETE /JSON/signatureRequest/32f8628d-6658-443d-a2a0-f59d9d3752d2 HTTP/1.1
Host: localhost:8080
x-api-key: 7796b696_bd2b1aaf7ef4f09be9f52ce2d8d599674d81aa9d6a4421696dc4d93dd0619d682ce56b4d64a9ef097761ced99e0f67265b5f76085e5b0ee7ca4696b2ad6fe2b2Response description #
When a request is made, API Server checks if signatureRequestId exists and deletes it. When a problem is detected, service returns HTTP 400 state. Report of the problem can be found in the body of the response in JSON format.
| Status code | Description |
| 200 OK | Success response |
| 401 Unauthorized | When user is not authenticated |
| 403 Forbidden | When user lacks required permissions |
| 400 Bad Request | If the signature request with the specified id does not exist. |
| 500 Internal Server Error | Server processing error |
Example of success response
{
"message": "msg.deleted",
"result": "32f8628d-6658-443d-a2a0-f59d9d3752d2"
}Example of error response
{
"message": "err.signature.request.not.exist",
"value": "32f8628d-6658-443d-a2a0-f59d9d3752d222"
}