latestOpenAPI 3.0.32026-08-12367267.0 KB

cda4b2b11372

List all blacklist records assosiated with the company

Retrieves all blacklist records associated with the company. You can optionally filter records by a query, set pagination with offset and limit, or retrieve the full list.

Parameters:

  • companyKey (string, required) - The company's secret key.
  • query (object of strings, optional) - Optional filter fields:
    • offset (number, optional) - Number of records to skip from the beginning.
    • limit (number, optional) - Maximum number of records to return.
post/list-blacklist-records

Request body

companyKeystring

Example request

{
  "companyKey": "your-company-secret-key"
}

Response

Success

Example response

{
  "result": {
    "offset": 0,
    "limit": 100,
    "total": 1,
    "data": [
      {
        "firstName": "John",
        "lastName": "Doe",
        "documentNumber": "123ABC123",
        "personalNumber": "012345678901",
        "birthday": "1980-01-01T00:00:00.000Z",
        "reason": "Reason for adding to blacklist",
        "notes": "Fraud-related activity",
        "id": "64f4d0ec35f5bb20a8022012"
      }
    ]
  }
}