Value Lists

Value lists allow you to group values together which can then be referenced in rules.

Related guide: Default Stripe lists

Was this section helpful? Yes No

Create a value list

POST / v1 / radar / value_lists

Update a value list

POST / v1 / radar / value_lists /:id

Retrieve a value list

GET / v1 / radar / value_lists /:id

List all value lists

GET / v1 / radar / value_lists

Delete a value list

DELETE / v1 / radar / value_lists /:id

The Value List object

Attributes

• id string Unique identifier for the object.
• alias string The name of the value list for use in rules.
• item _ type enum The type of items in the value list. One of card_fingerprint, card_bin, crypto_fingerprint, email, ip_address, country, string, case_sensitive_string, customer_id, account, sepa_debit_fingerprint, or us_bank_account_fingerprint. Possible enum values account Account IDs. card_bin Card BINs. card_fingerprint Card fingerprints. case_sensitive_string Case-sensitive strings. country Two-letter ISO country codes. crypto_fingerprint Cryptocurrency fingerprints. customer_id Customer IDs. email Email addresses. ip_address IP addresses. sepa_debit_fingerprint the related setting debit fingerprints. Show 2 more
• list _ items object List of items contained within this value list.
• metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
• name string The name of the value list.

More attributes

• object string, value is "radar.value_list"
• created timestamp
• created _ by string
• livemode boolean

The Value List object

Create a value list

POST / v1 / radar / value_lists

Creates a new ValueList object, which can then be referenced in rules.

Parameters

• alias string Required The name of the value list for use in rules. The maximum length is 100 characters.
• name string Required The human-readable name of the value list. The maximum length is 100 characters.
• item _ type string Type of the items in the value list. One of card_fingerprint, card_bin, crypto_fingerprint, email, ip_address, country, string, case_sensitive_string, customer_id, account, sepa_debit_fingerprint, or us_bank_account_fingerprint. Use string if the item type is unknown or mixed.
• metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Returns

Returns a ValueList object if creation succeeds.

Response