Skip to main content Link Search Menu Expand Document (external link) Copy Copied

Document status check

Table of contents
  1. Endpoint
  2. URL parameter description
  3. Query parameter description
  4. Response body parameter description
    1. Successful response
    2. Response data object description
    3. Failed response
  5. Sample request
  6. Sample response
    1. Sample success response
    2. Sample failed response
  7. Implementation
    1. CURL
    2. Using php-client

Short description

Endpoint

Path (Locale: LT) /api/document/{documentId}/check-status.json
Path (Locale: EN) /en/api/document/{documentId}/check-status.json
Method GET
Request Body Schema application/json

URL parameter description

Key Requirement Type Description
documentId Mandatory String Document UUID from response of “Document upload”

Query parameter description

Key Requirement Type Description
access_token Mandatory String API Access Token

Response body parameter description

Successful response

Key Type Description
status String Status of the request, ok in this case
data Object For object description, follow Response data object description

Response data object description

Key Type Description
status String Status of the request, ok in this case
document_status String Status of the document

Failed response

Key Type Description
status String Status of the request, error in this case
message String Brief message about what is wrong

Sample request


GET /en/api/document/cff827fc-e70e-167c-4ae5-d388b1b5c264/check-status.json?access_token=f4b79b72-7587-f417-41f8-2de5a7c87fae HTTP/1.1
Host: app.marksign.local

Sample response

Sample success response


{
  "status": "ok",
  "data": {
    "status": "ok",
    "document_status": "saved"
  }
}

Sample failed response


{
  "status": "error",
  "message": "Document was not found"
}

Implementation

CURL


curl --location --request GET 'https://app.marksign.local/en/api/document/cff827fc-e70e-167c-4ae5-d388b1b5c264/check-status.json?access_token=f4b79b72-7587-f417-41f8-2de5a7c87fae'

Using php-client

To use the php-client, please follow the installation and basic usage here, and use AppBundle\GatewaySDKPhp\RequestBuilder\DocumentStatusCheckRequestBuilder as request builder.


/**
 * 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';

$statusCheckReq = (new DocumentStatusCheckRequestBuilder)
  ->withDocumentId($documentId)
  ->createRequest();
$statusCheckRes = $client->postRequest($statusCheckReq);
$statusCheckResArray = $response->toArray();
var_dump($statusCheckResArray);