When using the Create Entry API, you must build your request using specific parameters for each listType. For the List Entries and Get Entry APIs, you will only receive a subset of properties in the response for each different listType.
View the following tables to see request parameters and response properties for each listType.
sidebar. Device Country 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" |
sidebar. Device Country Entry schema request properties table
|
JSON Path |
Field Name |
Description |
Type |
Example |
|
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." |
|
author |
Entry Author Properties Object |
Contains the properties associated with the user that added the entry. |
Object |
|
|
author.id |
Entry Author ID |
The unique identifier of the user that added the entry. |
String |
“d121ea2210434ffc8a90daff9cc97e76” |
|
author.name |
Entry Author Name |
The name of the user that added the entry. |
String |
“Jane Doe” |
|
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” |
|
countryCode |
Entry Country Code |
The country code of the device collection in the ISO-3166 format. |
String |
"US" |
sidebar. Device ID 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." |
|
deviceId |
Entry Device ID |
The unique identifier that was generated by Kount for the device. |
String |
"7363b8ae6b2247b99f5d56fc81102254" |
sidebar. Device ID Entry schema response properties table
|
JSON Path |
Field Name |
Description |
Type |
Example |
|
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." |
|
author |
Entry Author Properties Object |
Contains the properties associated with the user that added the entry. |
Object |
|
|
author.id |
Entry Author ID |
The unique identifier of the user that added the entry. |
String |
“d121ea2210434ffc8a90daff9cc97e76” |
|
author.name |
Entry Author Name |
The name of the user that added the entry. |
String |
“Jane Doe” |
|
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” |
|
deviceId |
Entry Device ID |
The unique identifier that was generated by Kount for the device. |
String |
"7363b8ae6b2247b99f5d56fc81102254" |
sidebar. Device ID 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." |
|
paymentToken |
Entry Payment Token |
The payment token submitted by the merchant for the order (credit card, payer ID, routing/transit, MICR, and account number). If paymentType is set to “NONE” then the paymentToken value should be left empty. Post-auth calls only – If the credit card information is not available and a tokenized value is returned from the payment processor, set paymentType=”TOKEN” and send the token returned from the payment processor in the paymentToken field. |
String |
"7363b8ae6b2247b99f5d56fc81102254" |
sidebar. Payment Token Entry schema response properties table
|
JSON Path |
Field Name |
Description |
Type |
Example |
|
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." |
|
author |
Entry Author Properties Object |
Contains the properties associated with the user that added the entry. |
Object |
|
|
author.id |
Entry Author ID |
The unique identifier of the user that added the entry. |
String |
“d121ea2210434ffc8a90daff9cc97e76” |
|
author.name |
Entry Author Name |
The name of the user that added the entry. |
String |
“Jane Doe” |
|
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” |
|
paymentToken |
Entry Payment Token |
The payment token submitted by the merchant for the order (credit card, payer ID, routing/transit, MICR, 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. Post-auth calls only – If the credit card information is not available and a tokenized value is returned from the payment processor, set paymentType=”TOKEN” and send the token returned from the payment processor in the paymentToken field. |
String |
sidebar. Physical Address 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." |
|
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" |
sidebar. Physical Address Entry response properties table
|
JSON Path |
Field Name |
Description |
Type |
Example |
|
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." |
|
author |
Entry Author Properties Object |
Contains the properties associated with the user that added the entry. |
Object |
|
|
author.id |
Entry Author ID |
The unique identifier of the user that added the entry. |
String |
“d121ea2210434ffc8a90daff9cc97e76” |
|
author.name |
Entry Author Name |
The name of the user that added the entry. |
String |
“Jane Doe” |
|
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” |
|
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" |
sidebar. Text 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." |
|
text |
Entry Text |
A string containing the text entry for this list. |
String |
"customer42@example.com" |
sidebar. Text Entry schema response properties table
|
JSON Path |
Field Name |
Description |
Type |
Example |
|
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." |
|
author |
Entry Author Properties Object |
Contains the properties associated with the user that added the entry. |
Object |
|
|
author.id |
Entry Author ID |
The unique identifier of the user that added the entry. |
String |
“d121ea2210434ffc8a90daff9cc97e76” |
|
author.name |
Entry Author Name |
The name of the user that added the entry. |
String |
“Jane Doe” |
|
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” |
|
text |
Entry Text |
A string containing the text entry for this list. |
String |
"customer42@example.com" |
sidebar. User IP Address 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." |
|
ipAddress |
Entry IP Address |
The customer/merchant’s end-user’s IPv4 address. |
String |
"192.168.1.27" |
sidebar. User IP Address Entry schema response properties table
|
JSON Path |
Field Name |
Description |
Type |
Example |
|
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." |
|
author |
Entry Author Properties Object |
Contains the properties associated with the user that added the entry. |
Object |
|
|
author.id |
Entry Author ID |
The unique identifier of the user that added the entry. |
String |
“d121ea2210434ffc8a90daff9cc97e76” |
|
author.name |
Entry Author Name |
The name of the user that added the entry. |
String |
“Jane Doe” |
|
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” |
|
ipAddress |
Entry IP Address |
The customer/merchant’s end-user’s IPv4 address. |
String |
"192.168.1.27" |