🔌 Introducción a la API

Esta página tiene una introducción rápida a las especificaciones de referencia de nuestra API, con algunos detalles sobre los estados y resultados de los reportes y el estado de la persona/carpeta.

Autenticación 🔒

La autenticación requiere únicamente el encabezado X-Api-Key configurado con tu clave API.

Cómo obtener una Clave API 🔑

La Clave API es el token que necesitarás para autenticarte en nuestros sistemas. Si aún necesitas obtener una, por favor contáctanos.

Estados y resultados de reportes

Cada reporte ejecutado pasa por una serie de estados hasta completarse. Los valores posibles de state son PENDING, PENDING_MANUAL_REVIEW (si está habilitado), COMPLETED, ERROR e INCOMPLETE. Cada state puede tener un resultado PASSED, FAILED o INFO.

Para una comprensión más profunda de cómo funcionan los reportes, puedes consultar el diagrama Flujo de Estados de Reportes en nuestras guías.

Estados 📌

PENDING o PENDING_MANUAL_REVIEW

Estamos construyendo los detalles del reporte y el resultado para ti, esperando que las fuentes devuelvan los resultados de las verificaciones y revisando aquellas que requieren intervención humana de nuestro equipo de expertos.

COMPLETED

¡Excelente! Todas las verificaciones se realizaron exitosamente y deberías tener tu resultado final.

INCOMPLETE

Revisa el mensaje dentro de los detalles de tu reporte. Usa el endpoint Obtener detalles de reportes.

ERROR

¡Oh no! Algo salió mal al procesar este reporte. Puedes intentar activar una actualización de reportes o contactar a nuestro equipo de soporte.

Estado	Descripción
PENDING	El primer estado de todos los reportes cuando se crea, actualiza una persona o se activa la actualización de reportes. Significa que las verificaciones se están realizando.
PENDING_MANUAL_REVIEW	El reporte está en cola para Revisión Manual. Ocurre cuando se han realizado verificaciones automatizadas, pero el reporte necesitó una Revisión Manual (usualmente cuando hay un resultado FAILED de las verificaciones automatizadas).
COMPLETED	Este estado representa que el reporte ha completado todas las verificaciones y debería incluir un resultado final (PASSED o FAILED) o solo los datos solicitados (para reportes con resultado BODY - sin toma de decisiones).
INCOMPLETE	Significa que el reporte no pudo completarse por alguna razón: la información proporcionada no era válida o no se encontró en las fuentes/bases de datos, los datos encontrados no fueron suficientes para alcanzar un resultado final bajo las reglas proporcionadas.
ERROR	Este estado significa que algo salió mal con la verificación: las fuentes pueden haber estado caídas por mucho tiempo o ocurrió un error interno en la API de Emptor.

Resultados ✅

Resultado	Descripción
PASSED	Este resultado significa que, bajo las reglas proporcionadas por el cliente (previamente acordadas o proporcionadas dentro de la solicitud Crear una Persona), no se encontraron datos que resultaran en un resultado FAILED (ej. no se encontraron antecedentes penales).
FAILED	Significa que, bajo las reglas proporcionadas por el cliente (previamente acordadas o proporcionadas dentro de la solicitud Crear una Persona), se encontró suficiente información para resultar en un resultado FAILED (ej. se encontraron antecedentes penales).
INFO	Este resultado significa que el reporte fue solicitado solo como informativo y se limitará a devolver un conjunto de datos, no un resultado de toma de decisiones como PASSED o FAILED.

Estado de Carpeta 🧾

La carpeta es, básicamente, el agregado de todos los reportes habilitados para una Persona dada. A diferencia de los reportes, que tienen state y outcome, la carpeta solo tiene un status que incluye valores tanto de los estados como de los resultados de los reportes como se describe a continuación.

El estado de la carpeta es el mismo que el estado de la Persona, que puedes obtener haciendo una solicitud al endpoint Obtener Estado de una Persona.

Para una comprensión más profunda de cómo funcionan las Carpetas, puedes consultar el gráfico Flujo de Estado de Carpetas en las Guías.

Estado	Descripción
PENDING	Cuando todos los reportes están en state PENDING.
PENDING_MANUAL_REVIEW	Cuando hay reportes en state PENDING_MANUAL_REVIEW.
PASSED	Cuando todos los reportes están en state COMPLETED y ninguno de ellos resultó en un outcome FAILED.
FAILED	Cuando todos los reportes están en state COMPLETED y al menos uno de ellos resultó en un outcome FAILED.
INCOMPLETE	Cuando no hay reportes en estado ERROR, pero al menos uno de ellos está en state INCOMPLETE.
ERROR	Cuando al menos un reporte está en estado ERROR o si hubo un problema calculando el estado.

Flujo de Estado del Reporte

Para cada reporte ejecutado, pasa por una serie de estados hasta completarse. Esos estados son PENDING, PENDING_MANUAL_REVIEW (si está habilitado), COMPLETED, ERROR e INCOMPLETE. Cada estado puede tener un resultado PASSED, FAILED o INFO. Puedes ver la transición entre estados en el siguiente diagrama.

Flujo de Estado de Carpeta

Después de crear una persona, actualizar una persona, o activar la actualización de reportes, la lógica del estado de la carpeta puede determinarse con el siguiente diagrama.

¡Estamos aquí para ayudar! 🙋‍♂️

Si tienes alguna pregunta, aún puedes contactarnos en support@emptor.io 📧.