For the complete documentation index, see llms.txt. This page is also available as Markdown.

KYC Hong Kong

Hong Kong KYC checks, each completed in a single synchronous call: AML name screening against global watchlists, and lookups against Hong Kong's official public registers returning the structured register record together with a page print (PDF) of the register's own detail page.

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. With full: true the report also renders each match's complete profile — sanctions, PEP positions, linked persons, and evidence sources. If report generation fails, the screening still succeeds and pdfUrl is omitted from the response.

Authorizations
x-client-idstringRequired

Client ID in x-client-id header.

x-client-secretstringRequired

Client Secret in x-client-secret header.

Body

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. Must be unique per screening request — it permanently identifies the screening case, and an id that was ever submitted before (even on a request that returned an error) is rejected with 422. Use a fresh id for every attempt, including retries.

fullbooleanOptional

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

dryRunbooleanOptional

When true, the watchlist provider is not called and nothing is billed: the response carries a static sample screen with matches — a company screen when entityType is Entity, an individual otherwise; full controls whether their profiles are included — and its PDF report is rendered from it, so the body mirrors a real screen exactly — only dryRun: true marks it. Use to integrate against the contract for free.

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
dryRunbooleanOptional

Present and true when the screen was a dry run — sample matches, nothing billed.

post/kyc/hk/screening
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"
}
{
  "requestId": "AML_a1b2c3d4e5f6",
  "caseId": "c1a2b3d4e5f60001",
  "name": "Dmitri Volkov",
  "externalRefId": "screen-9f2c81d6e5a4",
  "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"
}

SFC licensed person register lookup

post

Looks up one record in the SFC's Public Register of Licensed Persons and Registered Institutions and synchronously returns the structured record — covering every tab of the register's detail pages — together with a page print (PDF) of the first tab (licence details).

Identify the person by name, or by ceRef (Central Entity number). The query must resolve to exactly one register record — a query matching no record returns 404, a query matching more than one returns 422 and must be refined (the CE number is always unambiguous).

The register matches names case-insensitively and as a substring, so short queries resolve to many records — Wong alone matches over 5,000. Individuals are held surname-first, with the surname capitalised and a comma before any Western given name (WONG Tai Man, Peter); the comma may be omitted from a query. Because the match is by substring, a name that is complete and correct can still be contained in a longer one; where exactly one of the matched records carries the queried name in full, that record is returned instead of a 422. Records genuinely sharing a name — several licensees are registered as LEE Ka Ming — remain a 422, listing the candidates and their CE numbers.

A ceRef lookup additionally reaches firms — licensed corporations and registered institutions — which the name search does not cover.

Authorizations
x-client-idstringRequired

Client ID in x-client-id header.

x-client-secretstringRequired

Client Secret in x-client-secret header.

Body

At least one of ceRef, name, or nameChinese is required.

ceRefstringOptional

Central Entity (CE) number. Unambiguous — preferred over name lookups.

Example: ABC123
namestringOptional

Name in English as it appears on the register — surname first, with the surname capitalised and a comma before any Western given name. Matched case-insensitively as a substring; the comma is optional.

Example: WONG Siu Ming, Peter
nameChinesestringOptional

Name in Chinese as it appears on the register. Matched as a substring.

externalRefIdstringOptional

Your own reference id, echoed back in the response.

dryRunbooleanOptional

When true, the register is not queried and nothing is billed: the response carries a static sample record and a placeholder page print, so the body mirrors a real lookup exactly — only dryRun: true marks it. Use to integrate against the contract for free.

Responses
200

Exactly one register record matched. Returns the structured record and its page print.

application/json

Common envelope of all /kyc/hk register lookups. Each endpoint adds its register-specific record.

requestIdstringRequired

Unique id for this lookup, for tracking and billing reconciliation.

Example: KYC_HK_a1b2c3d4e5f6
externalRefIdstringOptional

Your own reference id, echoed back from the request.

dryRunbooleanOptional

Present and true when the lookup was a dry run — sample record, placeholder page print, nothing billed.

