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.

Example consumption:

Example response:

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: Citizenship ID (Cédula de Ciudadanía) PEP with passport only Foreigner ID (Cédula de Extranjería) 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: Citizenship ID PEP with passport only Foreigner ID 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	FechaExpiration dedate expiraciónof dethe cedulanational enID rutinascard quein hacenroutines consultathat delquery registroEcuador’s civil deregistry, ecuador,only unicamentewhen cuandothe elservice serviciois estaactive activoto pararetrieve traerthis estainformation. información.This Estefield campouses esthe enYYYY-MM-DD formatoformat, AAAA-MM-DD,ignoring ignorarthe la hora.time.
DateOfDeath	String	DateOfDeath.
MarriageDate	String	MarriageDate.
Instruction	String
PlaceBirth	String	LugarPlace deof nacimientobirth delof clientethe verificado.verified client
Nationality	String	NacionalidadNationality delof clientethe verificado.verified client
MotherName	String	NombreMother's dename laof madrethe delverified cliente verificado.client
FatherName	String	NombreFather's delname padreof delthe clienteverified verificado.client
HouseNumber	String
Profession	String	ProfesiónOccupation delof clientethe verificado.verified client
ExpeditionCity	String	ExpeditionCity.
ExpeditionDepartment	String	ExpeditionDepartment.
BirthCity	String	BirthCity.
BirthDepartment	String	BirthDepartment.
TransactionType	int	TipoType deof transaccióntransaction realizada.performed
TransactionTypeName	String	NombreName delof tipothe detype transacciónof realizada.transaction performed
IssueDate	String	FechaIssuance dedate expediciónof delthe documentodocument presentadopresented porby elthe clienteverified verificadoclient enin formatoYYYY-MM-DD AAAA-MM-DD,format, ignorarignoring lathe hora.time
BarcodeText	String
OcrTextSideOne	String	TextoText extraídoextracted defrom lathe tomadocument decapture documentos porby OCR (carafront delanteraside delof documento).the document)
OcrTextSideTwo	String	TextoText extraídoextracted defrom lathe tomadocument decapture documentos porby OCR (caraback posteriorside delof documento).the document)
SideOneWrongAttempts	int	NumeroNumber deof intentosfailed fallidosattempts tomandocapturing lathe carafront delanteraside delof documento.the document
SideTwoWrongAttempts	int	NumeroNumber deof intentosfailed fallidosattempts tomandocapturing lathe caraback psoteriorside delof documento.the document
FoundOnAdoAlert	String	RetornaReturns una booleanoboolean indicandoindicating siwhether huboalerts alertasoccurred enon lathe plataformaADO de ADO.platform
AdoProjectId	String	NúmeroProject delnumber proyectoin enthe laADO plataforma de ADO.platform
TransactionId	String	NumeroTransaction denumber lafor transacciónthe paraclient's la certificación del cliente.certification
ProductId	String	NumeroProduct denumber productofor parathe laverified transacciónclient’s del cliente verificado.transaction
ComparationFacesSuccesful	boolean	RetornaReturns una booleanoboolean indicandoindicating siwhether lathe comparaciónface decomparison rostroswas fue satisfactoria.successful
FaceFound	boolean	RetornaReturns una booleanoboolean indicandoindicating siwhether sea encontróface unwas rostrodetected duranteduring lathe transacción.transaction
FaceDocumentFrontFound	boolean	RetornaReturns una booleanoboolean indicandoindicating siwhether sea encontróface unwas rostrofound enin elthe documentodocument deduring lathe transacción.transaction
BarcodeFound	boolean	RetornaReturns una booleanoboolean indicandoindicating siwhether sea encontróbarcode unwas códigodetected deduring barrasthe durante la transacción.transaction
ResultComparationFaces	int	ResultadoFace decomparison la comparación de rostros.result
ResultCompareDocumentFaces	int	ResultadoFace decomparison laresult comparaciónbetween dedocument rostros en los documentos.images
ComparationFacesAproved	boolean	RetornaReturns una booleanoboolean indicandoindicating siwhether lathe comparaciónface decomparison rostroswas fue aprobada.approved
ThresholdCompareDocumentFaces	int	RetornaReturns unan enterointeger conrepresenting elthe umbralconfigured decomparison comparación configurado .threshold
CompareFacesDocumentResult	string	CompareFacesDocumentResult.
"extras”: {
IdState	String	NumeroRating denumber calificaciónfor parathe la transacción.transaction
StateName	String	CalificaciónTransaction de la transacción.rating
}
NumberPhone	String	NúmeroPhone denumber teléfonoof delthe clienteverified verificado.client
CodFingerprint	String
ResultQRCode	String
DactilarCode	String
ResponseControlList	String
Latitude	String	Latitude
Longitude	String	Longitude
"Images" : [{
Id	String	NúmeroImage deidentifier identificación de la imagen.number
ImageTypeId	String	IdImage deltype tipo de imagen.ID
ImageTypeName	String	NombreImage deltype tipo de imagen.name
Image	String	ImagenBase64 en base64.image
DownloadCode	String	CódigoImage dedownload descarga de la imagen.code
}],
SignedDocuments	String Array	ArregloArray concontaining lathe listalist deof documentosdigitally firmadossigned digitalmente,documents. estosThese documentosdocuments seare retornanreturned enin baseBase64 64,format paraand sumust visualizaciónbe seconverted debeto convertirPDF afor PDF.viewing.
"Scores" : [{
Id	int	IdRating de la calificación.ID
UserName	String
StateName	String	NombreRating de la calificación.name
StartingDate	String	FechaDate yand horatime enwhen quetransmission seto empezóthe aserver transmitirbegan alfor servidor,the lafirst primeraimage imagenrequired requeridain parathe realizarvalidation el proceso de validación.process
Observation	String	ObservacionesComments sobreor laobservations transacción.about the transaction
}]
"Response_ANI": {
Niup	String	NúmeroIdentification denumber identificaciónof delthe clienteclient consultadoconsulted enin ANI.the ANI
FirstSurname	String	PrimerFirst apellidosurname delof clientethe consultadoclient enconsulted ANI.in the ANI
Particula	String
SecondSurname	String	SegundoSecond apellidosurname delfrom documentothe consultadodocument enconsulted ANI.in the ANI
FirstName	String	PrimerFirst nombrename delof documentothe consultadodocument enconsulted in ANI.
SecondName	String	SegundoMiddle nombrename delof documentothe consultadodocument enconsulted in ANI.
ExpeditionMunicipality	String	MunicipioMunicipality deof expediciónissuance delof documentothe consultadodocument enconsulted in ANI.
ExpeditionDepartment	String	DepartamentoDepartment deof expediciónissuance delof documentothe consultadodocument enconsulted in ANI.
ExpeditionDate	String	FechaDate deof expediciónissuance delof documentothe consultadodocument enconsulted in ANI.
CedulaState	String
}
Parameters	String	ParámetrosParameters enviadossent porby elthe clienteclient asociadosassociated awith lathe transaccióntransaction (FormatoJSON Json)format).
StateSignatureDocument	String	IndicarIndicate siwhether sethe handocuments firmadoassociated digitalmentewith losthe documentostransaction asociadoshave abeen ladigitally transacción.signed.
}