Consultar estado de un documento electrónico

Este endpoint permite consultar el estado de un documento electrónico.

---

Entorno

URL Base: https://api.guarani.app

Endpoint

GET /sifen/consultas/estado/cdc/{cdc}

Ejemplo de solicitud

curl -X GET "https://api.guarani.app/sifen/consultas/estado/cdc/{cdc}" \
  -H "x-api-key: Bearer <access_token>" \
  -H "Accept: application/json" | jq

Nota: Reemplaza {cdc} por el CDC a consultar y <access_token> con un token JWT válido proporcionado por el equipo Guarani. Importante:
Es imprescindible incluir un token de acceso válido en el encabezado x-api-key para autenticar y autorizar el uso de este endpoint. Sin este token, la solicitud será rechazada.

---

Parámetros de ruta

Parámetro	Tipo	Requerido	Descripción
cdc	string	Sí	CDC a consultar.

Encabezados de la Solicitud

Encabezado	Valor	Descripción
x-api-key	Bearer <access_token>	Token de acceso válido proporcionado por el equipo Guarani.
Accept	application/json	Indica que la respuesta debe devolverse en formato JSON.

Ejemplo de respuesta

Ejemplo de respuesta de estado aprobado

{
  "success": true,
  "codigo": "200",
  "message": "Operación realizada correctamente.",
  "data": {
    "estado": "Aprobado",
    "mensaje": "Aprobado"
  }
}

Ejemplo de respuesta de estado rechazado

{
  "success": false,
  "codigo": "400",
  "mensaje": "Error al consultar el CDC.",
  "error": {
    "estado": "Rechazado",
    "mensaje": "TEST - RUC del receptor inexistente en la base de datos de Marangatu"
  }
}

Descripción de Campos de Respuesta

Campos principales

Campo	Tipo	Descripción
estado	string	Estado del documento electrónico.
mensaje	string	Mensaje de error del estado del documento electrónico.

Recursos adicionales

Para más información sobre posibles errores y cómo manejarlos, consulta errores