Artículos · API, Coincidencias

Una API de coincidencias que muestra su razonamiento

Publicado el Por el equipo de Crown Intelligence

El nuevo punto de acceso de coincidencias puntúa a una persona, empresa o embarcación frente a una colección y explica cada puntuación, característica por característica. Así se utiliza y así se interpreta la respuesta.

Una puntuación no es una explicación#

Un resultado de verificación debe ser revisado por una persona y, con frecuencia, defendido ante un auditor. Un número aislado como 0.87 no ayuda a ninguno de los dos. Necesitan ver qué datos coincidieron: el nombre, la fecha de nacimiento, la nacionalidad, un número IMO.

Cómo llamar a la API#

Envíe una o más consultas a POST /api/match/<collection>, donde la colección es una de las siguientes: default, sanctions, peps, crime o maritime:

curl -X POST "https://api.crownintelligence.net/api/match/sanctions" \
  -H "content-type: application/json" \
  -d '{"queries":{"q1":{"schema":"Person",
       "properties":{"name":["Jane Example"],
                     "birthDate":["1970"],
                     "nationality":["ca"]}}}}'

Cada consulta puede incluir un nombre, fecha de nacimiento, nacionalidad, número IMO y tipo de entidad. Se pueden enviar varias consultas en una sola solicitud, cada una bajo su propia clave.

Cómo interpretar la respuesta#

Para cada consulta, la respuesta enumera los registros candidatos con un valor global score, un indicador match y una lista features. Cada característica indica qué se comparó, su puntuación y su peso, junto con una explicación en lenguaje sencillo, por ejemplo, qué partes del nombre coincidieron y con qué grado de similitud. Cada resultado también indica su lista de origen, el programa cuando está publicado y la fecha en que se vio por última vez en la fuente, con un enlace al registro completo.

También es nuevo#

  • /api/search/<collection> busca dentro de una sola colección.
  • /api/reconcile/<collection> ofrece las mismas coincidencias a OpenRefine, de modo que una hoja de cálculo con nombres pueda conciliarse con nuestros datos.