1. Identity and Fraud Developer
  2. Kount 360
  3. Compliance

AML Compliance Solutions Integration Guide

AML Compliance Solutions Integration Guide

AML Compliance Solutions is a cloud-native Anti-Money Laundering (AML) solution that helps your organization comply with legal and regulatory requirements aimed at preventing, detecting, and reporting money laundering activities.

AML Compliance uses our Match Engine to screen and monitor individuals and businesses against sanctions lists, such as the US Office of Foreign Assets Control (OFAC), Politically Exposed Person (PEP), and Adverse Media.

The Match Engine ingests data from these sources. The data is validated and deduplicated for accuracy and then screened against global watchlists. Matches are either returned as alerts or put through an optional analyst review to reduce false positives. Additionally, our optional monitoring service can continuously monitor alerts in case a database is updated with new information.

For the API specifications, go to AML Compliance Solutions Screening API.

Generate an API Key

In Kount 360, after you have activated your organization, you can generate API keys to send data securely to Equifax. Only users with the Owner role permissions can generate, delete, or edit API keys.

Caution

You must have an initialized client before you can create an API key.

  1. Sign in to Kount 360.

    There are two integration environments: sandbox and production. Only integrate into our sandbox environment if you are integrating a pre-production environment without production data for testing.

  2. Select Admin, and then Product Configuration.

  3. In System Settings, select API Keys.

    All initialized clients display.

  4. For the client you want to create an API key, select Generate API Key.

    The new API key is generated. A prompt displays with the ability to copy the API key and add a description.

  5. Copy the API key, and then store it in a secure location.

    Note

    The API key is not provided again. You must store it in a secure location for future reference. If the API key is compromised or lost, create a new API key and delete the compromised one.

  6. Enter a description detailing the store used for the API key, and then select Confirm.

API keys are organized under each client on the API Keys page. Expand the client to view your API keys, the descriptions, and when client details were created.

Create a Bearer Token

After you have provisioned your API credentials in the portal, retrieve a temporary bearer token to authenticate calls to the Kount 360 API. Provide the API key in an HTTP POST to a specific login.equifax.com URL.

With a successful exchange, the returned JSON provides a special bearer token, which is the access_token property. The exchange also provides an expiration date, the expires_in property, provided in seconds until expiration. The API to retrieve the bearer token depends on if you are calling the sandbox or production environment.

The values are:

Sandbox

Auth Server URL:

https://login-uat.equifax.com/as/token

API Service Host:

https://api-sandbox.kount.com

Production

Auth Server URL:

https://login.equifax.com/as/token

API Service Host:

https://api.kount.com

After obtaining the bearer token, use it to authenticate requests to the Kount 360 API. Include the token in the Authorization header of your HTTP API request, prefixed with Bearer {bearer token}.

To prevent authentication issues, refresh the token before it expires. Tokens issued by login.equifax.com expire after 20 minutes, but client credentials remain valid unless revoked. Minimize calls to the /token endpoint by implementing token expiration handling in your customer applications. Always check if a token has expired before requesting a new one, as excessive calls to the /token endpoint could result in rate limiting.

Bearer Token Retrieval Examples

We provide several examples in popular programming languages to retrieve and use the bearer token.

Python

Python Code Example

"""sandbox"""
import requests
AUTH_SERVER_URL = "https://login-uat.equifax.com/as/token"
API_URL = "https://api-sandbox.kount.com"
API_KEY = "YOUR API KEY HERE"
CLIENT_ID = "YOUR CLIENT_ID HERE"

r = requests.post(AUTH_SERVER_URL,
                  params={"grant_type": "client_credentials",
                          "scope": "k1_integration_api"},
                  headers={"Authorization": "Basic" + API_KEY,
                           "Content-Type":
                           "application/x-www-form-urlencoded"})

t = r.json()["access_token"]