post/kyc/hk/sfc
POST /kyc/hk/sfc 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: 18

{
  "ceRef": "ABC123"
}
{
  "requestId": "KYC_HK_b2c3d4e5f6a7",
  "record": {
    "ceRef": "ABC123",
    "name": "Wong Siu Ming",
    "nameChinese": "黃小明",
    "entityType": "Individual",
    "status": "Active",
    "regulatedActivities": [
      "Type 1 (Dealing in Securities)",
      "Type 9 (Asset Management)"
    ],
    "licenceDetails": [
      {
        "regime": "SFO",
        "activityType": 1,
        "activity": "Dealing in Securities",
        "activityChinese": "證券交易",
        "role": "Representative",
        "principal": {
          "ceRef": "XYZ789",
          "name": "Harbourview Securities Limited"
        },
        "accreditedSince": "2017-03-27",
        "licensedSince": "2003-10-21",
        "statusCode": "A"
      }
    ],
    "accreditedTo": [
      {
        "ceRef": "XYZ789",
        "name": "Harbourview Securities Limited"
      }
    ],
    "addresses": [
      {
        "address": "39/F, One Exchange Square, Central, Hong Kong",
        "principal": {
          "ceRef": "XYZ789",
          "name": "Harbourview Securities Limited"
        }
      }
    ],
    "conditions": [],
    "publicDisciplinaryActions": [],
    "licenceRecord": [
      {
        "regime": "SFO",
        "role": "Representative",
        "principal": {
          "ceRef": "XYZ789",
          "name": "Harbourview Securities Limited"
        },
        "activityType": 1,
        "activity": "Dealing in Securities",
        "statusCode": "A",
        "effectivePeriods": [
          {
            "from": "2017-03-27"
          }
        ]
      }
    ]
  },
  "pagePrints": [
    {
      "status": "ready",
      "url": "https://kyc-bucket.s3.ap-east-1.amazonaws.com/KYC_HK_b2c3d4e5f6a7/page-print.pdf?X-Amz-Signature=...",
      "fileName": "kyc-hk-sfc-KYC_HK_b2c3d4e5f6a7.pdf"
    }
  ]
}

MPFA Subsidiary Intermediary register lookup

post

Looks up a person or licensed long-term insurance agency on the MPFA Public Register of Subsidiary Intermediaries (mpfa.org.hk) and returns the register record in one synchronous call — registration status, frontline regulator(s), attached principal intermediaries, conditions imposed, and public disciplinary orders of the last 5 years.

Supply exactly one identifier — they are used in order of precedence:

  1. registrationNo — unambiguous, preferred. Numeric for persons (123456), A-prefixed for agencies (A123456).

  2. name — English name as it appears on the register. For a person, surname first (e.g. Chan Tai Man); the register holds names in upper case but matches case-insensitively, as a substring.

  3. nameChinese — Chinese name, in either Simplified or Traditional characters. Matched as a substring, but a whole-name match takes precedence over the longer names it appears in. Whitespace is ignored; an exact match wins, and a substring match is used only when nothing matches exactly.

registrationNo reaches every kind of record. Name lookups reach people only, so an agency must be looked up by its registration number.

Because names are matched by substring, a name that is complete and correct can still be contained in a longer one; where exactly one of the matched records carries the queried name in full, that record is returned instead of a 422. Records genuinely sharing a name — a dozen people are registered as CHAN WAI MAN — remain a 422, listing the candidates and their registration numbers.

The lookup only succeeds when it narrows to exactly one record — 404 when nothing matched, 422 with a candidate list when several did.

Every successful lookup also produces a page print PDF of the official register detail page, returned in pagePrints as a presigned download link (valid for 7 days; the file is retained for 30 days). If the page print fails to render, the lookup still succeeds and the entry comes back with status: failed.

The register is updated by the MPFA every working day; registerRevisionDate states the register's own last-revision date at the time of the lookup.

