Table of contents Endpoint URL parameter description Request body parameter description Response body parameter description Successful response Failed response Sample request Sample response Sample success response Sample failed response Implementation CURL Using php-client Short description
Path /api/document/{documentId}/signers.json Method POST Request Body Schema application/json
Key Requirement Type Description documentId Mandatory String Document UUID
Key Requirement Type Description access_token Mandatory String API Access Token
Key Type Description status String Status of the request, ok in this case signers Array of Objects Signers list
Key Type Description status String Status of the request, error in this case message String Brief message about what is wrong
POST /api/document/{documentId}/signers.json HTTP/1.1
Host: app.marksign.local
Content-Type: application/json
{
"access_token": "d7aaXNN5wodRH3514RuhkMqYUTRnd4o07IYliG8fxQicLfldCBmbZXV5",
"document_id": "8c1b611f-ddcb-11ec-a74f-84c5a60a22fb"
}
{
"status": "ok",
"signers": [
{
"name": "KIRIL",
"surname": "MATOVIČ",
"isSignatureValid": "true",
"signStatus": "signed",
"rejectionReason": "reason"
}
]
}
{
"status": "error",
"message": "message text"
}
curl --location --request POST 'https://app.marksign.local/api/document/{documentId}/signers.json
--header 'Content-Type: application/json'
--data-raw '{
"access_token": "d7aaXNN5wodRH3514RuhkMqYUTRnd4o07IYliG8fxQicLfldCBmbZXV5",
"document_id": "8c1b611f-ddcb-11ec-a74f-84c5a60a22fb"
}'
To use the php-client, please follow the installation and basic usage here , and use AppBundle\GatewaySDKPhp\RequestBuilder\IframeGeneratesDocumentSignersListRequestBuilder
/**
* The document uuid that was found from "Document upload" request.
* The following is a dummy to use as example.
*/
$signersListReq = (new IframeGeneratesDocumentSignersListRequestBuilder)
->withDocumentId('8c1b611f-ddcb-11ec-a74f-84c5a60a22fb')
->createRequest();
$signersListRes = $client->postRequest($signersListReq);
$signersListResArray = $signersListRes->toArray();
var_dump($signersListResArray);