Documentacion PSD

1. APIs

En el modulo de API nos dirigimos a "PSD" (pruebas o producción).

2. Metodo Authenticate

En el metodo "ValidarIdentidad" dando click al boton "Try it" visualizaremos el cuerpo de la petición donde digitaremos las credenciales. Activamos el boton "Send" y en la respuesta copiaremos el parametro "Registro"

3. Metodo Validate

Nos dirigimos al metodo "GenerarPreguntas" y dando click al boton "Try it" digitaremos en el cuerpo de la petición las credenciales y el parametro "Registro". Enviamos la petición con el boton "Send" y copiamos el parametro "RegistroCuestionario" e "IdeCuestionario"

4. Metodo Enviar Respuesta

Por ultimo nos dirigimos al metodo "EnviarRespuestas" y dando click al boton "Try it" digitaremos en el cuerpo de la petición los parametros copiados anteriormente y las respuestas a las preguntas. Activamos el boton "Send" y visualizaremos en la respuesta nuestro resultado final

5. Video Consumo


Control de Cambios


Versión Fecha Descripción
1.0 24/03/2022 Creación Documento

Introducción

El servicio PSD permite la generación y validación de preguntas sociodemográficas acerca de una persona con el fin de validar si es o no quien dice ser. Este servicio está conformado por tres métodos, como sigue:


6. Información del Servicio


7. Metodos

La entidad cliente para consumir el servicio se llama FachadaServicioPSDClient, a través de ésta se hacen los llamados a los métodos del servicio pasando los argumentos respectivos explicados más adelante.

7.1 Dependecia

Existe una dependencia entre los métodos, pues algunos parámetros de salida de uno hacen parte de los parámetros de entrada de otro, por ello el llamado de los métodos se debe realizar en el siguiente orden:

7.2 Descripción

A continuación, se describe cada uno de los métodos del servicio, sus argumentos de entrada, sus respuestas y ejemplos de petición y respuesta. Hay que tener en cuenta que en cada una de las peticiones a los métodos deben ir las credenciales de autenticación ya mencionadas:

8 Validar Identidad

Dado el tipo, número de documento de identificación, primer apellido, segundo apellido (opcional), nombre(s) y credenciales, se determina sí los datos son válidos para el sistema y corresponden con las bases de datos de DataCrédito. Existe un control de intentos fallidos para la validación diario, si este es superado se retornará el código respectivo y no se continúa con el proceso.

Los argumentos de entrada se encuentran definidos a través de la entidad RequestValidacion:

5. Enviar Respuestas

Sí la generación de preguntas fue exitosa, el cliente procede a capturar las respuestas para cada pregunta. Dado el tipo y número del documento de identificación, identificador del cuestionario, registro del cuestionario, respuestas a las preguntas y las credenciales, se solicita la validación de las respuestas. El servicio hace la comparación con las respuestas reales de las preguntas y devuelve un código de aprobación o desaprobación de la identificación.

Los argumentos de entrada se encuentran definidos a través de la entidad RequestEnviarRespuestas:

Atributo Descripción Tipo Obligatorio
Codigo Aplicacion Código de Aplicacion del cliente GUID SI
Usuario Usuario de autenticación STRING SI
Contrasena Contraseña de autenticación STRING SI
Numero de Identificación Número de identificación LONG SI
Tipo de Identificación Tipo de identificación: 1 - Cedula de ciudadanía 4 – Cedula de extranjería. INT SI
Nombres Nombre(s) de la persona STRING SI
PrimerApellido Primer apellido de la persona STRING SI
SegundoApellido Segundo apellido de la persona STRING NO
IdCuestionario Identificador del cuestionario. Este valor se obtiene de la respuesta del método GenerarPreguntas. STRING SI
RegistroCuestionario Número de registro en el que se almacenó el cuestionario. Este valor se obtiene de la respuesta del método anterior. LONG SI
Respuestas Contiene las respuestas a las preguntas LISTA NO

Cada una de las respuestas contenidas en el listado Respuestas, está definida como sigue:

