Download OpenAPI specification:Download
Consulta de fuentes abiertas (API) 3.0. Data search, risk analysis and data sources integration via RestAPI services.
Esta API permite consultas diferentes listas y fuentes abiertas de información. Se diferencia entre robots y listas. Los robots son ejecuciones de RPA (Robotic Process Automation) a fuentes externas y el èxito/velocidad de la consulta depende de la disponibilidad de la fuente que esta siendo consultada (en ningun caso supera los 5min). Las listas por el contrario son consultas a fuentes internas y su indice de exito es del 100% con tiempos de respuesta alrededor de ~2seg. Cada request por lo tanto es una solicitud de consulta a una o multiples robots/listas.
This API allows queries from different lists and open sources of information. It differs between "robots" and "lists". The robots are RPA (Robotic Process Automation) executions to external sources, and the success/speed of the consultation depends on the availability of the source (in no case exceeds 5min). The lists, on the other hand, are queries to internal sources and their success rate is very high in relative fast response times (~ 2sec). Each request is, therefore, a query request to one or multiple robots/lists.
El endpoint principal de consulta /robotrequest recibe la consulta y genera una respuesta inmediata del estado de la misma con un identificador único de la petición denominado query_token que se encuentra en el objeto QUERYTOKEN dentro del MainResponse schema. Con dicho query token se puede consultar de forma periodica el estado del request al endpoint /robotdetails. Como politica de uso responsable se puede hacer peticiones máximo cada 3seg utilizando un mismo query_token.
The main query endpoint "/robotrequest" receives the query and generates an immediate response of the status with a unique request identifier called "query_token" found in the QUERYTOKEN object within the MainResponse schema. With this query token, you can periodically check the status of the request to the endpoint "/robotdetails". As a responsible use policy, requests can be made every 3sec using the same query_token.
Cada robot/lista requiere de unos parámetros mínimos de entrada, generando un response 400 en caso de que no se cumplan. A continuación se listan los requerimientos de cada robot/lista:
Each robot/list requires minimum input parameters. The requirements of each robot/list (parameters required in []) are listed below.
Como elemento validatorio de la consulta generamos screenshots/pdf de la respuesta de las fuentes consultadas. Para los robots (type: ROBOT) que no presentan errores (status: NO ERRORS) se pueden acceder a estas evidencias a traves de https://52.71.184.1/v3.0/static/screenshots/FILENAME. Para cada robot los siguientes patrones de QUERYTOKEN son usados como FILENAME:
As a query validation element, we generate screenshots/pdf of the response from the consulted sources. For robots (type: ROBOT) that do not present errors (status: NO ERRORS), the evidence can be accessed through https://52.71.184.1/v3.0/static/screenshots/FILENAME. For each robot the following pattern is used for FILENAME:
Las evidencias son almacenadas por 8 días.The evidences are stored for 8 days.
tipo_doc | string Enum: "cedula" "cedula_extranjeria" "pasaporte" "mx_curp" "ec_cedula" "ar_dni" "nit" "pep" Document identification type. 'cedula' - Colombian identificaction document, 'cedula_extranjeria' - Colombian immingration document, 'pasaporte' - Passport, 'mx_curp' - Mexican identification CURP, 'ec_cedula' - Ecuadorian document, 'ar_dni' - Argentine document, 'nit' - Colombian tax identification number, 'pep' - Colombian special stay permit |
documento | string Identification card number. It is required only for the execution of certain robots. Do not use periods or hyphens. For NIT type documents do not use the verification digit. |
names | string Name of the searched person |
lastnames | string Lastname of the searched person |
robot | Array of strings Items Enum: "POLI" "PROCU" "TYBA" "GOOGLE" "LINKEDIN" "CONTRAL" "SISBEN" "JEPMS" "LVREGI" "LVREGI2" "CURPRFC" "INFRAMEX" "CEDEXT" "PEPM" "ECONJUDI" "REGISECU" "ADRES" "ANTEECU" "RENAPO" "RENAPO2" "RUES" "RUES2" "RUES3" "RUAF" "INTERPOL" "SIGEP" "RNMC" "RUNT" "RUNTP" "RUNT2" "RUNTP2" Robot(s) to be executed. Note: This is a multiple value param. 'POLI': 'Antecedentes Policía Colombia','PROCU': 'Antecedentes Procuraduría Colombia','TYBA': 'Consulta de Procesos Judiciales TYBA - Colombia','CONTRAL' : 'Consulta Certificado Antecedentes Fiscales Colombia', 'SISBEN': 'Consulta puntaje SISBEN Colombia','JEPM': 'Juzgados de ejecución de penas y medidas de seguridad Colombia','CURPRFC': 'Consulta RFC Mexico','INFRAMEX': 'Infracciones de transito México','CEDEXT': 'Certificación del estado de Cédula de Extranjería Colombia','PEPM': 'Certificación del Permiso Especial de Permanencia Colombia','ECONJUDI': 'Consejo de la Judicatura de Ecuador','REGISECU': 'Verificacón de cédula de Ecuador','ADRES': 'Consulta afiliados compensados','ANTEECU' 'Antecedentes Ecuador','RENAPO': 'Consulta CURP Mexico','RUES': 'Consulta Rues Colombia','RUAF': 'Registro Único de Afiliados Colombia','INTERPOL': 'Lista roja de Interpol (Múltiples paises)','SIGEP': 'Directorio de Servidores Públicos Colombia', 'RNMC': 'Sistema Registro Nacional de Medidas Correctivas Colombia', 'RUNT': 'Consulta de Vehiculo Registro Único Nacional de Tránsito Colombia', 'RUNTP': 'Consulta de Persona Registro Único Nacional de Tránsito Colombia' |
list | Array of strings Items Enum: "SDN" "HIBP" "ONU" "WORLDBANK" "BIS" "IPSCAM" "CLFSUK" "UETERR" "SUPERSO" Set of lists PEPs/LA to be searched. Note: This is a multiple value param. 'SDN':'Specially Designated Nationals And Blocked Persons List (Lista Clinton)', 'HIBP' : 'Haveibeenpwned service', 'WORLDBANK':'Procurement - World Bank Listing of Ineligible Firms and Individuals','BIS':'Bureau of Industry and Security U.S Department of Commerce Denied Persons List', 'IPSCAM': 'Ip security breaches', 'UETERR': 'EU terrorist list', 'SUPERSO': 'Superintendencia de Sociedades, companies basic data 2018', 'CLFSUK': 'Consolidated List of Financial Sanctions Targets in the UK'. |
fecha_expe_doc | string Document identification issue date (YYYY-MM-DD) |
fecha_nacimiento | string Birth date (YYYY-MM-DD) |
ip | string IP address. Only for IPSCAM list. |
string Email address. Only for HIBP list. |
{- "data": {
- "ScoreModelName": {
- "robot": "BINARY",
- "score_risk_binary": true,
- "score_risk_int": 1,
- "score_trust_binary": true,
- "score_trust_int": 1,
- "status": "NO ERRORS",
- "type": "SCORE",
- "sources": {
- "RobotOrListName": {
- "alert_msg": "string",
- "score_risk_int": 1,
- "score_risk_binary": true
}
}
}, - "QUERYTOKEN": {
- "robot": "",
- "token": "string",
- "status": "NO ERRORS",
- "type": "TOKEN"
}, - "RobotOrListName": {
- "robot": "POLI",
- "status": "NO ERRORS",
- "texto": "string",
- "type": "ROBOT"
}
}, - "status": "Robots in execution process"
}
query_token required | string Query token. Note 'query_token' is the token returned by the request |
{- "data": {
- "ScoreModelName": {
- "robot": "BINARY",
- "score_risk_binary": true,
- "score_risk_int": 1,
- "score_trust_binary": true,
- "score_trust_int": 1,
- "status": "NO ERRORS",
- "type": "SCORE",
- "sources": {
- "RobotOrListName": {
- "alert_msg": "string",
- "score_risk_int": 1,
- "score_risk_binary": true
}
}
}, - "QUERYTOKEN": {
- "robot": "",
- "token": "string",
- "status": "NO ERRORS",
- "type": "TOKEN"
}, - "RobotOrListName": {
- "robot": "POLI",
- "status": "NO ERRORS",
- "texto": "string",
- "type": "ROBOT"
}
}, - "status": "Robots in execution process"
}