Skip to main content

WEBHOOK (Asynchronous Call)

It is possible to call the consolidated service and wait for a response in a custom callback.

The process works as follows:

  • You need to call one of the following endpoints using the POST method and send the authentication token in the "Bearer" header (authorization: Bearer).

🔗 Available Endpoints​

  • Only results with risk:

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

  • All results:

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

⏱️ Rate Limit​

Rate Limit

The service allows a maximum of 4 requests per second. Exceeding this limit will result in a 429 Too Many Requests response.

📦 JSON Structure​

The structure of this JSON to send follows the same structure as the synchronous consumption and additional attributes.

{
"datoConsultar":"19123402",
"tipoDocumento":"cc",
"codigoPais":"COL",
"url":"http://miurlcallback.com/respuestaServicioConsolidado",
"ignoreNombre":true
}
ValueTypeDescriptionRequired
datoConsultarStringThe data to be queried.Mandatory
tipoDocumentoStringThe document type format to query. You can refer to the document type guide for more information.Mandatory
codigoPaisStringThe country code format to query, based on ISO 3166-1 Alpha-3 format. You can refer to the country guide for more information.Mandatory
urlStringThe URL for the response to the request.Mandatory
ignoreNombreBooleanThis parameter is used when a quicker response is required without waiting for the complete response with the queried document name. Instead, the name of the queried data will be sent in the response to the provided URL.Optional

🧾 Possible Responses​

  • 201 CREATED: Query completed correctly
  • 400 Bad Request: There is an error with the sent information, it should be reviewed in the error message.
  • 401 Unauthorized: Incorrect or missing username and password.

✅ Example Response (201 CREATED) - ignoreNombre = true​

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

✅ Example Response (201 CREATED) - ignoreNombre = false​

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

⚠️ Example Response (404 Bad Request):​

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

In this case, the error message may vary indicating the missing field in the request.