Registraduría

Consulta a Registraduría Nacional para determinar se uma cédula colombiana está ativa ou foi cancelada pelo falecimento do titular. POST /co/registraduria/vital-status/v1

Campo	Tipo	Notas
`document_number`	string	Obrigatório. 5-12 dígitos, sem zero à esquerda (`^[1-9]\d{4,11}$`).

curl https://api.croma.run/co/registraduria/vital-status/v1 \
  -H "Authorization: Bearer $CROMA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "document_number": "5786287" }'

Campo	Notas
`found`	`true` quando a cédula está no registro; `false` quando não está (nesse caso `status` é `null`).
`document_number`	A cédula consultada, devolvida tal qual.
`status`	O estado vital quando encontrada, `null` caso contrário.

Quando found é true, status é um de:

`status`	Significado
`ALIVE`	Cédula ativa.
`DECEASED`	Cancelada pelo falecimento do titular.
`UNKNOWN`	A fonte devolveu um valor que a Croma não reconhece (é registrado para revisão).

Uma cédula que não está no registro não é um 404; é um 200 normal com found: false.

Referência completa

Esquemas, campos de resposta e um playground interativo.

Primeiros passos

Países

Referência completa