{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-connect-apis-catalog/product-catalog/KYCProtect/sidebars.yaml","current-catalog-info":"current-catalog-info-/connect-apis-catalog/product-catalog/kycprotect/kycprotect"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Business AML Search Workflow","llmstxt":{"hide":true}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"business-aml-search-workflow","__idx":0},"children":["Business AML Search Workflow"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This page describes the production-focused AML screening workflow for ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["business entities"]},":"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authenticate"]}," - Generate authentication token"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create Business AML Search"]}," - Submit company screening request"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Retrieve AML Hits"]}," - Get list of potential matches"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Retrieve Full AML Intelligence"]}," - Get detailed compliance data"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This deterministic sequence helps teams integrate quickly and reduces implementation ambiguity."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"workflow-diagram","__idx":2},"children":["Workflow Diagram"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart TD;\n A([Authenticate]) --> B([Create Business AML Search])\n B --> C([Retrieve AML Search Hits])\n C --> D([Retrieve Full AML Hit Details])\n","diagramHtml":"

Authenticate

Create Business AML Search

Retrieve AML Search Hits

Retrieve Full AML Hit Details

","diagramHtmlDark":"

Authenticate

Create Business AML Search

Retrieve AML Search Hits

Retrieve Full AML Hit Details

"},"children":["flowchart TD;\n A([Authenticate]) --> B([Create Business AML Search])\n B --> C([Retrieve AML Search Hits])\n C --> D([Retrieve Full AML Hit Details])\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Workflow Summary:"]}," Authenticate with the platform, perform a business AML screening search, retrieve screening hits, and retrieve detailed compliance intelligence for a selected match."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"workflow-summary-table","__idx":3},"children":["Workflow Summary Table"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Step"},"children":["Step"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"OperationId"},"children":["OperationId"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["1"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authenticate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /authenticate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Generate authentication token"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["2"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["KYCSearchBusiness"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /compliance/kyc-protect/searches/businesses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create AML screening search"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["3"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GetKYCSearchBusinessHitsBySearchId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /compliance/kyc-protect/searches/businesses/{searchId}/hits"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve AML hits"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["4"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GetKYCSearchBusinessHitsBySearchIdAndHitId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve full AML intelligence"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-1-authenticate","__idx":4},"children":["Step 1: Authenticate"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before accessing any KYC Protect endpoints, an authentication token must be generated."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The returned bearer token should be included in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," header for all subsequent requests."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"endpoint","__idx":5},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /authenticate\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request","__idx":6},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"username\": \"your-username\",\n \"password\": \"your-password\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-response","__idx":7},"children":["Example Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"token\": \"eyJhbGciOi...\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"success-criteria","__idx":8},"children":["Success Criteria"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Condition"},"children":["Condition"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTP Status Code = ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication token returned"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"workflow-outputs","__idx":9},"children":["Workflow Outputs"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Output"},"children":["Output"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accessToken"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bearer token used for subsequent API requests"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-2-create-business-aml-search","__idx":10},"children":["Step 2: Create Business AML Search"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a Business AML screening search using the supplied company details."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API performs screening across the configured AML datasets and returns a unique search identifier in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," field."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"endpoint-1","__idx":11},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /compliance/kyc-protect/searches/businesses\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request-1","__idx":12},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"countryCodes\": [\n \"GB\"\n ],\n \"threshold\": 85,\n \"name\": \"Creditsafe\",\n \"datasets\": [\n \"AM\"\n ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-parameters","__idx":13},"children":["Request Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["countryCodes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Country filter for screening"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["threshold"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Match threshold percentage (75, 80, 85, 90, 95, or 100)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Business name to screen"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["datasets"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AML datasets to screen against"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-response-1","__idx":14},"children":["Example Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\n \"name\": \"Creditsafe Ltd\",\n \"countryCodes\": [\n \"GB\"\n ],\n \"threshold\": 85,\n \"type\": \"business\",\n \"datasets\": [\n \"AM\"\n ],\n \"status\": \"new\",\n \"riskRating\": \"veryLow\",\n \"totalHitCount\": 1\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"success-criteria-1","__idx":15},"children":["Success Criteria"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Condition"},"children":["Condition"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTP Status Code = ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Search ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," returned"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Search successfully created"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"workflow-outputs-1","__idx":16},"children":["Workflow Outputs"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Output"},"children":["Output"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["searchId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique AML search identifier (mapped from response ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["totalHitCount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number of AML matches returned"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["riskRating"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Calculated AML risk level"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-3-retrieve-aml-search-hits","__idx":17},"children":["Step 3: Retrieve AML Search Hits"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve AML screening hits associated with the previously created AML search."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each hit represents a potential AML match and includes a unique ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hitId"]}," required for retrieval of the detailed AML intelligence profile."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"endpoint-2","__idx":18},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET /compliance/kyc-protect/searches/businesses/{searchId}/hits\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"path-parameters","__idx":19},"children":["Path Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["searchId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AML search identifier returned from Step 2"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-response-2","__idx":20},"children":["Example Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"[\n {\n \"id\": \"c4b6f41f-3ef8-44f6-9e79-812e55b8df9d\",\n \"name\": \"Creditsafe Holdings Ltd\",\n \"riskRating\": \"medium\",\n \"datasets\": [\n \"AM\"\n ]\n }\n]\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"success-criteria-2","__idx":21},"children":["Success Criteria"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Condition"},"children":["Condition"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTP Status Code = ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hits collection returned (can be empty)"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"workflow-outputs-2","__idx":22},"children":["Workflow Outputs"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Output"},"children":["Output"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hits"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Collection of AML matches (can be an empty array)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["firstHitId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AML hit identifier from the first item in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hits"]}," (not present when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hits"]}," is empty)"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-4-retrieve-full-aml-hit-details","__idx":23},"children":["Step 4: Retrieve Full AML Hit Details"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve the full compliance intelligence profile for a selected AML hit."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This endpoint provides detailed AML information associated with the selected screening result."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"endpoint-3","__idx":24},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET /compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"path-parameters-1","__idx":25},"children":["Path Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["searchId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AML search identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hitId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AML hit identifier"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-response-3","__idx":26},"children":["Example Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"id\": \"c4b6f41f-3ef8-44f6-9e79-812e55b8df9d\",\n \"name\": \"Creditsafe Holdings Ltd\",\n \"riskRating\": \"medium\",\n \"country\": \"GB\",\n \"datasets\": [\n \"AM\"\n ],\n \"adverseMedia\": [],\n \"sanctions\": [],\n \"pep\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"success-criteria-3","__idx":27},"children":["Success Criteria"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Condition"},"children":["Condition"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTP Status Code = ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Full AML intelligence returned"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"workflow-outputs-3","__idx":28},"children":["Workflow Outputs"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Output"},"children":["Output"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hitDetails"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Detailed AML intelligence profile"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example-end-to-end-workflow-sequence","__idx":29},"children":["Example End-to-End Workflow Sequence"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"sequenceDiagram\n participant Client\n participant AuthAPI\n participant AMLAPI\n\n Client->>AuthAPI: POST /authenticate\n AuthAPI-->>Client: accessToken\n\n Client->>AMLAPI: POST /searches/businesses\n AMLAPI-->>Client: searchId + hitCount\n\n Client->>AMLAPI: GET /searches/businesses/{searchId}/hits\n AMLAPI-->>Client: AML hits[]\n\n Client->>AMLAPI: GET /searches/businesses/{searchId}/hits/{hitId}\n AMLAPI-->>Client: Full AML intelligence profile\n","diagramHtml":"AMLAPIAuthAPIClientAMLAPIAuthAPIClientPOST /authenticateaccessTokenPOST /searches/businessessearchId + hitCountGET /searches/businesses/{searchId}/hitsAML hits[]GET /searches/businesses/{searchId}/hits/{hitId}Full AML intelligence profile","diagramHtmlDark":"AMLAPIAuthAPIClientAMLAPIAuthAPIClientPOST /authenticateaccessTokenPOST /searches/businessessearchId + hitCountGET /searches/businesses/{searchId}/hitsAML hits[]GET /searches/businesses/{searchId}/hits/{hitId}Full AML intelligence profile"},"children":["sequenceDiagram\n participant Client\n participant AuthAPI\n participant AMLAPI\n\n Client->>AuthAPI: POST /authenticate\n AuthAPI-->>Client: accessToken\n\n Client->>AMLAPI: POST /searches/businesses\n AMLAPI-->>Client: searchId + hitCount\n\n Client->>AMLAPI: GET /searches/businesses/{searchId}/hits\n AMLAPI-->>Client: AML hits[]\n\n Client->>AMLAPI: GET /searches/businesses/{searchId}/hits/{hitId}\n AMLAPI-->>Client: Full AML intelligence profile\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"workflow-decision-diagram","__idx":30},"children":["Workflow Decision Diagram"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart TD\n A[Authenticate] --> B{Authentication successful?}\n B -- Yes --> C[Create business AML search]\n B -- No --> Z1[Authentication failed]\n\n C --> D{Search successful?}\n D -- Yes --> E[Retrieve AML hits]\n D -- No --> Z2[Handle AML search failure]\n\n E --> F{Any hits returned?}\n F -- Yes --> G[Select AML hit]\n F -- No --> Z3[No AML hits found]\n\n G --> H[Retrieve full AML hit details]\n H --> I{Details returned?}\n I -- Yes --> J[Workflow complete]\n I -- No --> Z4[Handle AML detail failure]\n","diagramHtml":"

Yes

No

Yes

No

Yes

No

Yes

No

Authenticate

Authentication successful?

Create business AML search

Authentication failed

Search successful?

Retrieve AML hits

Handle AML search failure

Any hits returned?

Select AML hit

No AML hits found

Retrieve full AML hit details

Details returned?

Workflow complete

Handle AML detail failure

","diagramHtmlDark":"

Yes

No

Yes

No

Yes

No

Yes

No

Authenticate

Authentication successful?

Create business AML search

Authentication failed

Search successful?

Retrieve AML hits

Handle AML search failure

Any hits returned?

Select AML hit

No AML hits found

Retrieve full AML hit details

Details returned?

Workflow complete

Handle AML detail failure

"},"children":["flowchart TD\n A[Authenticate] --> B{Authentication successful?}\n B -- Yes --> C[Create business AML search]\n B -- No --> Z1[Authentication failed]\n\n C --> D{Search successful?}\n D -- Yes --> E[Retrieve AML hits]\n D -- No --> Z2[Handle AML search failure]\n\n E --> F{Any hits returned?}\n F -- Yes --> G[Select AML hit]\n F -- No --> Z3[No AML hits found]\n\n G --> H[Retrieve full AML hit details]\n H --> I{Details returned?}\n I -- Yes --> J[Workflow complete]\n I -- No --> Z4[Handle AML detail failure]\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication-requirements","__idx":31},"children":["Authentication Requirements"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All requests following authentication must include the bearer token in the request header."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-header","__idx":32},"children":["Example Header"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"Authorization: Bearer \n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"aml-match-threshold-guidance","__idx":33},"children":["AML Match Threshold Guidance"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["threshold"]}," property controls match sensitivity."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Threshold"},"children":["Threshold"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Behavior"},"children":["Behavior"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Lower Threshold"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Broader match results"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Higher Threshold"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["More precise match results"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Recommended production threshold values typically range between ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["80–90"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"aml-dataset-configuration","__idx":34},"children":["AML Dataset Configuration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["datasets"]}," property controls which screening datasets are evaluated during AML screening."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example","__idx":35},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"datasets\": [\"AM\"]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Dataset definitions are documented separately within the KYC Protect documentation."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"required-workflow-inputs","__idx":36},"children":["Required Workflow Inputs"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"Required:\n - username (string)\n - password (string)\n - threshold (integer: 75, 80, 85, 90, 95, or 100)\n - businessName (string)\n - datasets (array)\n\nOptional:\n - countryCodes (array, default: [\"GB\"])\n","lang":"yaml"},"children":[]}]},"headings":[{"value":"Business AML Search Workflow","id":"business-aml-search-workflow","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Workflow Diagram","id":"workflow-diagram","depth":2},{"value":"Workflow Summary Table","id":"workflow-summary-table","depth":2},{"value":"Step 1: Authenticate","id":"step-1-authenticate","depth":2},{"value":"Endpoint","id":"endpoint","depth":3},{"value":"Example Request","id":"example-request","depth":3},{"value":"Example Response","id":"example-response","depth":3},{"value":"Success Criteria","id":"success-criteria","depth":3},{"value":"Workflow Outputs","id":"workflow-outputs","depth":3},{"value":"Step 2: Create Business AML Search","id":"step-2-create-business-aml-search","depth":2},{"value":"Endpoint","id":"endpoint-1","depth":3},{"value":"Example Request","id":"example-request-1","depth":3},{"value":"Request Parameters","id":"request-parameters","depth":3},{"value":"Example Response","id":"example-response-1","depth":3},{"value":"Success Criteria","id":"success-criteria-1","depth":3},{"value":"Workflow Outputs","id":"workflow-outputs-1","depth":3},{"value":"Step 3: Retrieve AML Search Hits","id":"step-3-retrieve-aml-search-hits","depth":2},{"value":"Endpoint","id":"endpoint-2","depth":3},{"value":"Path Parameters","id":"path-parameters","depth":3},{"value":"Example Response","id":"example-response-2","depth":3},{"value":"Success Criteria","id":"success-criteria-2","depth":3},{"value":"Workflow Outputs","id":"workflow-outputs-2","depth":3},{"value":"Step 4: Retrieve Full AML Hit Details","id":"step-4-retrieve-full-aml-hit-details","depth":2},{"value":"Endpoint","id":"endpoint-3","depth":3},{"value":"Path Parameters","id":"path-parameters-1","depth":3},{"value":"Example Response","id":"example-response-3","depth":3},{"value":"Success Criteria","id":"success-criteria-3","depth":3},{"value":"Workflow Outputs","id":"workflow-outputs-3","depth":3},{"value":"Example End-to-End Workflow Sequence","id":"example-end-to-end-workflow-sequence","depth":2},{"value":"Workflow Decision Diagram","id":"workflow-decision-diagram","depth":2},{"value":"Authentication Requirements","id":"authentication-requirements","depth":2},{"value":"Example Header","id":"example-header","depth":3},{"value":"AML Match Threshold Guidance","id":"aml-match-threshold-guidance","depth":2},{"value":"AML Dataset Configuration","id":"aml-dataset-configuration","depth":2},{"value":"Example","id":"example","depth":3},{"value":"Required Workflow Inputs","id":"required-workflow-inputs","depth":2}],"frontmatter":{"arazzo-workflow":"../../single-search-workflow_arazzo.yaml","workflow-id":"single-aml-business-search","test-automation":true,"workflow-type":"arazzo-1.0.1","seo":{"title":"Business AML Search Workflow"}},"lastModified":"2026-07-17T12:34:15.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/connect-apis-catalog/product-catalog/kycprotect/documentation/processflows/businesssearch","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}