Documentación Servicio REST ANI con JWT

Versión Nro. 1

Nro. 5-20160208
CONTENIDO
1. CONTROL DE CAMBIOS .................................................................................................3

2. OBJETIVO ........................................................................................................................ 3

3. INTRODUCCION ..............................................................................................................3

4. LOGIN ............................................................................................................................. 4

4.1. URL PETICIÓN ..........................................................................................................4

4.2. PARAMETROS DE PETICIÓN ...................................................................................4

4.3. EJEMPLO DE USO....................................................................................................5

5. CONSULTAR DOCUMENTO ............................................................................................ 7

5.1. URL PETICIÓN ..........................................................................................................7

5.2. PARAMETROS DE PETICIÓN ...................................................................................7

5.3. EJEMPLOS DE USO .................................................................................................8

5.4. CODIGOS DE VIGENCIA DEL DOCUMENTO ......................................................... 10

5.5. CODIGOS DE ERROR ............................................................................................ 11

6. PROPIEDAD DE OLIMPIA ............................................................................................ 12

Documentación Servicio REST ANI

Versión Nro. 1 - Página Nro. 2 de 12
Documento de Olimpia – Uso RESTRINGIDO
1. CONTROL DE CAMBIOS

VERSIÓN FECHA DESCRIPCIÓN

1 2020-04-24 Creación del Documento

2. OBJETIVO

El objetivo del presente documento es explicar el servicio para la consulta de datos

biográficos contra el servicio del ANI de la Registraduría Nacional.

3. INTRODUCCION

Para la integración de nuestros clientes con el servicio ANI, contamos con una API que
permite a nuestros consultar en la Base de datos ANI de la Registraduria, esta tecnología
facilita una integración rápida y transparente con el fin de potencializar el negocio de
nuestros clientes y asociados.

A continuación, se detalla paso a paso cómo comunicarse con nuestro servicio.

Este servicio cuenta con los siguientes métodos:

1. /login/authenticate. (POST)
2. /validacion/documento. (POST)

Documentación Servicio REST ANI

Versión Nro. 1 - Página Nro. 3 de 12
Documento de Olimpia – Uso RESTRINGIDO
4. LOGIN

En este método se encuentra expuesto el servicio de autenticación, para el consumo del

servicio de consulta se asignarán 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

4.1. URL PETICIÓN

https://reconoserpruebas.olimpiait.com:6470/api/login/authenticate

4.2. PARAMETROS DE PETICIÓN

PARAMETRO 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

Documentación Servicio REST ANI

Versión Nro. 1 - Página Nro. 4 de 12
Documento de Olimpia – Uso RESTRINGIDO
4.3. EJEMPLO DE USO

Al realizar la autenticación, este servicio recibirá como parámetros de ingreso usuario,

contraseña y código de aplicación. El método generará un JWT que permitirá consumir el
método de consulta. Este token cuenta con un tiempo de vida el cual será notificado por el
administrador del servicio.

Documentación Servicio REST ANI

Versión Nro. 1 - Página Nro. 5 de 12
Documento de Olimpia – Uso RESTRINGIDO
Documentación Servicio REST ANI
Versión Nro. 1 - Página Nro. 6 de 12
Documento de Olimpia – Uso RESTRINGIDO
5. CONSULTAR DOCUMENTO

Luego de realizar la autenticación de usuario deberá tomar el token generado, en el método

de consulta de documento en los Headers de la petición, poner en el campo Authorization
el valor “Olimpia token”, la palabra “Olimpia”, un espacio, seguido del JWT generado en el
login.

5.1. URL PETICIÓN

https://reconoserpruebas.olimpiait.com6470/api/validacion/documento

5.2. PARAMETROS DE PETICIÓN

PARAMETRO DESCRIPCIÓN FORMATO

Código aplicación Es el código GUID asignado al cliente 30 – 40 caracteres
para el consumo del servicio alfanuméricos y guiones “-”.
Obligatorio
Documento Número de documento que se va a 5 – 11 caracteres numéricos.
consultar Obligatorio
Tipo Documento Tipo de Documento, cualquier tipo de 1 carácter numérico.
documento diferente a CC se rechaza. Obligatorio

Documentación Servicio REST ANI

Versión Nro. 1 - Página Nro. 7 de 12
Documento de Olimpia – Uso RESTRINGIDO
5.3. EJEMPLOS DE USO

A continuación, en el Body, enviar los parámetros de consulta los cuales 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.

Documentación Servicio REST ANI

Versión Nro. 1 - Página Nro. 8 de 12
Documento de Olimpia – Uso RESTRINGIDO
La petición generara una respuesta con la siguiente estructura:

 CodigoRespuesta: Código de respuesta que arrojo la consulta “0” (Cero) es exitoso

 DescripcionRespuesta: Breve descripción del error, si hubo algún error en la
consulta.
 La entidad Respuesta contiene los datos del candidato.

Documentación Servicio REST ANI

Versión Nro. 1 - Página Nro. 9 de 12
Documento de Olimpia – Uso RESTRINGIDO
5.4. CODIGOS DE VIGENCIA DEL DOCUMENTO
Los códigos de vigencia del documento de identidad para la Registraduría son los
siguientes:

CODIGO DESCRIPCION
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

Documentación Servicio REST ANI

Versión Nro. 1 - Página Nro. 10 de 12
Documento de Olimpia – Uso RESTRINGIDO
 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

5.5. CODIGOS DE ERROR

CODIGO DESCRIPCION
0 OK – Candidato encontrado
1 Candidato no encontrado
2 Campos de entrada con formato erróneo
3001 Error interno del servicio

Documentación Servicio REST ANI

Versión Nro. 1 - Página Nro. 11 de 12
Documento de Olimpia – Uso RESTRINGIDO
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.

Documentación Servicio REST ANI

Versión Nro. 1 - Página Nro. 12 de 12
Documento de Olimpia – Uso RESTRINGIDO