Skip to content
On this page

POST /consulta-cui

Descripción

Este endpoint permite realizar una consulta a la base de datos del Registro Nacional de las Personas (RENAP) de Guatemala para obtener información asociada a un Código Único de Identificación (CUI).

Método HTTP

POST

URL

/consulta-cui

Encabezados (Headers)

NombreDescripciónTipoEs requerido
aliasAlias del emisor de la consulta.String
llaveLlave de autenticación del emisor.String

Cuerpo de la solicitud (Body)

NombreDescripciónTipoEs requerido
cuiCódigo Único de Identificación.String

Ejemplo de solicitud

json
POST /consulta-cui
Headers:
{
  "alias": "alias_emisor",
  "llave": "llave_emisor"
}
Body:
{
  "cui": "2936476581901"
}

Respuesta

Si la solicitud es exitosa, el servidor responderá con el código de estado HTTP 200 y los datos asociados al CUI proporcionado.

NombreDescripciónTipo
cuiCódigo Único de Identificación consultado.String
nombreNombre del titular del CUI consultado.String
fallecidoIndicador de si el titular del CUI ha fallecidoString

Ejemplo de Respuesta

json
{
  "status": 200,
  "data": {
    "cui": "2936476581901",
    "nombre": "LUIS FERNANDO ,MUÑOZ CHACON ",
    "fallecido": ""
  }
}
typescript
export interface Pokedex {
    status: number;
    data:   Data;
}

export interface Data {
    cui:       string;
    nombre:    string;
    fallecido: string;
}

Códigos de Error

  • 400 Bad Request: Si los parámetros requeridos no están presentes o no tienen un formato válido.
  • 401 Unauthorized: Si las credenciales de autenticación (alias y llave) no son válidas.
  • 404 Not Found: Si no se encuentra ninguna información asociada al CUI proporcionado.
  • 500 Internal Server Error: Si ocurre un error en el servidor al procesar la solicitud.

Ejemplo de Código en Node.js (Express.js)

javascript
Router.post('/consulta-cui', async (req, res, next) => {
  try {
    const { headers, body } = req
    const data = await infileController.consultaCui(headers, body)
    return res.json(data)
  } catch (error) {
    throw error
  }
})