The register lists current registrations only — a suspended, revoked or disqualified intermediary is removed for the duration of the sanction, so a register miss alone cannot distinguish never-registered from removed-for-cause. Every lookup is therefore cross-checked against the enforcement notices the MPFA has published on its enforcement news page (mpfa.org.hk/en/enforcement/mpf-intermediary/enforcement-news), maintained in the service as a reviewed extract of that page and its press releases; notices naming the queried person come back as enforcementNotices on both the 200 and the 404 response.

Authorizations
x-client-idstringRequired

Client ID in x-client-id header.

x-client-secretstringRequired

Client Secret in x-client-secret header.

Body

At least one of registrationNo, name, or nameChinese is required.

registrationNostringOptional

MPF registration number. Unambiguous — preferred over name lookups.

Example: 123456
namestringOptional

English name as appearing on the register, surname first. The register holds names in upper case; matched case-insensitively as a substring. Finds people only — an agency must be looked up by its registration number.

Example: Chan Tai Man
nameChinesestringOptional

Chinese name as appearing on the register. Whitespace is ignored and an exact match is preferred over a substring match. Finds people only — an agency must be looked up by its registration number.

Example: 陳大文
externalRefIdstringOptional

Your own reference id, echoed back in the response.

dryRunbooleanOptional

When true, the register is not queried and nothing is billed: the response carries a static sample record and a placeholder page print, so the body mirrors a real lookup exactly — only dryRun: true marks it. Use to integrate against the contract for free.

Responses
200

Exactly one register record matched.

application/json

Common envelope of all /kyc/hk register lookups. Each endpoint adds its register-specific record.

requestIdstringRequired

Unique id for this lookup, for tracking and billing reconciliation.

Example: KYC_HK_a1b2c3d4e5f6
externalRefIdstringOptional

Your own reference id, echoed back from the request.

dryRunbooleanOptional

Present and true when the lookup was a dry run — sample record, placeholder page print, nothing billed.

registerRevisionDatestring · dateOptional

The register's own "Last Review / Revision Date" at the time of the lookup.

post/kyc/hk/mpfa
POST /kyc/hk/mpfa 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: 27

{
  "registrationNo": "123456"
}
{
  "requestId": "KYC_HK_a1b2c3d4e5f6",
  "registerRevisionDate": "2026-08-02",
  "record": {
    "registrationNo": "123456",
    "name": "CHAN TAI MAN",
    "nameChinese": "陳大文",
    "entityType": "Individual",
    "status": "Active",
    "frontlineRegulators": [
      "Insurance Authority"
    ],
    "principalIntermediaries": [
      {
        "name": "SAMPLE LIFE INSURANCE COMPANY LIMITED",
        "registrationNo": "IC000000",
        "address": "12/F SAMPLE TOWER 1 SAMPLE ROAD CENTRAL HONG KONG",
        "frontlineRegulator": "Insurance Authority",
        "registrationStatus": "Active",
        "actingAsResponsibleOfficer": "No",
        "responsibleOfficerStatus": "N/A",
        "attachmentStatus": "Active",
        "remarks": "Nil"
      }
    ],
    "conditionsImposed": "Nil",
    "disciplinaryOrders": [],
    "otherParticulars": "Nil"
  },
  "pagePrints": [
    {
      "status": "ready",
      "url": "https://kyc-bucket.s3.ap-east-1.amazonaws.com/KYC_HK_a1b2c3d4e5f6/page-print.pdf?X-Amz-Signature=...",
      "fileName": "kyc-hk-mpfa-KYC_HK_a1b2c3d4e5f6.pdf"
    }
  ]
}

IA licensed insurance intermediary register lookup

post

Looks up an individual on the Hong Kong Insurance Authority's Register of Licensed Insurance Intermediaries (iir.ia.org.hk) and returns the register record in one synchronous call — licence and its conditions, appointing principals past and present, and public enforcement actions of the last 5 years — together with a page print (PDF) of the register's own record page, its appointment history expanded.

