Ejemplo de consulta en la aplicación

Solicitudes de API en Verifik

Verifik ofrece una potente interfaz sin código para validar personas, empresas, vehículos y más en múltiples países. La plataforma proporciona una variedad de endpoints de API que los usuarios pueden consultar para obtener diversos datos relacionados con la verificación de identidad, validación de empresas, comprobación de registro de vehículos e incluso verificaciones de antecedentes. A continuación, se presenta una guía paso a paso sobre cómo realizar solicitudes de API dentro de la plataforma Verifik:

1. Selección de un Endpoint de API

  • Buscar la API aquí: Comienza seleccionando el tipo de validación que deseas realizar (persona, empresa o vehículo) utilizando la barra de búsqueda. Puedes filtrar por país y categoría (por ejemplo, Identidad, Verificación de Antecedentes, Validación Empresarial).

  • Lista de Endpoints de API: En la barra lateral izquierda encontrarás una lista de los endpoints de API disponibles para la validación. Cada endpoint está etiquetado con:

    • Una bandera del país (indicando de qué país provienen los datos).

    • El tipo de servicio que ofrece (Identidad, Verificación de Antecedentes, Validación Empresarial, etc.).

    • El costo por consulta (por ejemplo, $0.05 por solicitud). El precio depende del plan que tengas en tu cuenta, con un precio inicial de $0.20 por solicitud de API.

  • Selecciona tu API: Por ejemplo, si deseas validar a un ciudadano colombiano, puedes seleccionar la API de Información de Ciudadanos Colombianos (/v2/co/cedula), que proporciona detalles de identificación como nombre completo y número de identificación.

  • Lista de puntos finales de la API: la barra lateral izquierda proporciona una lista de puntos finales de la API disponibles para la validación. Cada punto final está etiquetado con:

    • Una bandera de país (que indica de qué país extrae los datos).

    • El tipo de servicio que ofrece (identidad, verificación de antecedentes, validación comercial, etc.).

    • El costo por consulta (por ejemplo, $0.05 por solicitud). El precio depende del plan que tenga actualmente en su cuenta. El precio inicial es de $0.20 por solicitud de API.

  • Seleccione su API: por ejemplo, si desea validar a un ciudadano colombiano, puede seleccionar la API de información de ciudadanos colombianos (/v2/co/cedula), que recupera detalles de identificación como el nombre completo y el número de identificación.

2. Introducir Parámetros de Entrada

  • Tipo de Documento:

    Una vez que hayas seleccionado una API, aparecerán los campos de entrada. Para las API de verificación de identidad, generalmente deberás ingresar un tipo de documento (por ejemplo, CC para la Cédula Colombiana).

  • Número de Documento: Ingresa el número de documento del ciudadano en el campo correspondiente (por ejemplo, 1023942106).

  • Agregar Más Consultas: Puedes añadir múltiples consultas a tu lista seleccionando el botón "+ Agregar", lo que te permitirá validar varias personas o documentos en una sola sesión.

Listas Dinámicas a través de la API:

El sistema maneja listas de forma dinámica. Cuando agregas un número de documento u otro dato a validar, Verifik coloca automáticamente esta solicitud en la cola de tu sesión. Este procesamiento dinámico permite validar grandes listas de manera rápida y eficiente.

3. Visualización del Carrito y Costo

  • Resumen del Carrito:

    • Una vez que hayas agregado una o más consultas, el costo total de tus solicitudes se mostrará en la barra lateral derecha. Aquí puedes revisar todas las llamadas a la API en cola.

    • Cada solicitud de API mostrará el número de documento o los datos de entrada que estás consultando.

    • El precio por llamada a la API se indicará claramente, permitiéndote hacer un seguimiento del costo total.

    Borrar Todo:

    Si deseas eliminar todas las entradas antes de continuar, puedes limpiar tu carrito haciendo clic en el botón "Borrar todo".

    Ejecutar la Consulta: Cuando estés listo, haz clic en el botón "Consultar" para ejecutar las llamadas a la API y recuperar los datos.

4. Resultados y Datos de Respuesta

  • Servicios Consultados:

    Después de enviar las consultas, el sistema devuelve los resultados en el Informe de Consultas. Para cada documento o solicitud de validación, se muestra:

    • El endpoint de la API utilizado (por ejemplo, /v2/co/cedula).

    • Los parámetros de entrada (por ejemplo, Número de Documento y Tipo de Documento).

    • Los resultados, incluyendo el nombre completo de la persona y el estado de la verificación del documento.

    Vistas: Sin Código y JSON

    Los resultados se pueden visualizar en dos formatos:

    • Vista Sin Código: Presenta los resultados en un formato de tabla fácil de leer.

    • Vista JSON: Si necesitas acceder a los datos sin procesar o integrarlos en tus sistemas, la respuesta está disponible en formato JSON, lo que facilita la integración de los resultados en tus propias aplicaciones o plataformas.

    Información Clave Devuelta:

    • Nombre Completo: El nombre legal completo asociado con el número de documento.

    • Número de Documento: El número de identificación único proporcionado.

    • Fecha de Nacimiento y Fecha de Expedición: Algunas API pueden devolver datos privados o semiprivados, como fechas de nacimiento, fechas de emisión del documento o detalles adicionales sobre su autenticidad.

    Países y Categorías Compatibles

    La plataforma de API de Verifik admite una amplia gama de países y categorías de validación:

    • Países Compatibles: Puedes seleccionar diferentes países para tus consultas de validación, incluyendo Colombia, México, Estados Unidos, entre otros. El sistema muestra dinámicamente todas las API disponibles según el país seleccionado.

    • Categorías de Validación:

      • Verificación de Identidad: Validación de individuos mediante sistemas de identificación nacionales.

      • Verificación de Antecedentes: Consulta de registros criminales, listas de vigilancia y más.

      • Validación Empresarial: Verificación de la legitimidad de empresas registradas, su estado legal y presentaciones públicas.

      • Validación de Vehículos: Recuperación de información sobre registros de vehículos, propiedad y estado legal.

    Ejemplo de Código para Integración con la API

    Para los desarrolladores que deseen integrar los servicios de API de Verifik en sus propias aplicaciones, aquí tienes un ejemplo de código en JavaScript (Axios) para realizar una solicitud a la API:

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.verifik.co/v2/co/cedula',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer YOUR_API_KEY',
  },
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error('Error making the request:', error);
}

Cómo Funciona:

  • Autorización: Cada solicitud a la API de Verifik requiere un token JWT válido en los encabezados.

  • Endpoint: La URL de la API especifica el país y el tipo de datos que estás consultando (por ejemplo, /v2/co/cedula es para la información de ciudadanos colombianos).

  • Respuesta: La API devolverá una respuesta estructurada en formato JSON con los datos de la persona consultada, que pueden ser procesados según las necesidades de tu aplicación.

Conclusión

La plataforma de Verifik ofrece una solución fluida basada en interfaces sin código y API para validar personas, empresas y vehículos en múltiples países. Ya sea que necesites verificaciones de identidad en tiempo real, registros empresariales o verificaciones de antecedentes, el sistema dinámico de API de Verifik se adapta a tus necesidades, permitiendo procesos de validación rápidos, escalables y totalmente integrables con tus sistemas existentes.

Esta guía está diseñada para ayudar a usuarios, desarrolladores y organizaciones a comenzar rápidamente con la potente suite de APIs de Verifik para sus necesidades de KYC y cumplimiento normativo.

PreviousRevisión InteligenteNextAcceso Inteligente

Last updated