Skip to main content

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.

PARAMETERS
PARAMETER TYPE MEDIUM DESCRIPTION
grant_type String FormData Type of Authorization
username String FormData Username assigned by Ado for the token query.
password String FormData Password corresponding to the assigned user for the token query, must be in SHA-1 hash format.

Example consumption:

1
curl -X POST "http://localhost:62859/api/token" -H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "grant_type=password&username=username&password=sha1password"

RESPONSES
Code Description
200 JSON object containing the token and other fields described in the RESPONSE FIELDS table
400 unsupported_grant_type
The user name or password is incorrect.

RESPONSE FIELDS:
Field Name TYPE DESCRIPTION
access_token String El token emitido.
token_type String Tipo de token generado.
expires_in Int Tiempo de vigencia del token en minutos.
issued String Fecha y hora de emisión de emisión del token.
expires String Fecha y hora de vencimiento del token.

Example response:

1
2
3
4
5
6
7
{
    "access_token": "laK8SdjrKUAN7ja4SicUS-mL8eNWW74OTU2ZmSzjABLCGUgZknEifQkNtd5F20pBQiWvDpVwda9Bf31hB-mnzJLWmuKYY1sygHT37RQGI3Ym1HkLHwduutHwze2m9ZSBWCSV9NgOjO5Zd0Rcl9eexjFOS7cR6lOIZxxu31rLI_mHMbgtdSMAG-gToiHkgeXw6zbYjVaO1IzKMDjczyLZuvlYOfKNiJeh-3XbfjRxUy0",
    "token_type": "bearer",
    "expires_in": 59,
    ".issued": "Mon, 27 Jul 2020 20:38:24 GMT",
    ".expires": "Mon, 27 Jul 2020 20:39:24 GMT"
}

NEW

Sending a selfie to the server

Name New
Url {URL_Base}/api/integration/{projectName}/Validation/New
TYPE POST


PARAMETERS
Name Data Type Parameter Type Required Description
ProjectName String Query Yes The name of the associated project.
Apikey String Header Yes The key assigned to the project.
Authorization String Header No Access token.
transactionInfo Json Body Yes The data of the new transaction.


Specification of the transactionInfo field

Name Type Required Description
ProductId Int Yes Product number for the verified customer transaction.
CustomerPhoto String Yes Base64-encoded selfie image
DocumentType String No Document type ID, obtained by consuming the IDENTIFICATIONTYPES service. If it is not provided in the request, the default value assigned is Cédula de ciudadanía (ID 1).
Longitude String No Longitude of the location where the process takes place.
Latitude String No Latitude of the location where the process takes place.
IdAssociated String No Co-signer’s identification number
ClientRole String No Assigned role number for the platform
KeyProcessLiveness String No Liveness process key received during the selfie capture process
UIdDevice String No Character string that defines and identifies the device from which the request is made
IdUser String No ID registered on the ADO platform for the user making the service request
SourceDevice Integer No Number that identifies the type of device: 1 for Web, 2 for Android, and 3 for iOS.
SdkVersion string No Build or SDK version number being used, which can be found in the repository's ChangeLog.
OS string No Type of operating system from which the service is being consumed
BrowserVersion string No If the OS field is set to Web, the browser version used is sent.
IMEI string No IMEI of the mobile device consuming the service
RiskId string No Risk classification ID
Uid String No Transaction identification number. If this is the first service call, the service will return a UID that must be sent in all subsequent service requests until the Close service is executed. If a UID already exists, it must be included to associate the uploaded images with the same transaction.


RESPONSES
Code Description
200 The transaction has been successfully initiated. An object is returned containing information associated with it.
201 The face being validated is already enrolled. An object is returned containing information about the created transaction, including the unique transaction number.
400 The type of document not is valid

The risk ID is not valid

The risk ID is not valid 

The risk ID must be an integer

Document type is not active
401 The api key value is required
Api Key not valid
Can't found User with specified credentials
Can't found specified Source Device
404 The specified project was not found
406 The facial photograph does not meet the expected criteria. This may be due to the face in the image having glasses, an open mouth, or a blink..
Base64 not valid.
Image not valid.
500 An error has occurred. Please check the error and try again.

DOCUMENTBACKSIDE

Allows uploading the back side of an identity document.

Name DocumentBackSide
Url {URL_Base}api/integration/{projectName}/
Validation/Images/DocumentBackSide
TYPE POST


PARAMETERS
Name Data Type Parameter Type Required Description
ProjectName String Query Yes The name of the associated project
Apikey String Header Yes The key assigned to the project
Authorization String Header No Access token
sideTwoInfo Json Body Yes The data of the new transaction


Specification of the sideTwoInfo field

