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.
FINDBYNUMBERID
GET web service that returns the last case for the specified client.
| Name | FindByNumberId |
|---|---|
| URL | {URL_Base}/api/{ProjectName}/FindByNumberId |
| 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 |
| identification | String | query | Yes | The customer's identification number |
| docType | String | query | Yes | Document type to be queried |
| returnImages | Boolean | query | Yes | Determines whether the images of the transaction will be returned. |
| Authorization | string | header | No | Access token |
| Code | Response | Description |
|---|---|---|
| 401 | ApiKey or Project or DocType not valid | The ApiKey, ProjectName, or DocType parameter is incorrect. |
| 404 | Client not found. | There are no records for the pair of document type and number. |
| 200 | { "Uid": "string", "StartingDate": "string", "CreationDate": "string", "CreationIP": "string", "DocumentType": 0, "IdNumber": "string", "FirstName": "string", "SecondName": "string", "FirstSurname": "string", "SecondSurname": "string", "Gender": "string", "BirthDate": "string", "Street": "string", "CedulateCondition": "string", "Spouse": "string", "Home": "string", "MaritalStatus": "string", "DateOfIdentification": "string", "DateOfDeath": "string", "MarriageDate": "string", "Instruction": "string", "PlaceBirth": "string", "Nationality": "string", "MotherName": "string", "FatherName": "string", "HouseNumber": "string", "Profession": "string", "TransactionType": 0, "TransactionTypeName": "string", "IssueDate": "string", "BarcodeText": "string", "OcrTextSideOne": "string", "OcrTextSideTwo": "string", "SideOneWrongAttempts": 0, "SideTwoWrongAttempts": 0, "FoundOnAdoAlert": false, "AdoProjectId": "string", "TransactionId": "string", "ProductId": "string", "ComparationFacesSuccesful": false, "FaceFound": false, "FaceDocumentFrontFound": false, "BarcodeFound": false, "ResultComparationFaces": 0, "ComparationFacesAproved": false, "Extras":{ "IdState": "string", "StateName": "string" }, "NumberPhone": "string", "CodFingerprint": "string", "ResultQRCode": "string", "DactilarCode": "string", "ResponseControlList": "string", "Images":[ { "Id": int, "ImageTypeId": "String", "ImageTypeName: "String", "Image": "Imagen base 64", } ], "SignedDocuments": ["String"], "Scores":[ { "Id": 0, "StateName": "string", "StartingDate": "string", "Observation": "string" } ], "Parameters": "String", "StateSignatureDocument":"String" } |
JSON-formatted object containing the information of the queried transaction. |
The Images field displays ImageTypeId and ImageTypeName, which are described in 'RESPONSE DICTIONARY IMAGES'.