latestOpenAPI 3.0.32026-08-12367267.0 KB

cda4b2b11372

Add person to the blacklist

Adds a person to the blacklist based on identifying attributes such as name, document number, or personal number.

Parameters:

  • companyKey (string, required) - The company's secret key.
  • query (object of strings, required) - Object containing query details. Must include reason and at least one of the following: firstName, lastName, personalNumber, documentNumber, birthday.
    • firstName (string, optional) - First name of the individual.
    • lastName (string, optional) - Last name of the individual.
    • personalNumber (string, optional) - Personal identification number.
    • documentNumber (string, optional) - Document number (e.g., from an ID or passport).
    • birthday (string, optional) - Birthday in ISO 8601 format (e.g., 1990-05-14).
    • reason (string, required) - The reason for blacklisting the individual.
    • notes (string, optional) - Additional information or context about the blacklisting that may be useful for record-keeping or future reference.
post/add-blacklist-record

Request body

companyKeystring

Example request

{
  "companyKey": "your-company-secret-key",
  "query": {
    "firstName": "John",
    "lastName": "Doe",
    "documentNumber": "123ABC123",
    "personalNumber": "12345678901",
    "birthday": "1980-01-01T00:00:00.000Z",
    "reason": "Reason for adding to blacklist",
    "notes": "Fraud-related activity"
  }
}

Response

Success

resultstring

Example response

{
  "result": "64ad3b14090678e34512eab8"
}