Name Type Required Description
Image String Yes Image of the back side of the document in Base64 format
DocumentType String No Document type ID, obtained by consuming the IDENTIFICATIONTYPES service. If this field is not provided, the system will default to assigning “Cédula de ciudadanía” (ID 1) as the document type.
UIdDevice String No String that defines and identifies the device from which the request is made.
SourceDevice Integer No Number that identifies the device type, with values of 1 for Web, 2 for Android, and 3 for iOS.
SdkVersion string No Build or SDK version number being used, which can be found in the repository's ChangeLog.
OS string No Type of operating system from which the service is being consumed
BrowserVersion string No If the OS field is set to Web, the browser version used is sent.
TransactionType string No Transaction type ID
ProductId string No Product number for the transaction
Uid String No Transaction identification number. If this is the first time the service is consumed, it will return a UID that must be sent in all subsequent service calls until the Close service is executed. If a UID already exists, it must be included to associate the uploaded images with the same transaction.
RiskId String No Risk classification ID


RESPONSES
Code Description
200 The transaction has been successfully initiated. An object containing information associated with it is returned. RESPONSE OBJECT DESCRIPTION
201 The client was previously registered. An object is returned containing information about the created transaction, including the unique transaction number.
400 The type of document not is valid
The specified transaction type was not found
Transaction type Id must be a valid integer
Document type is not active
Sdk Versión is not valid
401 The api key value is required
Api Key not valid
Can't found User with specified credentials
Can't found specified Source Device
404 The specified project was not found
406 Base64 not valid.
Image not valid.
500 An error has occurred. Please validate the error and try again.

FINGERPRINT

Allows uploading the fingerprint image

Name Fingerprint
Url {URL_Base}api/integration/{projectName}/
Validation/Images/Fingerprint
TYPE POST


PARAMETERS
Name Data Type Parameter Type Required Description
ProjectName String Query Yes The name of the associated project
Apikey String Header Yes The key assigned to the project
Authorization String Header No Access token
fingerInfo Json Body Yes The image encoded in Base64


Specification of the fingerInfo field

Name Type Required Description
Image String Yes Image of the front of the document in Base64 format
DocumentType String Yes

Document Type Number:

  1. Citizenship ID (Cédula de Ciudadanía)

  2. PEP with passport only

  3. Foreigner ID (Cédula de Extranjería)

  4. Identity Card (Tarjeta de Identidad)
FingerType int Yes Fingerprint enumerator, possible values: (1, 2)
Uid String Yes Transaction identification number. If this is the first time the service is consumed, it will return a UID that must be sent in all subsequent service calls until the Close service is executed. If a UID already exists, it must be included to link the uploaded images to the same transaction.
RiskId String No Risk identifier


RESPONSES
Code Description
200 The fingerprint has been successfully uploaded and the transaction information has been updated.
400 The provided data does not match the expected criteria
401 The authorization process was not successful. Please validate the project code and/or the API Key.
403 The fingerprint photograph is not valid for biometric extraction.
404 The project code and/or the specified UID does not exist.
500 An error has occurred. Please validate the provided ID number to obtain more details.

CLOSE

Allows finalizing the current transaction. Assigns a unique transaction number

Name Close
Url {URL_Base}/api/Integration/{projectName}/Validation/Close
TYPE POST


PARAMETERS
Name Data Type Parameter Type Required Description
ProjectName String Query Yes The name of the associated project
Apikey String Header Yes The key assigned to the project
Authorization String Header No Access token
info Json Body Yes The information required to close the transaction


Specification of the info field

Name Type Required Description
Uid String Yes Transaction UID
RiskId String No Risk classification ID


RESPONSES
Code Description
200 The transaction has been successfully created. An object containing information associated with it is returned — RESPONSE OBJECT DESCRIPTION
400 The risk ID is not valid
The risk ID must be an integer.
401 The api key value is required
Api Key not valid
404 The specified project was not found<404>
500 An error has occurred. Please check the error and try again.

CHECKHEALTH

POST web service that returns the overall status of the platform. If everything is functioning correctly, the Messagefield in the response will have the value “Alive.”

Name CheckHealt
URL {URL_Base}/api/Integration/CheckHealt
TYPE POST


PARAMETERS
Name Data Type Parameter Type Required Description
ProjectName String query Yes The name of the associated project
apiKey String header Yes The key assigned to the project
authorization String header Yes Access token


RESPONSES
Code Response Description
200 {
"Code": "String",
"Message": "String"
}		 JSON-formatted object containing information related to the platform status

DESCRIPTION OF THE RESPONSE OBJECT