Supply exactly one identifier — they are used in order of precedence:

  1. licenceNo — unambiguous, preferred.

  2. name — English name as it appears on the register, surname first (e.g. CHAN Tai Man). Matched case-insensitively, as a substring.

  3. nameChinese — Chinese name in Traditional characters. Matched as a substring; Simplified input does not match.

Only individuals are covered. Licensed insurance agencies and broker companies sit on a separate register this endpoint does not reach.

Every licence status is searched, lapsed and revoked included: restricting to active licences hides exactly the people a KYC check needs to find.

The register matches names literally — it folds case and normalises nothing else. Spacing and punctuation are part of the stored name (Au-Yeung Siu Ming Sam, Chan Mei Ling, Amy), so a name is looked up as written, then retried without its punctuation if that found nothing.

Because names are matched by substring, a name that is complete and correct can still be contained in a longer one; where exactly one of the matched records carries the queried name in full, that record is returned instead of a 422. The register holds no personal identifier other than the licence number, so records genuinely sharing a name — 66 people are registered as CHAN KA MAN — remain a 422, listing the candidates and their licence numbers.

The lookup only succeeds when it narrows to exactly one record — 404 when nothing matched, 422 with a candidate list when several did. A query matching more than 1,000 records also returns 422: the register caps its results there and stops reporting the true total, so beyond the cap no record can be resolved with confidence.

Authorizations
x-client-idstringRequired

Client ID in x-client-id header.

x-client-secretstringRequired

Client Secret in x-client-secret header.

Body

At least one of licenceNo, name, or nameChinese is required.

licenceNostringOptional

Insurance intermediary licence number. Unambiguous — preferred over name lookups.

Example: AA1234
namestringOptional

English name as it appears on the register, surname first. Matched case-insensitively as a literal substring: spacing and punctuation count, and are matched as the register stores them. A name that finds nothing is retried with its punctuation dropped. Finds people only — an agency or broker company is not on this register.

Example: CHAN Tai Man
nameChinesestringOptional

Chinese name as it appears on the register, in Traditional characters — Simplified input does not match. Matched as a substring; spacing is ignored.

Example: 陳大文
externalRefIdstringOptional

Your own reference id, echoed back in the response.

dryRunbooleanOptional

When true, the register is not queried and nothing is billed: the response carries a static sample record and a placeholder page print, so the body mirrors a real lookup exactly — only dryRun: true marks it. Use to integrate against the contract for free.

Responses
200

Exactly one register record matched.

application/json

Common envelope of all /kyc/hk register lookups. Each endpoint adds its register-specific record.

requestIdstringRequired

Unique id for this lookup, for tracking and billing reconciliation.

Example: KYC_HK_a1b2c3d4e5f6
externalRefIdstringOptional

Your own reference id, echoed back from the request.

dryRunbooleanOptional

Present and true when the lookup was a dry run — sample record, placeholder page print, nothing billed.

post/kyc/hk/ia
POST /kyc/hk/ia 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: 22

{
  "licenceNo": "AA1234"
}
{
  "requestId": "KYC_HK_a1b2c3d4e5f6",
  "record": {
    "licenceNo": "AA1234",
    "name": "CHAN Tai Man",
    "nameChinese": "陳大文",
    "status": "Inactive",
    "licenceType": "IND",
    "licencePeriod": {
      "from": "2020-01-01",
      "to": "2025-06-30"
    },
    "businessAddress": "12/F, Sample Tower, 1 Sample Road, Central, Hong Kong",
    "linesOfBusiness": "G + L(I)",
    "suspended": false,
    "pendingRenewal": false,
    "conditions": [],
    "publicDisciplinaryActions": [],
    "currentAppointments": [],
    "appointmentHistory": [
      {
        "appointingPrincipal": {
          "name": "Sample Life Insurance Limited",
          "nameChinese": "範例人壽保險有限公司"
        },
        "lineOfBusiness": "General & Long Term Business (including Linked Long Term Business)",
        "status": "Inactive",
        "from": "2021-01-01",
        "to": "2025-06-30"
      }
    ]
  },
  "pagePrints": [
    {
      "status": "ready",
      "url": "https://kyc-bucket.s3.ap-east-1.amazonaws.com/KYC_HK_a1b2c3d4e5f6/page-print.pdf?X-Amz-Signature=...",
      "fileName": "kyc-hk-ia-KYC_HK_a1b2c3d4e5f6.pdf"
    }
  ]
}

