REST API Response

In general, the consolidated service returns a JSON structure like the following:

✅ Scenario soloRiesgo = true with a data that does NOT generate risk

{
 "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
}

🚨 Scenario soloRiesgo = true with a data that DOES generate risk

{
 "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
}

📋 Scenario 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,
}

JSON Response Structure Detail

Attribute	Type	Description
idDatoConsultado	BigInt	Unique identifier of the queried data in the application. \n Used to search in the query history in the web application.
tipoDocumento	String	Type of document queried. Example: ID Card, Identity Card, etc.
datoConsultado	String	Document number queried. When the document type queried is “nom”, it returns the name queried.
totalFuentesConsultadas	Int	Number of sources queried for the sent document type. Depends on the configured sources.
idConsulta	BigInt	Query identifier. Internal number in the application.
nombre	String	Name of the person based on the document type and queried data
tieneResultados	Boolean	Indicates if at least one source returned results for the query. It's important to clarify that if a source returns results, it doesn’t necessarily mean there is a risk or warning. For example, the OFAC source may return a message in English indicating no results were found. In this case, the variable tieneResultados is true, but the presentaAdvertencia and presentaRiesgo variables are false.
presentaRiesgo	Boolean	Indicates if at least one source generated a risk alert
resultados	Array	Array with objects containing results from each source. The structure of the object is explained in detail below.
totalFuentesConError	Int	Number of sources that could not be queried due to an error at the source
isMenorDeEdad	Boolean	Indicates if the person is underage based on the civil registry date. For passport queries, this is not included in the response because it is not possible to know if the person is underage.
pep	Boolean	Indicates if the person is listed in the PEP lists

"Resultados" Object JSON Structure within the Response JSON

Each object in the "Resultados" array has the following structure:

Attribute	Type	Description
lista	String	Unique name of the source within the system. It should match the list of available sources described in this document.
tipo	String	Logical grouping within Compliance, for example: General Information, Social Security, National Sources, International Sources, PEPS, News, Search Engines, Private Lists.
duración	Int	Duration of the query in milliseconds.
presentaRiesgo	Boolean	Indicates if the source generated a risk alert.
presentaAdvertencia	Boolean	Indicates if the source generated a risk warning. This is only included if the SoloRiesgo parameter is sent as false.
descripción	Array	An array of strings containing the details returned by the source. Since the data structure varies depending on the source, columns are separated by pipes "
deshabilitada	Boolean	Indicates if the source has been disabled globally in the system. This can happen when a source is experiencing slow response times, and the technology department disables it to prevent increased response times and possible system instability.This is only included when the source has been disabled.
mensajeFuenteDeshatilitada	String	Descriptive message explaining why the source was globally disabled. This is only included when the source has been disabled.
error	String	Error message. This is only included when an error occurred at the source.