Name Type Description
{
Uid String Transaction identification number
StartingDate String Date and time when the first required image for the validation process began transmitting to the server.
CreationDate String Date and time when the full set of images required for the validation process finished transmitting to the server.
CreationIP String IP address from which the identity validation process was performed
DocumentType Int

Document Type Number:

  1. Citizenship ID

  2. PEP with passport only

  3. Foreigner ID

  4. Identity Card
IdNumber int Identification number of the validated client
FirstName String First name of the verified client
SecondName String Second name of the verified client
FirstSurname String First surname of the verified client
SecondSurname String Second surname of the verified client
Gender String Gender of the verified client
BirthDate String Date of birth of the verified client in YYYY-MM-DD format, ignoring the time
Street String Address of the verified client
CedulateCondition String  
Spouse String  
Home String  
MaritalStatus String Marital status of the verified client
DateOfIdentification String Expiration date of the national ID card in routines that query Ecuador’s civil registry, only when the service is active to retrieve this information. This field uses the YYYY-MM-DD format, ignoring the time.
DateOfDeath String DateOfDeath.
MarriageDate String MarriageDate.
Instruction String  
PlaceBirth String Place of birth of the verified client
Nationality String Nationality of the verified client
MotherName String Mother's name of the verified client
FatherName String Father's name of the verified client
HouseNumber String  
Profession String Occupation of the verified client
ExpeditionCity String ExpeditionCity.
ExpeditionDepartment String ExpeditionDepartment.
BirthCity String BirthCity.
BirthDepartment String BirthDepartment.
TransactionType int Type of transaction performed
TransactionTypeName String Name of the type of transaction performed
IssueDate String Issuance date of the document presented by the verified client in YYYY-MM-DD format, ignoring the time
BarcodeText String  
OcrTextSideOne String Text extracted from the document capture by OCR (front side of the document)
OcrTextSideTwo String Text extracted from the document capture by OCR (back side of the document)
SideOneWrongAttempts int Number of failed attempts capturing the front side of the document
SideTwoWrongAttempts int Number of failed attempts capturing the back side of the document
FoundOnAdoAlert String Returns a boolean indicating whether alerts occurred on the ADO platform
AdoProjectId String Project number in the ADO platform
TransactionId String Transaction number for the client's certification
ProductId String Product number for the verified client’s transaction
ComparationFacesSuccesful boolean Returns a boolean indicating whether the face comparison was successful
FaceFound boolean Returns a boolean indicating whether a face was detected during the transaction
FaceDocumentFrontFound boolean Returns a boolean indicating whether a face was found in the document during the transaction
BarcodeFound boolean Returns a boolean indicating whether a barcode was detected during the transaction
ResultComparationFaces int Face comparison result
ResultCompareDocumentFaces int Face comparison result between document images
ComparationFacesAproved boolean Returns a boolean indicating whether the face comparison was approved
ThresholdCompareDocumentFaces int Returns an integer representing the configured comparison threshold
CompareFacesDocumentResult string CompareFacesDocumentResult.
"extras”: {  
IdState String Rating number for the transaction
StateName String Transaction rating
}  
NumberPhone String Phone number of the verified client
CodFingerprint String  
ResultQRCode String  
DactilarCode String  
ResponseControlList String  
Latitude String Latitude
Longitude String Longitude
"Images" : [{  
Id String Image identifier number
ImageTypeId String Image type ID
ImageTypeName String Image type name
Image String Base64 image
DownloadCode String Image download code
}],  
SignedDocuments String Array Array containing the list of digitally signed documents. These documents are returned in Base64 format and must be converted to PDF for viewing.
"Scores" : [{  
Id int Rating ID
UserName String  
StateName String Rating name
StartingDate String Date and time when transmission to the server began for the first image required in the validation process
Observation String Comments or observations about the transaction
}]  
"Response_ANI": {  
Niup String Identification number of the client consulted in the ANI
FirstSurname String First surname of the client consulted in the ANI
Particula String  
SecondSurname String Second surname from the document consulted in the ANI
FirstName String First name of the document consulted in ANI.
SecondName String Middle name of the document consulted in ANI.
ExpeditionMunicipality String Municipality of issuance of the document consulted in ANI.
ExpeditionDepartment String Department of issuance of the document consulted in ANI.
ExpeditionDate String Date of issuance of the document consulted in ANI.
CedulaState String  
}  
Parameters String Parameters sent by the client associated with the transaction (JSON format).
StateSignatureDocument String Indicate whether the documents associated with the transaction have been digitally signed.
}

GETFACIALFEATURES

Service responsible for extracting facial features and a face template; these features may include whether the user is wearing glasses, has their eyes closed, and other characteristics to be described below.

Name GetFacialFeatures
URL {URL_Base}/api/GetFacialFeatures
TYPE POST

PARAMETERS
Name Data Type Parameter Type Required Description
ProjectName String Query Yes The name of the associated project.
Apikey String Header Yes The key assigned to the project.
request Json Body Yes JSON format of the information required to consume the service.

Description of the REQUEST field

