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 This API chceks status of mobile id identification session using token.
Path (Locale: LT) /mobile/status/{token}.json Path (Locale: EN) /en/mobile/status/{token}.json Method POST Request Body Schema application/json
Key Requirement Type Description access_token Mandatory String API Access Token
Key Type Description status String Status of the authentication session country String Country code certificate Object Certificate information of the provided phone number code String Provided person code token String Unique session token used in the request control_code String Verification code name String Person name for the phone number surname String Person surname for the phone number sanctions_data Object Sanction informatiion peps_data Object PEPs information
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
POST /en/mobile/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"
}
{
"status": "ok",
"country": "EE",
"certificate": {
"name": "/C=EE/CN=TESTNUMBER,TEN,60001017705/SN=TESTNUMBER/GN=TEN/serialNumber=PNOEE-60001017705",
"subject": {
"country": "EE",
"organisation": null,
"organisation_unit": null,
"common_name": "TESTNUMBER,TEN,60001017705",
"surname": "TESTNUMBER",
"name": "TEN",
"serial_number": "PNOEE-60001017705"
},
"issuer": {
"country": "EE",
"organisation": "AS Sertifitseerimiskeskus",
"common_name": "TEST of ESTEID-SK 2015"
},
"valid_from": "2020-11-13",
"valid_to": "2025-11-12",
"value": "TUlJRnRUQ0NBNTJnQXdJQkFnSVFYb1VTQmJPQmJJZGZybytZNF..........FSNXFaRFc0aStyM2FkOG1hb1RoSDRIWjFrb2w2TmVVWEErQT09"
},
"code": "60001017705",
"name": "TEN",
"token": "381ed84f-0851-ce1e-a048-fa1e13a53bba",
"control_code": "6223",
"surname": "TESTNUMBER",
"sanctions_data": [],
"peps_data": []
}
Please note that some json values have been truncated in the previous example.
{
"status": "error",
"message": "Session for given token was not found",
"error_code": 40402
}
curl --location --request POST 'https://app.marksign.local/en/mobile/status/381ed84f-0851-ce1e-a048-fa1e13a53bba.json' \
--header 'Content-Type: application/json' \
--data-raw '{
"access_token": "52900c96-3f60-5307-3719-5948f0191da6"
}'
To use the php-client, please follow the installation and basic usage here , and use AppBundle\GatewaySDKPhp\RequestBuilder\MobileidIdentificationStatusRequestBuilder
/**
* The token can be found from the response of 'initialize authentication via mobile id' request.
* The following is a dummy to use as example.
*/
$token = '40a77456-8b15-4818-2df2-034376f6c6f5';
$identStatusReq = (new MobileidIdentificationStatusRequestBuilder)
->withToken($token)
->createRequest();
$identStatusRes = $client->postRequest($identStatusReq);
$identStatusResArray = $identStatusRes->toArray();
var_dump($identStatusResArray);