Pular para o conteúdo principal

WEBHOOK (Chamada Assíncrona)

É possível chamar o serviço consolidado e aguardar uma resposta em um callback personalizado.

O processo funciona da seguinte forma:

  • Você deve chamar um dos seguintes endpoints usando o método POST e enviar o token de autenticação no cabeçalho "Bearer" (authorization: Bearer).

🔗 Endpoints Disponíveis​

  • Somente resultados com risco:

    POSThttp://localhost:8080/ValidadorDatainnova/ws/ConsultaConsolidadaService/webhook/soloRiesgo/true

  • Todos os resultados:

    POSThttp://localhost:8080/ValidadorDatainnova/ws/ConsultaConsolidadaService/webhook/soloRiesgo/false

⏱️ Limite de Requisições (Rate Limit)​

Rate Limit

O serviço permite no máximo 4 requisições por segundo. Caso esse limite seja excedido, o servidor responderá com o erro 429 Too Many Requests.

📦 Estrutura JSON​

A estrutura deste JSON a ser enviado segue a mesma estrutura do consumo síncrono e atributos adicionais.

{
"datoConsultar":"19123402",
"tipoDocumento":"cc",
"codigoPais":"COL",
"url":"http://miurlcallback.com/respuestaServicioConsolidado",
"ignoreNombre":true
}
ValorTipoDescriçãoRequerido
datoConsultarStringO dado a ser consultado.Obrigatório
tipoDocumentoStringO formato do tipo de documento a consultar. Você pode consultar o guia de tipos de documentos para mais informações.Obrigatório
codigoPaisStringO formato do código do país a consultar, baseado no formato ISO 3166-1 Alfa-3. Você pode consultar o guia de países para mais informações.Obrigatório
urlStringA URL de resposta à solicitação.Obrigatório
ignoreNombreBooleanEste parâmetro é usado quando uma resposta mais rápida é necessária, sem precisar esperar pela resposta completa com o nome do documento consultado. Em vez disso, o nome do dado consultado será enviado na resposta para a URL fornecida.Opcional

🧾 Respostas Possíveis​

  • 201 CREATED: Consulta concluída corretamente
  • 400 Bad Request: Há um erro com as informações enviadas, deve ser revisado na mensagem de erro.
  • 401 Unauthorized: Nome de usuário e senha incorretos ou ausentes.

✅ Exemplo de Resposta (201 CREATED) - ignoreNombre = true​

{
 "idDatoConsultado": 4592976054,
 "respuesta": "Solicitud creada satisfactoriamente.",
 "idConsulta": 237795049
}

✅ Exemplo de Resposta (201 CREATED) - ignoreNombre = false​

{
 "idDatoConsultado": 4592976054,
 "respuesta": "Solicitud creada satisfactoriamente.",
 "nombre": "PABLO RAMON PEREZ PEREZ",
 "idConsulta": 237795049
}

⚠️ Exemplo de Resposta (404 Bad Request):​

{
 "error": "Los datos de la petición son incorrectos."
}

Neste caso, a mensagem de erro pode variar indicando o campo ausente na solicitação.