API vigencia de documentos de identidad: cédula y pasaporte

Información de pago

Cada consulta a la API cuesta CLP$5. Puede obtener una api-key de prueba con CLP$1,000 si envía un correo con su expreso interés. También puede utilizar la API sin api-key a modo de prueba, limitado a 10 consultas cada 1 hora(s) por IP.

Se aceptan pagos a través de Litecoin y Monero.

Contáctese enviando un correo a

Demonstración

Resultado (JSON) Tiempo total: 0 ms Este es el tiempo que se demora desde nuestros servidores hacia su equipo

Documentación de endpoints

POST /query

Opcional: encabezado de autenticación X-api-key

Requiere: los siguientes campos de datos POST:

Campo	Descripción	Formato
`doc_num`	Número del documento de identidad	String (Ej. "12345678")
`run`	Identificador de la persona	String (Ej. "98765432-K")
`doc_type`	Tipo de documento de identidad	String: `CEDULA`, `PASAPORTE`

Devuelve: un JSON con el estado de la consulta:

Campo	Descripción
`state`	String: `VALID`, `NOT_VALID`, `NO_MATCH`. La tabla siguiente describe cada tipo.
`state_spa`	Cadena legible para el usuario con la descripción del estado en español.

Tipos de state:

Valor	Descripción
`NOT_VALID`	El documento existe, pero no está vigente.
`VALID`	El documento está vigente.
`NO_MATCH`	No se encuentra coincidencia / el documento no existe.

Ejemplo de solicitud con cURL:

curl "https://regcivil.impish.top/query" -v -H "X-api-key: ..." -d "doc_num=12345678&run=98765432-K&doc_type=CEDULA"

Ejemplo de respuesta:

{
    "error": false,
    "state": "VALID",
    "state_spa": "Vigente"
}

GET /balance

Requiere: encabezado de autenticación X-api-key

Devuelve: un JSON con el saldo (CLP$) disponible, como se muestra a continuación:

Campo	Descripción
`balance`	El saldo actual del usuario en pesos chilenos.

Ejemplo de solicitud con cURL:

curl "https://regcivil.impish.top/balance" -v -H "X-api-key: ..."

Ejemplo de respuesta:

{
    "error": false,
    "balance": 100000
}

Errores

Para detectar un error, basta con verificar el campo booleano error presente en todas las respuestas.

En caso de error, se devuelve un JSON con la estructura:

{
    "error": true,
    "desc": "descripción del error",
    "error_code": "código de error"
}

Además, se devuelve un código de estado HTTP distinto a 200 OK.

Códigos de error comunes:

Código de Error	Descripción	Código de Estado HTTP
`SERVER_ERROR`	Error interno.	500 Server Error
`NO_API_KEY`	No se proporcionó la clave de API o es inválida.	401 Unauthorized
`NO_BALANCE`	No se encontró saldo disponible.	402 Payment Required
`TRIAL_OVER`	Cuota de prueba superada (10 consultas cada 1 hora(s)).	402 Payment Required
`INVALID_PARAM`	Los parámetros son inválidos. No se descuenta saldo.	400 Bad Request

Aviso

No contamos con RUT de empresa por ende no emitimos factura, tampoco es necesario para el uso de este servicio.

El uptime está atado a los servidores del Registro Civil y los servidores de nuestro proveedor (Vultr y Cloudflare).

El servicio se entrega tal cual, sin SLA ni garantías. Aunque nos esforzamos por mantener la disponibilidad y el funcionamiento correcto, no podemos garantizar ni el uptime del Registro Civil ni el de nuestro proveedor. Por esta razón operamos con la modalidad de pago por uso y no suscripción.

El tiempo de respuesta son ~370 ms a nivel nacional.