Primeros pasos con la API

Una única API JSON de solo lectura ofrece coincidencias, consulta de entidades y búsqueda sobre todos los registros que publicamos. Esta página explica qué hace cada parte y a dónde ir a continuación.

AutenticaciónCómo funciona el acceso hoy y qué agrega una licencia de producción.La API de coincidenciasVerifique personas, empresas y embarcaciones frente a una colección.La API de entidadesObtenga un registro con sus inclusiones en listas y registros relacionados.La API de búsquedaBúsqueda por palabras clave y filtros para interfaces e investigación.

Qué hace la API

El servicio de datos de Crown Intelligence es una API JSON de solo lectura sobre los mismos registros que muestra este sitio. Tres puntos de acceso realizan la mayor parte del trabajo:

POST /api/match/<collection> compara lo que usted sabe de una parte (nombres, fecha de nacimiento, nacionalidad, número IMO, tipo de entidad) con cada registro candidato de una colección y devuelve resultados puntuados y explicados. Úselo para la verificación.
GET /api/entity/<id> devuelve un registro con sus inclusiones en listas y los demás registros que nombran a la misma parte, o una entidad combinada construida a partir de todos ellos.
GET /api/search/<collection>?q= encuentra registros por nombre con filtros. Úselo para consultas e interfaces, no para decisiones de verificación: los resultados de búsqueda no tienen puntuación.

Los puntos de acceso complementarios enumeran las colecciones (/api/catalog), los métodos de puntuación (/api/algorithms), las fuentes, los programas, los países y las facetas. La referencia de puntos de acceso los enumera todos.

Cómo obtener acceso

Hoy no se necesita clave de API. Los puntos de acceso públicos responden a solicitudes anónimas. El uso en un proceso empresarial, la verificación sistemática y la redistribución están cubiertos por una licencia comercial; consulte Autenticación para más detalles.

Por definir: Cómo se emitirán las claves de API, el acceso de prueba y las claves para usuarios de interés público o sin fines comerciales (decisión del propietario; aún no existe un sistema de claves).

Realice su primera solicitud

Siga la guía de inicio rápido para enviar una solicitud de coincidencia y leer el resultado.
Lea Autenticación para saber cómo funcionan el acceso y los límites.
Cargue la descripción OpenAPI 3 en su cliente de API o generador de código.
Pruebe el mismo motor de coincidencias de forma interactiva en Verificación; muestra el comando cURL de cada comprobación.

Por definir: Si publicaremos una biblioteca cliente, una herramienta de línea de comandos o un servidor MCP para la API (decisión del propietario).

Los puntos de acceso

La API de coincidenciasVerificación por lotes con puntuaciones y explicaciones. Análisis detallados: la solicitud y la respuesta.
La API de entidadesUn registro con sus inclusiones en listas anidadas, o una entidad combinada de varios registros.
La API de búsquedaBúsqueda por nombre con filtros y facetas; no apta para decisiones de verificación.
Referencia de puntos de accesoCada ruta, parámetro y campo, con ejemplos de código.

Comprender los resultados

Referencia del modelo: tipos de entidad y propiedades que publicamos.
Temas de riesgo: las etiquetas topics de cada resultado.
Programas de sanciones: el campo programme de cada inclusión en listas.
Entidades planas y anidadas: cómo se relacionan los registros, las inclusiones en listas y las entidades combinadas.

Cree un proceso de verificación

Ajuste el motor de coincidencias: umbral, método de puntuación, filtros y datos de entrada.
Algoritmos de coincidencia: características, efectos y constantes de cada método de puntuación.
Cómo crear un flujo de monitoreo: vuelva a verificar cuando cambien las listas.
Implementación local: verifique dentro de su propia red con una copia local de los datos.

Qué admite la API hoy

Una lista clara de lo que está y no está disponible, para que pueda planificar.

Función	Disponible	Notas
Coincidencias por lotes	Sí	Hasta 20 consultas por solicitud, con hasta 50 resultados cada una.
Umbral de puntuación	Sí	`?threshold=`, de 0 a 1; valor predeterminado 0.75.
Elección del método de puntuación	Sí	`?algorithm=standard` o `name-only`; enumerados por `/api/algorithms`.
Filtros de tema y de registro	Sí	`topics`, `include_dataset`, `exclude_dataset` en coincidencias y búsqueda.
Entidades combinadas	Sí	`/api/entity/<entity_id>` combina todos los registros de una misma parte.
Conciliación con OpenRefine	Sí	`/api/reconcile/<collection>`, API de conciliación 0.2.
Catálogo de colecciones	Sí	`/api/catalog`, a partir del índice de compilación actual.
Descripción OpenAPI	Sí	openapi.json.
Claves de API e informes de uso	Aún no	Consulte Autenticación.
Ponderaciones personalizadas de características	Aún no	Cada método de puntuación tiene efectos fijos; consulte Algoritmos de coincidencia.
Coincidencia por identificadores más allá de los números IMO	Aún no	Los números de registro, de identificación fiscal y LEI aún no se puntúan.
Filtro de cambios desde una fecha en coincidencias	Sí	`?changed_since=` en coincidencias y búsqueda; consulte Monitoreo.
Punto de acceso de linaje a nivel de declaración	Aún no	Use `statements.csv` en los archivos masivos.
Paginación de registros relacionados	Aún no	Los registros relacionados están limitados a 100 por registro.

Aspectos comerciales

La API forma parte de nuestra oferta comercial. Consulte los precios, las preguntas frecuentes comerciales o hable con ventas.

Por definir: Cómo se medirá y tarificará el uso de la API (por consulta, por solicitud o tarifa fija), los descuentos por volumen y si un portal de clientes mostrará el uso y la facturación. Las tarifas del resumen de licencia son solo propuestas.

Última actualización 2026-10-03