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

List Entries API Specifications

Use the List Entries APIs to create, retrieve, and delete list entries.

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

Create Entry

Use create entry POST to create a new list entry.

Sandbox Endpoint

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

Production Endpoint

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

Method: POST

Header Authorization: Bearer token

Header Content-Type: application/json

Body: Refer to the Create Entry request parameters.

Note

When creating list entries, the request must be created based on the listType of the list you are adding to. The response will only contain properties related to that listType. For more information about each list type schema, go to Entry Schemas.

Create Entry request properties

Create Entry request properties table

JSON Path

Field Name

Description

Type

Example

note

Note Contents

Contains the content of the note.

String

"List entry created for suspect order."

deviceCountry

Entry Country Name

The name of the country where the device was reportedly located when the order was placed.

String

"United States of America"

deviceId

Entry Device ID

The unique identifier that was generated by us for the device.

String

"7363b8ae6b2247b99f5d56fc81102254"

paymentToken

Entry Payment Token

Payment token submitted by merchant for order (credit card, payer ID, routing/transit, MIC`R, and account number).

The payment token is hashed with salted SHA256.

If paymentType is set to “NONE” then the paymentToken value should be left empty.

String

physicalAddress

Physical Address

An object containing the physical address of the order.

Object

physicalAddress.line1

Address Line 1

The first line of the physical address.

String

"1005 Main Street"

physicalAddress.line2

Address Line 2

The second line of the physical address.

String

"APT 56"

physicalAddress.city

City

The city of the physical address.

String

"Boise"

physicalAddress.region

Region

The state or region of the physical address.

String

"ID"

physicalAddress.postalCode

Postal Code

The postal code of the physical address.

String

"83704"

physicalAddress.countryCode

Entry Country Code

The country code of the device collection in the ISO-3166 format.

String

"US"

physicalAddress.addressType

Address Type

The type of address. Enumerations are BILLING_ADDRESS or SHIPPING_ADDRESS.

String

"SHIPPING_ADDRESS"

text

Text Entry

Contains the text entry for this list.

string

"customer42@example.com"

userIpAddress

User IP Address

The IP Address of the customer or merchant.

String

"192.168.1.27"

Create Entry request example

Create Entry request body example

{
  "note": "This is a suspect IP address.",
  "deviceCountry": "United States of America",
  "deviceId": "7363b8ae6b2247b99f5d56fc81102254",
  "paymentToken": "string",
  "physicalAddress": {
    "line1": "1005 Main Street",
    "line2": "APT 56",
    "city": "Boise",
    "region": "ID",
    "postalCode": "83704",
    "countryCode": "US",
    "addressType": "BILLING_ADDRESS"
  },
  "text": "customer42@example.com",
  "userIpAddress": "127.0.0.1"
}

Create Entry response properties

Create Entry 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"

entry

List Entry

Contains the identification for the list entry.

Object

id

List Entry Identification

The unique identifier of the list entry.

String

“d121ea2210434ffc8a90daff9cc97e76”

Create Entry response example

{
  "version": "1.0.0",
  "entry": {
    "id": "d121ea2210434ffc8a90daff9cc97e76"
  }
}

Get List Entries

Use the Get List Entries API to retrieve a group of list entries.

The List Entries API is a REST HTTPS endpoint that uses OAuth 2.0 for authentication.

Sandbox Endpoint 

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

Production Endpoint

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

Method: GET

Header Authorization: Bearer token

Header Content-Type: application/json

Body: Refer to the Get List Entries request parameters.

Note

When retrieving list entries, the response properties will be based on the listType of the list you are adding to. For more information about each list type schema, go to Entry Schemas.

Get List Entries request parameters

Get List Entries request parameters table

JSON Path

Field Name

Description

Type

Example

listId

List ID

Unique identifier of the list. Assigned when the list was created.

String

"d121ea2210434ffc8a90daff9cc97e76"

pageSize

Page Size

The maximum number of list entries returned by the endpoint at one time. Default is 1,000.

Integer (int32)

1000

pageToken

Page Token

An identifier to return the next page of results when the results are paginated (there are more entries than the page size allows). The page token can be retrieved by an initial call to the endpoint without providing a page token and will continue to be provided in subsequent pages until the final page of entries is reached.

String

“d121ea2210434ffc8a90daff9cc97e76”

Get List Entries request example

Get List Entries request URL example

https://api.kount.com/policy-manager/v1/lists/d121ea2210434ffc8a90daff9cc97e76?pageSize=1000&pageToken=d121ea2210434ddc8a90daee9cc97e76

Get List Entries response properties

Get List Entries 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

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”

list.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"

list.name

List Name

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

String

"Device Block List"

list.description

List Description

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

String

“Countries I can’t sell in.”

list.entries

Entries Array

Array that contains objects with the properties of each entry in this list. For example, an entry for a specific country in a list with a “DEVICE_COUNTRY” list type. The schema of the object will depend on the list type.

Array

 

list.entries.id

Entry ID

The unique identifier of the entry.

String

“d121ea2210434ffc8a90daff9cc97e76”

list.entries.note

Note Contents

The content of the note.

String

"List entry created for suspect order."

list.entries.author

Entry Author Properties Object

Contains the properties associated with the user that added the entry.

Object

 

list.entries.author.id

Entry Author ID

The unique identifier of the user that added the entry.

String

“d121ea2210434ffc8a90daff9cc97e76”

list.entries.author.name

Entry Author Name

The name of the user that added the entry.

String

"Jane Doe"

list.entries.addedDateTime

Entry Added Date/Time

The date and time that the entry was added or modified, in the ISO 8601 format.

String

“2023-03-30T15:41:58Z”

list.entries.deviceCountry

Entry Country Name

The name of the country where the device was reportedly located when the order was placed.

String

"United States of America"

list.entries.deviceId

Entry Device ID

The unique identifier that was generated by us for the device.

String

"7363b8ae6b2247b99f5d56fc81102254"

list.entries.paymentToken

Entry Payment Token

Payment token submitted by merchant for order (credit card, payer ID, routing/transit, MIC`R, and account number).