CR Directors Index search - Request

post

Searches the Hong Kong Companies Registry Directors Index (Director-based): given a person's name and/or partial identifier, returns every company where that person is or was registered as a director, together with page prints (PDF) of the Registry's own result pages.

Unlike the other /kyc/hk register lookups, this search is asynchronous: the lookup runs against the Registry in one continuous session, which takes minutes. This endpoint returns a token immediately; poll POST /kyc/hk/director/poll every ~10 seconds for the outcome. Most searches complete within 2–5 minutes.

Search modes

The supplied fields select the Registry's own search mode:

Fields supplied
Registry search mode

English name (surname + otherNames) and/or nameChinese only

Search by English and/or Chinese name

partialHkid and/or partialPassport only

Search by partial identifier

A name and a partial identifier

Exact match of all supplied fields

An English name needs both surname and otherNames — a surname on its own is rejected (400), because the Registry will not search it without a manual confirmation the automated flow cannot give. The English name and nameChinese may also be supplied together. Name searches still match loosely, so several people can share a name; the exact-match mode (a name and a partial identifier) is the way to refine after a 422.

One person, one result

The Directors Index groups its records by identity: the same person commonly appears under several name spellings, all rows carrying the same HKID / passport grouping number. Rows of a single grouping resolve to one 200 result, with the companies of all rows merged and de-duplicated by Business Registration Number. Only genuinely distinct persons (distinct groupings) produce a 422 with one candidate per person.

Only individual (natural person) directors are searched; body-corporate directors are not covered.

Authorizations
x-client-idstringRequired

Client ID in x-client-id header.

x-client-secretstringRequired

Client Secret in x-client-secret header.

Body

Supply an English name (surname and otherNames together), a nameChinese, a partialHkid, or a partialPassport — at least one of these.

surnamestringOptional

English surname. Requires otherNames alongside it — the Registry rejects a surname on its own.

Example: CHAN
otherNamesstringOptional

English other names (given names), matching the Registry's own field.

Example: TAI MAN DAVID
nameChinesestringOptional

Chinese name in Traditional characters. May be combined with the English name.

Example: 陳大文
partialHkidstring · max: 5Optional

Leading characters of the HKID number, up to 5 (the Registry stores and matches only this partial form, e.g. A123).

Example: A123
partialPassportstringOptional

Leading characters of the passport number.

externalRefIdstringOptional

Your own reference id, echoed back in the poll response.

dryRunbooleanOptional

When true, no Registry order is placed and nothing is billed: the poll resolves at once to a static sample of the found (200) outcome with a placeholder page print — only dryRun: true in the poll body marks it. Use to integrate against the contract for free.

Responses
200

Search accepted and queued. Poll for the outcome with the returned token.

application/json
tokenstringRequired

JWT token

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.dozjgNryP4J3jVmNHl0w5N_XgL0n3I9PlFUP0THsR8UPattern: ^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$
requestIdstringRequiredExample: KYC_HK_a1b2c3d4e5f6
post/kyc/hk/director
POST /kyc/hk/director 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: 27

{
  "nameChinese": "陳大文"
}
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.dozjgNryP4J3jVmNHl0w5N_XgL0n3I9PlFUP0THsR8U",
  "requestId": "KYC_HK_a1b2c3d4e5f6"
}

CR Directors Index search - Poll

post

