API SPEC · V1 · GADEVELOPER REFERENCE

    API para desarrolladores

    API REST para el cribado PBC/FT

    Incorpore el cribado de sanciones, PEP, listas de vigilancia criminal, medios adversos y KYB/UBO directamente en sus flujos de incorporación, monitorización y transacciones. La API está en producción: autentíquese con una clave API y llame al mismo motor de cribado que usa el portal.

    La API v1 está en producción

    Los endpoints están disponibles de forma general con autenticación por clave API y límites de solicitudes por nivel. Explore cada endpoint en la documentación OpenAPI interactiva en /api/v1/docs.

    §01Guía rápida

    01 / 05
    STEP 01

    1. Cree una clave de API

    Cree una clave de API con alcance limitado desde su panel, o genere una mediante programación con el token de portador de su cuenta para solicitudes de servidor a servidor.

    curl
    curl -X POST https://screenveritai.com/api/v1/keys \
      -H "Authorization: Bearer <SUPABASE_JWT>" \
      -H "Content-Type: application/json" \
      -d '{"name":"server-key","permissions":["search:read","search:write"]}'
    STEP 02

    2. Ejecute su primera búsqueda

    Envíe una entidad con la cabecera X-API-Key. La API devuelve un ID de búsqueda que recupera cuando termina el procesamiento.

    curl
    curl -X POST https://screenveritai.com/api/v1/search \
      -H "X-API-Key: <YOUR_API_KEY>" \
      -H "Content-Type: application/json" \
      -d '{"entity_name":"Acme Ltd","entity_type":"company","search_type":"full_search"}'
    STEP 03

    3. Envíe un lote

    Envíe un archivo CSV/XLSX para cribar muchas entidades en un solo trabajo, y recupere las filas o las exportaciones cuando el lote termine.

    curl
    curl -X POST https://screenveritai.com/api/v1/batch \
      -H "X-API-Key: <YOUR_API_KEY>" \
      -F "file=@entities.csv"

    §02Endpoints principales

    02 / 05
    EP 01ENDPOINT

    POST /api/v1/search

    Crea una solicitud de cribado para una entidad. Devuelve un ID de búsqueda y el estado del procesamiento. También hay disponibles endpoints de cuenta, cobertura y estado bajo /api/v1.

    Autenticación: X-API-Key (search:write)

    EP 02ENDPOINT

    POST /api/v1/batch

    Envía archivos CSV/XLSX para cribado de alto volumen, y recupera filas o exportaciones cuando los trabajos terminan.

    Autenticación: X-API-Key (batch:write)

    EP 03ENDPOINT

    POST /api/v1/keys

    Crea y gestiona credenciales de API con permisos de alcance limitado, límites de solicitudes según el nivel y seguimiento de uso.

    Autenticación: token de portador (cuenta)

    §03Por qué los equipos usan la API

    03 / 05
    • Una sola integración para el cribado de sanciones, PEP, listas de vigilancia criminal, medios adversos y KYB/UBO
    • Autenticación por clave API mediante la cabecera X-API-Key, con claves de alcance limitado para un acceso de mínimo privilegio
    • Límites de solicitudes por nivel con registro de uso para gobernanza y control de costes
    • Endpoints de búsqueda, lotes, claves, cuenta, cobertura y estado bajo /api/v1
    • Documentación OpenAPI interactiva en /api/v1/docs, además de un esquema OpenAPI legible por máquina
    • Salida estructurada apta para registros de auditoría, expedientes de casos y decisiones posteriores

    §05Preguntas frecuentes sobre la API

    05 / 05
    Q01

    ¿Cómo autentico las solicitudes a la API?

    Las solicitudes de cribado a /api/v1/search y /api/v1/batch se autentican con una clave de API enviada en la cabecera X-API-Key. Cree las claves desde su panel, o mediante programación a través de /api/v1/keys tras autenticarse con el token de portador de su cuenta.

    Q02

    ¿Está la API disponible de forma general?

    Sí. La API v1 está en producción y disponible de forma general. Autentíquese con una clave de API, llame a los endpoints de búsqueda, lotes y gestión de claves, y explore todo en la documentación OpenAPI interactiva en /api/v1/docs.

    Q03

    ¿Puedo limitar el alcance de los permisos de una clave de API?

    Sí. Las claves admiten permisos como search:read, search:write, batch:read y batch:write, para que pueda aplicar un acceso de mínimo privilegio por integración.

    Q04

    ¿Qué límites de solicitudes se aplican?

    Los límites se asignan por nivel de API y se aplican por clave de API — el nivel rige el rendimiento de solicitudes, no la facturación. Las cabeceras de respuesta incluyen el límite, la cuota restante y la hora de reinicio, para que pueda ajustar su ritmo de forma ordenada.

    Q05

    ¿Dónde puedo probar los endpoints rápidamente?

    Use la documentación interactiva en /api/v1/docs para pruebas con Swagger y /api/v1/redoc para la documentación de referencia. El esquema OpenAPI se sirve en /api/v1/openapi.json.