Portal
v1.1.0
POST/v1/screen/{endpoint_key}

Screen a subject against a published endpoint index

Generic screening contract for any published endpoint key. Product-specific filter and match schemas are documented on the concrete paths (`/v1/screen/sanctions`, `/v1/screen/pep`, `/v1/screen/legal`, `/v1/screen/sat`, `/v1/screen/sex-offenders`). Screens a subject against the Elasticsearch index for a configured endpoint (e.g. `sanctions`, `pep`, `legal`). Match fields follow the endpoint's published response schema — shapes differ per endpoint family. Each call generates an immutable `audit_ref` retrievable via the portal audit API. **Auth:** API key in the `apikey` header. `POST /v1/index/legal` uses the same header. **Rate limits:** Enforced by Kong per plan tier.

Clave de API — encabezado `apikey`

Parámetros

NombreEnTipoDescripción
endpoint_key*pathstringScreen endpoint key (configured in admin).

Cuerpo de la solicitud

application/json

Name only
Cargando…

Respuestas

Screening complete

Respuesta 200 — ejemplo
Cargando…
Pruebe esta solicitud

Copie un ejemplo en el lenguaje que prefiera. Reemplace los marcadores con sus credenciales.

curl -X POST 'https://screening-api.searchlook.mx/v1/screen/sanctions' \
  -H 'Content-Type: application/json' \
  -H 'apikey: sl_live_YOUR_KEY' \
  -d '{"full_name":"AGUILAR ARREOLA MARIA CONCEPCION"}'
Respuesta de ejemplo
200 OK
Cargando…