r = requests.post(API_URL + "/login",
                  headers={'Authorization': "Bearer " + t},
                  json={
                    "clientId": "900900",
                    "sessionId": "d121ea2210434ffc8a90daff9cc97e76",
                    "userId": "meoyyd8za8jdmwfm",
                    "username": "meoyyd8za8jdmwfm",
                    "userPassword": "38401eb46f8fbb74c1846a5f47f68d83a9bef126b1d4143f886cd464323cdaab",
                    "userIp": "192.168.0.1",
                    "loginUrl": "http://www.example.com/login",
                    "userAuthenticationStatus": "true",
                    "userCreationDate": "2019-08-24T14:15:22Z",
                    "userType": "VIP",
                    "mfaPhone": "+12081234567",
                    "mfaEmail": "username@example.com",
                    "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36",
                    "context": "LOGIN"
                })
print("Response:", r.json())

Bash

Bash Code Example

#!/usr/bin/env bash

API='https://api-sandbox.kount.com'
ISSUER='https://login-uat.equifax.com/as/token'
CLIENT_ID= "YOUR CLIENT_ID HERE"
API_KEY= "YOUR API KEY HERE"''

# Get our token (it is valid for 20 minutes)
RESPONSE=$(curl -s -X POST "${ISSUER}/v1/token?grant_type=client_credentials&scope=k1_integration_api" -H "Authorization: Basic ${API_KEY}" -H "Content-Type: application/x-www-form-urlencoded")
TOKEN=$(echo $RESPONSE | jq -r .access_token)

# Make our evaluation request
REQUEST_DATA='{
                "clientId": "900900",
                "sessionId": "d121ea2210434ffc8a90daff9cc97e76",
                "userId": "meoyyd8za8jdmwfm",
                "username": "meoyyd8za8jdmwfm",
                "userPassword": "38401eb46f8fbb74c1846a5f47f68d83a9bef126b1d4143f886cd464323cdaab",
                "userIp": "192.168.0.1",
                "loginUrl": "http://www.example.com/login",
                "userAuthenticationStatus": "true",
                "userCreationDate": "2019-08-24T14:15:22Z",
                "userType": "VIP",
                "mfaPhone": "+12081234567",
                "mfaEmail": "username@example.com",
                "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36",
                "context": "LOGIN"
              }'
RESPONSE=$(curl -s -X POST ${API}/login -H "Authorization: Bearer ${TOKEN}" -d "$REQUEST_DATA")
echo "$RESPONSE" | jq

TypeScript

TypeScript Code Example

const axios = require('axios')

const API = 'https://api-sandbox.kount.com'
const ISSUER = 'https://login-uat.equifax.com/as/token'
const CLIENT_ID = 'YOUR CLIENT ID HERE'
const API_KEY = 'YOUR API KEY HERE'

async function getBearerToken() {

    const auth = await axios({
        url: `${ISSUER}/v1/token`,
        method: 'post',
        headers: {
            authorization: `Basic ${API_KEY}`
        },
        params: {
            grant_type: 'client_credentials',
            scope: 'k1_integration_api'
        }
    })

    return auth.data.access_token
}

async function evaluateLogin(token: string) {

    const resp = await axios({
        url: `${API}/login`,
        method: 'post',
        headers: {
            authorization: `Bearer ${token}`,
        },
        data: {
            clientId: "900900",
            sessionId: "d121ea2210434ffc8a90daff9cc97e76",
            userId: "meoyyd8za8jdmwfm",
            username: "meoyyd8za8jdmwfm",
            userPassword: "38401eb46f8fbb74c1846a5f47f68d83a9bef126b1d4143f886cd464323cdaab",
            userIp: "192.168.0.1",
            loginUrl: "http://www.example.com/login",
            userAuthenticationStatus: "true",
            userCreationDate: "2019-08-24T14:15:22Z",
            userType: "VIP",
            mfaPhone: "+12081234567",
            mfaEmail: "username@example.com",
            userAgent: "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36",
            context: "LOGIN"
        }
    })

    return resp.data
}
const main = async () = {
    const token = await getBearerToken();
    const resp = await evaluateLogin(token);
    console.log(JSON.stringify(resp, null, 4))
}

main()

Go

Go Code Example

package main

import (
        "bytes"
        "encoding/json"
        "fmt"
        "io"
        "net/http"
)

type config struct {
        API      string
        Issuer   string
        ClientId string
        APIKey   string
}