The payment token is hashed with salted SHA256.

If paymentType is set to “NONE” then the paymentToken value should be left empty.

String

 

list.entries.physicalAddress

Physical Address

Contains the physical address of the order.

Object

list.entries.physicalAddress.line1

Address Line 1

The first line of the physical address.

String

"1005 Main Street"

list.entries.physicalAddress.line2

Address Line 2

The second line of the physical address.

String

"APT 56"

list.entries.physicalAddress.city

City

The city of the physical address.

String

"Boise"

list.entries.physicalAddress.region

Region

The state or region of the physical address.

string

"ID"

list.entries.physicalAddress.postalCode

Postal Code

The postal code of the physical address.

String

"83704"

list.entries.physicalAddress.countryCode

Entry Country Code

The country code of the device collection in the ISO-3166 format.

String

"US"

list.entries.physicalAddress.addressType

Address Type

The type of address. Enumerations are BILLING_ADDRESS or SHIPPING_ADDRESS.

String

"SHIPPING_ADDRESS"

list.entries.text

Text Entry

Contains the text entry for this list.

String

"customer42@example.com"

list.entries.userIpAddress

User IP Address

The IP Address of the customer or merchant.

String

"192.168.1.27"

nextPageToken

Next Page Token

To retrieve the next page of list entries, provide the next page token as the “pageToken” query parameter on a subsequent call to the endpoint.

String

“d121ea2210434ffc8a90daff9cc97e76”

Get List Entries response example

Get List Entries response body example

{
  "version": "1.0.0",
  "list": {
    "id": "d121ea2210434ffc8a90daff9cc97e76",
    "type": "DEVICE_ID",
    "name": "Device Block List",
    "description": "Countries I can’t sell in.",
    "entries": [
      {
        "id": "d121ea2210434ffc8a90daff9cc97e76",
        "note": "List entry created for suspect order.",
        "author": {
          "id": "d121ea2210434ffc8a90daff9cc97e76",
          "name": "Jane Doe"
        },
        "addedDateTime": "2023-03-30T15:41:58Z",
        "deviceCountry": "United States of America",
        "deviceId": "7363b8ae6b2247b99f5d56fc81102254",
        "paymentToken": "string",
        "physicalAddress": {
          "line1": "1005 Main Street",
          "line2": "APT 56",
          "city": "Boise",
          "region": "ID",
          "postalCode": "83704",
          "countryCode": "US",
          "addressType": "BILLING_ADDRESS"
        },
        "text": "customer42@example.com",
        "userIpAddress": "192.168.1.27"
      }
    ]
  },
  "nextPageToken": "d121ea2210434ffc8a90daff9cc97e76"
}

Get Entry

Use the Get Entry API to retrieve list entries.

The entries API is a REST HTTPS endpoint that uses OAuth 2.0 for authentication.

Sandbox Endpoint 

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

Production Endpoint

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

Method: GET

Header Authorization: Bearer token

Header Content-Type: application/json

Body: Refer to the Get Entry request properties.

Note

When retrieving list entries, the response properties will be based on the listType of the list you are pulling from. For more information about each list type schema, go to Entry Schemas.

Get Entry request parameters

Get Entry request parameters table

JSON Path

