GET SERVICES
VALIDATION
GET web service that allows querying a transaction by specifying its unique identifier.
| Name | Validation |
|---|---|
| URL | {URL_Base}/api/{ProjectName}/Validation/{id} |
| TYPE | GET |
| Name | Data Type | Parameter Type | Required | Description |
|---|---|---|---|---|
| ProjectName | String | Path | Yes | The assigned project name |
| apiKey | String | Header | Yes | The key assigned to the project |
| id | Int | path | Yes | The unique identifier of the transaction to be queried |
| returnImages | Boolean | query | Yes | Determines whether images are returned in the query |
| returnDocuments | boolean | header | Yes | Parameter that determines whether signed documents are returned or not. |
| returnVideoLiveness | boolean | header | Yes | Parameter that determines whether the Liveness video will be returned in Base64 format. |
| Authorization | string | header | No | Access token |
| Code | Response | Description |
|---|---|---|
| 401 | client not authorized to make requests The api key value is required Authorization is required to use this method |
The ApiKey, ProjectName, or DocType parameter is incorrect. |
| 404 | The specified project was not found Transaction not found |
There are no records for the pair of document type and number, and the condition of a successful process. |
| 200 | Response Object Description | JSON-formatted object containing the information of the queried transaction. |
| 500 | An error has occurred, please check the error and try again. |
The Images field displays ImageTypeId, which are described in 'RESPONSE DICTIONARY IMAGES'; in the same array, the Liveness video is returned.