func getToken(c *http.Client, issuer, creds string) string {

        req, _ := http.NewRequest(http.MethodPost, issuer+"/v1/token", nil)

        req.Header.Add("Authorization", "Basic "+creds)

        req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

        q := req.URL.Query()
        q.Add("grant_type", "client_credentials")
        q.Add("scope", "k1_integration_api")
        req.URL.RawQuery = q.Encode()

        resp, _ := c.Do(req)
        defer resp.Body.Close()

        t := struct {
                TokenType   string `json:"token_type"`
                ExpiresIn   int    `json:"expires_in"`
                AccessToken string `json:"access_token"`
        }{}

        json.NewDecoder(resp.Body).Decode(&t)
        return t.AccessToken
}

func evaluate(c *http.Client, api string, payload LoginRequest, token string) string {

        j, _ := json.Marshal(payload)

        req, _ := http.NewRequest(http.MethodPost, api+"/login", bytes.NewBuffer(j))

        req.Header.Add("Authorization", "Bearer "+token)

        resp, _ := c.Do(req)
        defer resp.Body.Close()

        b, _ := io.ReadAll(resp.Body)
        s := string(b)
        return s
}

type LoginRequest struct {
        ClientID                 string `json:"clientId"`
        SessionID                string `json:"sessionId"`
        UserID                   string `json:"userId"`
        Username                 string `json:"username"`
        UserPassword             string `json:"userPassword"`
        UserIP                   string `json:"userIp"`
        LoginURL                 string `json:"loginUrl"`
        UserAuthenticationStatus string `json:"userAuthenticationStatus"`
        UserCreationDate         string `json:"userCreationDate"`
        UserType                 string `json:"userType"`
        MFAPhone                 string `json:"mfaPhone"`
        MFAEmail                 string `json:"mfaEmail"`
        UserAgent                string `json:"userAgent"`
        Context                  string `json:"context"`
}

func main() {
        config := config{
                API:      "https://api-sandbox.kount.com",
                Issuer:   "https://login-uat.equifax.com/as/token",
                ClientId: "",
                APIKey:   "",
        }
        client := &http.Client{}
        token := getToken(client, config.Issuer, config.APIKey)

        payload := LoginRequest{
                ClientID:                 config.ClientId,
                SessionID:                "d121ea2210434ffc8a90daff9cc97e76",
                UserID:                   "meoyyd8za8jdmwfm",
                Username:                 "meoyyd8za8jdmwfm",
                UserPassword:             "38401eb46f8fbb74c1846a5f47f68d83a9bef126b1d4143f886cd464323cdaab",
                UserIP:                   "192.168.0.1",
                LoginURL:                 "http://www.example.com/login",
                UserAuthenticationStatus: "true",
                UserCreationDate:         "2019-08-24T14:15:22Z",
                UserType:                 "VIP",
                MFAPhone:                 "+12081234567",
                MFAEmail:                 "username@example.com",
                UserAgent:                "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36",
                Context:                  "LOGIN",
        }

        resp := evaluate(client, config.API, payload, token)
        fmt.Printf("%s\n", resp)
}

Confirm your integration

To confirm that your integration was successful, send a screening request and verify that you receive a response.

Send a screening request

Submit your request with as many fields as possible for the most accurate match results. The following example uses only the minimum required fields. For the complete list of possible fields, go to the AML Compliance Solutions Screening API.

  1. Submit the First and Last name for a person screening.

    You can enter more fields, but these are the minimum fields required for a response.

    Note

    Use a first and last name from a data source you subscribe to, such as OFAC, to ensure a successful response.

  2. A response is returned with one of the following matchSummary.review values:

    • no_match_found: The system attempted to find a match in the available data sources, but none was found.

    • machine_soft_hit: At least one match found.

    A successful response with a soft hit provides data similar to the example in this document.

Screening request example

{
  "metadata": {
    "monitoring": {
      "processingAction": "unspecified",
      "monitoringId": "string"
    }
  },
  "context": {
    "customerUse": {
      "uniqueId": "Your unique ID",
      "organization": "Your organization"
    }
  },
  "personMatch": {
    "name": {
      "first": "<subject first name>",
      "last": "<subject last name>"
    }
  }
}

Screening response example