Check the status of a Directors Index search initiated via POST /kyc/hk/director. Returns 202 while the search is still running; any other status is the search's final outcome, carrying the same register-lookup semantics as the synchronous /kyc/hk endpoints:

  • 200 — the search resolved to exactly one person: their name variants and the merged company list, plus a single combined PDF of the Registry's result pages (the record-list page and each company-list page).

  • 404 — the search found no records. A page print of the Registry's "No records have been found" page is attached as proof of search.

  • 422 — the search matched more than one distinct person, one candidate per person. Refine the query — ideally by re-submitting with a name and a partial identifier (exact-match mode).

  • 410 — the result has expired (results are kept for 30 days).

  • 503 — the retrieval failed (the Registry could not be reached or the session could not be completed); the case is flagged for manual follow-up.

The page-print link is presigned for 7 days from the moment of the poll — poll again for a fresh link. The underlying file is deleted after 30 days.

Authorizations
x-client-idstringRequired

Client ID in x-client-id header.

x-client-secretstringRequired

Client Secret in x-client-secret header.

Body
tokenstringRequired

JWT token

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.dozjgNryP4J3jVmNHl0w5N_XgL0n3I9PlFUP0THsR8UPattern: ^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$
Responses
200

The search resolved to exactly one person.

application/json
requestIdstringRequired

Unique id for this lookup, for tracking and billing reconciliation.

Example: KYC_HK_a1b2c3d4e5f6
externalRefIdstringOptional

Your own reference id, echoed back from the request.

dryRunbooleanOptional

Present and true when the search was a dry run — sample outcome, placeholder page print, nothing billed.

post/kyc/hk/director/poll
POST /kyc/hk/director/poll 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: 120

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.dozjgNryP4J3jVmNHl0w5N_XgL0n3I9PlFUP0THsR8U"
}
{
  "requestId": "KYC_HK_a1b2c3d4e5f6",
  "director": {
    "names": [
      "CHAN, TAI MAN DAVID",
      "CHAN TAI MAN DAVID"
    ],
    "namesChinese": [
      "陳大文"
    ],
    "partialHkid": "A123"
  },
  "companies": [
    {
      "brn": "12345678",
      "name": "SAMPLE TRADING LIMITED",
      "nameChinese": "範例貿易有限公司",
      "status": "Live",
      "capacity": "Director"
    },
    {
      "brn": "23456789",
      "name": "Sample Holdings Limited",
      "nameChinese": "範例控股有限公司",
      "status": "Live",
      "capacity": "Director"
    },
    {
      "brn": "34567890",
      "name": "SAMPLE TECHNOLOGY LIMITED",
      "nameChinese": "範例科技有限公司",
      "status": "Dissolved",
      "capacity": "Director"
    }
  ],
  "pagePrint": {
    "status": "ready",
    "url": "https://kyc-bucket.s3.ap-east-1.amazonaws.com/KYC_HK_a1b2c3d4e5f6/director-print.pdf?X-Amz-Signature=...",
    "fileName": "kyc-hk-director-KYC_HK_a1b2c3d4e5f6.pdf"
  }
}

Individual litigation search

post

Searches Hong Kong court records for an individual and returns every record naming them, in one synchronous call:

  • judgments — published judgments of the Hong Kong courts, civil and criminal.

  • writs — civil actions (writs of summons) from the court cause books.

  • hearings — hearings from the Judiciary's daily cause lists: magistrates' courts, District Court and High Court (civil and criminal), bankruptcy petitions, Labour Tribunal and Small Claims Tribunal.

Supply the English name as surname + otherNames, the Chinese name as nameChinese, or both, plus any aliases. Each name form is searched on its own — English and Chinese court records return different cases. Court records print the surname first (CHAN Tai Man), so give English aliases surname first too.

A record is returned only when one of its parties carries a searched name as whole words — in the given order or given name first — or a Chinese name verbatim, so WONG Siu Ming does not return KWONG Siu Ming.

Matches are by name only. Court records carry no identity-document number or date of birth, so a record may belong to a different person with the same name — a common name routinely returns several unrelated people. Supplying the Chinese name as well helps tell them apart: criminal and magistrates' court lists print both names.

Every search also produces a PDF report of the records 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 search still succeeds and pdfUrl is omitted from the response.

Authorizations
x-client-idstringRequired

Client ID in x-client-id header.

