Table of contents Endpoint URL parameter description Request body parameter description Response body parameter description Successful response Response data object description Failed response Sample request Sample response Sample success response Sample failed response Implementation CURL Using php-client Short description
Path (Locale: LT) /api/document/{documentId}/remove.json Path (Locale: EN) /en/api/document/{documentId}/remove.json Method DELETE Request Body Schema application/json
Key Requirement Type Description documentId Mandatory String Document UUID from response of “Document upload”
Key Requirement Type Description access_token Mandatory String API Access Token
Key Type Description status String Status of the request, ok in this case message String Brief status message
Key Type Description status String Status of the request, error in this case message String Brief message about what is wrong
DELETE /en/api/document/cff827fc-e70e-167c-4ae5-d388b1b5c264/remove.json HTTP/1.1
Host: app.marksign.local
Content-Type: application/json
{
"access_token": "f4b79b72-7587-f417-41f8-2de5a7c87fae"
}
{
"status": "ok",
"data": {
"status": "ok",
"message": "Document was successfully removed"
}
}
{
"status": "error",
"message": "Document was not found"
}
curl --location --request DELETE 'https://app.marksign.local/en/api/document/cff827fc-e70e-167c-4ae5-d388b1b5c264/remove.json' \
--header 'Content-Type: application/json' \
--data-raw '{
"access_token": "f4b79b72-7587-f417-41f8-2de5a7c87fae"
}'
To use the php-client, please follow the installation and basic usage here , and use AppBundle\GatewaySDKPhp\RequestBuilder\DocumentRemoveRequestBuilder
/**
* The document id that was found from "Document upload" request.
* The following is a dummy to use as example.
*/
$documentId = 'c66cf14e-f763-9757-3b83-e5e28126a6df';
$removeReq = (new DocumentRemoveRequestBuilder)
->withDocumentId($documentId)
->createRequest();
$removeRes = $client->postRequest($removeReq);
$removeResArray = $removeRes->toArray();
var_dump($removeResArray);