{
  "context": {
    "requestTime": "2025-07-30T15:12:21.604Z",
    "responseTime": "2025-07-30T15:12:21.604Z",
    "inquiryId": "4dd42d66-dd8b-11ee-a105-178d06e94420",
    "customerUse": {
      "uniqueId": "Your unique ID",
      "organization": "Your organization"
    },
    "correlationId": "4dd42d66-dd8b-11ee-a105-178d06e94420",
    "origination": "ORIGIN_UNSPECIFIED",
    "monitoringChange": true
  },
  "matchSummary": {
    "compositeScore": 0.85,
    "riskLevel": "risk_type_unspecified",
    "review": "machine_soft_hit",
    "decision": {
      "reason": "string",
      "remarks": [
        {
          "remark": "string",
          "userId": "string",
          "timestamp": "2025-07-30T15:12:21.604Z"
        }
      ]
    },
    "dataSourceRisk": [
      {
        "dataSourceClassification": "classification_unspecified",
        "riskLevel": "risk_type_unspecified"
      }
    ]
  },
  "matchResults": [
    {
      "source": {
        "dataSet": "DATA_SOURCE_SET_UNSPECIFIED",
        "dataSubset": "string",
        "riskType": "risk_type_unspecified",
        "riskCategories": [
          "string"
        ]
      },
      "data": [
        {
          "score": 1,
          "review": "unspecified",
          "reason": [
            {
              "attribute": "name"
            }
          ],
          "sourceId": "48891",
          "generatedAt": "2025-07-30T15:12:21.604Z",
          "person": {
            "name": {
              "first": "John",
              "middle": "David",
              "last": "Doe",
              "prefix": "Mr.",
              "suffix": "Jr.",
              "preferred": "Johnny D. Doe, Junior",
              "fullName": "Mr. John David Doe, Jr."
            },
            "aliases": [
              {
                "type": "a.k.a",
                "first": "John",
                "middle": "David",
                "last": "Doe",
                "prefix": "Mr.",
                "suffix": "Jr."
              }
            ],
            "genders": [
              "gender_unspecified"
            ],
            "addresses": [
              {
                "type": "unspecified",
                "line1": "123 Main Street",
                "line2": "Unit 4",
                "line3": "string",
                "city": "Springfield",
                "region": "Illinois",
                "postalCode": "12345",
                "countryCode": "USA",
                "countryName": "United States"
              }
            ],
            "digitalCurrencyWalletAddresses": [
              {
                "asset": "BTC",
                "address": "3J98t1WpEZ73CNmQviecrnyiWrnqRhWNLy"
              }
            ],
            "dates": [
              {
                "year": 0,
                "month": 0,
                "day": 0,
                "type": "unspecified"
              }
            ],
            "emailAddresses": [
              {
                "type": "unspecified",
                "value": "hello@example.com"
              }
            ],
            "phoneNumbers": [
              {
                "type": "unspecified",
                "value": "hello@example.com"
              }
            ],
            "countries": [
              {
                "type": "string",
                "value": "string"
              }
            ],
            "governmentIds": [
              {
                "type": "string",
                "value": "string",
                "country": "string"
              }
            ],
            "sanctionsOrPrograms": [
              {
                "type": "string",
                "value": "string"
              }
            ],
            "remarks": [
              {
                "type": "string",
                "value": "string"
              }
            ],
            "mediaArticles": [
              {
                "type": "unknown",
                "title": "string",
                "publisher": "string",
                "publishDate": "2025-07-30T15:12:21.604Z",
                "summary": "string",
                "fullName": "string",
                "sourceLink": "string",
                "street": "string",
                "address": "string",
                "country": "string",
                "dateOfBirth": "string",
                "gender": "string",
                "spouse": "string",
                "relative": "string"
              }
            ],
            "websites": [
              {
                "type": "string",
                "value": "string"
              }
            ],
            "relationships": [
              {
                "vendorId": "string",
                "expired": true,
                "type": "string"
              }
            ]
          },
          "riskLevel": "risk_type_unspecified",
          "id": "string"
        }
      ]
    }
  ],
  "disclaimer": "string"
}
Was this article helpful?
0 out of 0 found this helpful
Compliance
AML Compliance Solutions Integration Guide