Link Search Menu Expand Document (external link)

Signing status

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

This API checks the status of the signing process initialized by Initialize signing via mobile id request.

Endpoint

Path (Locale: LT) /mobile/sign/status/{token}.json
Path (Locale: EN) /en/mobile/sign/status/{token}.json
Method POST
Request Body Schema application/json

URL parameter description

Key Requirement Type Description
token Mandatory String Token that is being sent as a response of Initialize signing via mobile id

Request body 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 signing process
signature_id String Unique ID of signature
file Object Follow Response file object description section
person ObJect Follow Response person object description section
sanctions_data Object Sanction information
peps_data Object PEPs information

Response file object description

Key Type Description
name String Name of the file
content String Base64 encoded file content
digest String Digest string of the file

Response person object description

Key Type Description
name String Name of the signer
surname String Surname of the signer

Failed response

Key Type Description
status String Status of the request, error in this case
message String Brief message about what is wrong
error_code Integer Unique code for the error. Error codes are listed here

Sample request


POST /en/mobile/sign/status/381ed84f-0851-ce1e-a048-fa1e13a53bba.json HTTP/1.1
Host: app.marksign.local
Content-Type: application/json

{
  "access_token": "52900c96-3f60-5307-3719-5948f0191da6"
}

Sample response

Sample success response


{
  "status": "ok",
  "signature_id": "Signature1",
  "file": {
    "name": "d251f53441f61822a7884454e89d0c5baf246ab2_signed.pdf",
    "content": "JVBERi0xLjUKJbXtrvsKNzYgMCBvYmoKPDwgL0xlbmd0aCA3Ny..........RzdHJlYW0KZW5kb2JqCnN0YXJ0eHJlZgo1MDg5MwolJUVPRgo=",
    "digest": "cf4e55c5111e4fd9bd32b5d3ac34fd4eb00d938d"
  },
  "person": {
    "name": "NAME",
    "surname": "SURNAME"
  },
  "sanctions_data": [{
    "id": 17,
    "reference": "10131008196",
    "first_name": "Ali Barzan Ibrahim Hasan",
    "last_name": "AL-TIKRITI",
    "full_name": "",
    "date_of_birth": "18 Apr 1981",
    "place_of_birth": "Country",
    "aka": "Barzan Ibrahim Hasan al-Tikriti",
    "gender": "male",
    "document_number": "",
    "country_of_origin": "Country",
    "type_sdn_or_entity": "Individual",
    "name_of_the_list": "OFAC SDN (Specially Designated Nationals) List",
    "date_of_publication": "OFAC SDN List",
    "date_of_publication_of_the_list": "2020-09-23 07:28:28",
    "search_created_at": "2019-04-07T11:21:53Z",
    "associates": {
      "parent": "Name Surname"
    },
    "image_url": "http://www.eltiempo.com/archivo/documento/MAM-2761276.jpg",
    "date_of_death": "2020-09-23 07:28:28"
  }],
  "peps_data": [{
    "id": 1422,
    "reference": "10101007067-sHft2244Qt",
    "first_name": "Name",
    "last_name": "Surname",
    "full_name": "Name Surname",
    "political_position": "Lithuanian politician",
    "associates": {
      "parent": "Name Surname"
    },
    "aka": "Name Surname, Name Surname",
    "date_of_birth": "1972-07-20",
    "place_of_birth": "Lithuania",
    "gender": "male",
    "country_of_origin": "",
    "country_of_activity": "",
    "search_created_at": "2020-06-30 08:40:02",
    "date_of_death": "2020-06-30 08:40:02"
  }]
}

Please note that some json values have been truncated in the previous example.

Sample failed response


{
  "status": "error",
  "message": "Session for given token was not found",
  "error_code": 40402
}

Implementation

CURL


curl --location --request POST 'https://app.marksign.local/en/mobile/sign/status/381ed84f-0851-ce1e-a048-fa1e13a53bba.json' \
--header 'Content-Type: application/json' \
--data-raw '{
  "access_token": "52900c96-3f60-5307-3719-5948f0191da6"
}'

Using php-client

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


/**
 * The token can be found from the response of "Initialize signing via mobile id" request
 * The following is a dummy to use as example.
 */
$token = '40a77456-8b15-4818-2df2-034376f6c6f5';

$signProcStatReq = (new MobileidSigningProcessStatusRequestBuilder)
  ->withToken($token)
  ->createRequest();
$signProcStatRes = $client->postRequest($signProcStatReq);
$signProcStatResArray = $signProcStatRes->toArray();
var_dump($signProcStatResArray);