Saltar al contenido principal

WEBHOOK (Llamado Asíncrono)

Es posible llamar al servicio consolidado y esperar una respuesta en un callback personalizado.

El funcionamiento es el siguiente:

  • Debe llamar uno de los siguientes endpoints con un método POST y en el header "Bearer" (authorization: Bearer) enviar el token de autenticación.

🔗 Endpoints disponibles​

  • Solo resultados con riesgo:

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

  • Todos los resultados:

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

⏱️ Límite de Velocidad (Rate Limit)​

Rate Limit

El servicio permite un máximo de 4 peticiones por segundo. Si se supera este límite, el servidor responderá con un error 429 Too Many Requests.

📦 Estructura JSON​

La estructura de este JSON a enviar cumple con la misma estructura del consumo sincrono y atributos adicionales

{
"datoConsultar":"19123402",
"tipoDocumento":"cc",
"codigoPais":"COL",
"url":"http://miurlcallback.com/respuestaServicioConsolidado",
"ignoreNombre":true
}
ValorTipoDescripciónRequerido
datoConsultarStringDato que requiere consultarObligatorio
tipoDocumentoStringFormato del tipo de documento a consultar, puede consultar la guia de tipos de documentos para obtener mas informaciónObligatorio
codigoPaisStringFormato del codigo de pais a consultar, basado bajo el formato de ISO 3166-1 Alfa-3. Puede consulta la guia de Paises para obtener mas informaciónObligatorio
urlStringLa URL de respuesta a la solicitudObligatorio
ignoreNombreBooleanEste parametro se emplea cuando se requiere una respuesta más ágil sin tener que esperar a la respuesta completa de la solicitud con el nombre del documento consultado. En su lugar, el nombre del dato consultado se enviará en la respuesta a la URL proporcionada.Opcional

🧾 Respuestas posibles​

  • 201 CREATED: Petición generada de manera correcta
  • 400 Bad Request: Hay un error con la información enviada, debe ser revisada en el mensaje de error
  • 401 Unauthorized: Usuario y contraseña incorrectos o ausentes

✅ Ejemplo de respuesta (201 CREATED) - ignoreNombre = true​

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

✅ Ejemplo de respuesta (201 CREATED) - ignoreNombre = false​

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

⚠️ Ejemplo de respuesta (404 Bad Request):​

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

Para este caso el mensaje de error puede variar indicando el campo faltante en la petición