# Manuales Técnicos



# SERVICIOS REST

solución de Identificación & Servicios Biométricos

<table border="1" class="align-center" id="bkmrk-manual-c%C3%B3digote-mt-0" style="border-collapse: collapse; border: 1px solid rgb(0, 0, 0);"><tbody><tr><td style="border-color: rgb(0, 0, 0);">Manual</td><td style="border-color: rgb(0, 0, 0);">Código  
TE-MT-002</td><td style="border-color: rgb(0, 0, 0);">Versión:  
3.3</td></tr><tr><td style="border-color: rgb(0, 0, 0);">Fecha emisión  
06/10/2022</td><td colspan="3" style="border-color: rgb(0, 0, 0);">Titulo  
Integración servicios REST</td></tr><tr><td style="border-color: rgb(0, 0, 0);">Elaborado por:  
Camilo García</td><td style="border-color: rgb(0, 0, 0);">Revisado por:  
Ingrid Mercado</td><td style="border-color: rgb(0, 0, 0);">Aprobado por:  
Oscar castañeda</td></tr></tbody></table>

<table border="1" class="align-center" id="bkmrk-versi%C3%93n-fecha-emisi%C3%93" style="border-collapse: collapse; width: 100%; border: 1px solid rgb(0, 0, 0);"><tbody><tr><th style="width: 10.630408%; border-color: rgb(0, 0, 0);">**VERSIÓN**</th><th style="width: 16.685132%; border-color: rgb(0, 0, 0);">**FECHA EMISIÓN**</th><th style="width: 72.68446%; border-color: rgb(0, 0, 0);">**DESCRIPCIÓN DE CAMBIOS**</th></tr><tr><td style="width: 10.630408%; border-color: rgb(0, 0, 0);">3.2</td><td style="width: 16.685132%; border-color: rgb(0, 0, 0);">6 de octubre de 2022</td><td style="width: 72.68446%; border-color: rgb(0, 0, 0);">Versionamiento del documento</td></tr><tr><td style="width: 10.630408%; border-color: rgb(0, 0, 0);">3.3</td><td style="width: 16.685132%; border-color: rgb(0, 0, 0);">14 de octubre de 2022</td><td style="width: 72.68446%; border-color: rgb(0, 0, 0);">La validación del SDKVersion sale por el código 400 en el DocumentBackSide y la validación del producto solo sale por código 404 en el CustomerVerification</td></tr></tbody></table>

# GET SERVICES

### VALIDATION

GET web service that allows querying a transaction by specifying its unique identifier.

<table border="1" id="bkmrk-name-validation-url-" style="border-collapse: collapse; border-color: rgb(0, 0, 0); border-style: solid; width: 99.876543%; height: 88px;"><tbody><tr style="height: 29px;"><th style="border-color: rgb(0, 0, 0); width: 18.253968%; height: 29px;">**Name**</th><th style="border-color: rgb(0, 0, 0); width: 81.746032%; height: 29px;">**Validation**</th></tr><tr style="height: 30px;"><td class="align-center" style="border-color: rgb(0, 0, 0); width: 18.253968%; height: 30px;">URL</td><td class="align-center" style="border-color: rgb(0, 0, 0); width: 81.746032%; height: 30px;">{URL\_Base}/api/{ProjectName}/Validation/{id}</td></tr><tr style="height: 29px;"><td class="align-center" style="border-color: rgb(0, 0, 0); width: 18.253968%; height: 29px;">TYPE</td><td class="align-center" style="border-color: rgb(0, 0, 0); width: 81.746032%; height: 29px;">GET</td></tr></tbody></table>

<table border="1" id="bkmrk-parameters-name-data" style="border-collapse: collapse; border-color: rgb(0, 0, 0); border-style: solid; height: 470px; width: 100.864198%;"><caption>**PARAMETERS**</caption><tbody><tr style="height: 29px;"><th style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 29px;">**Name**</th><th style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 29px;">**Data Type**</th><th style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 29px;">**Parameter Type**</th><th style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 29px;">**Required**</th><th style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 29px;">**Description**</th></tr><tr style="height: 45px;"><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 45px;">ProjectName</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 45px;">String</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 45px;">Path</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 45px;">Yes</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 45px;">The assigned project name</td></tr><tr style="height: 45px;"><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 45px;">apiKey</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 45px;">String</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 45px;">Header</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 45px;">Yes</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 45px;">The key assigned to the project</td></tr><tr style="height: 61px;"><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 61px;">id</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 61px;">Int</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 61px;">path</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 61px;">Yes</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 61px;">The unique identifier of the transaction to be queried</td></tr><tr style="height: 76px;"><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 76px;">returnImages</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 76px;">Boolean</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 76px;">query</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 76px;">Yes</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 76px;">Determines whether images are returned in the query</td></tr><tr style="height: 92px;"><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 92px;">returnDocuments</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 92px;">boolean</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 92px;">header</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 92px;">Yes</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 92px;">Parameter that determines whether signed documents are returned or not.</td></tr><tr style="height: 93px;"><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 93px;">returnVideoLiveness</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 93px;">boolean</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 93px;">header</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 93px;">Yes</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 93px;">Parameter that determines whether the Liveness video will be returned in Base64 format.</td></tr><tr style="height: 29px;"><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 29px;">Authorization</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 29px;">string</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 29px;">header</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 29px;">No</td><td style="border-color: rgb(0, 0, 0); width: 20.024722%; height: 29px;">Access token</td></tr></tbody></table>