Field Name

Description

Type

Example

listId

List ID

Unique identifier of the list. Assigned when the list was created.

String

"d121ea2210434ffc8a90daff9cc97e76"

id

List Entry Identification

The unique identifier of the list entry.

String

“d121bc2210434ffc8a90daff9dd97e76”

Get Entry response properties

Get Entry 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"

entry

List Entry

Contains the properties for the list entry.

Object

entry.id

List Entry Identification

The unique identifier of the list entry.

String

“d121bc2210434ffc8a90daff9dd97e76”

note

Note Contents

The content of the note.

String

"List entry created for suspect order."

entry.author

Entry Author Properties Object

Contains the properties associated with the user that added the entry.

Object

entry.author.id

Entry Author ID

The unique identifier of the user that added the entry.

String

“d121ea2210434ffc8a90daff9cc97e76”

entry.author.name

Entry Author Name

The name of the user that added the entry.

String

“Jane Doe”

entry.addedDateTime

Entry Added Date/Time

The date and time that the entry was added or modified, in the ISO 8601 format.

String

“2023-03-30T15:41:58Z”

entry.deviceCountry

Entry Country Name

The name of the country where the device was reportedly located when the order was placed.

String

"United States of America"

entry.deviceId

Entry Device ID

The unique identifier that was generated by us for the device.

String

"7363b8ae6b2247b99f5d56fc81102254"

entry.paymentToken

Entry Payment Token

Payment token submitted by merchant for order (credit card, payer ID, routing/transit, MIC`R, and account number).

The payment token is hashed with salted SHA256.

If paymentType is set to “NONE” then the paymentToken value should be left empty.

String

entry.physicalAddress

Physical Address

An object containing the physical address of the order.

Object

entry.physicalAddress.line1

Address Line 1

The first line of the physical address.

String

"1005 Main Street"

entry.physicalAddress.line2

Address Line 2

The second line of the physical address.

String

"APT 56"

entry.physicalAddress.city

City

The city of the physical address.

String

"Boise"

entry.physicalAddress.region

Region

The state or region of the physical address.

String

"ID"

entry.physicalAddress.postalCode

Postal Code

The postal code of the physical address.

String

"83704"

entry.physicalAddress.countryCode

Entry Country Code

The country code of the device collection in the ISO-3166 format.

String

"US"

entry.physicalAddress.addressType

Address Type

The type of address. Enumerations are BILLING_ADDRESS or SHIPPING_ADDRESS.

String

"SHIPPING_ADDRESS"

entry.text

Text Entry

Contains the text entry for this list.

String

"customer42@example.com"

entry.userIpAddress

User IP Address

The IP Address of the customer or merchant.

String

"192.168.1.27"

Get Entry response example

Get Entry response body example

{
  "version": "1.0.0",
  "entry": {
    "id": "d121ea2210434ffc8a90daff9cc97e76",
    "note": "List entry created for suspect order.",
    "author": {
      "id": "d121ea2210434ffc8a90daff9cc97e76",
      "name": "Jane Doe"
    },
    "addedDateTime": "2023-03-30T15:41:58Z",
    "deviceCountry": "United States of America",
    "deviceId": "7363b8ae6b2247b99f5d56fc81102254",
    "paymentToken": "string",
    "physicalAddress": {
      "line1": "1005 Main Street",
      "line2": "APT 56",
      "city": "Boise",
      "region": "ID",
      "postalCode": "83704",
      "countryCode": "US",
      "addressType": "BILLING_ADDRESS"
    },
    "text": "customer42@example.com",
    "userIpAddress": "192.168.1.27"
  }
}

Delete Entry

Use the Delete Entry DELETE API to delete a list entry.

Sandbox Endpoint

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

Production Endpoint

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

Method: DELETE

Header Authorization: Bearer token

Header Content-Type: application/json

Body: Refer to the Delete Entry request parameters.

Delete Entry request parameters

Delete Entry request parameters table

JSON Path

Field Name

Description

Type

Example

listId

List ID

Unique identifier of the list. Assigned when the list was created.

String

"d121ea2210434ffc8a90daff9cc97e76"

id

List Entry Identification

The unique identifier of the list entry.

String

“d121bc2210434ffc8a90daff9dd97e76”

Delete Entry response properties

Delete Entry 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"

entry

List Entry

Contains the identification for the list entry.

Object

entry.id

List Entry Identification

The unique identifier of the list entry.

String

“d121ea2210434ffc8a90daff9cc97e76”

Delete Entry response example

Delete Entry response body example

{
  "version": "1.0.0",
  "entry": {
    "id": "d121bc2210434ffc8a90daff9dd97e76"
  }
}
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