Field Name Data Type Required Description
Image String Yes Facial image in Base64 format
GetFeatures Boolean Yes Specifies whether to retrieve the features of the submitted image
GetTemplete Boolean Yes Specifies whether to retrieve the template of the submitted face


For the service to respond correctly, at least one of the fields in the request parameter—either GetFeatures or GetTemplate—must be set to true; otherwise, the response will be 400



SERVICE RESPONSES
Code Description
200 Process executed successfully:The request was received by the server. The response, in JSON format, is described below.
400 Data error, check the request data: los dos valores de los campos GetFeatures y GetTemplete son False.
500 Internal server error: Internal server error.

JSON Response Object
Code Response
200 {
 "Status": "SUCCESS",
 "Message": "string",
 "Response": {
    "lstResults":[
     {
      "BoundingRect_X": 0,
      "BoundingRect_Y": 0,
      "BoundingRect_Width": 0,
      "BoundingRect_Height": 0,
      "FeaturePoints": [
         {
           "Point_X": 0,
           "Point_Y": 0,
           "Confidence": 0,
           "Code": 0,
            "Name": "string"
         }
      ],
      "Age": 0,
      "Gender": "string",
      "GenderConfidence": 0,
      "Expression": "string",
      "ExpressionConfidence": 0,
      "Blink": true,
      "BlinkConfidence": 0,
      "MouthOpen": true,
      "MouthOpenConfidence": 0,
      "Glasses": true,
      "GlassesConfidence": 0,
      "DarkGlasses": true,
      "DarkGlassesConfidence": 0,
      "EmotionAngerConfidence": 0,
      "EmotionContemptConfidence": 0,
      "EmotionDisgustConfidence": 0,
      "EmotionFearConfidence": 0,
      "EmotionHappinessConfidence": 0,
      "EmotionNeutralConfidence": 0,
      "EmotionSadnessConfidence": 0,
      "EmotionSurpriseConfidence": 0,
      "EthnicityAsianConfidence": 0,
      "EthnicityBlackConfidence": 0,
      "EthnicityHispanicConfidence": 0,
      "EthnicityIndianConfidence": 0,
      "EthnicityWhiteConfidence": 0,
      "Template": "string"
     }
    ]
 },
 "data": {}
}


The Status field may return code 6, which corresponds to NO TEMPLATE. This means that the service was unable to obtain a facial template from the submitted image.



Example of service response.

Json Code Success
{
 "Status": 1,
 "Message": null,
 "Response": {
    "lstResults":[
     {
      "BoundingRect_X": 101,
      "BoundingRect_Y": 22,
      "BoundingRect_Width": 105,
      "BoundingRect_Height": 142,
      "FeaturePoints": [
         {
           "Point_X": 179,
           "Point_Y": 179,
           "Confidence": 98,
           "Code": 449,
            "Name": "LeftEyeCenter"
         }
      ],
      "Age": 23,
      "Gender": "Female",
      "GenderConfidence": 76,
      "Expression": "Unknown",
      "ExpressionConfidence": 24,
      "Blink": false,
      "BlinkConfidence": 77,
      "MouthOpen": false,
      "MouthOpenConfidence": 60,
      "Glasses": false,
      "GlassesConfidence": 30,
      "DarkGlasses": false,
      "DarkGlassesConfidence": 34,
      "EmotionAngerConfidence": 0,
      "EmotionContemptConfidence": 69,
      "EmotionDisgustConfidence": 0,
      "EmotionFearConfidence": 0,
      "EmotionHappinessConfidence": 12,
      "EmotionNeutralConfidence": 19,
      "EmotionSadnessConfidence": 0,
      "EmotionSurpriseConfidence": 0,
      "EthnicityAsianConfidence": 12,
      "EthnicityBlackConfidence": 4,
      "EthnicityHispanicConfidence": 2,
      "EthnicityIndianConfidence": 8,
      "EthnicityWhiteConfidence": 73,
      "Template": "String del templete"
     }
    ]
 },
 "data": null
}		 1
{
 "Status": 6,
 "Message": "FACE_NOT_FOUND",
 "Response": null,
 "data": null
}		 6

CUSTOMER VERIFICATION

This service must be consumed when the FindByNumberIdSuccess service returns a JSON response indicating a successful process and the verification method must be executed. This service records the transaction and requires the following parameters.

Name CustomerVerification
URL {URL_Base}/api/CustomerVerification
TYPE POST

PARAMETERS
Name Data Type Parameter Type Required Description
ProjectName String Query Yes The name of the associated project.
ApiKey String Header Yes The key assigned to the project.
Data Json Body Yes JSON format of the information required to consume the service.

Specification of the Data field.

