API documentation

Screening requests and result interpretation

Submit names without forced first-name and last-name fields, preserve identifiers, and handle each outcome correctly.

Updated

Create
POST /screenings

Submit a subject and selected coverage.

Required scope
screenings:write

Use a key for the intended environment.

Retry identity
Idempotency-Key

Keep the same key and body on a retry.

Describe the subject with the facts you have

POST /api/v1/screenings accepts subject, one coverage selector, and optional retention. The subject requires a name of 2 to 300 characters. entityType supports person, organization, vessel, aircraft, and other. Supply optional identifiers as type, value, and issuer rather than guessing a universal document-number format.

birthDate accepts a real full date, a year and month, or a year. Omit unknown fields. Do not replace an unknown day with January 1 or split every name into Western first-name and last-name fields. Country and identifiers can help a review, but missing values are not evidence that a candidate is different.

JSON request
{
  "subject": {
    "name": "Alex Morgan",
    "entityType": "person",
    "birthDate": "1984"
  },
  "package": "sandbox@1"
}

Interpret the response in three paths

potential_match means at least one candidate met the matching policy. Read record, evidence, conflicts, and score for each match. no_match means the screen completed without such a candidate in the requested qualified coverage. An error means the request did not establish either result.

Similarity scores are deterministic ranking values, not probabilities of identity, wrongdoing, or legal risk. Record the result ID and versions with your own business record. Do not reduce the response to a permanent isSanctioned boolean that loses its scope, date, and review context.

KEEP BUILDING

Where to go next