4. Session Result (/session)
Description
Operation for obtaining the result of the session.
Request
To start the operation, make a HTTP GET request to an HTTP URL of the following form:
https://{service}/v1/session/{session_id}
Authorization
In the Authorization header, include the API key you were given. See [API Authorization] for
more information.
Request parameters
Certain parameters are required to obtain the session result.
| Name | Type | Use | Description |
|---|---|---|---|
| session_id | PATH | Required | Session ID acquired when initiating the associated operation. |
Request headers
The following Headers must be present in the HTTP request:
- Authorization - API key.
Authorization: Basic <API-key>Request body
The body part is not used for the HTTP GET requests.
Response
A response with a 200 OK status specifying that the request was correctly processed will be returned.
Example
HTTP/1.1 200 OK
Content-Type: application/json
{JSON-DATA}In case of error, the response will indicate a status other than 200 OK.
In such case, the response will contain additional information on the error cause. See [Handling
API Errors][Handling
API Errors] for more information.
Example
HTTP/1.1 400 Bad Request
Content-Type: application/json
{
"error" : { "value": "unauthorized" }
}Response parameters
The response is a JSON representation with the following parameters.
| Name | Use | Description |
|---|---|---|
| status | Required | Status of the request. Possible values:
|
| error | Optional | Structure describing the API error. Available when operation completed with an error. |
| error.id | Optional | Error identifier for the issue tracking. |
| error.value | Required | Error value. See [Handling API Errors] for more information. |
| error.message | Optional | Additional error message. |
| certificates[] | Optional | Structure describing list of the certificates result from the Certificates operation. May be empty or missing when still running or operation completed with an error. |
| certificates[].label | Required | Certificate label. Useble for the Authentication and Signature operations. |
| certificates[].value | Required | Certificate value encoded in ASN.1 DER and Base64. ⚠️ The certificate is always valid at the time of the response therefore additional status checks (OCSP or CRL) are not required. |
| signature | Optional | Structure describing the signature result from the Authentication or Signature operation. May be empty or missing when still running or operation completed with an error. |
| signature.value | Required | Signature value encoded in Base64. |
| signature.algorithm | Required | Signature algorithm used in the process. (rsa-sha256, rsa-sha384, rsa-sha512, ecdsasha256, ecdsa-sha384, ecdsa-sha512) |
| device_address | Optional | IP address of the device running the eParaksts mobile or eID Scan application. Available for the Authentication or Signature operation. Empty when address cannot be resolved or operation completed with an error. |
Response headers
The following Headers may be present in the HTTP response:
- Content-Type - the content type of the document model.
Content-Type: application/jsonUpdated about 1 month ago