---
title: "Comply Advantage"
method: POST
path: "/"
---

# Comply Advantage

`POST /`

Use this check to verify whether a user or company is listed on international watchlists.

## Request body

- object
  - `entityType` string — Choose between `person` or `company`.
  - `name` string, required — User's full name or company's name
  - `birthYear` integer — Applicable to 'person', only. User's year of birth.
  - `monitor` boolean — Set to true if you want the search to be monitored regularly.
  - `callbackUrl` string — Callback URL for monitoring updates through webhooks. Mandatory if monitor = true.
  - `countryCodes` string[] — An array of 2-letter country codes as per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
  - `exactMatch` boolean — Specify that results must match all specified parameters.
  - `fuzzinessThreshold` integer — Integer in range of 0-100 specifying how closely matched results must be to the specified parameters.
  - `metadata` string, json — Use the `metadata` parameter to add internal references.

## Response `200`

200

- object
  - `data` object
    - `searchedOn` string
    - `nameSearched` string
    - `profileUrl` string
    - `error` unknown

---

[API](https://skmtc.net/metamap/apis/get-authorization-token.md) · [All operations](https://skmtc.net/metamap/apis/get-authorization-token/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/metamap/get-authorization-token/revisions/ffdfcfeffe2a/schema)