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

Custom Fields API Specifications

Use the Custom Fields APIs to create, retrieve, and delete list entries.

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

Important

In Payments Fraud, the custom fields created in the user interface must match the type in the API custom fields. Misalignment between these two applications causes comparison errors.

Create Custom Field

Use Custom Field POST to create a new custom field.

Sandbox Endpoint

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

Production Endpoint

https://api.kount.com/policy-manager/v1/custom-fields

Method: POST

Header Authorization: Bearer token

Header Content-Type: application/json

Body: Refer to the Create Custom Field request parameters.

Create Custom Field request properties

Create Custom Field request properties table

JSON Path

Field Name

Description

Type

Example

key

Key

The unique identifier of this key that is provided with the value for the custom field when passed in with an API call.

String

"PROGRAM_ID"

type

Type

A string containing the type of data that will be associated with this custom field. Must be one of the following enumerations:

  • BOOLEAN

  • DATE

  • NUMBER

  • STRING

String

“NUMBER”

description

Description

The long-form human-readable description of this custom field.

String

“The government program the customer belongs to."

Create Custom Field request example

Create Custom Field request example

{
  "key": "PROGRAM_ID",
  "type": "NUMBER",
  "description": "The government program the customer belongs to."
}

Create Custom Field response properties

Create Custom Field 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"

customField

Custom Field Properties

The properties of the custom field.

Object

customField.key

Custom Field Key

The unique identifier of this key that is provided with the value for the custom field when passed in with an API call.

String

"PROGRAM_ID"

Create Custom Field response example

Create Custom Field response body example

{
  "version": "1.0.0",
  "customField": {
    "key": "PROGRAM_ID"
  }
}

Get Custom Field

Use Custom Field GET to retrieve the details of a custom field.

Sandbox Endpoint

https://api-sandbox.kount.com/policy-manager/v1/custom-fields/{key}

Production Endpoint

https://api.kount.com/policy-manager/v1/custom-fields/{key}

Method: GET

Header Authorization: Bearer token

Header Content-Type: application/json

Body: Refer to the Get Custom Field request parameters.

Get Custom Field request parameters

Get Custom Field request parameters table

JSON Path

Field Name

Description

Type

Example

key

Custom Field Key

The unique identifier of this key that is provided with the value for the custom field when passed in with an API call.

String

"PROGRAM_ID"

Get Custom Field response properties

Get Custom Field 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"

customField

Custom Field Properties Object

The properties of the custom field.

Object

customField.key

Custom Field Key

The unique identifier of this key that is provided with the value for the custom field when passed in with an API call.

String

"PROGRAM_ID"

customField.type

Custom Field Type

A string containing the type of data that will be associated with this custom field. Must be one of the following enumerations:

  • BOOLEAN

  • DATE

  • NUMBER

  • STRING

String

"NUMBER"

customField.description

Custom FieldDescription

The long-form human-readable description of this custom field.

String

“The government program the customer belongs to."

customField.lastSeenDateTime

Last Seen Date/Time

The date/time (in ISO 8601 format) that an event was sent to the system that contains the custom field.

String

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

Get Custom Field response example

Get Custom Field response body example

{
  "version": "1.0.0",
  "customField": {
    "key": "PROGRAM_NUMBER",
    "type": "NUMBER",
    "description": "The government program the customer belongs to.",
    "lastSeenDateTime": "2023-03-30T15:41:58Z"
  }
}

Get List Custom Fields

Use List Custom Fields GET to retrieve a list of the custom fields.

Sandbox Endpoint

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

Production Endpoint

https://api.kount.com/policy-manager/v1/custom-fields

Method: GET

Header Authorization: Bearer token

Header Content-Type: application/json

Body: Refer to the Get List Custom Field request parameters.

Get List Custom Field response properties

Get List Custom Field 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"

customFields

Custom Field Objects Array

An array of objects for the custom fields.

Array

customFields.key

Custom Fields Key

The unique identifier of this key that is provided with the value for the custom field when passed in with an API call.

String

"PROGRAM_ID"

customFields.type

Custom Fields Type

A string containing the type of data that will be associated with this custom field. Must be one of the following enumerations:

  • BOOLEAN

  • DATE

  • NUMBER

  • STRING

String

"NUMBER"

customFields.description

Custom Fields Description

The long-form human-readable description of this custom field.

String

“The government program the customer belongs to."

customFields.lastSeenDateTime

Last Seen Date/Time

The date/time (in ISO 8601 format) that an event was sent to the system that contains the custom field.

String

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

Get List Custom Fields response example

Get List Custom Fields response body example

{
  "version": "1.0.0",
  "customFields": [
    {
      "key": "PROGRAM_NUMBER",
      "type": "NUMBER",
      "description": "The government program the customer belongs to.",
      "lastSeenDateTime": "2023-03-30T15:41:58Z"
    }
  ]
}

Delete Custom Field

Use Custom Field DELETE to delete a custom field.

Sandbox Endpoint

https://api-sandbox.kount.com/policy-manager/v1/custom-fields/{key}

Production Endpoint

https://api.kount.com/policy-manager/v1/custom-fields/{key}

Method: DELETE

Header Authorization: Bearer token

Header Content-Type: application/json

Body: Refer to the Delete Custom Field request parameters.

Delete Custom Field request parameters

Delete Custom Field request parameters table

JSON Path

Field Name

Description

Type

Example

key

Key

A string containing the unique identifier of this key that will be provided along with the value for the custom field when passed in with an API call.

String

"PROGRAM_ID"

Delete Custom Field response properties

Delete Custom Field 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"

customField

Custom Field Object

The properties of the custom field.

Object

customField.key

Key

A string containing the unique identifier of this key that will be provided along with the value for the custom field when passed in with an API call.

String

"PROGRAM_ID"

Delete Custom Field response example

Delete Custom Field response body example

{
  "version": "1.0.0",
  "customField": {
    "key": "PROGRAM_NUMBER"
  }
}
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