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

Document download

Table of contents
  1. Endpoint
  2. URL parameter description
  3. Request body parameter description
  4. Response body parameter description
    1. Successful response
    2. 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}/download.json
Path (Locale: EN) /en/api/document/{documentId}/download.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”

Request body parameter description

Key Requirement Type Description
access_token Mandatory String API Access Token

Response body parameter description

Successful response

The document will be sent as response.

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/download.json?access_token=f4b79b72-7587-f417-41f8-2de5a7c87fae HTTP/1.1
Host: app.marksign.local

Sample response

Sample success response

The document will be sent as response.

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/download.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\DocumentDownloadRequestBuilder 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';

$downloadReq = (new DocumentDownloadRequestBuilder)
  ->withDocumentId($documentId)
  ->createRequest();
$downloadRes = $client->postRequest($downloadReq);

/**
 * Here, only pdf type is being checked for example.
 * Other supported document types also have to be checked.
 * Also, note that, Content-Type can be 'application/json' if there occurs any
 */
if ($downloadRes->getHeader('Content-Type') == 'application/pdf') {
  file_put_contents(__DIR__ . '/save.pdf', $response->getContent());
}