Atributo Descripción Tipo Obligatorio
IdPregunta Identificador de la pregunta STRING SI
IdRespuesta Identificador de la Respuesta STRING SI

Las respuestas del método se encuentra definida a través de la entidad ResponseEnviarRespuesta:

Atributo Descripción Tipo Obligatorio
CodigoRespuesta Código de la respuesta STRING SI
DescripcionRespuesta Descripción de la respuesta STRING SI
CodigoSeguridad Código de seguridad asignado a la verificación realizada STRING SI
PreguntasCompletas Indica si todas las preguntas evaluadas tenían respuesta o no BOOL SI
Resultado Indica si se pudo realizar la verificación de las respuestas o no BOOL SI
Score Puntaje de la verificación INT NO

5.1 EJEMPLOS

PETICINÓN (XML):

RESPUESTA (XML):

6 CODIGOS DE RESPUESTA

A continuación, se describen una serie de tablas que describen los distintos códigos de respuesta y sus descripciones, dependiendo del método que se esté usando:

6.1. TABLA 1 - VALIDAR IDENTIDAD

Codigo Descripción
01 Valido con historia de crédito
05 Valido sin historia de crédito
06 No coinciden los datos
07 No existe identificación
08 Valido con número de documento no vigente
09 Superado el número de intentos validos máximo
10 El servicio web no permite la utilización del producto evidente+, conectarse a idws2
11 Cliente monitoreado por la entidad consultada no autorizada

6.2. TABLA 2 - GENERAR PREGUNTAS

Codigo Descripción
00 No tiene activa la opción de última consulta o no hubo resultados para la solicitud
01 Preguntas generadas con éxito
02 Error en el proceso de generación de preguntas
07 No hay suficientes preguntas
10 Máximo de intentos por día
11 Máximo de intentos por mes
12 Máximo de intentos por año
13 Excedió el número de ingresos permitidos para el producto por este día
14 Excedió el número de ingresos permitidos para el producto por este mes
15 Excedió el número de ingresos permitidos para el producto por este año

6.3. TABLA 3 - ENVIAR RESPUESTAS

Codigo Descripción
00 Aprovado
01 No Aprovado

7. ERRORES CONOCIDOS

Se listan los posibles errores conocidos que se pueden presentar durante el consumo de los métodos del servicio, en dado caso que se obtenga un error que no se encuentre en la tabla o se desee mas información del error, se debe coordinar con el proveedor del servicio para realizar una revisión mas detallada:

Codigo Descripción
1001 El número de identificación es invalido
1002 Los nombres son vacíos
1003 El primer apellido es vacío
1004 El segundo apellido es vacío
1006 El numero de registro es invalido
1007 El id del cuestionario es invalido
1008 El registro del cuestionario es invalido
1009 El id de la pregunta es vacío
1010 El id de la respuesta es invalido
1011 El código de la aplicación es vacío
1012 El usuario de la aplicación es vacío
1013 La contraseña de la aplicación es vacía
1014 El usuario no esta activo
1015 No existen las credenciales
1016 No se pudo obtener el id de la aplicación
1017 No se pudo obtener el id de la solicitud de Validación de Identidad
1018 No se pudo obtener el id de la solicitud de Generación de Preguntas
1019 No se pudo actualizar el estado de respuesta en la solicitud de Validación de Identidad
1020 No se pudo actualizar el estado de respuesta en la solicitud de Generación de Preguntas
1021 No se pudo actualizar el estado de respuesta en la solicitud de Envío de Respuestas
1022 Se obtuvo una respuesta vacía empleando el método de Validación de Identidad
1023 Se obtuvo una respuesta vacía empleando el método de Generación de Preguntas
1024 Se obtuvo una respuesta vacía empleando el método de Envió de Respuestas
1025 El id de la solicitud actual es cero
1027 No se pudo obtener la descripción de la respuesta a la solicitud
9998 Error interno del servicio - capa fachada
9999 Error interno del servicio - capa dominio