The endpoint and http method information to retrieve list are stated below.
| HTTP Method | URL |
|---|---|
GET |
/fraud/v1/value-lists/:name |
The parameters expected to be sent in requests to retrieve a list are listed under the table and subheadings below.
| Parameter Name | Type | Required | Description |
|---|---|---|---|
name |
string |
Yes | List name |
Parameters returned as a result of retrieve a list are also subject to the rules specified in
the Response Formats
section of the API documentation home page. In the absence of a systematic or fictional error, the sub-parameters of the
object returned in the data parameter are as follows:
| Parameter Name | Type | Description |
|---|---|---|
name |
string |
List name |
values |
FraudValue[] |
Values (see: Fraud Value) |
Contains value itself and expiration duration for each value added to list.
| Parameter Name | Type | Description |
|---|---|---|
value |
string |
Value |
expireInSeconds |
number |
Expiration Duration |
You can review the sample codes in the open source Craftgate API clients.