<table border="1" id="bkmrk-responses-code-respo" style="border-collapse: collapse; border-color: rgb(0, 0, 0); border-style: solid; width: 100%; height: 285px;"><caption>**RESPONSES**</caption><tbody><tr style="height: 45px;"><th style="border-color: rgb(0, 0, 0); width: 9.39523%; height: 45px;">**Code**</th><th style="border-color: rgb(0, 0, 0); width: 26.327885%; height: 45px;">**Response**</th><th style="border-color: rgb(0, 0, 0); width: 64.276885%; height: 45px;">**Description**</th></tr><tr style="height: 93px;"><td style="border-color: rgb(0, 0, 0); width: 9.39523%; height: 93px;">401</td><td style="border-color: rgb(0, 0, 0); width: 26.327885%; height: 93px;">client not authorized to make requests  
The api key value is required  
Authorization is required to use this method  
</td><td style="border-color: rgb(0, 0, 0); width: 64.276885%; height: 93px;">The ApiKey, ProjectName, or DocType parameter is incorrect.</td></tr><tr style="height: 61px;"><td style="border-color: rgb(0, 0, 0); width: 9.39523%; height: 61px;">404</td><td style="border-color: rgb(0, 0, 0); width: 26.327885%; height: 61px;">The specified project was not found  
Transaction not found  
</td><td style="border-color: rgb(0, 0, 0); width: 64.276885%; height: 61px;">There are no records for the pair of document type and number, and the condition of a successful process.</td></tr><tr style="height: 57px;"><td style="border-color: rgb(0, 0, 0); width: 9.39523%; height: 57px;" valign="top">200</td><td style="border-color: rgb(0, 0, 0); width: 26.327885%; height: 57px;">[Response Object Description](https://adocolumbia.ado-tech.com/documentation/ServiciosRest.html#line2_6)</td><td style="border-color: rgb(0, 0, 0); width: 64.276885%; height: 57px;" valign="top">JSON-formatted object containing the information of the queried transaction.</td></tr><tr style="height: 29px;"><td style="border-color: rgb(0, 0, 0); width: 9.39523%; height: 29px;">500</td><td style="border-color: rgb(0, 0, 0); width: 26.327885%; height: 29px;"> </td><td style="border-color: rgb(0, 0, 0); width: 64.276885%; height: 29px;">An error has occurred, please check the error and try again.</td></tr></tbody></table>

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.

<table border="1" class="align-center" id="bkmrk-name-findbynumberid-" style="border-collapse: collapse; width: 47.283951%; height: 103px; border: 1px solid rgb(0, 0, 0);"><tbody><tr style="height: 29px;"><th style="border-color: rgb(0, 0, 0); width: 17.008872%; height: 29px;">**Name**</th><th style="border-color: rgb(0, 0, 0); width: 82.991128%; height: 29px;">**FindByNumberId**</th></tr><tr style="height: 45px;"><td style="border-color: rgb(0, 0, 0); width: 17.008872%; height: 45px;">URL</td><td style="border-color: rgb(0, 0, 0); width: 82.991128%; height: 45px;">{URL\_Base}/api/{ProjectName}/FindByNumberId</td></tr><tr style="height: 29px;"><td style="border-color: rgb(0, 0, 0); width: 17.008872%; height: 29px;">TYPE</td><td class="align-center" style="border-color: rgb(0, 0, 0); width: 82.991128%; height: 29px;">GET</td></tr></tbody></table>

<table border="1" id="bkmrk-parameters-name-data-1" style="border-collapse: collapse; border-color: rgb(0, 0, 0); border-style: solid;"><caption>**PARAMETERS**</caption><tbody><tr><th style="border-color: rgb(0, 0, 0);">**Name**</th><th style="border-color: rgb(0, 0, 0);">**Data Type**</th><th style="border-color: rgb(0, 0, 0);">**Parameter Type**</th><th style="border-color: rgb(0, 0, 0);">**Required**</th><th style="border-color: rgb(0, 0, 0);">**Description**</th></tr><tr><td style="border-color: rgb(0, 0, 0);">ProjectName</td><td style="border-color: rgb(0, 0, 0);">String</td><td style="border-color: rgb(0, 0, 0);">Path</td><td style="border-color: rgb(0, 0, 0);">Yes</td><td style="border-color: rgb(0, 0, 0);">The assigned project name</td></tr><tr><td style="border-color: rgb(0, 0, 0);">apiKey</td><td style="border-color: rgb(0, 0, 0);">String</td><td style="border-color: rgb(0, 0, 0);">Header</td><td style="border-color: rgb(0, 0, 0);">Yes</td><td style="border-color: rgb(0, 0, 0);">The key assigned to the project</td></tr><tr><td style="border-color: rgb(0, 0, 0);">identification</td><td style="border-color: rgb(0, 0, 0);">String</td><td style="border-color: rgb(0, 0, 0);">query</td><td style="border-color: rgb(0, 0, 0);">Yes</td><td style="border-color: rgb(0, 0, 0);">The customer's identification number</td></tr><tr><td style="border-color: rgb(0, 0, 0);">docType</td><td style="border-color: rgb(0, 0, 0);">String</td><td style="border-color: rgb(0, 0, 0);">query</td><td style="border-color: rgb(0, 0, 0);">Yes</td><td style="border-color: rgb(0, 0, 0);">Document type to be queried</td></tr><tr><td style="border-color: rgb(0, 0, 0);">returnImages</td><td style="border-color: rgb(0, 0, 0);">Boolean</td><td style="border-color: rgb(0, 0, 0);">query</td><td style="border-color: rgb(0, 0, 0);">Yes</td><td style="border-color: rgb(0, 0, 0);">Determines whether the images of the transaction will be returned.</td></tr><tr><td style="border-color: rgb(0, 0, 0);">Authorization</td><td style="border-color: rgb(0, 0, 0);">string</td><td style="border-color: rgb(0, 0, 0);">header</td><td style="border-color: rgb(0, 0, 0);">No</td><td style="border-color: rgb(0, 0, 0);">Access token</td></tr></tbody></table>

<table border="1" id="bkmrk-responses-code-respo-1" style="border-collapse: collapse; border-color: rgb(0, 0, 0); border-style: solid; width: 100%;"><caption>**RESPONSES**</caption><tbody><tr><th style="border-color: rgb(0, 0, 0); width: 8.527827%;">**Code**</th><th style="border-color: rgb(0, 0, 0); width: 33.499367%;">**Response**</th><th style="border-color: rgb(0, 0, 0); width: 57.972806%;">**Description**</th></tr><tr><td style="border-color: rgb(0, 0, 0); width: 8.527827%;">401</td><td style="border-color: rgb(0, 0, 0); width: 33.499367%;">ApiKey or Project or DocType not valid</td><td style="border-color: rgb(0, 0, 0); width: 57.972806%;">The ApiKey, ProjectName, or DocType parameter is incorrect.</td></tr><tr><td style="border-color: rgb(0, 0, 0); width: 8.527827%;">404</td><td style="border-color: rgb(0, 0, 0); width: 33.499367%;">Client not found.</td><td style="border-color: rgb(0, 0, 0); width: 57.972806%;">There are no records for the pair of document type and number.</td></tr><tr><td style="border-color: rgb(0, 0, 0); width: 8.527827%;" valign="top">200</td><td style="border-color: rgb(0, 0, 0); width: 33.499367%;">{  
 **"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"  
}</td><td style="border-color: rgb(0, 0, 0); width: 57.972806%;" valign="top">JSON-formatted object containing the information of the queried transaction.</td></tr></tbody></table>

The Images field displays ImageTypeId and ImageTypeName, which are described in 'RESPONSE DICTIONARY IMAGES'.

### FINDBYNUMBERIDSUCCESS  


Endpoint that returns the most recent case with a rating of 'Satisfactory Process', which corresponds to code 2, for the queried document.

<table border="1" id="bkmrk-nombre-findbynumberi" style="border-collapse: collapse; border-color: rgb(0, 0, 0); border-style: solid;"><tbody><tr><th style="border-color: rgb(0, 0, 0);">Name</th><th style="border-color: rgb(0, 0, 0);">FindByNumberIdSuccess</th></tr><tr><td style="border-color: rgb(0, 0, 0);">URL</td><td style="border-color: rgb(0, 0, 0);">{URL\_Base}/api/{ProjectName}/FindByNumberIdSuccess</td></tr><tr><td style="border-color: rgb(0, 0, 0);">TYPE</td><td class="align-center" style="border-color: rgb(0, 0, 0);">GET</td></tr></tbody></table>

<table border="1" id="bkmrk-parameters-name-data-2" style="border-collapse: collapse; border-color: rgb(0, 0, 0); border-style: solid; width: 100%; height: 490px;"><caption>**PARAMETERS**</caption><tbody><tr style="height: 61px;"><th style="width: 13.597033%; height: 61px; border-color: rgb(0, 0, 0);">Name</th><th style="width: 10.012361%; height: 61px; border-color: rgb(0, 0, 0);">Data Type</th><th style="width: 17.428925%; height: 61px; border-color: rgb(0, 0, 0);">Parameter Type</th><th style="width: 10.383189%; height: 61px; border-color: rgb(0, 0, 0);">Required</th><th style="width: 48.578492%; height: 61px; border-color: rgb(0, 0, 0);">Description</th></tr><tr style="height: 61px;"><td style="width: 13.597033%; height: 61px; border-color: rgb(0, 0, 0);">ProjectName</td><td style="width: 10.012361%; height: 61px; border-color: rgb(0, 0, 0);">String</td><td style="width: 17.428925%; height: 61px; border-color: rgb(0, 0, 0);">Path</td><td style="width: 10.383189%; height: 61px; border-color: rgb(0, 0, 0);">Yes</td><td style="width: 48.578492%; height: 61px; border-color: rgb(0, 0, 0);">The assigned project name

</td></tr><tr style="height: 45px;"><td style="width: 13.597033%; height: 45px; border-color: rgb(0, 0, 0);">apiKey</td><td style="width: 10.012361%; height: 45px; border-color: rgb(0, 0, 0);">String</td><td style="width: 17.428925%; height: 45px; border-color: rgb(0, 0, 0);">Header</td><td style="width: 10.383189%; height: 45px; border-color: rgb(0, 0, 0);">Yes</td><td style="width: 48.578492%; height: 45px; border-color: rgb(0, 0, 0);">The key assigned to the project

</td></tr><tr style="height: 61px;"><td style="width: 13.597033%; height: 61px; border-color: rgb(0, 0, 0);">identification</td><td style="width: 10.012361%; height: 61px; border-color: rgb(0, 0, 0);">String</td><td style="width: 17.428925%; height: 61px; border-color: rgb(0, 0, 0);">query</td><td style="width: 10.383189%; height: 61px; border-color: rgb(0, 0, 0);">Yes</td><td style="width: 48.578492%; height: 61px; border-color: rgb(0, 0, 0);">The client's identification number

</td></tr><tr style="height: 61px;"><td style="width: 13.597033%; height: 61px; border-color: rgb(0, 0, 0);">doctype</td><td style="width: 10.012361%; height: 61px; border-color: rgb(0, 0, 0);">Integer ($int32)</td><td style="width: 17.428925%; height: 61px; border-color: rgb(0, 0, 0);">query</td><td style="width: 10.383189%; height: 61px; border-color: rgb(0, 0, 0);">Yes</td><td style="width: 48.578492%; height: 61px; border-color: rgb(0, 0, 0);">The type of document to be queried

</td></tr><tr style="height: 61px;"><td style="width: 13.597033%; height: 61px; border-color: rgb(0, 0, 0);">returnImages</td><td style="width: 10.012361%; height: 61px; border-color: rgb(0, 0, 0);">Boolean</td><td style="width: 17.428925%; height: 61px; border-color: rgb(0, 0, 0);">query</td><td style="width: 10.383189%; height: 61px; border-color: rgb(0, 0, 0);">Yes</td><td style="width: 48.578492%; height: 61px; border-color: rgb(0, 0, 0);">Indicates whether the transaction images will be returned

</td></tr><tr style="height: 61px;"><td style="width: 13.597033%; height: 61px; border-color: rgb(0, 0, 0);">Authorization</td><td style="width: 10.012361%; height: 61px; border-color: rgb(0, 0, 0);">string</td><td style="width: 17.428925%; height: 61px; border-color: rgb(0, 0, 0);">header</td><td style="width: 10.383189%; height: 61px; border-color: rgb(0, 0, 0);">No</td><td style="width: 48.578492%; height: 61px; border-color: rgb(0, 0, 0);">Access token

</td></tr><tr style="height: 79px;"><td style="width: 13.597033%; height: 79px; border-color: rgb(0, 0, 0);">Enrol</td><td style="width: 10.012361%; height: 79px; border-color: rgb(0, 0, 0);">Boolean</td><td style="width: 17.428925%; height: 79px; border-color: rgb(0, 0, 0);">query</td><td style="width: 10.383189%; height: 79px; border-color: rgb(0, 0, 0);">No</td><td style="width: 48.578492%; height: 79px; border-color: rgb(0, 0, 0);">This parameter indicates whether the process will be queried with enrollment or not; this depends on the site configuration and whether enrollment is enabled

</td></tr></tbody></table>

<table border="1" id="bkmrk-responses-code-respo-2" style="width: 100%; border-collapse: collapse; border-color: rgb(0, 0, 0); border-style: solid;"><caption>**RESPONSES**</caption><tbody><tr><th style="width: 8.15822%; border-color: rgb(0, 0, 0);">Code</th><th style="width: 58.961681%; border-color: rgb(0, 0, 0);">Response</th><th style="width: 32.880099%; border-color: rgb(0, 0, 0);">Description</th></tr><tr><td style="width: 8.15822%; border-color: rgb(0, 0, 0);">400</td><td style="width: 58.961681%; border-color: rgb(0, 0, 0);">Error description message: The type of document is not valid</td><td style="width: 32.880099%; border-color: rgb(0, 0, 0);">There is an error in the submitted model or the document type provided is not found</td></tr><tr><td style="width: 8.15822%; border-color: rgb(0, 0, 0);">401</td><td style="width: 58.961681%; border-color: rgb(0, 0, 0);">The api key value is required Authorization is required to use this method</td><td style="width: 32.880099%; border-color: rgb(0, 0, 0);">The 'apiKey' parameter is missing or the 'projectName-apiKey' combination is not valid</td></tr><tr><td style="width: 8.15822%; border-color: rgb(0, 0, 0);">404</td><td style="width: 58.961681%; border-color: rgb(0, 0, 0);">The specified project was not found</td><td style="width: 32.880099%; border-color: rgb(0, 0, 0);">The submitted 'projectName' was not found, or no transaction was found with the provided data</td></tr><tr><td style="width: 8.15822%; border-color: rgb(0, 0, 0);" valign="top">200</td><td style="width: 58.961681%; border-color: rgb(0, 0, 0);">[![Screenshot 2025-06-12 at 15-55-53 ADO TECNOLOGIES Manuales Tecnicos.png](https://docs.ado-tech.com/uploads/images/gallery/2025-06/scaled-1680-/y7kBGXMS3SyD2kU0-screenshot-2025-06-12-at-15-55-53-ado-tecnologies-manuales-tecnicos.png)](https://docs.ado-tech.com/uploads/images/gallery/2025-06/y7kBGXMS3SyD2kU0-screenshot-2025-06-12-at-15-55-53-ado-tecnologies-manuales-tecnicos.png)<div><div class="syntaxhighlighter  javascript" id="bkmrk--6"></div></div></td><td style="width: 32.880099%; border-color: rgb(0, 0, 0);" valign="top">A JSON-formatted object containing the information of the queried transaction</td></tr></tbody></table>

The 'Images' field displays 'ImageTypeId' and 'ImageTypeName', which are described in the 'Images Response Dictionary'

### IDENTIFICATIONTYPES

GET web service that returns all identification types defined in the application

<table border="1" class="align-center" id="bkmrk-name-findbynumberid--1" style="border-collapse: collapse; border: 1px solid rgb(0, 0, 0);"><tbody><tr><th style="border-color: rgb(0, 0, 0);">**Name**</th><th style="border-color: rgb(0, 0, 0);">**FindByNumberId**</th></tr><tr><td style="border-color: rgb(0, 0, 0);">URL</td><td style="border-color: rgb(0, 0, 0);">{URL\_Base}/api/{ProjectName}/IdentificationTypes</td></tr><tr><td style="border-color: rgb(0, 0, 0);">TYPE</td><td class="align-center" style="border-color: rgb(0, 0, 0);">GET</td></tr></tbody></table>

<table border="1" class="align-center" id="bkmrk-parameters-name-data-3" style="border-collapse: collapse; border-color: rgb(0, 0, 0); border-style: solid;"><caption>**PARAMETERS**</caption><tbody><tr><th style="border-color: rgb(0, 0, 0);">**Name**</th><th style="border-color: rgb(0, 0, 0);">**Data Type**</th><th style="border-color: rgb(0, 0, 0);">**Parameter Type**</th><th style="border-color: rgb(0, 0, 0);">**Required**</th><th style="border-color: rgb(0, 0, 0);">**Description**</th></tr><tr><td style="border-color: rgb(0, 0, 0);">ProjectName</td><td style="border-color: rgb(0, 0, 0);">String</td><td style="border-color: rgb(0, 0, 0);">Path</td><td style="border-color: rgb(0, 0, 0);">Yes</td><td style="border-color: rgb(0, 0, 0);">The assigned project name</td></tr><tr><td style="border-color: rgb(0, 0, 0);">apiKey</td><td style="border-color: rgb(0, 0, 0);">String</td><td style="border-color: rgb(0, 0, 0);">Header</td><td style="border-color: rgb(0, 0, 0);">Yes</td><td style="border-color: rgb(0, 0, 0);">The key assigned to the project</td></tr><tr><td style="border-color: rgb(0, 0, 0);">Authorization</td><td style="border-color: rgb(0, 0, 0);">string</td><td style="border-color: rgb(0, 0, 0);">Header</td><td style="border-color: rgb(0, 0, 0);">No</td><td style="border-color: rgb(0, 0, 0);">Access token</td></tr></tbody></table>

<table border="1" class="align-center" id="bkmrk-responses-code-respo-3" style="border-collapse: collapse; border-color: rgb(0, 0, 0); border-style: solid; width: 98.518519%; height: 170px;"><caption>**RESPONSES**</caption><tbody><tr style="height: 29px;"><th style="border-color: rgb(0, 0, 0); width: 7.150876%; height: 29px;">**Code**</th><th style="border-color: rgb(0, 0, 0); width: 31.243101%; height: 29px;">**Response**</th><th style="border-color: rgb(0, 0, 0); width: 61.606023%; height: 29px;">**Description**</th></tr><tr style="height: 141px;"><td style="border-color: rgb(0, 0, 0); width: 7.150876%; height: 141px;">200</td><td style="border-color: rgb(0, 0, 0); width: 31.243101%; height: 141px;">{  
 **"Id"**: int,  
 **"IdentitificationName"**: "String",  
 **"Active"**: boolean,  
 **"Locked"**: boolean,  
 **"ActiveDescription"**: "String",  
 **"LockedDescription"**: "String"  
}</td><td style="border-color: rgb(0, 0, 0); width: 61.606023%; height: 141px;">JSON-formatted object containing the information of the queried transaction.</td></tr></tbody></table>

The document type ID can be found in 'DOCUMENT DICTIONARY'.

## TEMPLATES

GET web service that returns the templates by enrolled identification in the application.

<table border="1" class="align-center" id="bkmrk-name-templates-url-%7B" style="width: 115.802469%; height: 89px; border-collapse: collapse; border-color: rgb(0, 0, 0); border-style: solid;"><tbody><tr style="height: 29px;"><th style="width: 16.115108%; height: 29px; border-color: rgb(0, 0, 0);">Name</th><th style="width: 83.884892%; height: 29px; border-color: rgb(0, 0, 0);">Templates</th></tr><tr style="height: 29px;"><td style="width: 16.115108%; height: 29px; border-color: rgb(0, 0, 0);">URL</td><td style="width: 83.884892%; height: 29px; border-color: rgb(0, 0, 0);">{URL\_Base}/api/{ProjectName}/Templates</td></tr><tr style="height: 29px;"><td style="width: 16.115108%; height: 29px; border-color: rgb(0, 0, 0);">TYPE</td><td class="align-center" style="width: 83.884892%; height: 29px; border-color: rgb(0, 0, 0);">GET</td></tr></tbody></table>

<table border="1" class="align-center" id="bkmrk-parameters-name-data-4" style="border-collapse: collapse; border-color: rgb(0, 0, 0); border-style: solid;"><caption>**PARAMETERS**</caption><tbody><tr><th style="border-color: rgb(0, 0, 0);">**Name**</th><th style="border-color: rgb(0, 0, 0);">**Data Type**</th><th style="border-color: rgb(0, 0, 0);">**Parameter Type**</th><th style="border-color: rgb(0, 0, 0);">**Required**</th><th style="border-color: rgb(0, 0, 0);">**Description**</th></tr><tr><td style="border-color: rgb(0, 0, 0);">ProjectName</td><td style="border-color: rgb(0, 0, 0);">String</td><td style="border-color: rgb(0, 0, 0);">Path</td><td style="border-color: rgb(0, 0, 0);">Yes</td><td style="border-color: rgb(0, 0, 0);">The assigned project name</td></tr><tr><td style="border-color: rgb(0, 0, 0);">apiKey</td><td style="border-color: rgb(0, 0, 0);">String</td><td style="border-color: rgb(0, 0, 0);">Header</td><td style="border-color: rgb(0, 0, 0);">Yes</td><td style="border-color: rgb(0, 0, 0);">The key assigned to the project</td></tr><tr><td style="border-color: rgb(0, 0, 0);">DocumentType</td><td style="border-color: rgb(0, 0, 0);">Integer</td><td style="border-color: rgb(0, 0, 0);">Query</td><td style="border-color: rgb(0, 0, 0);">Yes</td><td style="border-color: rgb(0, 0, 0);">Number of the registered document type in the platform.</td></tr><tr><td style="border-color: rgb(0, 0, 0);">IdentificationNumber</td><td style="border-color: rgb(0, 0, 0);">String</td><td style="border-color: rgb(0, 0, 0);">Query</td><td style="border-color: rgb(0, 0, 0);">Yes</td><td style="border-color: rgb(0, 0, 0);">Identification number</td></tr><tr><td style="border-color: rgb(0, 0, 0);">Authorization</td><td style="border-color: rgb(0, 0, 0);">string</td><td style="border-color: rgb(0, 0, 0);">Header</td><td style="border-color: rgb(0, 0, 0);">No</td><td style="border-color: rgb(0, 0, 0);">Access token.</td></tr></tbody></table>

<table border="1" class="align-center" id="bkmrk-responses-code-respo-4" style="border-collapse: collapse; border-color: rgb(0, 0, 0); border-style: solid; width: 100%;"><caption>**RESPONSES**</caption><tbody><tr><th style="border-color: rgb(0, 0, 0); width: 8.157152%;">**Code**</th><th style="border-color: rgb(0, 0, 0); width: 32.881167%;">**Response**</th><th style="border-color: rgb(0, 0, 0); width: 58.961681%;">**Description**</th></tr><tr><td style="border-color: rgb(0, 0, 0); width: 8.157152%;">200</td><td style="border-color: rgb(0, 0, 0); width: 32.881167%;">{  
 **IdentificationTypeId**: Integer,  
 **IdentificationType**: "String",  
 **IdentificationNumber**: "String",  
 **FirstName**: "String",  
 **SecondName**: "String",  
 **FirstSurname**: "String",  
 **SecondSurname**: "String",  
 **Gender**: "String",  
 **Templates**: \[  
 **TemplateType**: "String",  
 **Template**: "String",  
 \]  
}</td><td style="border-color: rgb(0, 0, 0); width: 58.961681%;">JSON-formatted object containing the information of the queried transaction.</td></tr><tr><td style="border-color: rgb(0, 0, 0); width: 8.157152%;">401</td><td style="border-color: rgb(0, 0, 0); width: 32.881167%;">ApiKey or Project or Authorization not valid</td><td style="border-color: rgb(0, 0, 0); width: 58.961681%;">The ApiKey, ProjectName, or Authorization field is incorrect.</td></tr><tr><td style="border-color: rgb(0, 0, 0); width: 8.157152%;">404</td><td style="border-color: rgb(0, 0, 0); width: 32.881167%;">Customer not Found</td><td style="border-color: rgb(0, 0, 0); width: 58.961681%;">Identification number not enrolled in the platform.</td></tr></tbody></table>

The TemplateType field has two options: 'FaceTemplate,' which corresponds to the enrolled face template, and 'FingerTemplate,' which corresponds to the fingerprint template that is enrolled when fingerprint reading applies.

## RISKCLASIFICATION

GET web service that returns the risk levels per configured transaction.

<table border="1" class="align-center" id="bkmrk-name-templates-url-%7B-1" style="border-collapse: collapse; border-color: rgb(0, 0, 0); border-style: solid; width: 49.506173%;"><tbody><tr><th style="border-color: rgb(0, 0, 0); width: 17.25%;">**Name**</th><th style="border-color: rgb(0, 0, 0); width: 82.75%;">**Templates**</th></tr><tr><td style="border-color: rgb(0, 0, 0); width: 17.25%;">URL</td><td style="border-color: rgb(0, 0, 0); width: 82.75%;">{URL\_Base}/api/Integration/GetRiskClassification</td></tr><tr><td style="border-color: rgb(0, 0, 0); width: 17.25%;">TYPE</td><td style="border-color: rgb(0, 0, 0); width: 82.75%;">GET</td></tr></tbody></table>

<table border="1" class="align-center" id="bkmrk-responses-code-respo-5" style="border-collapse: collapse; border-color: rgb(0, 0, 0); border-style: solid; width: 100%; height: 201px;"><caption>**RESPONSES**</caption><tbody><tr style="height: 45px;"><th style="border-color: rgb(0, 0, 0); width: 7.540173%; height: 45px;">**Code**</th><th style="border-color: rgb(0, 0, 0); width: 10.505425%; height: 45px;">**Response**</th><th style="border-color: rgb(0, 0, 0); width: 81.954402%; height: 45px;">**Description**</th></tr><tr style="height: 156px;"><td style="border-color: rgb(0, 0, 0); width: 7.540173%; height: 156px;">200</td><td style="border-color: rgb(0, 0, 0); width: 10.505425%; height: 156px;">{  
 **Id**: Int,  
 **From**: Int,  
 **To**: Int  
}</td><td style="border-color: rgb(0, 0, 0); width: 81.954402%; height: 156px;">"JSON-formatted object containing the information of the configured risk levels. Each risk level includes the following three parameters.</td></tr></tbody></table>

This would be an example of how risk levels could be configured in the platform. Intervals cannot overlap; each new ID must respect the value of X+1.

<table border="1" class="align-center" id="bkmrk-risk-levels-id-from-" style="border-collapse: collapse; border-color: rgb(0, 0, 0); border-style: solid; width: 107.407407%; height: 168px;"><caption>**Risk Levels**</caption><tbody><tr><th style="border-color: rgb(0, 0, 0); width: 12.608158%;">**Id**</th><th style="border-color: rgb(0, 0, 0); width: 41.779975%;">**From**</th><th style="border-color: rgb(0, 0, 0); width: 45.488257%;">**To**</th></tr><tr><td style="border-color: rgb(0, 0, 0); width: 12.608158%;">1</td><td style="border-color: rgb(0, 0, 0); width: 41.779975%;">$0</td><td style="border-color: rgb(0, 0, 0); width: 45.488257%;">$1.000.000</td></tr><tr><td style="border-color: rgb(0, 0, 0); width: 12.608158%;">2</td><td style="border-color: rgb(0, 0, 0); width: 41.779975%;">$1.000.001</td><td style="border-color: rgb(0, 0, 0); width: 45.488257%;">$15.000.000</td></tr><tr><td style="border-color: rgb(0, 0, 0); width: 12.608158%;">3</td><td style="border-color: rgb(0, 0, 0); width: 41.779975%;">$15.000.001</td><td style="border-color: rgb(0, 0, 0); width: 45.488257%;">$50.000.000</td></tr><tr><td style="border-color: rgb(0, 0, 0); width: 12.608158%;">4</td><td style="border-color: rgb(0, 0, 0); width: 41.779975%;">$50.000.001</td><td style="border-color: rgb(0, 0, 0); width: 45.488257%;">$100.000.000</td></tr></tbody></table>

# POST Services

### GET TOKEN

This service should only be consumed when OAuth is active in the application. It generates a token to consume the other services.

<div class="col-md-22" id="bkmrk-parameters-parameter"><table border="1" style="border-collapse: collapse; border-color: rgb(0, 0, 0); border-style: solid; width: 100%;"><caption>**PARAMETERS**</caption><tbody><tr><th style="border-color: rgb(0, 0, 0); width: 13.349815%;">**PARAMETER**<span class="Apple-tab-span" style="white-space: pre;"> </span></th><th style="border-color: rgb(0, 0, 0); width: 8.776267%;">**TYPE**</th><th style="border-color: rgb(0, 0, 0); width: 10.876101%;">**MEDIUM**</th><th style="border-color: rgb(0, 0, 0); width: 66.997818%;">**DESCRIPTION**</th></tr><tr><td style="border-color: rgb(0, 0, 0); width: 13.349815%;">**grant\_type**</td><td style="border-color: rgb(0, 0, 0); width: 8.776267%;">String</td><td style="border-color: rgb(0, 0, 0); width: 10.876101%;">FormData</td><td class="align-center" style="border-color: rgb(0, 0, 0); width: 66.997818%;">Type of Authorization</td></tr><tr><td style="border-color: rgb(0, 0, 0); width: 13.349815%;">**username**</td><td style="border-color: rgb(0, 0, 0); width: 8.776267%;">String</td><td style="border-color: rgb(0, 0, 0); width: 10.876101%;">FormData</td><td class="align-center" style="border-color: rgb(0, 0, 0); width: 66.997818%;">Username assigned by Ado for the token query.</td></tr><tr><td style="border-color: rgb(0, 0, 0); width: 13.349815%;">**password**</td><td style="border-color: rgb(0, 0, 0); width: 8.776267%;">String</td><td style="border-color: rgb(0, 0, 0); width: 10.876101%;">FormData</td><td class="align-center" style="border-color: rgb(0, 0, 0); width: 66.997818%;">Password corresponding to the assigned user for the token query, must be in SHA-1 hash format.</td></tr></tbody></table>

  
</div>**Example consumption:**

<div class="col-md-22" id="bkmrk-1-curl--x-post-%22http"><div><div class="syntaxhighlighter  javascript" id="bkmrk-1-curl--x-post-%22http-1"><table border="1" cellpadding="0" cellspacing="0" style="border-collapse: collapse; border-width: 1px; border-spacing: 0px; background-color: rgb(52, 73, 94); border-style: solid;"><tbody><tr><td class="gutter" style="border-width: 1px;"><div class="line number1 index0 alt2"><span style="color: rgb(126, 140, 141);">1</span></div></td><td class="code" style="border-width: 1px;"><div class="container"><div class="line number1 index0 alt2">`<span style="color: rgb(149, 165, 166);">curl -X POST</span> `<span style="color: rgb(22, 145, 121);">`"<a href="http://localhost:62859/api/token" style="color: rgb(22, 145, 121);">http://localhost:62859/api/token</a>"`</span> <span style="color: rgb(149, 165, 166);">`-H `</span><span style="color: rgb(22, 145, 121);">`"accept: application/json"`</span> <span style="color: rgb(149, 165, 166);">`-H `</span><span style="color: rgb(22, 145, 121);">`"Content-Type: application/x-www-form-urlencoded"`</span> <span style="color: rgb(149, 165, 166);">`-d `</span><span style="color: rgb(22, 145, 121);">`"grant_type=password&username=username&password=sha1password"`</span></div></div></td></tr></tbody></table>

</div></div>  
<table border="1" style="width: 83.82716%; border-collapse: collapse; border-color: rgb(0, 0, 0); border-style: solid; height: 119px;"><caption>**RESPONSES**</caption><tbody><tr style="height: 29px;"><th style="width: 10.617514%; border-color: rgb(0, 0, 0); height: 29px;">**Code**</th><th style="width: 89.382486%; border-color: rgb(0, 0, 0); height: 29px;">**Description**</th></tr><tr style="height: 45px;"><td style="width: 10.617514%; border-color: rgb(0, 0, 0); height: 45px;">200</td><td style="width: 89.382486%; border-color: rgb(0, 0, 0); height: 45px;">JSON object containing the token and other fields described in the RESPONSE FIELDS table</td></tr><tr style="height: 45px;"><td style="width: 10.617514%; border-color: rgb(0, 0, 0); height: 45px;">400</td><td style="width: 89.382486%; border-color: rgb(0, 0, 0); height: 45px;">unsupported\_grant\_type  
The user name or password is incorrect.  
</td></tr></tbody></table>

  
<table border="1" id="bkmrk-campos-respuesta%3A-no" style="border-collapse: collapse; border-color: rgb(0, 0, 0); border-style: solid;"><caption>**RESPONSE FIELDS:**</caption><tbody><tr><th style="border-color: rgb(0, 0, 0);">**Field Name**</th><th style="border-color: rgb(0, 0, 0);">**TYPE**</th><th style="border-color: rgb(0, 0, 0);">**DESCRIPTION**</th></tr><tr><td style="border-color: rgb(0, 0, 0);">**access\_token**</td><td style="border-color: rgb(0, 0, 0);">String</td><td style="border-color: rgb(0, 0, 0);">El token emitido.</td></tr><tr><td style="border-color: rgb(0, 0, 0);">**token\_type**</td><td style="border-color: rgb(0, 0, 0);">String</td><td style="border-color: rgb(0, 0, 0);">Tipo de token generado.</td></tr><tr><td style="border-color: rgb(0, 0, 0);">**expires\_in**</td><td style="border-color: rgb(0, 0, 0);">Int</td><td style="border-color: rgb(0, 0, 0);">Tiempo de vigencia del token en minutos.</td></tr><tr><td style="border-color: rgb(0, 0, 0);">**issued**</td><td style="border-color: rgb(0, 0, 0);">String</td><td style="border-color: rgb(0, 0, 0);">Fecha y hora de emisión de emisión del token.</td></tr><tr><td style="border-color: rgb(0, 0, 0);">**expires**</td><td style="border-color: rgb(0, 0, 0);">String</td><td style="border-color: rgb(0, 0, 0);">Fecha y hora de vencimiento del token.</td></tr></tbody></table>

</div>**Example response:**

<div class="col-md-22" id="bkmrk-1-2-3-4-5-6-7-%7B-%C2%A0%C2%A0%C2%A0%C2%A0"><div><div class="syntaxhighlighter  javascript" id="bkmrk-1-2-3-4-5-6-7-%7B-%C2%A0%C2%A0%C2%A0%C2%A0-1"><table border="1" cellpadding="0" cellspacing="0" style="border-collapse: collapse; border-spacing: 0px; width: 100%; background-color: rgb(52, 73, 94); height: 157px; border: 1px solid rgb(0, 0, 0);"><tbody><tr style="height: 157px;"><td class="gutter" style="border-color: rgb(0, 0, 0); width: 3.213844%; border-width: 1px; height: 157px;"><div class="line number1 index0 alt2"><span style="color: rgb(126, 140, 141);">1</span></div><div class="line number2 index1 alt1 highlighted"><span style="color: rgb(126, 140, 141);">2</span></div><div class="line number3 index2 alt2"><span style="color: rgb(126, 140, 141);">3</span></div><div class="line number4 index3 alt1 highlighted"><span style="color: rgb(126, 140, 141);">4</span></div><div class="line number5 index4 alt2"><span style="color: rgb(126, 140, 141);">5</span></div><div class="line number6 index5 alt1"><span style="color: rgb(126, 140, 141);">6</span></div><div class="line number7 index6 alt2"><span style="color: rgb(126, 140, 141);">7</span></div></td><td class="code" style="border-color: rgb(0, 0, 0); width: 96.786156%; border-width: 1px; height: 157px;"><div class="container"><div class="line number1 index0 alt2"><span style="color: rgb(149, 165, 166);">`{`</span></div><div class="line number2 index1 alt1 highlighted">`    `<span style="color: rgb(22, 145, 121);">`"access_token"`</span>`<span style="color: rgb(149, 165, 166);">: </span>`<span style="color: rgb(22, 145, 121);">`"laK8SdjrKUAN7ja4SicUS-mL8eNWW74OTU2ZmSzjABLCGUgZknEifQkNtd5F20pBQiWvDpVwda9Bf31hB-mnzJLWmuKYY1sygHT37RQGI3Ym1HkLHwduutHwze2m9ZSBWCSV9NgOjO5Zd0Rcl9eexjFOS7cR6lOIZxxu31rLI_mHMbgtdSMAG-gToiHkgeXw6zbYjVaO1IzKMDjczyLZuvlYOfKNiJeh-3XbfjRxUy0"`</span>`<span style="color: rgb(149, 165, 166);">,</span>`</div><div class="line number3 index2 alt2">`    `<span style="color: rgb(22, 145, 121);">`"token_type"`</span>`<span style="color: rgb(149, 165, 166);">:</span> `<span style="color: rgb(22, 145, 121);">`"bearer"`</span><span style="color: rgb(149, 165, 166);">`,`</span></div><div class="line number4 index3 alt1 highlighted">`    `<span style="color: rgb(22, 145, 121);">`"expires_in"`</span>`<span style="color: rgb(149, 165, 166);">:</span> <span style="color: rgb(149, 165, 166);">59,</span>`</div><div class="line number5 index4 alt2">`    ``<span style="color: rgb(22, 145, 121);">".issued"</span>``<span style="color: rgb(149, 165, 166);">:</span> `<span style="color: rgb(22, 145, 121);">`"Mon, 27 Jul 2020 20:38:24 GMT"`</span><span style="color: rgb(149, 165, 166);">`,`</span></div><div class="line number6 index5 alt1">`    `<span style="color: rgb(22, 145, 121);">`".expires"`</span>`<span style="color: rgb(149, 165, 166);">:</span> `<span style="color: rgb(22, 145, 121);">`"Mon, 27 Jul 2020 20:39:24 GMT"`</span></div><div class="line number7 index6 alt2"><span style="color: rgb(149, 165, 166);">`}`</span></div></div></td></tr></tbody></table>

</div></div></div>