PATCH service used to update already created signatureRequestId.
When a request is made, OKdokument API Server checks if signatureRequestId exists and updates it. When a problem is detected, HTTP error is returned. Report of the problem can be found in the body of the response in JSON format.
Service specification #
| URL | https://apidev.okdokument.com/JSON/signatureRequest |
| Method | PATCH |
| Authentication | Header x-api-key |
| Content type | application/json |
| Response type | application/json |
Request description #
Parts of the JSON request body:
| signatureRequestId | The signatureRequestId retrieved from the response body of the Create signature request service |
| sendInfoUrl | URL used in SendInfo processing |
| resulturl | URL to redirect the browser after finishing the signing process |
HTTP- Click to view HTTP code snippet
PATCH /JSON/signatureRequest HTTP/1.1
Host: localhost:8080
Content-Type: application/json
x-api-key: 7796b696_bd2b1aaf7ef4f09be9f52ce2d8d599674d81aa9d6a4421696dc4d93dd0619d682ce56b4d64a9ef097761ced99e0f67265b5f76085e5b0ee7ca4696b2ad6fe2b2
Content-Length: 171
{
"signatureRequestId": "1d58a59e-e8f7-4d07-bb99-d3fa39cb58a8",
"sendInfoURL": "https://azure/sendInfo?arg=123456",
"resulturl": "https://okdokument.com"
}Example of request body:
{
"signatureRequestId": "1d58a59e-e8f7-4d07-bb99-d3fa39cb58a8",
"sendInfoURL": "https://azure/sendInfo?arg=123456",
"resulturl": "https://okdokument.com"
}Response description #
| 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.updated",
"result": "1d58a59e-e8f7-4d07-bb99-d3fa39cb58a8",
"url": "https://apidev.okdokument.com/1d58a59e-e8f7-4d07-bb99-d3fa39cb58a8"
}Example of error response
{
"message": "View ID does not exist: 32f8628d-6658-443d-a2a0-f59d9d3752d222",
"value": "32f8628d-6658-443d-a2a0-f59d9d3752d222"
}