¿Qué es API Universal?
Es una herramienta que permite a nuestros clientes registrar candidatos, consultar paquetes y obtener información de los procesos, integrándose de manera sencilla con sus sistemas actuales.
Nuestra nueva API Universal es una actualización clave que nos permitirá atraer a nuevos clientes y crecer nuestra oferta tecnológica en el mercado.
¿cómo funciona API Universal?
Al cliente se le proporciona la documentación y llaves de acceso necesarias para que pueda acceder y autenticarse de forma exitosa.
Los usuarios de API Universal pueden:
Registro de candidatos:
Los usuarios podrán registrar candidatos por National ID y Nombre.
El registro por nombre requiere:
- Nombre completo (nombre, apellido paterno y materno)
- Fecha de nacimiento
- Sexo
- Estado
Registro por National ID:
Se requiere el National ID del candidato.
También se podrá solicitar campos adicionales dependiendo del paquete seleccionado por el cliente y de los procesos incluidos, como:
- Correo Electrónico
- NSS
- RFC
Consulta de Paquetes y Procesos
Los usuarios podrán consultar la información de sus registros a través de dos endpoints; el primer endpoint brinda el detalle general del registro, como:
Datos del Candidato: Información completa del candidato.
Nombre del Paquete: Detalles del paquete asignado.
Resultado Global y Estatus Global: Información del avance del proceso.
Resultado Global del Paquete:
Recomendado
Recomendado con reserva
No recomendado
Pendiente
No completado
Fecha de Finalización Global
Estatus Global del Paquete:
Finalizado
Validando
En proceso
Expirado
Procesos Individuales del Paquete:
Estatus del Proceso
Resultado del Proceso
Fecha de Finalización
El segundo endpoint está enfocado en el detalle de los procesos. Este detalle devolverá la información descrita en los niveles de visibilidad 3 y 4. Dependiendo el proceso es el nivel de detalle que entregará la API, ejemplo:
- Global Watchlist entrega información hasta el nivel 3.
- BGC Laboral entrega información hasta el nivel 4.
Al cliente se le entregan ambos endpoints para su uso.
Niveles de visibilidad
BGC Legal
Nivel 1
Información del Paquete
Paquete
Resultado
Estatus
Fecha de inicio
Fecha de fin
Procesos
Nivel 2
Información del Proceso
Nombre proceso
Resultado
Estatus
Fecha de inicio proceso
Fecha de fin proceso
Tiempo de evaluación
Detalle del proceso
Nivel 3
Detalle de proceso
Si encuentra juicios:
Fuentes consultadas
Detalle de la evaluación (por registro):
Actor
Demandado
Tipo
Expediente
Federal
Estado
Órgano jurisdiccional
Juicio
Delito
Materia
Información adicional
Registros encontrados
Si no encuentra juicios:
Fuentes consultadas
Nivel 4
Mayor detalle
Si encuentra juicios:
Registros encontrados:
Actor
Demandado
Tipo
Expediente
Federal
Estado
Órgano jurisdiccional
BGC News
Nivel 1
Información del Paquete
Paquete
Resultado
Estatus
Fecha de inicio
Fecha de fin
Procesos
Nivel 2
Información del Proceso
Nombre proceso
Resultado
Estatus
Fecha de inicio proceso
Fecha de fin proceso
Tiempo de evaluación
Detalle del proceso
Nivel 3
Detalle de proceso
Si encuentra noticias:
Fuentes consultadas
Resumen general
Detalle de la evaluación (por enlace):
Tipo de noticia
URL
Tipo de delito
Comentarios de la evaluación
Registros encontrados
Si encuentra noticias y es resultado automático:
Fuentes consultadas
Registros encontrados
Noticias adversas
URL
Noticias generales
URL
Si no encuentra juicios:
Fuentes consultadas
Nivel 4
Mayor detalle
Si encuentra noticias:
Registros encontrados
Noticias adversas
URL
Noticias generales
URL
Global Watchlist
Nivel 1
Información del Paquete
Paquete
Resultado
Estatus
Fecha de inicio
Fecha de fin
Procesos
Nivel 2
Información del Proceso
Nombre proceso
Resultado
Estatus
Fecha de inicio proceso
Fecha de fin proceso
Tiempo de evaluación
Detalle del proceso
Nivel 3
Detalle de proceso
Si encuentran en listas y es automático:
Fuentes consultadas
Detalle de la evaluación (por lista)
Lista
País
Nombre
Nacimiento
Nacionalidad
Detalle adicional
URL
Si encuentran en listas y llega a QC:
Fuentes consultadas
Detalle de la evaluación (por lista)
Lista
País
Nombre
Nacimiento
Nacionalidad
Detalle adicional
URL
Comentarios de la evaluación
Si no encuentran en listas:
Fuentes consultadas
PEPs
Nivel 1
Información del Paquete
Paquete
Resultado
Estatus
Fecha de inicio
Fecha de fin
Procesos
Nivel 2
Información del Proceso
Nombre proceso
Resultado
Estatus
Fecha de inicio proceso
Fecha de fin proceso
Tiempo de evaluación
Detalle del proceso
Nivel 3
Detalle de proceso
Si se encuentran puestos:
Puestos encontrados (por puesto)
Puesto
Área
Dependencia
Disposición
Inicio – Fin del cargo
Entidad
Ingresos
RFC
Estatus
Personas relacionadas
Nombre
Parentesco
Puesto
National ID
Estatus
Si no encuentra juicios:
Puestos encontrados: No se encontró información del candidato.
Personales relacionadas: No se encontró información del candidato.
BGC Laboral
Nivel 1
Información del Paquete
Paquete
Resultado
Estatus
Fecha de inicio
Fecha de fin
Procesos
Nivel 2
Información del Proceso
Nombre proceso
Resultado
Estatus
Fecha de inicio proceso
Fecha de fin proceso
Tiempo de evaluación
Detalle del proceso
Nivel 3
Detalle de proceso
NNS
CURP
Fecha de emisión del reporte
Resumen IMSS
Semanas cotizadas
Semanas descontadas
Total de semanas cotizadas
Información generada por BlackTrust
Total de razones sociales
Total de empleos
Semanas promedio por empleo
Total de años laborando
Fuente consultada
Detalle de empleo
Nivel 4
Mayor detalle
Detalle de empleo
Empresa
RFC empresa
Dirección
Fecha de Alta
Fecha de Baja
Semanas laboradas
Salario Base de Cotización
BTrust
Nivel 1
Información del Paquete
Paquete
Resultado
Estatus
Fecha de inicio
Fecha de fin
Procesos
Nivel 2
Información del Proceso
Nombre proceso
Resultado
Estatus
Fecha de inicio proceso
Fecha de fin proceso
Tiempo de evaluación
Detalle del proceso
Nivel 3
Detalle de proceso
Reporte BTrust
National ID
Perfil
Inicio
Fin
Duración
Detalle por categoría del reporte BTrust
Nivel 4
Mayor detalle
Detalle por categoría del reporte BTrust
Congruencia
Porcentaje
Resultado
Nivel de riesgo
Credibilidad
Porcentaje
Riesgo
Delitos
Porcentaje
Resultado
Nivel de riesgo
Robo
Porcentaje
Resultado
Nivel de riesgo
Violencia
Porcentaje
Resultado
Nivel de riesgo
Documentos
Nivel 1
Información del Paquete
Paquete
Resultado
Estatus
Fecha de inicio
Fecha de fin
Procesos
Nivel 2
Información del Proceso
Nombre proceso
Resultado
Estatus
Fecha de inicio proceso
Fecha de fin proceso
Tiempo de evaluación
Detalle del proceso
Detalle de proceso
Nombre del documento
Estatus documento
Resultado del documento
Obligatorio: Obligatorio/opcional
Adjuntado por:
Comentario:
Referencias Laborales
Nivel 1
Información del Paquete
Paquete
Resultado
Estatus
Fecha de inicio
Fecha de fin
Procesos
Nivel 2
Información del Proceso
Nombre proceso
Resultado
Estatus
Fecha de inicio proceso
Fecha de fin proceso
Tiempo de evaluación
Detalle del proceso
Nivel 3
Detalle de proceso
No. de Referencia
Nombre de referencia
Puesto del jefe directo
Nombre de la empresa
Puesto desempeñado por el candidato
Fecha Inicio
Fecha Fin
Observaciones sobre el colaborador
Referencias Personales
Nivel 1
Información del Paquete
Paquete
Resultado
Estatus
Fecha de inicio
Fecha de fin
Procesos
Nivel 2
Información del Proceso
Nombre proceso
Resultado
Estatus
Fecha de inicio proceso
Fecha de fin proceso
Tiempo de evaluación
Detalle del proceso
Nivel 3
Detalle de proceso
No. de Referencia
Resultado de la referencia
Nombre de referencia
Relación con el candidato
Tiempo de conocerse
Se conocieron en
Fortalezas percibidas
Áreas de oportunidad
Problema o situación con el candidato
¿Se recomienda para trabajar en una empresa?
Comentarios adicionales
Listas Negras del SAT
Nivel 1
Información del Paquete
Paquete
Resultado
Estatus
Fecha de inicio
Fecha de fin
Procesos
Nivel 2
Información del Proceso
Nombre proceso
Resultado
Estatus
Fecha de inicio proceso
Fecha de fin proceso
Tiempo de evaluación
Detalle del proceso
Nivel 3
Detalle de proceso
Fuente consultada
Validación de situación del RFC
Resultado de la búsqueda del RFC en las lista 69B y 69
Reporte de Crédito
Nivel 1
Información del Paquete
Paquete
Resultado
Estatus
Fecha de inicio
Fecha de fin
Procesos
Nivel 2
Información del Proceso
Nombre proceso
Resultado
Estatus
Fecha de inicio proceso
Fecha de fin proceso
Tiempo de evaluación
Detalle del proceso
Nivel 3
Detalle de proceso
Alcance
El detalle dependerá de la configuración del microservicio con alguna de las 4 opciones:
Reporte de Crédito en formato .pdf extraído directamente de la fuente consultado desde plataforma (Ya existe) o API.
BC Score en formato Json extraído desde API BC y consultado desde API btapp.
Reporte de Crédito en formato Json extraído desde API BC y consultado desde API btapp.
Reporte de Crédito en formato .pdf + BC Score puede ser consultado desde API btapp.
Geolocalización
Nivel 1
Información del Paquete
Paquete
Resultado
Estatus
Fecha de inicio
Fecha de fin
Procesos
Nivel 2
Información del Proceso
Nombre proceso
Resultado
Estatus
Fecha de inicio proceso
Fecha de fin proceso
Tiempo de evaluación
Detalle del proceso
Nivel 3
Detalle de proceso
URL de ubicación
Dirección proporcionada
Notas de la evaluación
Nombre del documento
Obligatorio: obligatorio u opcional
Resultado del documento
Comentarios de la evaluación
Validación de Estudios
Nivel 1
Información del Paquete
Paquete
Resultado
Estatus
Fecha de inicio
Fecha de fin
Procesos
Nivel 2
Información del Proceso
Nombre proceso
Resultado
Estatus
Fecha de inicio proceso
Fecha de fin proceso
Tiempo de evaluación
Detalle del proceso
Nivel 3
Detalle de proceso
Ultimo grado de estudios
Estatus de grado
Institución educativa
Fecha Inicio
Fecha Fin
Profesión o carrera
Comprobante de estudios
Estatus de documento
Adjuntado por:
Comentarios de la evaluación
Proceso de consentimiento
Nivel 1
Información del Paquete
Paquete
Resultado
Estatus
Fecha de inicio
Fecha de fin
Procesos
Nivel 2
Información del Proceso
Nombre proceso
Resultado
Estatus
Fecha de inicio proceso
Fecha de fin proceso
Tiempo de evaluación
Detalle del proceso
Validación de Identidad (Amazon)
Nivel 1
Información del Paquete
Paquete
Resultado
Estatus
Fecha de inicio
Fecha de fin
Procesos
Nivel 2
Información del Proceso
Nombre proceso
Resultado
Estatus
Fecha de inicio proceso
Fecha de fin proceso
Tiempo de evaluación
Detalle del proceso
aPI Buró de Crédito
La API Universal también permite obtener información detallada del Reporte de Crédito, que puede configurarse en distintos formatos según las necesidades del cliente:
Reporte de Crédito en PDF:
Enlace para la descarga del reporte en formato PDF.
BC Score:
Información del BC Score con detalles clave:
- codigoScore: «002»
- valorScore: «0724»
- score: «% de probabilidad de pago»
- codigoRazon: [“001”, “004”, “008”]
- Razón: Nivel de endeudamiento, consulta reciente, aumento en cuentas con endeudamiento.
Especificaciones para Buró de Crédito
Para el proceso del buró de crédito, se le permite al cliente elegir el responsable de la recolección de datos necesarios para la consulta de información crediticia:
Si el Cliente decide recolectar los datos, debe de completar estos campos durante el registro:
NIP (cuatro dígitos del año de nacimiento del candidato).
Timestamp de Consentimiento.
Timestamp de Términos y Condiciones.
- Domicilio Personal y Domicilio Laboral.
Si el Cliente decide que BlackTrust recolecte los datos, se debe de completar estos campos durante el registro para solicitarlos en Candidate Web:
Correo electrónico del candidato.
El cliente tiene cuatro formas de obtener la información. Esta forma debe de definirla al momento de la contratación del servicio. Las opciones son las siguientes:
Acércate a Producto si tienes alguna duda respecto a la API Universal.