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, orus_bank_account_fingerprint. Usestringif 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
Update a value list
POST / v1 / radar / value_lists /:id
Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.
Parameters
- alias string The name of the value list for use in rules. The maximum length is 100 characters.
- 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. - name string The human-readable name of the value list. The maximum length is 100 characters.
Returns
Returns an updated ValueList object if a valid identifier was provided.
Response
Retrieve a value list
GET / v1 / radar / value_lists /:id
Retrieves a ValueList object.
Parameters
No parameters.
Returns
Returns a ValueList object if a valid identifier was provided.
Response