Resposta da API REST
Em geral, o serviço consolidado retorna uma estrutura JSON como a seguinte:
✅ Cenário soloRiesgo = true com um dado que NÃO gera risco
{
"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
}
🚨 Cenário soloRiesgo = true com um dado que GERA risco
{
"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
}
📋 Cenário 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,
}
Detalhes da Estrutura JSON de Resposta
| Atributo | Tipo | Descrição |
|---|---|---|
| idDatoConsultado | BigInt | Identificador único do dado consultado na aplicação. \n Usado para buscar no histórico de consultas na aplicação web. |
| tipoDocumento | String | Tipo de documento consultado. Exemplo: Cédula de Identidade, Cartão de Identidade, etc. |
| datoConsultado | String | Número do documento consultado. Quando o tipo de documento consultado for “nom”, retorna o nome consultado. |
| totalFuentesConsultadas | Int | Número de fontes consultadas para o tipo de documento enviado. Depende das fontes configuradas. |
| idConsulta | BigInt | Identificador da consulta. Número interno na aplicação. |
| nombre | String | Nome da pessoa conforme o tipo de documento e dado consultado |
| tieneResultados | Boolean | IIndica se pelo menos uma fonte retornou resultados ao consultar. É importante esclarecer que, se uma fonte retornar resultados, isso não significa necessariamente que haja risco ou advertência. Por exemplo, a fonte OFAC pode retornar uma mensagem em inglês indicando que não foram encontrados resultados. Nesse caso, a variável tieneResultados será verdadeira, mas as variáveis presentaAdvertencia e presentaRiesgo estarão falsas. |
| presentaRiesgo | Boolean | Indica se pelo menos uma fonte gerou um alerta de risco |
| resultados | Array | Array com objetos contendo os resultados de cada fonte. A estrutura do objeto é explicada em detalhes abaixo. |
| totalFuentesConError | Int | Número de fontes que não puderam ser consultadas devido a um erro na fonte |
| isMenorDeEdad | Boolean | Indica se a pessoa é menor de idade com base na data do registro civil. Para consultas por passaporte, isso não é incluído na resposta, pois não é possível saber se a pessoa é menor de idade. |
| pep | Boolean | Indica se a pessoa está na lista de PEP |
Estrutura JSON do Objeto "Resultados" dentro do JSON de Resposta
Cada objeto no array "Resultados" tem a seguinte estrutura:
| Atributo | Tipo | Descrição |
|---|---|---|
| lista | String | Nome único da fonte no sistema. Deve corresponder à lista de fontes disponíveis descrita neste documento. |
| tipo | String | Agrupamento lógico dentro do Compliance, por exemplo: Informações Gerais, Segurança Social, Fontes Nacionais, Fontes Internacionais, PEPS, Notícias, Buscadores, Listas Privadas. |
| duración | Int | Duração da consulta em milissegundos. |
| presentaRiesgo | Boolean | Indica se a fonte gerou um alerta de risco. |
| presentaAdvertencia | Boolean | Indica se a fonte gerou um alerta de risco. Isso é incluído apenas se o parâmetro soloRiesgo for enviado como falso. |
| descripción | Array | Matriz de Strings contendo os detalhes retornados pela fonte. Como a estrutura de dados varia dependendo da fonte, as colunas são separadas por barras verticais " |
| deshabilitada | Boolean | Indica se a fonte foi desabilitada globalmente no sistema. Isso pode acontecer quando uma fonte está apresentando tempos de resposta lentos, e o departamento de tecnologia desativa para evitar o aumento dos tempos de resposta e possível instabilidade do sistema. Isso é incluído apenas quando a fonte foi desabilitada. |
| mensajeFuenteDeshatilitada | String | Mensaje descriptivo que muestra la razón por la cual la fuente fue deshabilitada de forma general. Isso é incluído apenas quando a fonte foi desabilitada. |
| error | String | Mensagem de erro. Isso é incluído apenas quando ocorreu um erro na fonte. |