Documentación Onboarding Digital

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

Este servicio cuenta con los siguientes métodos:

1. /login/authenticate. (POST)

2. /validacion/documento. (POST)

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

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.

Ya realizada la autenticación de usuario, en el método de validación/documento se podrá realizar la consulta del documento de referencia.

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 Onboarding Digital 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.

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 candidata