Respuesta API REST
En general, el servicio consolidado retorna una estructura JSON como la siguiente:
✅ Escenario soloRiesgo = true con un dato que NO genera riesgo
{
"idDatoConsultado": 46793409,
"tipoDocumento": "cc",
"resultados": [],
"isMenorEdad": false,
"totalFuentesConError": 0,
"datoConsultado": "9734609",
"totalFuentesConsultadas": 46,
"idConsulta": 15386233,
"nombre": "JUAN DIEGO CARDENAS VALENCIA",
"presentaRiesgo": false,
"pep": false,
"tieneResultados": false
}
🚨 Escenario soloRiesgo = true con un dato que SI genera riesgo
{
"idDatoConsultado": 46793434,
"tipoDocumento": "cc",
"resultados": [
{
"lista": "OtrasPepsService",
"descripcion": [
"tipoDocumento: cc|numDocumento: 19123402|informacion: PRESIDENTE|fechaNoticia:
15/04/18|fechaCargue: Mon Apr 18 00:00:00 UTC 2016|fuente: MINISTRO Y VICEMINISTROS|observaciones:
PERSONA PUBLICAMENTE EXPUESTA POR SU RECONOCIMIENTO, PROFESIÓN, CARGO U OFICIO -
NO ES INFORMACIÓN RESTRICTIVA NI VINCULANTE. BASADO EN LAS 40 RECOMENDACIONES DEL
GAFI - Concepto 2014115420-001 del 21 de enero de 2015, emitido por la Superintendencia Financiera de
Colombia.|tipopep: PERSONA PUBLICAMENTE EXPUESTA|id: 335|nombre: JUAN MANUEL SANTOS
Página 10
El contenido aquí expuesto es confidencial y no debe ser reproducido ni compartido con terceras partes sin autorización.
CALDERÓN\n",
"tipoDocumento: cc|numDocumento: 19123402|informacion: PRESIDENTE LA REPÚBLICA|fechaNoticia:
15/04/18|fechaCargue: Mon Apr 18 00:00:00 UTC 2016|fuente: PRESIDENTE LA REPÚBLICA|observaciones:
PERSONA PUBLICAMENTE EXPUESTA POR SU RECONOCIMIENTO, PROFESIÓN, CARGO U OFICIO -
NO ES INFORMACIÓN RESTRICTIVA NI VINCULANTE. BASADO EN LAS 40 RECOMENDACIONES DEL
GAFI - Concepto 2014115420-001 del 21 de enero de 2015, emitido por la Superintendencia Financiera de
Colombia.|tipopep: PERSONA PUBLICAMENTE EXPUESTA|id: 1638|nombre: JUAN MANUEL SANTOS
CALDERÓN\n"
],
"tipo": "peps",
"duracion": 62,
"presentaRiesgo": true,
"tieneResultados": true,
"presentaAdvertencia": false
}
],
"isMenorEdad": false,
"totalFuentesConError": 0,
"datoConsultado": "19123402",
"totalFuentesConsultadas": 46,
"idConsulta": 15386259,
"nombre": "JUAN MANUEL SANTOS CALDERON",
"presentaRiesgo": true,
"tieneResultados": true
}
📋 Escenario soloRiesgo = false
{
"idDatoConsultado": 10007490,
"tipoDocumento": "cc",
"resultados": [
{
"lista": "BidService",
"descripcion": [],
"tipo": "listasInternacionales",
"duracion": 452,
"presentaRiesgo": false,
"tieneResultados": false,
"presentaAdvertencia": false
},
{
"lista": "BoletinDeudoresMorososService",
"descripcion": ["descripcion: El documento de identificación número 19123402 NO está incluido en el BDME
que publica la CONTADURÍA GENERAL DE LA NACIÓN, de acuerdo con lo establecido en el artículo 2° de la Ley
901 de 2004.\nEl documento de identificación número 19123402 NO ha incumplido acuerdos de pago de conformidad
con lo establecido en el numeral 5° del artículo 2º de la Ley 1066 de 2006.\n"],
"tipo": "listasNacionales",
"duracion": 157,
"presentaRiesgo": false,
"tieneResultados": true,
"presentaAdvertencia": false
},
{
"lista": "DianRutService",
"descripcion": [
"digitoVerificacion: 5",
"razonSocial: JUAN MANUEL SANTOS CALDERON",
"estado: REGISTRO ACTIVO",
"nit: 19123402"
],
"presentaRiesgo": false,
"tieneResultados": true,
"presentaAdvertencia": false
},
{
"lista": "FosygaAfiliacionesService",
"descripcion": [
"idDatoConsultado: 10007490|estado: ACTIVO|fechaAfiliacion: 10/07/1998|entidad: COMPENSAR E.P.S.|id:
3968|regimen: CONTRIBUTIVO|tipoAfiliado: COTIZANTE\n",
"apellidos: SANTOS CALDERON|idDatoConsultado: 10007490|fechaNacimiento:
**/**/**|numIdentificacion: 19123402|tipoIdentificacion: CC|municipio: BOGOTA D.C.|departamento: BOGOTA
D.C.|id: 4184|nombres: JUAN MANUEL\n"
],
"presentaRiesgo": false,
"tieneResultados": true,
"presentaAdvertencia": false
},
{
"lista": "InterpolService",
"descripcion": ["respuestaSin: El documento ingresado no se encuentra registrado en la lista de Interpol"],
"tipo": "listasInternacionales",
"presentaRiesgo": false,
"tieneResultados": true,
"presentaAdvertencia": false
},
{
"lista": "LibretaMilitarService",
"descripcion": ["idDatoConsultado: 10007490|mensajeError: |lugar: Distrito Militar No. 055|direccion: Av.
Carrera Centro Comercial Centro Fusa Local 117 (Fusagasugá - Cundinamarca)|id: 154|nombre: JUAN MANUEL
SANTOS CALDERON|mensajeWarning: |clase: Reservista - 1ra Clase\n"],
"tipo": "infoGeneral",
"presentaRiesgo": false,
"tieneResultados": true,
"presentaAdvertencia": false
},
{
"lista": "OfacService",
"descripcion": ["respuestaSin: Your search has not returned any results."],
"tipo": "listasInternacionales",
"presentaRiesgo": false,
"tieneResultados": true,
"presentaAdvertencia": false
}
],
"datoConsultado": "19123402",
"totalFuentesConsultadas": 7,
"idConsulta": 107239,
"nombre": "JUAN MANUEL SANTOS CALDERON",
"tieneResultados": true,
"presentaRiesgo": false,
"pep": true,
}
Detalle Estructura JSON de Respuesta
| Atributo | Tipo | Descripción |
|---|---|---|
| idDatoConsultado | BigInt | Se trata del identificador único del dato consultado en la aplicación. \n Sirve para buscar en el historial de consultas en la aplicación web. |
| tipoDocumento | String | Tipo de Documento consultado. Ejemplo: Cédula, Tarjeta de Identidad, etc. |
| datoConsultado | String | Número de documento consultado. Cuando el tipo de documento consultado es “nom” viene el texto del nombre consultado. |
| totalFuentesConsultadas | Int | Cantidad de fuentes consultadas para el tipo de documento enviado. Depende de las fuentes parametrizadas. |
| idConsulta | BigInt | Identificador de Consulta. Número interno en la aplicación. |
| nombre | String | Nombre de la persona según el tipo de documento y dato consultado |
| tieneResultados | Boolean | Indica si al menos una fuente retornó resultados al consultar. Es importante aclarar que si una fuente tiene resultados, no necesariamente presenta riesgo o advertencia. Por ejemplo, es posible que la fuente de Ofac retorne un mensaje en inglés indicando que no se obtuvieron resultados. En este caso la variable tieneResultados es true pero las variables presentaAdvertencia y presentaRiesgo están en false. |
| presentaRiesgo | Boolean | Indica si al menos una fuente generó alerta de Riesgo |
| resultados | Array | Arreglo con objetos que contienen los resultados de cada fuente. A continuación se explica en detalle la estructura del objeto. |
| totalFuentesConError | Int | Cantidad de fuentes que no pudieron ser consultadas por un error en el origen |
| isMenorDeEdad | Boolean | Indica si la persona aparece como menor de edad según la fecha de registro civil. Para las consultas por pasaporte no se incluye en la respuesta debido a que no es posible saber si se trata de un menor de edad o no. |
| pep | Boolean | Indica si la persona es Pep según las listas peps donde aparezca |
Estructura JSON del Objeto "Resultados" dentro del JSON de Respuesta
La estructura de cada objeto contenido en el arreglo "Resultados" tiene la siguiente estructura:
| Atributo | Tipo | Descripción |
|---|---|---|
| lista | String | Nombre único de la fuente dentro del sistema. Se debe homologar con el listado de fuentes disponibles descrito en este documento |
| tipo | String | Agrupación lógica dentro de Compliance, ejemplo: InformaciónGeneral, Seguridad Social, Fuentes Nacionales, Fuentes Internacionales, PEPS, Noticias, Buscadores, Lista Privadas. |
| duración | Int | Duración de la consulta en milisegundos. |
| presentaRiesgo | Boolean | Indica si la fuente generó alerta de riesgo. |
| presentaAdvertencia | Boolean | Indica si la fuente generó advertencia de riesgo. Sólo se incluye si el parámetro SoloRiesgo se envia en false. |
| descripción | Array | Arreglo de Strings que contiene el detalle retornado por la fuente. Como la estructura de datos es variable dependiendo de la fuente, las columnas se separan por pipes " |
| deshabilitada | Boolean | Indica si la fuente ha sido deshabilitada de forma general en el sistema. Esto puede ocurrir cuando una fuente está presentando tiempos de respuesta lentos y desde el área de tecnología se deshabilita para evitar el incremento de los tiempos y una posible inestabilidad del sistema. Se incluye únicamente cuando la fuente se deshabilitó. |
| mensajeFuenteDeshatilitada | String | Mensaje descriptivo que muestra la razón por la cual la fuente fue deshabilitada de forma general. Se incluye únicamente cuando la fuente se deshabilitó. |
| error | String | Mensaje de error que se incluye únicamente cuando se produjo un error en el origen. |