solución de Identificación & Servicios Biométricos
Manual |
Código
TE-MT-002 |
Versión:
3.3 |
|
Fecha emisión
06/10/2022 |
Titulo
Integración servicios REST |
||
Elaborado por:
Camilo García |
Revisado por:
Ingrid Mercado |
Aprobado por:
Oscar castañeda |
VERSIÓN | FECHA EMISIÓN | DESCRIPCIÓN DE CAMBIOS |
---|---|---|
3.2 | 6 de octubre de 2022 | Versionamiento del documento |
3.3 | 14 de octubre de 2022 | 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 |
Servicio web GET que permite consultar una transacción especificando el identificador único de la misma.
Nombre | Validation |
---|---|
URL | {URL_Base}/api/{ProjectName}/Validation/{id} |
TIPO | GET |
Nombre | Tipo Dato | Tipo Parámetro | Requerido | Descripción |
---|---|---|---|---|
ProjectName | String | Path | Si | El nombre de proyecto asignado |
apiKey | String | Header | Si | La llave asignada al proyecto |
id | Int | path | Si | El identificador unico de la transacción que se desea consultar |
returnImages | Boolean | query | Si | Determina si se retornan las imagenes en la consulta |
returnDocuments | boolean | header | Si | Parametro que destermina si se retorna o no documentos firmados. |
returnVideoLiveness | boolean | header | Si | Parametro que determina si se retornara o no el video de Liveness en base 64. |
Authorization | string | header | No | Token de acceso. |
Código | Respuesta | Descipción |
---|---|---|
401 |
client not authorized to make requests The api key value is required Authorization is required to use this method |
El parámetro ApiKey o ProjectName o el DocType no es correcto. |
404 |
The specified project was not found Transaction not found |
No existen registros para la dupla tipo y número de documento y la condición proceso satisfactorio. |
200 | DESCRIPCIÓN DEL OBJETO DE RESPUESTA | Objeto de formato JSON con la información de la transacción consultada. |
500 | Ha ocurrido un error, valide el error e intente de nuevo. |
El campo Images muestra ImageTypeId que se describen en "DICCIONARIO RESPUESTA IMAGES", en este mismo arreglo, se retorna el video de Liveness.
Servicio web GET que retorna el último caso para el cliente indicado.
Nombre | FindByNumberId |
---|---|
URL | {URL_Base}/api/{ProjectName}/FindByNumberId |
TIPO | GET |
Nombre | Tipo Dato | Tipo Parámetro | Requerido | Descripción |
---|---|---|---|---|
ProjectName | String | Path | Si | El nombre de proyecto asignado |
apiKey | String | Header | Si | La llave asignada al proyecto |
identification | String | query | Si | El inúmero de identificación del cliente |
docType | String | query | Si | Tipo de documento que se desea consultar |
returnImages | Boolean | query | Si | Determina si se retornarán las imagenes de la transacción |
Authorization | string | header | No | Token de acceso. |
Código | Respuesta | Descripción |
---|---|---|
401 | ApiKey or Project or DocType not valid | El parámetro ApiKey o ProjectName o el DocTye no es correcto. |
404 | No se encontró el cliente | No existen registros para la dupla tipo y número de documento |
200 |
{
"Uid": "string", "StartingDate": "string", "CreationDate": "string", "CreationIP": "string", "DocumentType": 0, "IdNumber": "string", "FirstName": "string", "SecondName": "string", "FirstSurname": "string", "SecondSurname": "string", "Gender": "string", "BirthDate": "string", "Street": "string", "CedulateCondition": "string", "Spouse": "string", "Home": "string", "MaritalStatus": "string", "DateOfIdentification": "string", "DateOfDeath": "string", "MarriageDate": "string", "Instruction": "string", "PlaceBirth": "string", "Nationality": "string", "MotherName": "string", "FatherName": "string", "HouseNumber": "string", "Profession": "string", "TransactionType": 0, "TransactionTypeName": "string", "IssueDate": "string", "BarcodeText": "string", "OcrTextSideOne": "string", "OcrTextSideTwo": "string", "SideOneWrongAttempts": 0, "SideTwoWrongAttempts": 0, "FoundOnAdoAlert": false, "AdoProjectId": "string", "TransactionId": "string", "ProductId": "string", "ComparationFacesSuccesful": false, "FaceFound": false, "FaceDocumentFrontFound": false, "BarcodeFound": false, "ResultComparationFaces": 0, "ComparationFacesAproved": false, "Extras":{ "IdState": "string", "StateName": "string" }, "NumberPhone": "string", "CodFingerprint": "string", "ResultQRCode": "string", "DactilarCode": "string", "ResponseControlList": "string", "Images":[ { "Id": int, "ImageTypeId": "String", "ImageTypeName: "String", "Image": "Imagen base 64", } ], "SignedDocuments": ["String"], "Scores":[ { "Id": 0, "StateName": "string", "StartingDate": "string", "Observation": "string" } ], "Parameters": "String", "StateSignatureDocument":"String" } |
Objeto de formato JSON con la información de la transacción consultada. |
El campo Images muestra ImageTypeId y ImageTypeName que se describen en "DICCIONARIO RESPUESTA IMAGES".
Endpoint que retorna el último caso que tuvo una calificación “Proceso satisfactorio” equivalente al codigo 2, para el documento consultado.
Nombre | FindByNumberIdSuccess |
---|---|
URL | {URL_Base}/api/{ProjectName}/FindByNumberIdSuccess |
TIPO | GET |
Nombre | Tipo Dato | Tipo Parámetro | Requerido | Descripción |
---|---|---|---|---|
ProjectName | String | Path | Si | El nombre de proyecto asignado |
apiKey | String | Header | Si | La llave asignada al proyecto |
identification | String | query | Si | El inúmero de identificación del cliente |
doctype | Integer ($int32) | query | Si | Tipo de documento que se desea consultar |
returnImages | Boolean | query | Si | Determina si se retornarán las imagenes de la transacción |
Authorization | string | header | No | Token de acceso. |
Enrol | Boolean | query | No | Este parámetro indica si se consultará el proceso con enrolamiento o no, esto depende de la configuración del sitio si este encendido el enrolamiento. |
Código | Respuesta | Descripción |
---|---|---|
400 | Mensaje de descripción del error The type of document not is valid | Hay un error en el modelo enviado o el tipo de documento enviado no se encuentra |
401 | The api key value is required Authorization is required to use this method | No se encuentra el parámetro apiKey o no es válida la combinación projectName-apiKey. |
404 | The specified project was not found | No se encuentra el projectName enviado o no se encontró transacción con los datos enviados |
200 |
{ "Uid": "string", "StartingDate": "2022-09-06T01:56:10.620Z", "CreationDate": "2022-09-06T01:56:10.620Z", "CreationIP": "string", "DocumentType": 0, "IdNumber": "string", "FirstName": "string", "SecondName": "string", "FirstSurname": "string", "SecondSurname": "string", "Gender": "string", "BirthDate": "2022-09-06T01:56:10.620Z", "Street": "string", "CedulateCondition": "string", "Spouse": "string", "Home": "string", "MaritalStatus": "string", "DateOfIdentification": "2022-09-06T01:56:10.620Z", "DateOfDeath": "2022-09-06T01:56:10.620Z", "MarriageDate": "2022-09-06T01:56:10.620Z", "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": true, "AdoProjectId": "string", "TransactionId": "string", "ProductId": "string", "ComparationFacesSuccesful": true, "FaceFound": true, "FaceDocumentFrontFound": true, "BarcodeFound": true, "ResultComparationFaces": 0, "ResultCompareDocumentFaces": 0, "ComparationFacesAproved": true, "ThresholdCompareDocumentFaces": 0, "CompareFacesDocumentResult": "string", "Extras": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "NumberPhone": "string", "CodFingerprint": "string", "ResultQRCode": "string", "DactilarCode": "string", "ReponseControlList": "string", "Latitude": "string", "Longitude": "string", "Images": [ { "Id": 0, "ImageTypeId": 0, "ImageTypeName": "string", "Image": "string", "DownloadCode": "string" } ], "SignedDocuments": [ "string" ], "Scores": [ { "Id": 0, "UserName": "string", "StateName": "string", "CausalRejectionName": "string", "StartingDate": "2022-09-06T01:56:10.620Z", "Observation": "string" } ], "Response_ANI": { "Niup": "string", "FirstSurname": "string", "Particle": "string", "SecondSurname": "string", "FirstName": "string", "SecondName": "string", "ExpeditionMunicipality": "string", "ExpeditionDepartment": "string", "ExpeditionDate": "string", "CedulaState": "string" }, "Parameters": "string", "StateSignatureDocument": true } |
Objeto de formato JSON con la información de la transacción consultada. |
El campo Images muestra ImageTypeId y ImageTypeName que se describen en "DICCIONARIO RESPUESTA Images".
Servicio web GET que retorna todos los tipos de identificación definidos en la aplicación.
Nombre | FindByNumberId |
---|---|
URL | {URL_Base}/api/{ProjectName}/IdentificationTypes |
TIPO | GET |
Nombre | Tipo Dato | Tipo Parámetro | Requerido | Descripción |
---|---|---|---|---|
ProjectName | String | Path | Si | El nombre de proyecto asignado |
apiKey | String | Header | Si | La llave asignada al proyecto |
Authorization | string | Header | No | Token de acceso. |
Código | Respuesta | Descripción |
---|---|---|
200 |
{
"Id": int, "IdentitificationName": "String", "Active": boolean, "Locked": boolean, "ActiveDescription": "String", "LockedDescription": "String" } |
Objeto de formato JSON con la información de la transacción consultada. |
El id de tipo de documentos lo puede consultar en "DICCIONARIO DE DOCUMENTOS".
Servicio web GET que retorna los templates por identificación enrolados en la aplicación.
Nombre | Templates |
---|---|
URL | {URL_Base}/api/{ProjectName}/Templates |
TIPO | GET |
Nombre | Tipo Dato | Tipo Parámetro | Requerido | Descripción |
---|---|---|---|---|
ProjectName | String | Path | Si | El nombre de proyecto asignado |
apiKey | String | Header | Si | La llave asignada al proyecto |
DocumentType | Integer | Query | Si | Número del Tipo de Documento registrado en la plataforma |
IdentificationNumber | String | Query | Si | Numero de identificación |
Authorization | string | Header | No | Token de acceso. |
Código | Respuesta | Descripción |
---|---|---|
200 |
{
IdentificationTypeId: Integer, IdentificationType: "String", IdentificationNumber: "String", FirstName: "String", SecondName: "String", FirstSurname: "String", SecondSurname: "String", Gender: "String", Templates: [ TemplateType: "String", Template: "String", ] } |
Objeto de formato JSON con la información de la transacción consultada. |
401 | ApiKey or Project or Authorization not valid | El parámetro ApiKey o ProjectName o el campo Authorization no es correcto. |
404 | Customer not Found | Número de identificación no enrolado en la plataforma. |
El campo TemplateType tiene dos opciones "FaceTamplate", que corresponde al template del rostro enrolado y "FingerTemplate", que corresponde al template de la huella dactilar que es enrolada cuando aplica la lectura de huella dactilar.
Servicio web GET que retorna los niveles de riesgo por transaccion configurados.
Nombre | Templates |
---|---|
URL | {URL_Base}/api/Integration/GetRiskClassification |
TIPO | GET |
Código | Respuesta | Descripción |
---|---|---|
200 |
{
Id: Int, From: Int, To: Int } |
Objeto de formato JSON con la información de los niveles de riesgo configurados, cada nivel de riesgo trae estos tres parametros. |
Este seria un ejemplo de como se podrían configurar los niveles de riesgo en la plataforma, no se pueden ingresar intervalos dentro de otro intervalos, tiene que respetarse el valor de X+1 para un nuevo Id.
Id | Desde | Hasta |
---|---|---|
1 | $0 | $1.000.000 |
2 | $1.000.001 | $15.000.000 |
3 | $15.000.001 | $50.000.000 |
4 | $50.000.001 | $100.000.000 |
Este servicio se debe consumir únicamente cuando OAuth este activo en la aplicación, genera un token para consumir los demás servicios
PARÁMETRO | TIPO | MEDIO | DESCRIPCION. |
---|---|---|---|
grant_type | String | FormData | Tipo de autorización. |
username | String | FormData | Nombre de usuario asignado por Ado para la consulta del token. |
password | String | FormData | Clave que corresponde al usuario asignado para la consulta del token, debe ir en hash SHA-1. |
Ejemplo consumo:
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"
Código | Descipción |
---|---|
200 | Objeto json que contiene el token y otros campos descritos en la tabla CAMPOS RESPUESTA |
400 |
unsupported_grant_type The user name or password is incorrect. |
NOMBRE CAMPO | TIPO | DESCRIPCÓN |
---|---|---|
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. |
Ejemplo respuesta:
{ "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" }
Envió de selfie al servidor
Nombre | New |
---|---|
Url | {URL_Base}/api/integration/{projectName}/Validation/New |
TIPO | POST |
Nombre | Tipo Dato | Tipo parámetros | Requerido | Descripción |
---|---|---|---|---|
ProjectName | String | Query | Si | El nombre del proyecto asociado. |
Apikey | String | Header | Si | La llave asignada al proyecto. |
Authorization | String | Header | No | Token de acceso. |
transactionInfo | Json | Body | Si | Los datos de la nueva transacción. |
Especificación del campo transactionInfo
Nombre | Tipo | Requerido | Descripción |
---|---|---|---|
ProductId | Int | Si | Numero de producto para la transacción del cliente verificado. |
CustomerPhoto | String | Si | Imagen del selfie en base 64. |
DocumentType | String | No | Id del tipo de documento, se obtiene consumiendo el servicio IDENTIFICATIONTYPES, si no se envía, por defecto se asigna el tipo de documento Cédula de ciudadanía (Id 1) |
Longitude | String | No | Longitud de la ubicación en donde se hace el proceso. |
Latitude | String | No | Latitud de la ubicación en donde se hace el proceso. |
IdAssociated | String | No | Número de identificación del codeudor. |
ClientRole | String | No | Numero de rol asigando para la plataforma. |
KeyProcessLiveness | String | No | Llave del proceso del liveness que es recibido en el proceso de la captura de la selfi |
UIdDevice | String | No | Cadena de caracteres que define e identifica el dispositivo de donde se hace la petición. |
IdUser | String | No | Id registrado en la plataforma ADO del usuario que realiza la petición del servicio. |
SourceDevice | Integer | No | Número que identifica que el tipo de dispositivo, respectivamente es 1 para Web 2 para Android y 3 para iOS. |
SdkVersion | string | No | Número de compilación o SDK que se esa usando, este pude ser leido en el ChangeLog del repositrio. |
OS | string | No | Tipo de sistema operativo de donde se hace el consumo del servicio. |
BrowserVersion | string | No | Si el campo OS es Web, se envia la versión del navegador que se usa. |
IMEI | string | No | IMEI del dispositivo movil que hace el consumo del servicio. |
RiskId | string | No | Id de la clasificación de riesgo. |
Uid | String | No | Número de identificación de la transacción. Si se hace este consumo en primer lugar, el servicio devolvera un UID que debe ser enviado en los demas servicios hasta finalizar con el servicio Close, en caso de tener uno, debe ser enviado para atar las imagenes enviadas a la misma transacción. |
Código | Descripción |
---|---|
200 | La transacción ha sido iniciada exitosamente. Se retorna un objeto con información asociada a la misma DESCRIPCIÓN DEL OBJETO DE RESPUESTA |
201 | El rostro que intenta validar se encuentra enrolado previamente. Se retorna un objeto con información de la transacción creada que incluye el número unico de transacción DESCRIPCIÓN DEL OBJETO DE RESPUESTA. |
400 |
The type of document not is valid El Id de riesgo no es valido El Id de riesgo no es valido El Id de riesgo debe ser un número entero 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 |
La fotografia facial no cumple con los criterios esperados, puede corresponder a que el rostro enviado tiene gafas, boca abierta, o parpadeo().
Base64 not valid. Image not valid. |
500 | Ha ocurrido un error, valide el error e intente de nuevo. |
Permite cargar la cara frontal de un documento de identidad.
Nombre | DocumentFrontSide |
---|---|
Url | {URL_Base}/api/integration/{projectName}/ Validation/Images/DocumentFrontSide |
TIPO | POST |
Nombre | Tipo Dato | Tipo Parámetro | Requerido | Descripción |
---|---|---|---|---|
ProjectName | String | Query | Si | El nombre del proyecto asociado |
Apikey | Apikey | Header | Si | La llave asignada al proyecto. |
Authorization | String | Header | No | Token de acceso. |
sideOneInfo | Json | Body | Si | Los datos de la nueva transacción |
Especificación del campo transactionInfo
Nombre | Tipo | Requerido | Descripción |
---|---|---|---|
Image | String | Si | Imagen del fornt del documento en base 64. |
DocumentType | String | No | Id del tipo de documento, se obtiene consumiendo el servicio IDENTIFICATIONTYPES, si no se envía, por defecto se asigna el tipo de documento Cédula de ciudadanía (Id 1) |
UIdDevice | String | No | Cadena de caracteres que define e identifica el dispositivo de donde se hace la petición. |
IdUser | String | No | Id registrado en la plataforma ADO del usuario que realiza la petición del servicio. |
SourceDevice | Integer | No | Número que identifica que el tipo de dispositivo, respectivamente es 1 para Web 2 para Android y 3 para iOS. |
SdkVersion | string | No | Número de compilación o SDK que se esa usando, este pude ser leido en el ChangeLog del repositrio. |
OS | string | No | Tipo de sistema operativo de donde se hace el consumo del servicio. |
BrowserVersion | string | No | Si el campo OS es Web, se envia la versión del navegador que se usa. |
TransactionType | string | No | Id del tipo de transacción |
ProductId | string | No | Numero de producto para la transacción del cliente verificado. |
Uid | String | No | Número de identificación de la transacción. Si se hace este consumo en primer lugar, el servicio devolvera un UID que debe ser enviado en los demas servicios hasta finalizar con el servicio Close, en caso de tener uno, debe ser enviado para atar las imagenes enviadas a la misma transacción. |
RiskId | String | No | Id de la clasificación de riesgo. |
Código | Descipción |
---|---|
200 | La transacción ha sido iniciada exitosamente. Se retorna un objeto con información asociada a la misma DESCRIPCIÓN DEL OBJETO DE RESPUESTA |
201 | Se encontro el cliente registrado previamente, se retorna un objeto con información de la transacción creada que incluye el número unico de transacción DESCRIPCIÓN DEL OBJETO DE RESPUESTA |
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 |
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 | Ha ocurrido un error, valide el error e intente de nuevo. |
Permite cargar la cara posterior de un documento de identidad.
Nombre | DocumentBackSide |
---|---|
Url | {URL_Base}api/integration/{projectName}/ Validation/Images/DocumentBackSide |
TIPO | POST |
Nombre | Tipo Dato | Tipo Parámetro | Requerido | Descripción |
---|---|---|---|---|
ProjectName | String | Query | Si | El nombre del proyecto asociado. |
Apikey | String | Header | Si | La llave asignada al proyecto |
Authorization | String | Header | No | Token de acceso. |
sideTwoInfo | Json | Body | Si | Los datos de la nueva transacción. |
Especificación del campo sideTwoInfo
Nombre | Tipo | Requerido | Descripción |
---|---|---|---|
Image | String | Si | Imagen de la parte posterior del documento en base 64. |
DocumentType | String | No | Id del tipo de documento, se obtiene consumiendo el servicio IDENTIFICATIONTYPES, si no se envía, por defecto se asigna el tipo de documento Cédula de ciudadanía (Id 1) |
UIdDevice | String | No | Cadena de caracteres que define e identifica el dispositivo de donde se hace la petición. |
SourceDevice | Integer | No | Número que identifica que el tipo de dispositivo, respectivamente es 1 para Web 2 para Android y 3 para iOS. |
SdkVersion | string | No | Número de compilación o SDK que se esa usando, este pude ser leido en el ChangeLog del repositrio. |
OS | string | No | Tipo de sistema operativo de donde se hace el consumo del servicio. |
BrowserVersion | string | No | Si el campo OS es Web, se envia la versión del navegador que se usa. |
TransactionType | string | No | Id del tipo de transacción |
ProductId | string | No | Numero de producto para la transacción. |
Uid | String | No | Número de identificación de la transacción. Si se hace este consumo en primer lugar, el servicio devolvera un UID que debe ser enviado en los demas servicios hasta finalizar con el servicio Close, en caso de tener uno, debe ser enviado para atar las imagenes enviadas a la misma transacción. |
RiskId | String | No | Id de la clasificación de riesgo. |
Código | Descipción |
---|---|
200 | La transacción ha sido iniciada exitosamente. Se retorna un objeto con información asociada a la misma DESCRIPCIÓN DEL OBJETO DE RESPUESTA |
201 | Se encontro el cliente registrado previamente, se retorna un objeto con información de la transacción creada que incluye el número unico de transacción |
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 | Ha ocurrido un error, valide el error e intente de nuevo. |
Permite cargar la imagen de la huella digital.
Nombre | Fingerprint |
---|---|
Url | {URL_Base}api/integration/{projectName}/ Validation/Images/Fingerprint |
TIPO | POST |
Nombre | Tipo Dato | Tipo Parámetro | Requerido | Descripción |
---|---|---|---|---|
ProjectName | String | Query | Si | El nombre del proyecto asociado. |
Apikey | String | Header | Si | La llave asignada al proyecto |
Authorization | String | Header | No | Token de acceso. |
fingerInfo | Json | Body | Si | La imagen codificada en base64. |
Especificación del campo fingerInfo
Nombre | Tipo | Requerido | Descripción |
---|---|---|---|
Image | String | Si | Imagen del fornt del documento en base 64. |
DocumentType | String | Si | Número del Tipo de Documento: 1) Cédula de Ciudadanía 2) PEP con solo pasaporte 4) Cédula de Extranjería 5) Tarjeta de identidad. |
FingerType | int | Si | Enumerador de huella dactilar, posibles valores (1,2) |
Uid | String | Si | Número de identificación de la transacción. Si se hace este consumo en primer lugar, el servicio devolvera un UID que debe ser enviado en los demas servicios hasta finalizar con el servicio Close, en caso de tener uno, debe ser enviado para atar las imagenes enviadas a la misma transacción. |
RiskId | String | No | Identificador de riesgo. |
Código | Descipción |
---|---|
200 | La huella ha sido cargada exitosamente y la información de la transacción ha sido actualizada |
400 | Los datos proporcionados no corresponden con los criterios esperados |
401 | El proceso de autorización no fue exitoso. Valide el codigo de proyecto y/o el API Key |
403 | La fotografia de la huella no es válida para extracción biometrica. |
404 | El codigo de proyecto y/o el UID especificado no existe. |
500 | Ha ocurrido un error, valide el número de id entregado para obtener más detalles. |
Permite finalizar la transacción en curso. Asigna un número único de transacción
Nombre | Close |
---|---|
Url | {URL_Base}/api/Integration/{projectName}/Validation/Close |
TIPO | POST |
Nombre | Tipo Dato | Tipo Parámetro | Requerido | Descripción |
---|---|---|---|---|
ProjectName | String | Query | Si | El nombre del proyecto asociado. |
Apikey | String | Header | Si | La llave asignada al proyecto. |
Authorization | String | Header | No | Token de acceso. |
info | Json | Body | Si | La información requerida para cerrar la transacción. |
Especificación del campo info
Nombre | Tipo | Requerido | Descripción |
---|---|---|---|
Uid | String | Si | Uid de la transacción. |
RiskId | String | No | Id de la clasificación de riesgo. |
Código | Descipción |
---|---|
200 | La transacción ha sido creada exitosamente. Se retorna un objeto con información asociada a la misma DESCRIPCIÓN DEL OBJETO DE RESPUESTA |
400 |
El Id de riesgo no es valido El Id de riesgo debe ser un número entero |
401 |
The api key value is required Api Key not valid |
404 | The specified project was not found<404> |
500 | Ha ocurrido un error, valide el error e intente de nuevo. |
Servicio web POST que retorna el estado en general de la plataforma, si todo funciona de manera correcta, el campo Message de la respuesta estará con el valor “Alive”.
Nombre | CheckHealt |
---|---|
URL | {URL_Base}/api/Integration/CheckHealt |
TIPO | POST |
Nombre | Tipo Dato | Tipo Parámetro | Requerido | Descripción |
---|---|---|---|---|
ProjectName | String | query | Si | El nombre del proyecto asociado. |
apiKey | String | header | Si | La llave asignada al proyecto. |
authorization | String | header | Si | Token de acceso. |
Código | Respuesta | Descripción |
---|---|---|
200 | {
"Code": "String", "Message": "String" } |
Objeto de formato JSON con la información correspondiente al estado de la plataforma. |
Nombre | Tipo | Descripción |
---|---|---|
{ | ||
Uid | String | Número de identificación de la transacción. |
StartingDate | String | Fecha y hora en que se empezó a transmitir al servidor, la primera imagen requerida para realizar el proceso de validación. |
CreationDate | String | Fecha y hora en que se terminó de transmitir al servidor, la totalidad de imágenes requeridas para realizar el proceso de validación. |
CreationIP | String | Número de IP desde la cual se realizó el proceso de validación de identidad. |
DocumentType | Int | Número del Tipo de Documento: 1) Cédula de Ciudadanía 2) PEP con solo pasaporte 4) Cédula de Extranjería 5) Tarjeta de identidad. |
IdNumber | int | Número de identificación del cliente validado. |
FirstName | String | Primer nombre del cliente verificado. |
SecondName | String | Segundo nombre del cliente verificado. |
FirstSurname | String | Primer apellido del cliente verificado. |
SecondSurname | String | Segundo apellido del cliente verificado. |
Gender | String | Género (Sexo) del cliente verificado. |
BirthDate | String | Fecha de nacimiento del cliente verificado en formato AAAA-MM-DD, ignorar la hora. |
Street | String | Dirección del cliente verificado. |
CedulateCondition | String | |
Spouse | String | |
Home | String | |
MaritalStatus | String | Estado civil del cliente verificado. |
DateOfIdentification | String | Fecha de expiración de cedula en rutinas que hacen consulta del registro civil de ecuador, unicamente cuando el servicio esta activo para traer esta información. Este campo es en formato AAAA-MM-DD, ignorar la hora. |
DateOfDeath | String | DateOfDeath. |
MarriageDate | String | MarriageDate. |
Instruction | String | |
PlaceBirth | String | Lugar de nacimiento del cliente verificado. |
Nationality | String | Nacionalidad del cliente verificado. |
MotherName | String | Nombre de la madre del cliente verificado. |
FatherName | String | Nombre del padre del cliente verificado. |
HouseNumber | String | |
Profession | String | Profesión del cliente verificado. |
ExpeditionCity | String | ExpeditionCity. |
ExpeditionDepartment | String | ExpeditionDepartment. |
BirthCity | String | BirthCity. |
BirthDepartment | String | BirthDepartment. |
TransactionType | int | Tipo de transacción realizada. |
TransactionTypeName | String | Nombre del tipo de transacción realizada. |
IssueDate | String | Fecha de expedición del documento presentado por el cliente verificado en formato AAAA-MM-DD, ignorar la hora. |
BarcodeText | String | |
OcrTextSideOne | String | Texto extraído de la toma de documentos por OCR (cara delantera del documento). |
OcrTextSideTwo | String | Texto extraído de la toma de documentos por OCR (cara posterior del documento). |
SideOneWrongAttempts | int | Numero de intentos fallidos tomando la cara delantera del documento. |
SideTwoWrongAttempts | int | Numero de intentos fallidos tomando la cara psoterior del documento. |
FoundOnAdoAlert | String | Retorna un booleano indicando si hubo alertas en la plataforma de ADO. |
AdoProjectId | String | Número del proyecto en la plataforma de ADO. |
TransactionId | String | Numero de la transacción para la certificación del cliente. |
ProductId | String | Numero de producto para la transacción del cliente verificado. |
ComparationFacesSuccesful | boolean | Retorna un booleano indicando si la comparación de rostros fue satisfactoria. |
FaceFound | boolean | Retorna un booleano indicando si se encontró un rostro durante la transacción. |
FaceDocumentFrontFound | boolean | Retorna un booleano indicando si se encontró un rostro en el documento de la transacción. |
BarcodeFound | boolean | Retorna un booleano indicando si se encontró un código de barras durante la transacción. |
ResultComparationFaces | int | Resultado de la comparación de rostros. |
ResultCompareDocumentFaces | int | Resultado de la comparación de rostros en los documentos. |
ComparationFacesAproved | boolean | Retorna un booleano indicando si la comparación de rostros fue aprobada. |
ThresholdCompareDocumentFaces | int | Retorna un entero con el umbral de comparación configurado . |
CompareFacesDocumentResult | string | CompareFacesDocumentResult. |
"extras”: { | ||
IdState | String | Numero de calificación para la transacción. |
StateName | String | Calificación de la transacción. |
} | ||
NumberPhone | String | Número de teléfono del cliente verificado. |
CodFingerprint | String | |
ResultQRCode | String | |
DactilarCode | String | |
ResponseControlList | String | |
Latitude | String | Latitude |
Longitude | String | Longitude |
"Images" : [{ | ||
Id | String | Número de identificación de la imagen. |
ImageTypeId | String | Id del tipo de imagen. |
ImageTypeName | String | Nombre del tipo de imagen. |
Image | String | Imagen en base64. |
DownloadCode | String | Código de descarga de la imagen. |
}], | ||
SignedDocuments | String Array | Arreglo con la lista de documentos firmados digitalmente, estos documentos se retornan en base 64, para su visualización se debe convertir a PDF. |
"Scores" : [{ | ||
Id | int | Id de la calificación. |
UserName | String | |
StateName | String | Nombre de la calificación. |
StartingDate | String | Fecha y hora en que se empezó a transmitir al servidor, la primera imagen requerida para realizar el proceso de validación. |
Observation | String | Observaciones sobre la transacción. |
}] | ||
"Response_ANI": { | ||
Niup | String | Número de identificación del cliente consultado en ANI. |
FirstSurname | String | Primer apellido del cliente consultado en ANI. |
Particula | String | |
SecondSurname | String | Segundo apellido del documento consultado en ANI. |
FirstName | String | Primer nombre del documento consultado en ANI. |
SecondName | String | Segundo nombre del documento consultado en ANI. |
ExpeditionMunicipality | String | Municipio de expedición del documento consultado en ANI. |
ExpeditionDepartment | String | Departamento de expedición del documento consultado en ANI. |
ExpeditionDate | String | Fecha de expedición del documento consultado en ANI. |
CedulaState | String | |
} | ||
Parameters | String | Parámetros enviados por el cliente asociados a la transacción (Formato Json). |
StateSignatureDocument | String | Indicar si se han firmado digitalmente los documentos asociados a la transacción. |
} |
Servicio encargado de extraer características y templete de un rostro, estas características pueden ser, si el usuario tiene gafas, tiene los ojos cerrados y otras características que serán descritas a continuación.
Nombre | GetFacialFeatures |
---|---|
URL | {URL_Base}/api/GetFacialFeatures |
TIPO | POST |
Nombre | Tipo Dato | Tipo Parámetro | Requerido | Descripción |
---|---|---|---|---|
ProjectName | String | Query | Si | El nombre del proyecto asociado. |
Apikey | String | Header | Si | La llave asignada al proyecto. |
request | Json | Body | Si | Formato json de información requerdia para hacer consumo del servicio. |
Descripción del campo REQUEST
Nombre Campo | Tipo Dato | Requerido | Descripción |
---|---|---|---|
Image | String | Si | Fotografia del rostro en base 64 |
GetFeatures | Boolean | Si | Define si se desea o no obtener las caracteristicas de la imagen envida. |
GetTemplete | Boolean | Si | Define si se desea o no obtener el templete del rostro enviado |
Para que el servcio responda de forma correcta al menos uno de los campos del parametro request que son GetFeatures o GetTemplete deben ir en true, de lo contrario la respuesta sera 400.
Código | Descripción |
---|---|
200 | Process executed successfully: La petición fue recibida en el servidor. Respuesta en formato Json descrita mas adelante. |
400 | Data error, check the request data: los dos valores de los campos GetFeatures y GetTemplete son False. |
500 | Internal server error: Error interno del servidor. |
Codigo | Respuesrta |
---|---|
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": {} } |
El campo Staus Puede devolver un codigo 6, lo cual corresponde a NO TEMPLATE, esto siginifca que el servicio con la imagen enviada no se logro obtener un templete del rostro.
Ejemplo de respuesta del servicio
Json | Código 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 |
Servicio que debe ser consumido cuando el servicio FindByNumberIdSuccess da como respuesta un Json con proceso satisfactorio y se debe hacer el metodo de Verificición, este servicio le registra la transacción, este servicio necesita los siguientes parametros
Nombre | CustomerVerification |
---|---|
URL | {URL_Base}/api/CustomerVerification |
TIPO | POST |
Nombre | Tipo Dato | Tipo Parámetro | Requerido | Descripción |
---|---|---|---|---|
ProjectName | String | Query | Si | El nombre del proyecto asociado. |
ApiKey | String | Header | Si | La llave asignada al proyecto. |
Data | Json | Body | Si | Formato json de información requerdia para hacer consumo del servicio. |
Especificación del campo Data.
Nombre | tipo | Si | Descripción |
---|---|---|---|
DocumentType | String | No | Id de tipo de documento. |
IdentificationNumber | String | Si | Numero de identificación |
Face | String | Si | Imagen en base 64 que se desea verificar |
FingerPrint | String | No | Imagen de la huella en base 64 que se desea verificar |
longitude | String | No | Cordenada de la ubicación |
Latitude | String | No | Cordenada de la ubicación |
ProductId | Integer | No | Id de producto que corresponde al proceso de verificación. |
KeyProcessLiveness | String | No | Llave del proceso de Liveness que se devuleve al realizar la captura de la selfie |
SourceDevice | Integer | No | Id de correspondiente a dispositivo de donde se esta realizando el proceso. |
SdkVersion | String | No | Versión del Sdk que se esta usando. |
OS | String | No | Version del sistema operativo. |
BrowserVersion | String | No | Version del navegador que se esta usando. |
UIdDevice | String | No | Cadena de caracteres que define e identifica el dispositivo de donde se hace la petición. |
IdUser | String | No | Id registrado en la plataforma ADO del usuario que realiza la petición del servicio. |
IMEI | string | No | IMEI del dispositivo movil que hace el consumo del servicio. |
RiskId | string | No | Id de riesgo configurado en la plataforma. |
Código | Descipción |
---|---|
200 | La transacción ha sido creada exitosamente. |
400 |
All fields are required Face not valid The type of document not is valid El Id de riesgo no es valido El Id de riesgo debe ser un número entero |
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 | La fotografia facial no cumple con los criterios esperados, puede corresponder a que el rostro enviado tiene gafas, boca abierta, o parpadeo(). |
CÓDIGO | RESPUESTA | DESCRIPCIÓN |
---|---|---|
200 | DESCRIPCIÓN DEL OBJETO DE RESPUESTA | Objeto de formato JSON con la información de la transacción. |
Servicio que crea una transacción de tipo firma digital, este servicio solicita información básica del cliente y los documentos que se desean firmar, estos deben ser únicamente archivos PDF convertidos a base 64, los parámetros que necesita son los siguientes:
Nombre | Tipo Dato | Tipo Parametro | Requerido | Descripción |
---|---|---|---|---|
Model | Json | Body | Si | La información requerida para cerrar la transacción. |
projectName | String | Path | Si | Nombre de proyecto. |
apiKey | String | Header | Si | apiKey proyecto. |
Authorization | String | Header | No | Token de acceso. |
Nombre | Tipo Dato | Requerido | Descripción |
---|---|---|---|
IdentificationType | String | Si | Tipo de identificación. |
IdentificationNumber | String | Si | Numero de identificación. |
FirstName | String | Si | Primer nombre. |
SecondName | String | No | Segundo nombre. |
FirstSurname | String | Si | Primer apellido. |
SecondSurname | String | No | Segundo apellido. |
Documents | String Array | Si | Arreglo de documentos pdf convertidos a base64. |
CÓDIGO | RESPUESTA | DESCRIPCIÓN |
---|---|---|
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" } |
Objeto de formato JSON con la información de la transacción. para más información consultar el apartado DESCRIPCIÓN DEL OBJETO DE RESPUESTA |
Este servicio retorna el estado en “Pendiente” para la transacciónde esta forma se notifica que se inicio el proceso de firma, 20 segundos después se podrán recuperar los documentos firmados en el servicio GET/Validation.
Servicio que nos permite saber si un usuario esta o no enrolado a partir del template del rostro.
Nombre | Tipo Dato | Tipo Parametro | Requerido | Descripción |
---|---|---|---|---|
transactionInfo | Json | Body | Si | La información requerida para cerrar la transacción. |
projectName | String | Path | Si | Nombre de proyecto. |
apiKey | String | Header | Si | apiKey proyecto. |
Authorization | String | Header | No | Token de acceso. |
Nombre | Tipo Dato | Requerido | Descripción |
---|---|---|---|
ProductId | Int | Si | Tipo de producto. |
CustomerPhoto | String Base64 | Si | Imagen del rostro de la persona en formato base 64. |
DocumentType | Int | Si | Tipo de documento. |
CÓDIGO | RESPUESTA | DESCRIPCIÓN |
---|---|---|
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" } |
Objeto de formato JSON con la información de la transacción. para más información consultar el apartado DESCRIPCIÓN DEL OBJETO DE RESPUESTA |
404 | Enroll not found | No se encuentra un enrolamiento previo asignado a este rostro. |
Al finalizar cualquiera de las invocaciones mensionadas anteriormente y siempre y cuando el usuario final haya finalizado con la totalidad de imágenes solicitadas, cliente recibirá en su URL CallBack un objeto JSON con la siguiente estructura
CÓDIGO | RESPUESTA | DESCRIPCIÓN |
---|---|---|
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": 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" } |
Objeto de formato JSON con la información de la transacción. |
Si el mecanismo de retorno pactado es GET, el resultado del proceso llegará con una cadena concatena a la URL de CallBack, en caso de que el mecanismo de respuesta pactado sea POST, se retornará como un Objeto JSON hacia URL_CallBack, que deberá estar en capacidad de digerir dicho objeto.
NOMBRE | TIPO | DESCRIPCIÓN |
---|---|---|
IdState | String | Indica en número el resultado de la transacción con base en el diccionario expuesto más adelante. |
StateName | String | Indica en texto el resultado de la transacción con base en el diccionario expuesto más adelante. |
Las respuestas se pueden validar en "DICCIONARIO DE RESPUESTAS".
NOMBRE | TIPO | DESCRIPCIÓN |
---|---|---|
Niup | String | Numero único de identificación personal. Número Cedula de Ciudadanía de las personas con nacionalidad colombiana. |
FirstSurname | String | Primer Apellido del documento consultado, retorna vacío si no contiene ningún dato. |
Particle | String | |
SecondSurname | String | Segundo Apellido del documento consultado, retorna vacío si no contiene ningún dato. |
FirstName | String | Primer Nombre del documento consultado, retorna vacío si no contiene ningún dato. |
SecondName | String | Segundo Nombre del documento consultado, retorna vacío si no contiene ningún dato. |
ExpeditionMunicipality | String | Municipio donde se expidió el documento, retorna vacío si no contiene ningún datos. |
ExpeditionDepartment | String | Departamento donde se expidió el documento, retorna vacío si no contiene ningún dato. |
ExpeditionDate | String | Fecha en la cual se expidió el documento, retorna vacío si no contiene ningún dato. |
CedulaState | String | Estado en el cual se encuentra la cédula (revisar tabla de códigos para más información). |
Conforme a lo pactado en el ANS, se consultarán o no listas de control. En caso de estar contratado y pactada la consulta, ésta se podrá realizar por los siguientes parámetros de búsqueda:
Ejemplos retorno consulta
Ejemplo valor dentro del JSON:
ResponseControlList: Al des serializar este objeto se puede interpretar, así:
Caso 1: Respuesta a la consulta de una sola persona Des serealizada
{ "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 }
Dentro el campo "datos_tsti" se encunetran todas las listas de control en las que la busqueda hizo match.
OBSERVACIONES: La matriz de salida tiene los siguientes datos:
LISTAS DEL SISTEMA
A continuación se relacionan todas las listas que a la fecha, se reportan en el sistema, es
importante aclarar que la lista OFAC (restrictiva), responde al código 3765.
Código | Nombre |
---|---|
9963 | Acuerdos de Reestructuración Supersociedades |
1381 | AFRICAN BANK |
5349 | Agencia Nacional de Minería 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 España |
8561 | Aml_News Estados Unidos |
6844 | Aml_News Guatemala |
9515 | Aml_News Honduras |
9194 | Aml_News México |
9726 | Aml_News Nicaragua |
4297 | Aml_News Panamá |
1189 | Aml_News Paraguay |
9534 | Aml_News Perú |
2889 | Aml_News R. Dominica |
3356 | Aml_News Venezuela |
4144 | ASIAN BANK Anticorruption and Integrity |
4454 | AUSTRALIAN FOREING AFFAIRS |
2955 | Bahamas leaks |
9745 | Banco Interamericano de Desarrollo (BID) |
2375 | Banco Mundial |
8391 | Bancos sancionados Panamá |
5362 | Boletín Guardia Civil Española |
6242 | Boletines de la DEA |
2487 | Boletines Procuraduría Colombia |
2776 | Bureau of Industry and Security BIS |
6967 | Concordatos Supersociedades |
8315 | Contraloría del Perú |
5694 | Contratistas 2015 y 2016 Alcaldía Mayor de Bogotá |
9851 | Contratistas Alcaldía Mayor de Bogotá |
3754 | Contratistas sancionados Panamá |
5228 | Liquidadas o en Liquidación Voluntarias Supersalud |
1871 | Ejercicio ilegal de actividad Financiera Superfinanciera |
4936 | Empresas en Liquidación Voluntaria Supersolidaria |
1627 | Entidades en Acuerdo de Reestructuración Supersalud |
1976 | Entidades en Medida Cautelar Vigilancia Especial Supersalud |
8573 | Entidades Liquidadas Supersalud |
2637 | European Bank for reconstruction and Development |
8454 | European List |
3766 | Europol |
5622 | Fugitivos FBI |
8616 | Funcionarios Alcaldía Mayor de Bogotá |
3241 | Funcionarios y Contratistas Contraloría |
3417 | GREATER VICTORIA CRIME STOPPERS |
8923 | HM Treasury |
4193 | Immigration and Customs Eforcement ICE |
7264 | Interpol Organización International de Policía Criminal |
7127 | Intervenciones Forzosas Administrativas Supersalud |
3889 | Junta Central de Contadores |
3861 | Liquidación Judicial Supersociedades |
5778 | Liquidadas, Intervención Forzosa Administrativa Supersalud |
1692 | Ministerio público Colombia |
7594 | Ministerio Público de Honduras |
8495 | Ministerio público Perú |
3765 | OFAC List |
4298 | Offshore leakst |
6622 | Organizaciones terroristas designadas por Estados Unidos |
3113 | OSFI |
9279 | Panama Papers |
5668 | Paradise Papers |
5318 | PEPS Antigua y Barbuda |
5488 | PPEPS Argentina |
2489 | PPEPS Bahamas |
5747 | PPEPS Barbados |
2138 | PPEPS Belize |
6356 | PPEPS Brasil |
4259 | PPEPS Canadá |
3192 | PPEPS Chile |
4223 | PPEPS Colombia |
7714 | PPEPS Costa Rica |
3523 | PPEPS Ecuador |
4366 | PPEPS Estados Unidos |
6135 | PPEPS México |
5929 | PPEPS Nicaragua |
3126 | PPEPS Panamá |
1914 | PPEPS Paraguay |
6729 | PPEPS Perú |
8277 | PPEPS Puerto Rico |
1636 | PPEPS República Dominicana |
2651 | PPEPS Santa Lucía |
6255 | PPEPS Trinidad y Tobago |
4671 | PPEPS Uruguay |
9861 | PPEPS Venezuela |
8971 | Policía Argentina |
8998 | Policía Nacional Puerto Rico |
6482 | Postulados ley 975 justicia y paz. Fiscalía General |
7416 | Presidencia del Consejo de Ministros de Perú |
8737 | Proveedores Ficticios DIAN Colombia |
4734 | Responsables Fiscales Contraloría |
7828 | Sancionados COPNIA |
1422 | Sanciones en Firme Superintendencia Financiera de Colombia |
8456 | Sentencias por competencia desleal SIC |
3982 | Sociedades en Liquidación Obligatoria |
7978 | THE UK POLICE |
Ejemplo de Búsqueda por Nombre y Número de documento
"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}