Business AML Search Workflow

This page describes the production-focused AML screening workflow for business entities:

1. Authenticate - Generate authentication token
2. Create Business AML Search - Submit company screening request
3. Retrieve AML Hits - Get list of potential matches
4. Retrieve Full AML Intelligence - Get detailed compliance data

This deterministic sequence helps teams integrate quickly and reduces implementation ambiguity.

Diagram summary: This flowchart shows a single linear path with four steps: authenticate, create a business AML search, retrieve AML search hits, and retrieve full AML hit details.

Workflow Summary: Authenticate with the platform, perform a business AML screening search, retrieve screening hits, and retrieve detailed compliance intelligence for a selected match.

Before accessing any KYC Protect endpoints, an authentication token must be generated.

The returned bearer token should be included in the Authorization header for all subsequent requests.

POST /authenticate

{
  "username": "your-username",
  "password": "your-password"
}

{
  "token": "eyJhbGciOi..."
}

Create a Business AML screening search using the supplied company details.

The API performs screening across the configured AML datasets and returns a unique search identifier in the id field.

POST /compliance/kyc-protect/searches/businesses

{
  "countryCodes": [
    "GB"
  ],
  "threshold": 85,
  "name": "Creditsafe",
  "datasets": [
    "AM"
  ]
}

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "Creditsafe Ltd",
  "countryCodes": [
    "GB"
  ],
  "threshold": 85,
  "type": "business",
  "datasets": [
    "AM"
  ],
  "status": "new",
  "riskRating": "veryLow",
  "totalHitCount": 1
}

Retrieve AML screening hits associated with the previously created AML search.

Each hit represents a potential AML match and includes a unique hitId required for retrieval of the detailed AML intelligence profile.

GET /compliance/kyc-protect/searches/businesses/{searchId}/hits

[
  {
    "id": "c4b6f41f-3ef8-44f6-9e79-812e55b8df9d",
    "name": "Creditsafe Holdings Ltd",
    "riskRating": "medium",
    "datasets": [
      "AM"
    ]
  }
]

Retrieve the full compliance intelligence profile for a selected AML hit.

This endpoint provides detailed AML information associated with the selected screening result.

GET /compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}

{
  "id": "c4b6f41f-3ef8-44f6-9e79-812e55b8df9d",
  "name": "Creditsafe Holdings Ltd",
  "riskRating": "medium",
  "country": "GB",
  "datasets": [
    "AM"
  ],
  "adverseMedia": [],
  "sanctions": [],
  "pep": []
}

Diagram summary: This sequence diagram shows the client authenticating first, then creating a business search, retrieving hits for that search, and finally retrieving full details for one selected hit.

Diagram summary: This decision flow shows success and failure paths for each stage: authentication, search creation, hit retrieval, and detailed hit retrieval, ending in workflow completion or a stage-specific failure outcome.

All requests following authentication must include the bearer token in the request header.

Authorization: Bearer <token>

The threshold property controls match sensitivity.

Recommended production threshold values typically range between 80–90.

The datasets property controls which screening datasets are evaluated during AML screening.

{
  "datasets": ["AM"]
}

Dataset definitions are documented separately within the KYC Protect documentation.

Required:
  - username (string)
  - password (string)
  - threshold (integer: 75, 80, 85, 90, 95, or 100)
  - businessName (string)
  - datasets (array)

Optional:
  - countryCodes (array, default: ["GB"])