Name Type Yes Description
DocumentType String No Document type ID.
IdentificationNumber String Yes Identification number.
Face String Yes Base64-encoded image to be verified.
FingerPrint String No Base64-encoded fingerprint image to be verified.
longitude String No Location coordinate.
Latitude String No Location coordinate.
ProductId Integer No Product ID corresponding to the verification process.
KeyProcessLiveness String No Liveness process key returned after capturing the selfie.
SourceDevice Integer No ID of the device from which the process is being carried out.
SdkVersion String No Version of the SDK being used.
OS String No Operating system version.
BrowserVersion String No Browser version being used.
UIdDevice String No Character string that defines and identifies the device from which the request is made.
IdUser String No ID registered in the ADO platform of the user making the service request.
IMEI string No IMEI of the mobile device consuming the service.
RiskId string No Configured risk ID in the platform.

RESPONSES
Code Description
200 The transaction has been successfully created.
400 All fields are required.
Face not valid.
The type of document not is valid.
The risk ID is not valid.
The risk ID must be an integer.
401 The api key value is required
Authorization is required to use this method
Can't found specified Source Device
Can't found User with specified credentials
404 The specified project was not found
The specified product was not found
Customer not Found
406 The facial photograph does not meet the expected criteria; this may be due to the person wearing glasses, having an open mouth, or blinking.

RESPONSE
CODE RESPONSE DESCRIPTION
200 RESPONSE OBJECT DESCRIPTION JSON-formatted object containing the transaction information.

CREATESIGNDOCUMENTSTRANSACTION

Service that creates a digital signature transaction. This service requests basic client information and the documents to be signed, which must be PDF files converted to Base64 format. The required parameters are as follows:

   PARAMETERS
Name Data Type Parameter Type Required Description
Model Json Body Yes The information required to close the transaction.
projectName String Path Yes Project name.
apiKey String Header Yes Project API key.
Authorization String Header No Access token.

   PARAMETERS
Name Data Type Required Description
IdentificationType String Yes Identification type.
IdentificationNumber String Yes Identification number.
FirstName String Yes First name.
SecondName String No Middle name.
FirstSurname String Yes First surname.
SecondSurname String No Second surname.
Documents String Array Yes Array of PDF documents converted to Base64.

