The search endpoint is perfect for real-time, on-the-fly compliance checks. With this feature, you can swiftly verify individual entities or transactions, ensuring your business remains in compliance with the latest AML regulations.

POST /search

Headers

x-client-id string

klexta client id key for authentication
x-klexta-key string

klexta api key for authentication

application/json

Body Required

request body of search endpoint

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

POST /search

curl \
 --request POST 'https://api.klexta.com/rta/search' \
 --header "Content-Type: application/json" \
 --header "x-client-id: string" \
 --header "x-klexta-key: string" \
 --data '{"keyword":"string","identification":"string","size":5,"minSimilarity":90,"birthYear":42,"listType[]":["adverse"],"entityType":"individual","phoneticEnabled":false}'

Request examples

# Headers
x-client-id: string
x-klexta-key: string

# Payload
{
  "keyword": "string",
  "identification": "string",
  "size": 5,
  "minSimilarity": 90,
  "birthYear": 42,
  "listType[]": [
    "adverse"
  ],
  "entityType": "individual",
  "phoneticEnabled": false
}

Response examples (200)

[
  {
    "id": "string",
    "name": [
      "string"
    ],
    "datasets": [
      "string"
    ],
    "listTypes": [
      "string"
    ],
    "type": [
      "string"
    ],
    "riskLevel": "string",
    "countries": [
      "string"
    ],
    "similarity": {
      "ratio": 42,
      "matchedKeyword": "string",
      "matchedWith": "NAME",
      "phoneticMatch": true
    },
    "_links": {
      "appURL": "string"
    }
  }
]

Response examples (400)

{
  "type": "string",
  "title": "string"
}

Response examples (401)

{
  "type": "string",
  "title": "string"
}

Response examples (402)

{
  "type": "string",
  "title": "string"
}

Response examples (403)

{
  "type": "string",
  "title": "string"
}

Response examples (422)

{
  "type": "string",
  "title": "string"
}

Response examples (429)

{
  "type": "string",
  "title": "string"
}

Response examples (500)

{
  "type": "string",
  "title": "string"
}