Changelog

​

API Enhancements

• Additional Doc for Non-HK Resident (document type not accepted) - The submitted document type is not accepted
• Additional Doc for Non-HK Resident (expired document) - The submitted document has expired
• Additional Doc for Non-HK Resident (unclear image) - The document image quality is insufficient
• Additional Doc for Non-HK Resident (document not belong to client) - The document does not belong to the applicant
• Additional Doc for Non-HK Resident (potential bogus document) - The document appears to be fraudulent

​

Important Update

​

What’s Changing:

• TRAVEL_PERMIT_FRONT - Front side of the permit
• TRAVEL_PERMIT_BACK - Back side of the permit

​

Example Submission:

{
  "supportingDocuments": [
    {
      "documentType": "TRAVEL_PERMIT_FRONT",
      "file": "data:image/jpeg;base64,..."
    },
    {
      "documentType": "TRAVEL_PERMIT_BACK",
      "file": "data:image/jpeg;base64,..."
    }
  ]
}

​

變更內容：

• TRAVEL_PERMIT_FRONT - 通行證正面
• TRAVEL_PERMIT_BACK - 通行證背面

​

提交範例：

{
  "supportingDocuments": [
    {
      "documentType": "TRAVEL_PERMIT_FRONT",
      "file": "data:image/jpeg;base64,..."
    },
    {
      "documentType": "TRAVEL_PERMIT_BACK",
      "file": "data:image/jpeg;base64,..."
    }
  ]
}

​

Important Updates

• occupation - Select from /v1/occupations endpoint
• position - Select from /v1/positions endpoint
• gender - MALE or FEMALE
• nationality - ISO 3166-1 alpha-2 format (e.g., HK)
• supportingDocuments - Required for non-Hong Kong (HK) nationals (see accepted document types →)

• occupation（職業）- 從 /v1/occupations 端點選擇
• position（職位）- 從 /v1/positions 端點選擇
• gender（性別）- MALE 或 FEMALE
• nationality（國籍）- ISO 3166-1 alpha-2 格式（例如：HK）
• supportingDocuments（證明文件）- 非香港 (HK) 國籍申請人必須提供（查看可接受的文件類型 →）

​

New Features

​

New Features

• Auto-Recovery: Suspended webhooks are automatically pinged every 5 minutes for up to 24 hours
• Automatic Resumption: If a ping succeeds, webhook delivery resumes automatically without manual intervention
• Auto-Deletion: Webhooks are automatically deleted if they remain suspended with failed recovery pings for 24 consecutive hours