RESPONSE
CODE RESPONSE` DESCRIPTION
200
     "Uid": "string",
     "StartingDate": "string",
     "CreationDate": "string",
     "CreationIP": "string",
     "DocumentType": "string",
     "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",
     "ExpeditionCity": "string",
     "ExpeditionDepartment": "string",
     "BirthCity": "string",
     "BirthDepartment": "string",
     "TransactionType": 0,
     "TransactionTypeName": "string",
     "IssueDate": "string",
     "BarcodeText": "string",
     "OcrTextSideOne": "string",
     "OcrTextSideTwo": "string",
     "SideOneWrongAttempts": 0,
     "SideTwoWrongAttempts": 0,
     "FoundOnAdoAlert": false,
     "AdoProjectId": "string",
     "TransactionId": "int",
     "ProductId": "string",
     "ComparationFacesSuccesful": false,
     "FaceFound": false,
     "FaceDocumentFrontFound": false,
     "BarcodeFound": false,
     "ResultComparationFaces": 0,
     "ComparationFacesAproved": false,
     "Extras":{
          "IdState": "string",
          "StateName": "Pendiente"
     },
     "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 transaction information. For more details, see the section RESPONSE OBJECT DESCRIPTION.

This service returns the status as ‘Pending’ for the transaction. This indicates that the signing process has started. Twenty seconds later, the signed documents can be retrieved using the GET/Validation service.

SEARCH ONE TO MANY

Service that allows us to determine whether a user is enrolled based on their facial template.

PARAMETERS
Name Data Type Parameter Type Required Description
transactionInfo Json Body Yes The information required to close the transaction.
projectName String Path Yes Project name.
apiKey String Header Yes Project API key.
Authorization String Header No Access token.
PARAMETERS
Name Data Type Required Description
ProductId Int Yes Product type.
CustomerPhoto String Base64 Yes Person’s facial image in Base64 format.
DocumentType Int Yes Document Type


RESPONSE
CODE RESPONSE DESCRIPTION
200
     "Uid": "string",
     "StartingDate": "string",
     "CreationDate": "string",
     "CreationIP": "string",
     "DocumentType": "string",
     "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",
     "ExpeditionCity": "string",
     "ExpeditionDepartment": "string",
     "BirthCity": "string",
     "BirthDepartment": "string",
     "TransactionType": 0,
     "TransactionTypeName": "string",
     "IssueDate": "string",
     "BarcodeText": "string",
     "OcrTextSideOne": "string",
     "OcrTextSideTwo": "string",
     "SideOneWrongAttempts": 0,
     "SideTwoWrongAttempts": 0,
     "FoundOnAdoAlert": false,
     "AdoProjectId": "string",
     "TransactionId": "int",
     "ProductId": "string",
     "ComparationFacesSuccesful": false,
     "FaceFound": false,
     "FaceDocumentFrontFound": false,
     "BarcodeFound": false,
     "ResultComparationFaces": 0,
     "ComparationFacesAproved": false,
     "Extras":{
          "IdState": "string",
          "StateName": "Pendiente"
     },
     "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 transaction information. For more information, see the section RESPONSE OBJECT DESCRIPTION.
404 Enroll not found No prior enrollment has been found for this face.

RESULTED RETORS

At the end of any of the invocations mentioned above and provided that the end user has finished with all the images requested, client will receive in his CallBack URL a JSON object with the following structure

Answer
CODE Answer DESCRIPTION
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",
"ExpeditionCity": "string",
"ExpeditionDepartment": "string",
"BirthCity": "string",
"BirthDepartment": "string",
"TransactionType" : 0,
"TransactionTypeName": "string,"
"IssueDate": "string",
"BarcodeText": "string,"
"OcrTextSideOne": "string,"
"OcrTextSideTwo": "string,"
"SideOneWrongAttempts" . 0,
"SideTwoWrongAttempts" . 0,
"FoundOnAdoAlert" . . . . . . .
"AdoProjectId": "string,"
"TransactionId""TransactionId": "string",
"ProductId": "string",
"ComparationFacesSuccesful" : false,
"FaceFound" : false,
"FaceDocumentFrontFound" : false,
"BarcodeFound" : false,
"ResultComparationFaces" : 0,
"ComparationFacesGearn" : false,
"Extras".
"IdState": "string",
"StateName": "string"
- - Oh,
"NumberPhone": "string",
"CodFingerprint": "string",
"ResultQRCode": "string,"
"DactilarCode": "string",
"ResponseControlList" : "string,"
"Images" :[ . . . . . . . . . . . .
"Id": int,
"ImageTypeId": "String",
"ImageTypeName": "String",
"Image": "Image base 64,"
],
"Signed Documents" : ["String"],
"Scores" :[ . . . . . . . . . . . .
"Id": 0,
"StateName": "string,"
"StartingDate": "string",
"Observation": "string"
],
"Parameters": "String",
"StateSignature": "String"
*		 JSON format object with transaction information.

If the agreed return mechanism is GET, the result of the process will come with a concatenity chain to the CallBack URL, in case the agreed response mechanism is POST, it will be returned as a JSON Object to URL-CallBack, which must be able to digest that object.

FIELDS ARRAY "EXTRAS"

NAME TYPE DESCRIPTION
IdState String Indicates in number the result of the transaction based on the dictionary shown below.
State String Indicates in text the outcome of the transaction based on the dictionary above below.


Responses can be validated in "Answer DICCIONARY".

CAMPOS OBJECT "RESPONSE ANI"
NAME TYPE DESCRIPTION
Niup String Unique personal identification number. Cedula of Citizenship of persons with Colombian nationality.
FirstSurname String First surname of the document consulted, it returns empty if it does not contain any data.
Particle String  
SecondSurname String Second surname of the document consulted, it returns empty if it does not contain any data.
First String First Name of the document consulted, it returns empty if it does not contain any data.
Second String Second Name of the document consulted, it returns empty if it does not contain any data.
ExpeditionMunicipality String Municipality where the document was issued, it returns empty if it does not contain any data.
ExpeditionDepartment String Department where the document was issued, it returns empty if it does not contain any information.
ExpeditionDate String Date on which the document was issued, it returns empty if it does not contain any data.
Cedula State String Status in which the ballot is located (review code tables for more information).

RESPONSE CONTROL LIST’ OBJECT FIELDS

As agreed at the NSA, control lists will be consulted or not. If the consultation is contracted and agreed, it can be carried out by the following search parameters:

  1. Search by Name.
  2. Search by Name and Document Number.
  3. Search by Document Number.

Examples return consultation

  1. If a search will be done by name = RODRIGUEZ OREJUELA we will obtain a total of 12 records, starting by which they most resemble the searched text.
  2. If we search by name=RODRIGUEZ OREJUELA and Document Number=6068015 we will get a single record.
  3. If we search for the document number: 6068015 we will get a single record.

Example value within the JSON:
ResponseControlList: When serializing this object can be interpreted as follows:
Case 1: Response to consultation of a single person Unrealized

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
{
    "datetime": "2021-04-14 09:23:37",
    "id_bitacora": 783286,
    "results": [
        {
            "item_no": 2,
            "nombre": "rodriguez orejuela",
            "doc_id": "6068015",
            "block": true,
            "datos_pro": null,
            "datos_ramajudicial": null,
            "datos_amlnews": [],
            "datos_tsti": [
                {
                    "lista": [
                        "2776"
                    ],
                    "estado": null,
                    "categoria": [
                        "SDNT"
                    ],
                    "nombre_apellido": [
                        "RODRIGUEZ OREJUELA, Gilberto Jose"
                    ],
                    "pasaporte2": [
                        "10545599, 77588, 6067015, T321642"
                    ],
                    "url": "http://bit.ly/1MLgpye ,http://bit.ly/1I7ipyR",
                    "detalle": [
                        "Specially Designated Nationals (SDN) - Treasury Department"
                    ],
                    "pasaporte": [
                        "10545599, 77588, 6067015, T321642"
                    ],
                    "n_identificacion2": [
                        "6067015, 6068015"
                    ],
                    "ciudadania": [
                        ""
                    ],
                    "alias": [
                        "THE CHESS PLAYER, LUCAS"
                    ],
                    "id": "1733370",
                    "n_identificacion": [
                        "6067015, 6068015"
                    ],
                    "nombre_relacion_lista": [
                        "BIS"
                    ],
                    "id_relacion_lista": [
                        "352"
                    ],
                    "_version_": 1696964922198458368,
                    "estado1": null,
                    "estado2": null,
                    "estado3": null,
                    "relacionado": "[]"
                },
                {
                    "lista": [
                        "3765"
                    ],
                    "estado": null,
                    "categoria": [
                        "SDNT"
                    ],
                    "nombre_apellido": [
                        "Gilberto Jose RODRIGUEZ OREJUELA"
                    ],
                    "pasaporte2": [
                        "Passport 10545599 Venezuela, Passport 77588 Argentina, Passport 6067015 Comoros, Passport T321642 Colombia"
                    ],
                    "pais": [
                        "Colombia"
                    ],
                    "detalle": [
                        "Individual"
                    ],
                    "pasaporte": [
                        "Passport 10545599 Venezuela, Passport 77588 Argentina, Passport 6067015 Comoros, Passport T321642 Colombia"
                    ],
                    "n_identificacion2": [
                        "Cedula No. 6067015 Colombia, Cedula No. 6068015 Colombia"
                    ],
                    "alias": [
                        " THE CHESS PLAYER,  LUCAS"
                    ],
                    "id": "1757445",
                    "n_identificacion": [
                        "Cedula No. 6067015 Colombia, Cedula No. 6068015 Colombia"
                    ],
                    "nombre_relacion_lista": [
                        "OFAC List"
                    ],
                    "id_relacion_lista": [
                        "180"
                    ],
                    "_version_": 1696965283939352576,
                    "estado1": null,
                    "estado2": null,
                    "estado3": null,
                    "relacionado": "[]"
                },
                {
                    "lista": [
                        "3765"
                    ],
                    "estado": null,
                    "categoria": [
                        "SDNT"
                    ],
                    "nombre_apellido": [
                        "Miguel Angel RODRIGUEZ OREJUELA"
                    ],
                    "pais": [
                        "Colombia"
                    ],
                    "detalle": [
                        "Individual"
                    ],
                    "n_identificacion2": [
                        "Cedula No. 6095803 Colombia"
                    ],
                    "alias": [
                        " EL SENOR,  PATRICIA,  PATRICIO,  PATTY,  PAT,  MANUEL,  MANOLO,  MIKE,  MAURO,  DOCTOR M.R.O."
                    ],
                    "id": "1757446",
                    "n_identificacion": [
                        "Cedula No. 6095803 Colombia"
                    ],
                    "nombre_relacion_lista": [
                        "OFAC List"
                    ],
                    "id_relacion_lista": [
                        "180"
                    ],
                    "_version_": 1696965283939352577,
                    "estado1": null,
                    "estado2": null,
                    "estado3": null,
                    "relacionado": "[]"
                }
            ],
            "datos_twitter": []
        }
    ],
    "elapsed_time": 2.3528490066528
}

 

Inside the "data-tsti" field, all the control lists on which the search made match are completed.

OBSERVATIONS: The output matrix contains the following data:

  1. datetime: Date and time of execution of the operation.
  2. results: It is an array or list of objects representing the "(s) result(s) of the persons(() consulted(s). For each person an object, separated by commas is defined from each other, with three fields:
    • item-no: Registration identification sequence.
    • Docc?id: Identification number of the person consulted.
    • block: Variable boolean. A value true The person was found on some prohibitive list.
  3. Time: Time in seconds that the consultation lasted.


LISTS DEL SYSTEM
The following are all the lists that are reported in the system to date, is It is important to clarify that the OFAC (restric) list is in line with code 3765.

Code Name
9963 Supersociety Restructuring Agreements
1381 AFRICAN BANK
5349 National Mining Agency RUCOM.
5666 Aml.News Argentina
1313 Aml.News Chile
3875 Aml.News Colombia
8458 Aml.News Costa Rica
4573 Aml-News Dominica
5899 Aml.News Ecuador
7661 Aml.News El Salvador
4491 Aml.News Spain
8561 Aml.News United States
6844 Aml.News Guatemala
9515 Aml.News Honduras
9194 Aml.News Mexico
9726 Aml-News Nicaragua
4297 Aml.News Panama
1189 Aml-News Paraguay
9534 Aml.News Peru
2889 Aml-News R. Dominica
3356 Aml-News Venezuela
4144 ASIAN BANK Anti-corruption and Integrity
4454 AUSTRALIAN FOREING AFFAIRS
2955 Bahamas leaks
9745 Inter-American Development Bank (IDB)
2375 World Bank
8391 Banks sanctioned Panama
5362 Newsletter Spanish Civil Guard
6242 DEA tickets
2487 Boletines Colombia Attorney's Office
2776 Bureau of Industry and Security BIS
6967 Concordets Supersocieties
8315 Comptroller of Peru
5694 Contractors 2015 and 2016 Mayor of Bogotá
9851 Construction contractors Mayor of Bogotá
3754 Contractors sanctioned Panama
5228 Liquidated or in Voluntary Liquidation Superhealth
1871 Illegal financial exercise Superfinanciera financial activity
4936 Companies in Supersolidary Voluntary Liquidation
1627 Entities in SuperHealth Restructuring Agreement
1976 Entities in Measure Cautellar Special Surveillance Superhealth
8573 Liquidated Superhealth Entities
2637 European Bank for Reconstruction and Development
8454 European List
3766 Europol
5622 FBI Fugitives
8616 Chief Mayor of Bogotá
3241 Officials and Contractors Comptroller
3417 GREATER VICTORIA CRIME STOPPERS
8923 HM Treasury
4193 Immigration and Customs Eforcement ICE
7264 Interpol International Criminal Police Organization
7127 Adverse Interventions Administrative Superhealth
3889 Central Board of Accountants
3861 Judicial Liquidation Supersocieties
5778 Liquidated, Administrative Forzosa Superhealth
1692 Public Ministry Colombia
7594 Public Prosecutor's Office of Honduras
8495 Public ministry Peru
3765 OFAC List
4298 Offshore leakst
6622 Terrorist organizations designated by the United States
3113 OSFI
9279 Panama Papers
5668 Paradise Papers
5318 PEPS Antigua and Barbuda
5488 PPEPS Argentina
2489 PPEPS Bahamas
5747 PPEPS Barbados
2138 PPEPS Belize
6356 PPEPS Brazil
4259 PPEPS Canada
3192 PPEPS Chile
4223 PPEPS Colombia
7714 PPEPS Costa Rica
3523 PPEPS Ecuador
4366 PPEPS United States
6135 PPEPS Mexico
5929 PPEPS Nicaragua
3126 PPEPS Panama
1914 PPEPS Paraguay
6729 PPEPS Peru
8277 PPEPS Puerto Rico
1636 PPEPS Dominican Republic
2651 PPEPS Saint Lucia
6255 PPEPS Trinidad and Tobago
4671 PPEPS Uruguay
9861 PPEPS Venezuela
8971 Argentine police
8998 Puerto Rico National Police
6482 Postulates Law 975 Justice and Peace. Attorney General's Office
7416 Presidency of the Peruvian Council of Ministers
8737 Suppliers Fictitious DIAN Colombia
4734 Fiscal Managers Comptroller's Office
7828 Punishments COPNIA
1422 Penalties in Colombia's Financial Superintendency
8456 Sentences for unfair competition SIC
3982 Companies in Compulsory Liquidation
7978 THE UK POLICE

Example of Case by Name and Document Number

1
2
"ReponseControlList":
    {\"datetime\":\"2021-04-14 09:10:52\",\"id_bitacora\":783284,\"results\":[{\"item_no\":2,\"nombre\":\"DAVID DUARTE\",\"doc_id\":\"1070974525\",\"block\":false,\"datos_pro\":null,\"datos_ramajudicial\":null,\"datos_amlnews\":[],\"datos_tsti\":null,\"datos_twitter\":[{\"url\":\"https:\\/\\/twitter.com\\/i\\/web\\/status\\/1376299318034972680\",\"text\":\"\\\"Confié en un guionista y un director que saben mucho de cine y que además son hermanos: David y Fernando Trueba. Ellos hicieron que lo complejo pareciera fácil\\\": Héctor Abad habla del filme “El olvido que seremos”. https:\\/\\/t.co\\/E5QkAid1ne\",\"crimes\":\"[\\\"PERTURBACION\\\"]\",\"name_account\":\"elespectador\",\"name\":\"David\",\"date\":\"2021-03-28T22:25:02Z\"}]}],\"elapsed_time\":3.561439037323}
FLOWCHART FOR VALIDATING AGAINST THE CIVIL REGISTRY

image.png

Back to top