Allowlists

Use allowlists to exclude specific customer attribute data from risk score checks.

Allowlists are lists of data that are excluded from risk score checks. Allowlists prevent specific data from being added to a blocklist record when a risk score threshold reached.

Operations

Retrieve allowlist collection

Request

Retrieves allowlist collection.

Security
SecretApiKey or JWT
Query
filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]

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

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/allowlists?filter=string&sort=string&limit=0&offset=0' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Allowlist collection retrieved.

Bodyapplication/json
Array [
idstring, <= 50 charactersread-only

ID of the allowlist record.

Example:"rsal_01HXBY67D5CNWM2YK79PFZR4C2"
typestringrequired

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"
valuestringrequired

Value of the allowlist record.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

]
Response
[
  {
    "id": "rsal_01HXBY67D5CNWM2YK79PFZR4C2",
    "type": "address",
    "value": "string",
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "_links": [ … ]
  }
]