Headers

• x-client-id string

  klexta client id key for authentication

• x-klexta-key string

  klexta api key for authentication

Query parameters

• query parameters of search endpoint

  Hide attributes Show attributes object

  • keyword string Required

    search keyword

    Minimum length is 5, maximum length is 150.

  • identification string | null

    identification (optional) to include into search

    Minimum length is 5, maximum length is 100.

  • size integer(int32) | null

    limits the number of results

    Minimum value is 1, maximum value is 10. Default value is 5.

  • minSimilarity integer(int32) | null

    minimum similarity accepted

    Minimum value is 85, maximum value is 100. Default value is 90.

  • birthYear integer(int32) | null

    birth year parameter to filter results

    Minimum value is 1920, maximum value is 2024.

  • listType[] array[string] | null

    Not more than 5 elements. Values are adverse, regulation, sanction, law_enforcement, or pep.

  • entityType string | null

    Values are individual, legal_entity, company, organization, vessel, aircraft, crypto_wallet, or unknown.

  • phoneticEnabled boolean | null

    include / exclude keyword phonetic match results

    Default value is false.

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • id string Required

    klexta unique id of the entity

  • name array[string] Required

    entity names

  • datasets array[string] Required

    entity datasets

  • listTypes array[string] Required

    entity list types

  • type array[string] Required

    entity type

  • riskLevel string Required

    entity risk level

  • countries array[string] Required

    entity countries

  • similarity object Required
    Hide similarity attributes Show similarity attributes object

    • ratio integer(int32)
    • matchedKeyword string Required
    • matchedWith string Required

      Values are NAME, ALIAS, or IDENTIFICATION.

    • phoneticMatch boolean
  • _links object Required
    Hide _links attribute Show _links attribute object

    • appURL string | null
• 400 application/problem+json

  Bad request

  Hide response attributes Show response attributes object

  • type string
  • title string
• 401 application/problem+json

  Unauthorized

  Hide response attributes Show response attributes object

  • type string
  • title string
• 402 application/problem+json

  Not Enough Credit

  Hide response attributes Show response attributes object

  • type string
  • title string
• 403 application/problem+json

  Forbidden

  Hide response attributes Show response attributes object

  • type string
  • title string
• 422 application/problem+json

  Unprocessable Entity

  Hide response attributes Show response attributes object

  • type string
  • title string
• 429 application/problem+json

  Rate Limit Exceed

  Hide response attributes Show response attributes object

  • type string
  • title string
• 500 application/problem+json

  Internal Server Error

  Hide response attributes Show response attributes object

  • type string
  • title string