1. Identity and Fraud Developer
  2. Kount 360
  3. Common Services

List API Specifications

Use the List APIs to create, retrieve, and delete lists.

The List APIs are REST HTTPS endpoints that use OAuth 2.0 for authentication. Go to Lists for the swagger documentation.

Create List

Use create lists POST to create a new list.

Sandbox Endpoint

https://api-sandbox.kount.com/policy-manager/v1/lists

Production Endpoint

https://api.kount.com/policy-manager/v1/lists

Method: POST

Header Authorization: Bearer token

Header Content-Type: application/json

Body: Refer to the Create List request parameters.

Create List request parameters

Create List request parameters table

JSON Path

Field Name

Description

Type

Example

type

List Type

The type of list. Enumerations are:

  • DEVICE_ID

  • USER_IP_ADDRESS

  • PAYMENT_TOKEN

  • PHYSICAL_ADDRESS

  • DEVICE_COUNTRY

  • TEXT

String

"DEVICE_ID"

name

List Name

A string containing the human-readable name of the list.

String

"Device Block List"

description

List Description

A string containing the human-readable description of the list.

String

"Countries I can’t sell in."

Create List request example

Create List request body example

{
  "type": "DEVICE_ID",
  "name": "Device Blocked List",
  "description": "Countries I can’t sell in."
}

Create List response properties

Create List response properties table

JSON Path

Field Name

Description

Type

Example

version

Response Version

The version of the lists endpoint response contract used for this response, as a string containing a three-digit semantic version number.

String

"v1.0.0"

list

List Object

Contains the properties that describe the list and contains all of its current entries.

Object

list.id

List Identification

Unique identifier of the list so the list can be queried and referenced in other contexts.

String

"d121bc2210434ffc8a90daff9dd97e76"

Create List response example

Create List response body example

{
  "version": "1.0.0",
  "list": {
    "id": "d121bc2210434ffc8a90daff9dd97e76"
  }
}

Get Lists

Use GET Lists to retrieve all existing lists.

Sandbox Endpoint

https://api-sandbox.kount.com/policy-manager/v1/lists

Production Endpoint

https://api.kount.com/policy-manager/v1/lists

Method: GET

Header Authorization: Bearer token

Header Content-Type: application/json

Body: N/A

Get Lists response properties

Get Lists response properties table

JSON Path

Field Name

Description

Type

Example

version

Response Version

The version of the lists endpoint response contract used for this response, as a string containing a three-digit semantic version number.

String

"v1.0.0"

lists

List

Contains the properties that describe the list and contains all of its current entries.

Object

lists.id

List Identification

Unique identifier of the list so the list can be queried and referenced in other contexts.

String

“d121bc2210434ffc8a90daff9dd97e76”

lists.type

Type of List Entry

The type of list being retrieved. Enumerations are:

  • DEVICE_ID

  • USER_IP_ADDRESS

  • PAYMENT_TOKEN

  • PHYSICAL_ADDRESS

  • DEVICE_COUNTRY

  • TEXT

String

"DEVICE_ID"

lists.name

List Name

A string containing the human-readable name of the list.

String

"Device Block List"

lists.description

List Description

A string containing the human-readable description of the list.

String

“Countries I can’t sell in.”

Get Lists response example

Get Lists response body example

{
  "version": "1.0.0",
  "lists": [
    {
        "id": "d121ea2210434ffc8a90daff9cc97e76",
        "type": "DEVICE_ID",
        "name": "Device Block List",
        "description": "Countries I can’t sell in.",
    }
  ]
}

Delete List

Use List DELETE to delete a list.

Sandbox Endpoint

https://api-sandbox.kount.com/policy-manager/v1/lists/{id}

Production Endpoint

https://api.kount.com/policy-manager/v1/lists/{id}

Method: DELETE

Header Authorization: Bearer token

Header Content-Type: application/json

Body: Refer to the Delete List request parameters.

Delete List request parameters

Delete List request parameters table

JSON Path

Field Name

Description

Type

Example

id

List Identification

Unique identifier of the list so the list can be queried and referenced in other contexts.

String

"d121bc2210434ffc8a90daff9dd97e76"

Delete List response properties

Delete List response table properties

JSON Path

Field Name

Description

Type

Example

version

Response Version

The version of the lists endpoint response contract used for this response, as a string containing a three-digit semantic version number.

String

"v1.0.0"

list

List

Contains the identification for the list.

Object

list.id

List Identification

The unique identifier of the list.

String

“d121ea2210434ffc8a90daff9cc97e76”

Delete List response example

Delete List response body example

{
  "version": "string",
  "list": {
    "id": "string"
  }
}
Was this article helpful?
0 out of 0 found this helpful
Common Services
API requirements for custom fields
Orders API: Best Practices
Implementing a Webhook Notification
Resolve Webhook Issues
Multi-factor Authentication API Specifications
Verification Status Update Webhook
Get Orders API Specification
List API Specifications
List Entries API Specifications
Policy Management Entry Schemas