View Categories

3.3 Update Signature Request ID

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:

URLhttps://apidev.okdokument.com/JSON/signatureRequest
MethodPATCH
Authenticationset header x-api-key
Content typeapplication/json
Request bodyData in JSON format
ResponseHTTP status 200 when successful

Parts of the JSON request body:

signatureRequestIdsignature Request ID
sendInfoUrlURL used in SendInfo processing
resulturlURL to redirect the browser after finishing the signing process

Example of request body:

{
    "signatureRequestId": "1d58a59e-e8f7-4d07-bb99-d3fa39cb58a8",
    "sendInfoURL": "https://azure/sendInfo?arg=123456",
    "resulturl": "https://okdokument.com"
}

Response Body Example:

{    "message": "msg.updated",
    "result": "1d58a59e-e8f7-4d07-bb99-d3fa39cb58a8",    "url": "https://apidev.okdokument.com/1d58a59e-e8f7-4d07-bb99-d3fa39cb58a8"}