KYC Hong Kong

Hong Kong AML name screening against global sanctions, PEP, and adverse-media watchlists (powered by Acuris Risk Intelligence).

---

Flow

Call /kyc/hk/screening with a name (plus optional date of birth, gender, country, and entity type). The screen runs synchronously and returns the matching watchlist records, each with a match strength and the categories it appears on, along with a caseId referencing the screening case.

Single-name AML / sanctions / PEP screening

post

Screens a single name against global sanctions, PEP (Politically Exposed Person), and adverse-media watchlists (data sourced from Acuris Risk Intelligence) and returns any matches in one synchronous call.

Supply at least one name field — name, nameEnglish, nameChinese, or nameOtherLang. Optional dob, gender, country, and entityType narrow the screen.

The response summary counts matches by resolution status, and matches lists each watchlist hit with its strength (0–1), the categories it appears on (PEP, Sanction, …), and identifying details. A returned caseId references the screening case for future retrieval.

Set full: true to also include each match's complete profile (addresses, ID & passport numbers, sanction regime & measures, PEP positions, linked persons, evidence sources, photo, …) under matches[].profile. This is heavier — it makes one extra upstream call per match — so it defaults to false, returning only the headline match data.

Every screening also produces a PDF report of the result, returned as a presigned download link in pdfUrl (valid for 7 days; the file is retained for 30 days). Download it promptly — there is no endpoint to re-fetch the link later. If report generation fails, the screening still succeeds and pdfUrl is omitted from the response.

Authorizations

ClientID & ClientSecret

x-client-idstringRequired

Client ID in x-client-id header.

x-client-secretstringRequired

Client Secret in x-client-secret header.

Body

application/json

At least one of name, nameEnglish, nameChinese, or nameOtherLang is required.

namestringOptional

Name to screen. Use this when you have a single name and don't need to disambiguate the script.

Example: Dmitri Volkov

nameEnglishstringOptional

Name in English / Latin script.

nameChinesestringOptional

Name in Chinese script.

nameOtherLangstringOptional

Name in a language other than English or Chinese.

entityTypestring · enumOptional

Type of entity being screened. Optional.

Possible values:

dobstringOptional

Date of birth in YYYY-MM-DD format. Optional.

Example: 1969-04-22

genderstring · enumOptional

Optional.

Possible values:

countrystringOptional

Nationality, citizenship, or residency — name or code of the country/region. Optional.

Example: Ruritania

externalRefIdstringOptional

Your own reference id for this screen, echoed back in the response. Optional.

fullbooleanOptional

When true, fetch each match's complete profile and include it as matches[].profile. Adds one upstream call per match. Defaults to false (headline match data only).

Responses

200

Screening completed. Returns the screening case id and any watchlist matches.

application/json

requestIdstringRequired

Unique id for this screening request, for tracking and billing reconciliation.

caseIdstringRequired

Identifier of the screening case, for future retrieval.

namestringRequired

The name that was screened.

externalRefIdstringOptional

The reference id supplied in the request, if any.

pdfUrlstringOptional

Presigned download link for the PDF report of this screening. Valid for 7 days; the file itself is retained for 30 days. Omitted if report generation failed — the screening result is unaffected.

pdfFileNamestringOptional

Suggested file name for the PDF report.

Example: aml-screening-AML_a1b2c3d4e5f6.pdf

400

Bad Request — no name field supplied.

503

Screening provider unavailable or rejected the request.

post/kyc/hk/screening

HTTPcURLJavaScriptPython

POST /kyc/hk/screening HTTP/1.1
Host: sandbox.staging-api.fill-easy.com
x-client-id: YOUR_API_KEY
x-client-secret: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "name": "Dmitri Volkov",
  "entityType": "Individual"
}

Screen an individual by nameScreen with disambiguating detailsScreen and include each match's full profile

{
  "requestId": "AML_a1b2c3d4e5f6",
  "caseId": "c1a2b3d4e5f60001",
  "name": "Dmitri Volkov",
  "externalRefId": "applicant-7781",
  "summary": {
    "total": 1,
    "positive": 0,
    "possible": 0,
    "false": 0,
    "unspecified": 0,
    "unresolved": 1
  },
  "matches": [
    {
      "matchId": "ari9900123",
      "matchedName": "Dmitri Volkov",
      "name": "Dmitri Andreyevich VOLKOV",
      "nameType": "AKA",
      "nameOriginalScript": "Дмитрий Волков",
      "alias": "Dmitri Volkov, D. A. Volkov, Dmitry Volkov",
      "types": [
        "PEP",
        "Sanction"
      ],
      "matchStrength": 0.95,
      "matchType": "Native Name Match",
      "dob": "1969-04-22",
      "gender": "Male",
      "countryOfResidence": "Ruritania"
    }
  ],
  "pdfUrl": "https://kyc-bucket.s3.ap-east-1.amazonaws.com/AML_a1b2c3d4e5f6/screening.pdf?X-Amz-Signature=...",
  "pdfFileName": "aml-screening-AML_a1b2c3d4e5f6.pdf"
}