logo

Retrieve allowlist collection

Retrieves allowlist collection.

SecuritySecretApiKey or JWT
Request
query Parameters
filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

Responses
200

Allowlist collection retrieved.

Response Schema: application/json
Array
type
required
string

Type of data to exclude from risk score checks. Data types that are added to this field are excluded from risk score checks and are not added to blocklists.

Enum: "address" "bank-account" "bin" "country" "customer-id" "email" "email-domain" "fingerprint" "ip-address" "payment-card"
value
required
string

Value of the allowlist record.

id
string <= 50 characters

ID of the allowlist record.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/allowlists
Request samples 
Response samples 
application/json
[
  • {
    }
]
➔ Next to Create allowlist record