KYC Hong Kong
Flow
Client ID in x-client-id header.
Client Secret in x-client-secret header.
At least one of name, nameEnglish, nameChinese, or nameOtherLang is required.
Name to screen. Use this when you have a single name and don't need to disambiguate the script.
Dmitri VolkovName in English / Latin script.
Name in Chinese script.
Name in a language other than English or Chinese.
Type of entity being screened. Optional.
Date of birth in YYYY-MM-DD format. Optional.
1969-04-22Optional.
Nationality, citizenship, or residency — name or code of the country/region. Optional.
RuritaniaYour own reference id for this screen, echoed back in the response. Optional.
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).
Screening completed. Returns the screening case id and any watchlist matches.
Unique id for this screening request, for tracking and billing reconciliation.
Identifier of the screening case, for future retrieval.
The name that was screened.
The reference id supplied in the request, if any.
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.
Suggested file name for the PDF report.
aml-screening-AML_a1b2c3d4e5f6.pdfBad Request — no name field supplied.
Screening provider unavailable or rejected the request.
Last updated

