Mis Pagarés

INTRODUCCION #

En el presente documento define un diseño que busca facilitar la interacción de los comercios interesados en el uso de la plataforma Firmamos con los servicios de OLIMPIA IT – Reconocer por cuanto a la solicitud de validación de datos del cliente con servicio ANI, aprobación de tratamiento de datos públicos ATDP, proceso de validación, firma de PAGARÉS y recibo de archivos tipo pdf. En este orden de ideas, el presente documento se definen los contratos de servicio que corresponde al proceso definido en el presente servicio.

API DE FIRMAMOS #

Esta API permite a las aplicaciones validar los datos de una persona con documento de identificación ciudadana de Colombia, Aprobar el tratamiento de datos personales y todo el flujo de aprobación y firma de documentos pagarés.

Para acceder se requiere tener las siguientes características:

SERVICIO SOLICITUD DE LOGIN – AUTORIZACION API #

Este servicio se encarga de dar de alta al receptor para que pueda realizar de manera segura, la solicitud de cada uno de los servicios expuestos en el API. Para acceder, se debe realizar un consumo al servicio web REST, el cual contempla las siguientes directrices técnicas:

Operación #

Estructura modelo de consulta #

Estructura modelo de respuesta #

SERVICIO DE CONSULTAS ANI (Archivo Nacional de Identificación). #

Este servicio suministra al receptor información de cualquier ciudadano colombiano, como lo es: el nombre, el apellido, el número de la cédula de ciudadanía, la fecha de expedición del documento de identidad y la vigencia de la cédula, datos que provienen de fuentes legales de la Registraduría Nacional de Colombia.

Para la solicitud de información del cualquier ciudadano colombiano en ANI, se debe realizar un consumo de servicio web REST, el cual contempla las siguientes directrices técnicas:

Operación #

Estructura modelo de consulta #

Estructura modelo de respuesta #

Códigos de vigencia del documento #

Los códigos de vigencia del documento de identidad para la Registraduría son los siguientes:

Códigos de respuesta #

Los códigos de respuesta que puede retornar el servicio son:

SERVICIO SOLICITUD DE APROBACIÓN Y TRATAMIENTO DE DATOS PERSONALES- ATDP #

Este servicio suministra al receptor la información acerca de cómo se tratara la información persona que el acreedor de la deuda suministra al comercio. Para acceder, se debe realizar un consumo al servicio web REST, el cual contempla las siguientes directrices técnicas:

Operación #

Estructura modelo de consulta #

Estructura modelo de respuesta #

Estados de error de proceso #

SERVICIO DE RECEPCION DE ARCHIVO PAGARÉ #

Este servicio se encarga únicamente de la recepción de un archivo tipo PDF, que contiene toda la información pertinente al pagaré, una vez se tenga en custodia el archivo, se enviará una notificación al solicitante para que acceda al portal web y pueda visualizar este archivo pdf pagaré, con el fin de realizar el proceso de validación y aceptar la respectiva obligación con la entidad.

Para acceder, se debe realizar un consumo al servicio web REST, el cual contempla las siguientes directrices técnicas:

Operación #

Estructura modelo de consulta #

Estructura modelo de respuesta #

SERVICIO DE CONSULTA DE ESTADO DEL PROCESO COMERCIO #

Este servicio se encarga de suministrar la fecha, la identificación de la transacción, el método invocado y el resultado del proceso solicitado.

Para acceder, se debe realizar un consumo al servicio web REST, el cual contempla las siguientes directrices técnicas:

Operación #

Estructura modelo de consulta #

Estructura modelo de respuesta #

La siguiente estructura responde de uno a muchos eventos del proceso de solicitud de crédito.

SERVICIO DE RECEPCION DE DOCUMENTOS DEL SOLICITANTE #

Este servicio se encarga únicamente de la recepción de archivos tipo PDF, conocidos como documentos soporte que los comercios solicitan para la aprobación de un crédito, estos pueden ser fotocopia de la cédula de ciudadanía del solicitante.

para acceder, se debe realizar un consumo al servicio web REST, el cual contempla las siguientes directrices técnicas:

Operación #

Estructura modelo de consulta #

Estructura modelo de respuesta #

SERVICIO DE VALIDACION CLIENTE CON RECONOSER EXPERIAN (EN CONSTRUCCIÓN) #

Este servicio se encarga una vez se tenga la confirmación por parte del cliente en la aprobación del documento ATDP y el medio en que se realiza la aprobación (celular o Correo), el servicio procederá a realizar la validación de los datos del cliente como lo son el número de celular con el servicio de Experian (Aprobado ATDP desde celular) o validación con el correo electrónico del cliente con Experian (Aprobado ATDP desde Correo).

para acceder, se debe realizar un consumo al servicio web REST, el cual contempla las siguientes directrices técnicas:

Operación #

Estructura modelo de consulta #

Estructura modelo de respuesta #

SERVICIO DE APROBACIÓN MULTIPLES DOCUMENTOS #

Este servicio se encarga de facilitar la aprobación de varios documentos por parte de los firmantes involucrados, con el fin de aumentar la efectividad y el tiempo de respuesta al momento de necesitar la aprobación de varios documentos por parte de uno o varios involucrados. Todos los documentos firmados con este método serán firmados electrónica y digitalmente. Para los documentos de vaucher y factura protegida es necesario tener un pagaré firmado, de lo contrario el sistema solicitara una petición con pagaré firmado 

Operación #

Estructura modelo de consulta #