x-client-secretstringRequired

Client Secret in x-client-secret header.

Body

The English name (surname + otherNames), nameChinese, or both are required.

surnamestringOptional

English surname. Required together with otherNames.

Example: CHAN
otherNamesstringOptional

English given names, including any Western first name. Required together with surname.

Example: Tai Man
nameChinesestringOptional

Chinese name, as printed in Hong Kong court records (Traditional characters). At least two characters.

Example: 陳大文
aliasesstring[] · max: 5Optional

Other names the person is known by, each searched as one more name form. English aliases need at least two words (surname first); Chinese aliases at least two characters.

Example: ["CHAN David Tai Man"]
externalRefIdstringOptional

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

dryRunbooleanOptional

When true, no court record is searched and nothing is billed: the response carries a static sample with one record of each kind and its PDF report is rendered from it, so the body mirrors a real search exactly — only dryRun: true marks it. Use to integrate against the contract for free.

Responses
200

Search completed. Every array is empty when no record names the person.

application/json
requestIdstringRequired

Unique id for this search, for tracking and billing reconciliation.

externalRefIdstringOptional

The reference id supplied in the request, if any.

searchedNamesstring[]Required

Every name form searched — the English name (surname first), the Chinese name, then the aliases.

Example: ["CHAN Tai Man","陳大文"]
pdfUrlstringOptional

Presigned link to the PDF report, valid for 7 days. Omitted if report generation failed.

Example: https://kyc-bucket.s3.ap-east-1.amazonaws.com/KYC_HK_a1b2c3d4e5f6/litigation.pdf?X-Amz-Signature=...
pdfFileNamestringOptional

Suggested file name for the PDF report.

Example: kyc-hk-litigation-KYC_HK_a1b2c3d4e5f6.pdf
dryRunbooleanOptional

Present and true when the search was a dry run — sample records, nothing billed.

post/kyc/hk/litigation
POST /kyc/hk/litigation 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: 67

{
  "surname": "CHAN",
  "otherNames": "Tai Man",
  "nameChinese": "陳大文"
}
{
  "requestId": "text",
  "externalRefId": "text",
  "searchedNames": [
    "CHAN Tai Man",
    "陳大文"
  ],
  "judgments": [
    {
      "title": "SAMPLE ENGINEERING LTD V. EXAMPLE CONSTRUCTION CO LTD",
      "caseRef": "HCA1234/2020",
      "citation": "[2020] HKCFI 1234",
      "court": "Court of First Instance",
      "date": "text",
      "parties": "text",
      "judge": "text",
      "judgmentUrl": "text"
    }
  ],
  "writs": [
    {
      "caseType": "civil_action",
      "caseNo": "HCA 712/2026",
      "primaryDate": "text",
      "parties": [
        {
          "side": "plaintiff",
          "nameRaw": "text",
          "nameEn": "text",
          "nameLocal": "text"
        }
      ],
      "remarks": "text",
      "representation": "text",
      "claimNature": "text",
      "claimAmount": 1,
      "claimCurrency": "text",
      "claimAmountRaw": "text",
      "filingResponses": [
        {
          "partyName": "text",
          "filingDate": "text",
          "intentionToContest": "text"
        }
      ],
      "lowerCourtCaseNo": "text",
      "lowerCourtJudge": "text",
      "appellantRepresentation": "text",
      "respondentRepresentation": "text",
      "subjectMatter": "text"
    }
  ],
  "hearings": [
    {
      "hearingDate": "text",
      "courtCode": "HCMC",
      "court": "text",
      "time": "9:30",
      "caseNumber": "text",
      "parties": "text",
      "nature": "text"
    }
  ],
  "pdfUrl": "https://kyc-bucket.s3.ap-east-1.amazonaws.com/KYC_HK_a1b2c3d4e5f6/litigation.pdf?X-Amz-Signature=...",
  "pdfFileName": "kyc-hk-litigation-KYC_HK_a1b2c3d4e5f6.pdf",
  "dryRun": true
}

Last updated