Screening AML en tiempo real

​

Permite screening AML en tiempo real.

Headers

  • x-api-key
    Type: string

    API Key de la organización (zk_...)

  • x-api-secret
    Type: string

    API Secret de la organización (sk_...)

  • x-org-id
    Type: string
    required

    UUID de la organización

Body·

required
application/json
  • name
    Type: string
    required

    Nombre completo de la persona o razón social de la entidad a consultar.

  • country
    Type: string

    Código de país ISO-3166-1 alpha-2 (residencia, registro o actividad).

  • data_source
    Type: string

    Fuentes contra las que consultar: códigos short_name de /api/aml/lists o colecciones (ej. sanctions-lists, PEP), separados por coma. Obligatorio si no se envía validation_group_id.

  • date_of_birth
    Type: string

    Fecha de nacimiento (personas): YYYY-MM-DD, YYYY-MM o YYYY.

  • entity_type
    Type: stringenum

    Tipo de sujeto; recomendado para reducir falsos positivos.

    values
    individualentityvesselaircraft
  • identifier
    Type: string

    Identificador adicional (pasaporte, email, dominio, ID fiscal, etc.) para refinar el match.

  • identifier_match_boosting_threshold
    Type: number
    min:  
    0
    max:  
    1

    Umbral opcional para potenciar matches por identificador/documento.

  • min_score
    Type: number
    min:  
    0
    max:  
    1

    Umbral mínimo de confianza del match (0–1). Recomendado ~0.88.

  • name_match_boosting_threshold
    Type: number
    min:  
    0
    max:  
    1

    Umbral opcional para potenciar matches de nombre de alta confianza.

  • nationality
    Type: string

    Nacionalidad (Código ISO-3166-1 alpha-2).

  • page
    Type: number
    min:  
    1

    Página de resultados cuando el proveedor pagina coincidencias.

  • validation_group_id
    Type: stringFormat: uuid

    UUID del grupo de validación configurado en /aml/groups.

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/api/v2/aml/screening
curl /api/v2/aml/screening \
  --request POST \
  --header 'x-org-id: ' \
  --header 'Content-Type: application/json' \
  --header 'x-org-id: YOUR_SECRET_TOKEN' \
  --data '{
  "name": "Pied Piper Inc.",
  "data_source": "sanctions-lists",
  "validation_group_id": "",
  "entity_type": "individual",
  "min_score": 0.88,
  "date_of_birth": "1980-05-15",
  "country": "US",
  "identifier": "",
  "name_match_boosting_threshold": 0,
  "page": 1,
  "identifier_match_boosting_threshold": 0,
  "year_of_birth": "1980",
  "nationality": "EC"
}'

{
  "additionalProperty": "anything"
}

Recurso creado correctamente.