Estructura modelo de respuesta #

SERVICIO DE CONSULTA ESTADO DOCUMENTO #

Este servicio se encarga de recopilar la información referente al documento solicitado, con el fin de conocer el tipo de documento, el estado del envío y la firma, además detallar si este fue exitoso o fallido, se debe realizar un consumo al servicio web REST, el cual contempla las siguientes directrices técnicas:

Operación #

Estructura modelo de consulta #

Estructura modelo de respuesta #

SERVICIO DE OBTENCIÓN DOCUMENTO #

Este servicio se encarga facilitar el documento pagaré posterior a su revisión y aprobación por parte del solicitante del crédito, se debe realizar un consumo al servicio web REST, el cual contempla las siguientes directrices técnicas:

Operación #

Estructura modelo de consulta #

Estructura modelo de respuesta #

SERVICIO DE CONSULTA ESTADO DE FIRMA DOCUMENTO #

Este servicio se encarga de detallar el o los usuarios involucrados en la aprobación del documento, tipo de usuario involucrado, fecha de la transacción, estado de la firma etc. Se debe realizar un consumo al servicio web REST, el cual contempla las siguientes directrices técnicas:

Operación #

Estructura modelo de consulta #

Estructura modelo de respuesta #

Estados Documento ID #

SERVICIO DE SOLICITUD DE DOCUMENTO #

Este servicio se encarga de dos funcionalidades específicas, una es la solicitud de un documento plantilla almacenado en la BD y la otra es recibir un documento enviado por el usuario de tipo Base64. Esto dependiendo de la petición realizada al servicio.

Operación #

Estructura modelo de consulta #

Estructura de modelo de respuesta #

SERVICIO DE OBTENER MULTIPLES DOCUMENTOS #

Este servicio se encarga de facilitar uno o varios documentos al usuario solicitante, antes de su aprobación y firma. Esto se controla mediante el GUID único, generado por cada petición realizada por el usuario final.

Operación #

Estructura modelo de consulta #

Estructura de modelo de respuesta #

SERVICIO OBTENER MÚLTIPLES DOCUMENTOS CON PROCESO CLIENTE #

Este servicio se encarga de facilitar uno o varios documentos dependiendo si en la petición realizada en el servicio Documento/AprobacionMultiplesDocumentos se envió uno o varios documentos, con el uso de este servicio se obtienen los documentos firmados electrónica y digitalmente

Operación #

Estructura modelo de consulta #

Estructura modelo de respuesta #

SERVICIO DE FIRMA MÚLTIPLES DOCUMENTOS #

Este servicio se encarga de firma los documentos enviados desde el servicio /AprobacionMultipleDocmentos, en caso de ser una petición realizada con codeudores, esté servicio individualiza las firmas con el guid enviado a cada involucrado en la url que llega a cada firmante en el correo y SMS. Aquí se detalla el sistema operativo desde el cual se firma el documento, la versión, el navegador web usado y su versión y la dirección IP del dispositivo desde el cual se realizo el proceso de firma electrónica.

Operación #

Estructura modelo de consulta #

Estructura modelo de respuesta #

SERVICIO DE CONSULTA TRANSACCIÓN #

El servicio se encarga de la consulta del estado de la transacción que se genera en cada uno de los métodos a asociados al API que están sujetos al IdProcesocliente.

Operación #

Estructura modelo de consulta #

Estructura modelo de respuesta #

SERVICIO DE CREACIÓN PLANTILLA #

El servicio se encarga del almacenamiento de las plantillas que va a ser ejecutadas en el servicio de múltiples documentos, hay que recalcar que los campos que se crean en el archivo PDF de plantilla deben estar congruentes con el servicio de múltiples documentos.

Operación #

Estructura modelo de consulta #

SERVICIO DE REENVÍO OTP #

Este servicio se encarga de reenviar el SMS y correo electrónico con la información pertinente para firmar los documentos solicitados, esta funcionalidad se utiliza al momento de que el involucrado en la firma electrónica del documento excedió en tiempo limite para firmar o lo rechazo por error y se requiero hacer el envió nuevamente sin necesidad de realizar una nueva petición.

Operación #

Estructura modelo de consulta #

Estructura modelo de respuesta #

SERVICO DE CONSULTA ESTADO DE PROCESO #

Este servicio se encarga de facilitar la información del estado de las peticiones realizadas al API, detalla el servicio consumido la fecha en la que se realizó el consumo del servicio y si este fue exitoso o fallido

Operación #

Estructura modelo de consulta #

Estructura modelo de respuesta #

SERVICIO DE CONSULTA ESTADO DE FIRMA DOCUMENTO #

Este servicio se encarga de suministrar el estado actual de las firmas electrónicos del documento o documentos consultados, para proporcionar información acerca de que involucrada ha firmado el documento, cual está pendiente por firmar y quien lo rechazo.

Operación #

Estructura modelo de consulta #

Estructura modelo de respuesta #

SERVICIO DE CONSULTA DATACREDITO EXPIRIAN #

Este servicio se encarga de validar los datos y la información de la persona (correo y celular).

Operación #

Estructura modelo de consulta #

Estructura modelo de respuesta #

SERVICIO PARA LA RECEPCION DE DOCUMENTOS DEL CLIENTE #

Este servicio se encarga cargar documentos del deudor faltantes (cedula y factura del comercio).

Operación #

Estructura modelo de consulta #

Estructura modelo de respuesta #

CONTROL DE CAMBIOS #

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.