1. OBJETIVO
Este documento tiene como objetivo guiarte en el uso del servicio para consultar datos biográficos con el servicio del ANI de la Registraduría Nacional.
2. INTRODUCCIÓN
Para que nuestros clientes se conecten fácilmente con el servicio ANI, hemos desarrollado una API que les permite acceder a la Base de datos ANI de la Registraduría. Esta tecnología hace que la integración sea rápida y sencilla, ayudando a impulsar el éxito de sus negocios y asociaciones.
Aquí te mostramos, de manera sencilla, cómo puedes comunicarte con nuestro servicio, el cual cuenta con los siguientes métodos:
- /login/authenticate. (POST)
- /validacion/documento.(POST)
3. LOGIN
Aquí te mostramos cómo funciona el servicio de autenticación. Para que puedas usar el servicio de consulta, te proporcionaremos credenciales en los siguientes campos:
- Username: Usuario de autenticación ante el servicio.
- Password: Contraseña de autenticación.
- ApplicationCode: GUID de identificación de cliente.
3.1. URL PETICIÓN
https://reconoserpruebas.olimpiait.com:6470/api/login/authenticate
3.2. PARÁMETROS DE PETICIÓN
|
PARÁMETRO |
DESCRIPCIÓN |
|
Username |
Es el usuario asignado al cliente para el consumo del servicio. |
|
Password |
Es la contraseña asignado al cliente para el consumo del servicio. |
|
ApplicationCode |
Es el código GUID asignado al cliente para el consumo del servicio. |
3.3. EJEMPLO DE USO
Cuando te autentiques, el servicio recibirá tu usuario, contraseña y código de aplicación. Luego, generará un JWT que te permitirá usar el método de consulta. No te preocupes, el administrador del servicio te avisará sobre el tiempo de vida de este token.
4. CONSULTAR DOCUMENTO
Una vez que hayas completado la autenticación, simplemente toma el token generado y, al hacer la consulta de documento, coloca en los Headers de la petición el valor "Olimpia token". Solo necesitas escribir "Olimpia", dejar un espacio, y luego añadir el JWT que obtuviste al iniciar sesión.
4.1. URL PETICIÓN
https://reconoserpruebas.olimpiait.com6470/api/validacion/documento
4.2. PARÁMETROS DE PETICIÓN
|
PARÁMETRO |
DESCRIPCIÓN |
FORMATO |
|
Código aplicación |
Es el código GUID asignado al cliente para el consumo del servicio. |
|
|
Documento |
Número de documento que se va a consultar. |
|
|
Tipo Documento |
Tipo de Documento, cualquier tipo de documento diferente a CC se rechaza. |
|
4.3. EJEMPLOS DE USO
A continuación, en el Body, por favor envía los parámetros de consulta que son:
- CodigoAplicacion: GUID de identificación de cliente.
- TipoDocumento: Tipo de Documento. Para ANI solo se usa el valor de “1”, que corresponde a cedula de identidad, cualquier otro valor será rechazado.
- Documento: Numero de documento del candidato a consultar.
Tu solicitud te dará una respuesta con esta estructura:
- CodigoRespuesta: Código de respuesta que arrojo la consulta “0” (Cero) es exitoso.
- DescripcionRespuesta: Una breve explicación del error, en caso de que haya ocurrido alguno durante la consulta.
- La entidad Respuesta contiene los datos del candidato.
4.4. CÓDIGOS DE VIGENCIA DEL DOCUMENTO
Aquí te mostramos los códigos de vigencia del documento de identidad para la Registraduría:
|
CÓDIGO |
DESCRIPCIÓN |
|
0 |
Vigente |
|
1 |
Vigente |
|
12 |
Baja por Pérdida o Suspensión de los Derechos Políticos |
|
14 |
Baja por Interdicción Judicial por Demencia |
|
21 |
Cancelada por Muerte |
|
22 |
Cancelada por Doble Cedulación |
|
23 |
Cancelada por Suplantación o Falsa Identidad |
|
24 |
Cancelada por Menoría de Edad |
|
25 |
Cancelada por Extranjería |
|
26 |
Cancelada por Mala Elaboración |
|
27 |
Cancelada por Reasignación o cambio de sexo |
|
51 |
Cancelada por Muerte Facultad Ley 1365 2009 |
|
52 |
Cancelada por Intento de Doble Cedulación NO Expedida |
|
53 |
Cancelada por Falsa Identidad o Suplantación NO Expedida |
|
54 |
Cancelada por Menoría de Edad NO Expedida |
|
55 |
Cancelada por Extranjería NO Expedida |
|
56 |
Cancelada por Mala Elaboración No Expedida |
4.5. CÓDIGOS DE ERROR
|
CÓDIGO |
DESCRIPCIÓN |
|
0 |
OK – Candidato encontrado |
|
1 |
Candidato no encontrado |
|
2 |
Campos de entrada con formato erróneo |
|
3001 |
Error interno del servicio |
5. CONTROL DE CAMBIOS
| VERSIÓN | FECHA | DESCRIPCIÓN |
| 1 | 2020-04-24 | Creación del documento. |
6. PROPIEDAD DE OLIMPIA
El presente documento es de carácter confidencial y está protegido por las normas de derechos de autor, cualquier reproducción, distribución o modificación total o parcial a usuarios no autorizados o cualquier uso indebido de la información confidencial será considerado un delito conforme a lo establecido por el Código Penal y Leyes vigentes del estado Colombiano.
Documento de Olimpia - Uso PÚBLICO