Single AML Search Workflow

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

Overview

This page describes one clear, production-focused AML screening journey for a business search:

1. Authenticate
2. Run AML Search
3. Retrieve AML Hits
4. Retrieve Full AML Intelligence

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

Metadata Summary

Workflow 1: Business AML Screening

Overview

The Business AML Screening workflow lets you screen a business for AML risk and then retrieve detailed compliance intelligence for matched entities.

It is the primary integration pattern for onboarding, compliance operations, procurement due diligence, and other regulated business processes.

The workflow uses this API sequence:

1. Authenticate with the Creditsafe Connect platform
2. Submit a Business AML Screening request
3. Retrieve AML screening hits
4. Retrieve detailed intelligence for a selected AML hit

Business AML Screening Workflow

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.

Workflow Summary Table

Step 1: Authenticate

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.

Endpoint

POST /authenticate

Example Request

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

Example Response

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

Success Criteria

Workflow Outputs

Step 2: Create Business AML Search

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.

Endpoint

POST /compliance/kyc-protect/searches/businesses

Example Request

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

Request Parameters

Example Response

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

Success Criteria

Workflow Outputs

Step 3: Retrieve AML Search Hits

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.

Endpoint

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

Path Parameters

Example Response

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

Success Criteria

Workflow Outputs

Step 4: Retrieve Full AML Hit Details

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

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

Endpoint

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

Path Parameters

Example Response

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

Success Criteria

Workflow Outputs

Runtime Expression Mapping

The Arazzo workflow uses runtime expressions to pass data between workflow steps.

Example End-to-End Workflow Sequence

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.

Workflow Decision Diagram

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.

Authentication Requirements

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

Example Header

Authorization: Bearer <token>

AML Match Threshold Guidance

The threshold property controls match sensitivity.

Recommended production threshold values typically range between 80–90.

AML Dataset Configuration

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

Example

{
  "datasets": ["AM"]
}

Dataset definitions are documented separately within the KYC Protect documentation.