tencent cloud

APIs

DokumentasiAPIseKYCData Types

Data Types

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-09-18 17:45:25

Address

Overseas document address

Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

Name Type Description
Country String Country
PostalCode String Postal code
Subdivision String Sub-region
City String city
FormattedAddress String Complete address
LineOne String First line of the address bar
LineTwo String Second line of the address bar
LineThree String Third line of the address bar
LineFour String Fourth line of the address bar
LineFive String Fifth line of the address bar

AttackRiskDetail

Suspected attack detail

Used by actions: DetectAIFakeFaces.

Name Type Description
Type String

Suspected attack trace type, specific type as follows:
SuspectedSpoofingAttack: Re-photography Attack
SuspectedSynthesisImage: Suspected synthesized image
SuspectedSynthesisVideo: Suspected synthesized video
SuspectedAnomalyAttack: Facial features suspected of not being real
SuspectedAdversarialAttack: Suspected adversarial sample attack
SuspectedBlackIndustry: Suspected black industry batch Template attack
SuspectedWatermark: Suspected watermark

CardVerifyResult

The OCR result of a user's identity document during the eKYC verification process.

Used by actions: GetSdkVerificationResult.

Name Type Description
IsPass Boolean Whether the authentication or OCR process is successful.
IsEdit Boolean Whether the user modified the card recognition result
CardVideo FileInfo The download URL of the video used for identity document verification, which is valid for 10 minutes. This parameter is returned only if video-based identity document verification is enabled.
Note: This field may return null, indicating that no valid value can be obtained.
CardImage FileInfo The download URL of the identity document image, which is valid for 10 minutes.
Note: This field may return null, indicating that no valid value can be obtained.
CardInfoOcrJson FileInfo The OCR result (in JSON) of the identity document image. If verification or OCR fails, this parameter is left empty. The URL is valid for 10 minutes.
(1) Hong Kong (China) identity card
When the value of IdCardType is HK:
- CnName (string): Name in Chinese.
- EnName (string): Name in English.
- TelexCode (string): The code corresponding to the name in Chinese.
- Sex (string): Gender. Valid values: M (male) and F (female).
- Birthday (string): Date of birth.
- Permanent (int): Whether it is a permanent residence identity card. Valid values: 0 (non-permanent), 1 (permanent), and -1 (unknown).
- IdNum (string): Identity card number.
- Symbol (string): The ID symbol below the date of birth, such as "***AZ".
- FirstIssueDate (string): Month and year of first registration.
- CurrentIssueDate (string): The date of latest issuance.

(2) Malaysian identity card
When the value of IdCardType is ML:
- Sex (string): Gender. Valid values: LELAKI (male) and PEREMPUAN (female).
- Birthday (string): Date of birth.
- ID (string): Identity card number.
- Name (string): Name.
- Address (string): Address.
- Type (string): Identity document type.

(3) Philippine identity document
When the value of IdCardType is PhilippinesVoteID:
- Birthday (string): Date of birth.
- Address (string): Address.
- LastName (string): Last name.
- FirstName (string): First name.
- VIN (string): Voter's identification number (VIN).
- CivilStatus (string): Civil status.
- Citizenship (string): Citizenship.
- PrecinctNo (string): Precinct.

When the value of IdCardType is PhilippinesDrivingLicense:
- Sex (string): Gender.
- Birthday (string): Date of birth.
- Name (string): Name.
- Address (string): Address.
- LastName (string): Last name.
- FirstName (string): First name.
- MiddleName (string): Middle name.
- Nationality (string): Nationality.
- LicenseNo (string): License number.
- ExpiresDate (string): Expiration date.
- AgencyCode (string): Agency code.

When the value of IdCardType is PhilippinesTinID:
- LicenseNumber (string): Tax identification number (TIN).
- FullName (string): Full name.
- Address (string): Address.
- Birthday (string): Date of birth.
- IssueDate (string): Issue date.

When the value of IdCardType is PhilippinesSSSID:
- LicenseNumber (string): Common reference number (CRN).
- FullName (string): Full name.
- Birthday (string): Date of birth.

When the value of IdCardType is PhilippinesUMID:
- Surname (string): Surname.
- MiddleName (string):Middle name.
- GivenName (string): Given name.
- Sex (string): Gender.
- Birthday (string): Date of birth.
- Address (string): Address.
- CRN (string): Common reference number (CRN).

(4) Indonesian identity card
When the value of IdCardType is IndonesiaIDCard:
- NIK (string): Single Identity Number.
- Nama (string): Full name.
- TempatTglLahir (string): Place and date of birth.
- JenisKelamin (string): Gender.
- GolDarah (string): Blood type.
- Alamat (string): Address.
- RTRW (string): Street.
- KelDesa (string): Village.
- Kecamatan (string): Region.
- Agama (string): Religion.
- StatusPerkawinan (string): Marital status.
- Perkerjaan (string): Occupation.
- KewargaNegaraan (string): Nationality.
- BerlakuHingga (string): Expiry date.
- IssuedDate (string): Issue date.

(5) A passport issued in Hong Kong (China) /Macao (China) /Taiwan (China) or other countries/regions
When the value of IdCardType is MLIDPassport:
- FullName (string): Full name.
- Surname (string): Surname.
- GivenName (string): Given name.
- Birthday (string): Date of birth.
- Sex (string): Gender. Valid values: F (female) and M (male).
- DateOfExpiration (string): Expiration date.
- IssuingCountry (string): Issuing country.
- NationalityCode (string): Country/region code.
Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The request ID of a single process.
NormalCardInfo NormalCardInfo License OCR result
WarnCardInfos Array of Integer Card warning information
-9101 Alarm for covered certificate,
-9102 Alarm for photocopied certificate,
-9103 Alarm for photographed certificate,
-9107 Alarm for reflective certificate,
-9108 Alarm for blurry image,
-9109 This capability is not enabled.
EditDetails Array of EditDetail Details of the OCR modifications for this EKYC card, when the user manually modifies the card recognition results (IsEdit=true), EditDetails will return the modified fields. When IsEdit=false, EditDetails is empty.

Company

AML Company object

Used by actions: RunAMLNameScreening, UpdateAMLCustomerProfile.

Name Type Required Description
CompanyName String No

Enterprise name (required)
CompanyCertNumber String No

Enterprise registration number / unified social credit code (Option)
CompanyCountry String No

Enterprise registration country, ISO 3166-1 alpha-2 country code (optional)
CompanyAddress String No

Company address (optional)

CompareResult

The description of a single comparison result.

Used by actions: GetSdkVerificationResult.

Name Type Description
ErrorCode String The final verification result code.
0: Succeeded.
1001: Failed to call the liveness engine.
1002: Suspected spoofed recording.
1004: Face detection failed.
1005: Liveness detection failed.
1201: Lighting is too dark or overexposed.
2004: The image passed in is too large or too small.
2012: Multiple faces detected.
2013: No face was detected, or the face detected was incomplete.
2014: The image resolution is too low or the quality does not meet the requirements.
2015: Face comparison failed.
2016: The similarity did not reach the standard passing threshold.
2017: Facial occlusion detected.
ErrorMsg String The description of the final verification result.
LiveData FileInfo The liveness algorithm package generated during this SDK-based liveness detection.
LiveVideo FileInfo The download URL of the video used for verification, which contains specific color reflection effects, is valid for 10 minutes.
ActionVideo FileInfo Records the specific action performed by the user, used for AI Face Shield analysis.
LiveErrorCode String The liveness detection result code.
0: Success.
1001: Failed to call the liveness detection engine.
1002: Suspected spoofed recording.
1004: Face detection failed.
1005: Liveness detection failed.
1201: Lighting is too dark or overexposed.
LiveErrorMsg String The description of the liveness detection result.
BestFrame FileInfo The download URL of the face screenshot during verification, which is valid for 10 minutes.
Note: This field may return null, indicating that no valid value can be obtained.
ProfileImage FileInfo The download URL of the profile photo screenshot from the identity document, which is valid for 10 minutes.
CompareErrorCode String The face comparison result code.
0: Success.
2004: The image passed in is too large or too small.
2012: Multiple faces detected.
2013: No face was detected, or the face detected was incomplete.
2014: The image resolution is too low or the quality does not meet the requirements.
2015: Face comparison failed.
2016: The similarity did not reach the standard passing threshold.
2017: Facial occlusion detected.
Note: This field may return null, indicating that no valid value can be obtained.
CompareErrorMsg String The description of the face comparison result.
Note: This field may return null, indicating that no valid values can be obtained.
Sim Float The similarity score of face comparison.
Note: This field may return null, indicating that no valid values can be obtained.
IsNeedCharge Boolean This parameter is disused.
CardInfoInputJson FileInfo The identity document photo info edited by the user. Currently, this parameter is not applied.
Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The request ID of this verification process.
LivenessInfoTag Array of String Describes the detailed reason for the current liveness detection failure. Output only when SdkVersion is PLUS. Details are as follows:
01 - User kept eyes closed throughout the process.
02 - User failed to complete the specified action.
03 - Suspected photo replay attack.
04 - Suspected synthetic image.
05 - Suspected synthetic video.
06 - Suspected synthetic action.
07 - Suspected fraud template.
08 - Suspected watermark existence.
09 - Light verification failed.
10 - Face verification failed.
11 - Poor face quality.
12 - Unqualified collection quality.
13 - Suspected adversarial sample attack.

EditDetail

EKYC Document OCR Result Modification Details

Used by actions: GetSdkVerificationResult.

Name Type Description
FieldName String Modified Field Name
OriginalFieldValue String Value of the field before modification, the original OCR result
RevisedFieldValue String Value of the field after modification,the user's manually entered result

Encryption

Sensitive Data Encryption

Used by actions: BankCard2EVerification, BankCard4EVerification, BankCardVerification, CheckBankCardInformation, CheckIdCardInformation, CheckIdNameDate, DetectAIFakeFaces, IdCardOCRVerification, IdCardVerification, ImageRecognitionV2, MobileNetworkTimeVerification, MobileStatus.

Name Type Required Description
EncryptList Array of String Yes

When using the encryption service, fill in the field to be encrypted. This API can auto-fill one or more encrypted fields.
CiphertextBlob String Yes

Encrypted symmetric key. For key generation and use, see the data encryption document.
Iv String Yes

Users with encryption requirements import the initial vector for CBC encryption (custom string, length 16 characters).
Algorithm String No

Encryption algorithm (supports 'AES-256-CBC', 'SM4-GCM'), defaults to 'AES-256-CBC' if not passed.
TagList Array of String No

Message digest generated by the SM4-GCM algorithm (used when verifying message integrity)

ExtraInfo

Additional details

Used by actions: DetectAIFakeFaces.

Name Type Description
RetrievalLivenessExtraInfo Array of RetrievalLivenessExtraInfo Detailed information of the hit template, return only the template information with the highest similarity.

FileInfo

The description of a file, including a download URL and the MD5 checksum and size of the file.

Used by actions: GetLivenessResult, GetSdkVerificationResult, VideoLivenessCompare.

Name Type Required Description
Url String Yes The URL for downloading the file
MD5 String Yes The 32-bit MD5 checksum of the file
Size Integer Yes The file size

GeneralCard

General card certificate information

Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

Name Type Description
LicenseNumber String ID number
PersonalNumber String Personal number. It is returned when the identity document type is a passport.
PassportCodeFirst String MRZ line 1 of the passport
PassportCodeSecond String MRZ line 2 of the passport
ExpirationDate String Expiration date in YYYY-MM-DD format
DueDate String Expiration date in YYYY-MM-DD format
IssuedDate String Issue date in YYYY-MM-DD format
IssuedAuthority String Issuing authority
IssuedCountry String Issuing country. Return following the ISO 3166 country coding specification.
FullName String Name
FirstName String Name
LastName String Last name
Sex String Gender on the document
-M: male
-F: female
- X: Other gender identity
Age String Age. 0 indicates no valid info is obtained.
Birthday String Date of birth
BirthPlace String Birth place
Nationality String Document nationality. Return following the ISO 3166 country coding specification.
RegistrationNumber String Registration number
Address Address Document address information
FullNameLocal String Localized name
FirstNameLocal String Localized name
LastNameLocal String Localized last name

HMTPermit

Hong Kong, Macau and Taiwan Travel Permit

Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

Name Type Description
Name String Name
EnglishName String English name
Number String ID number
Sex String Sex
ValidDate String Validity period.
IssueAuthority String Issuing authority
IssueAddress String Issuing place
Birthday String Date of birth

IndonesiaDrivingLicense

Indonesian driving license

Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

Name Type Description
LastName String Last name
FirstName String First name
LicenseNumber String No.
Birthday String Date of birth
Address String Address.
ExpirationDate String Expiration date
IssuedDate String Issue date
IssuedCountry String Issuing country

InternationalIDPassport

Hong Kong, Macao, and Taiwan region as well as overseas passport

Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

Name Type Description
LicenseNumber String Passport ID
FullName String Name
Surname String Last name
GivenName String Name
Birthday String Date of birth
Sex String Gender (F: female, M: male).
DateOfExpiration String Validity period.
IssuingCountry String Issuing country
NationalityCode String Country region code
PassportCodeFirst String MRZ Code sequence in the first row at the bottom
PassportCodeSecond String MRZ Code sequence in the second line from the bottom

JapanIDCard

Japan identity card

Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

Name Type Description
FullName String Name.
LicenseNumber String Identity card
Age String Age
Birthday String Birthday
ExpirationDate String Expiration time.
FormattedAddress String Address.

MacaoIDCard

Macao identity card

Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

Name Type Description
FirstName String First name
LastName String Last name
Birthday String Birthday
ExpirationDate String Expiration date
LicenseNumber String Identity number
Sex String Sex
Age String Age
IssuedCountry String Issuing country
Field1 String mrz field 1
Field2 String mrz field 2

MainlandIDCard

Mainland ID card recognition result

Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

Name Type Required Description
FullName String No

Name
Sex String No

Gender
Nation String No

Ethnicity
Birthday String No

Birthday
LicenseNumber String No

Identity card number
FormattedAddress String No

Address
Authority String No

Issuing authority
ValidDate String No

Validity period

NormalCardInfo

Document recognition result (mapped field result)

Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

Name Type Description
HKIDCard NormalHKIDCard Hong Kong identity card
MLIDCard NormalMLIDCard Malaysian identity card
PhilippinesVoteID PhilippinesVoteID Philippines voter card
IndonesiaIDCard NormalIndonesiaIDCard Indonesian Identity Card
PhilippinesDrivingLicense PhilippinesDrivingLicense Philippines driving license
PhilippinesTinID PhilippinesTinID Philippines TinID
PhilippinesSSSID PhilippinesSSSID Philippines SSSID
PhilippinesUMID PhilippinesUMID Philippines UMID
InternationalIDPassport InternationalIDPassport Hong Kong, Macao, and Taiwan region as well as overseas passport
GeneralCard GeneralCard General card certificate information
IndonesiaDrivingLicense IndonesiaDrivingLicense Indonesian driving license
ThailandIDCard NormalThailandIDCard Thai Identity Card
SingaporeIDCard SingaporeIDCard Singapore ID card
MacaoIDCard MacaoIDCard Macao identity card
MainlandIDCard MainlandIDCard Mainland ID card
JapanIDCard JapanIDCard Japan identity card
TaiWanIDCard TaiWanIDCard Taiwan (China) identity card
HMTPermitCard HMTPermit Hong Kong, Macau and Taiwan Travel Permit

NormalHKIDCard

Hong Kong identity card (mapped field result)

Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

Name Type Description
ChineseName String Chinese name
FullName String English name
RegistrationNumber String Chinese telegraph code corresponding to the Chinese name
Sex String Gender: "M" (male) or "F" (female).
Birthday String Date of birth
Permanent String Permanent resident ID card: 0: non-permanent; 1: permanent; -1: unknown
LicenseNumber String Identity number
Symbol String Document symbol, the symbol under the date of birth, for example, "***AZ"
IssuedDate String Date of first issue
CurrentIssueDate String Most recent date of issue
HKIDVersion String Hong Kong identity card version. HKID-2003: 2003 edition identity card. HKID-2018: 2018 edition identity card.

NormalIndonesiaIDCard

Indonesian Identity Card (mapped field result)

Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

Name Type Description
LicenseNumber String ID number
FullName String Name
Birthday String Birthplace/Date of birth
Sex String Sex
BloodType String Blood type
FormattedAddress String Address.
Street String Street
Village String Village
Area String Region.
Religion String Religious belief
MaritalStatus String Marital status
Occupation String Occupation
Nationality String Nationality
DueDate String Validity period of the ID card
IssuedDate String Issue date
Province String Province
City String city

NormalMLIDCard

Malaysian identity card (mapped field result)

Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

Name Type Description
FullName String Name
LicenseNumber String Identity card number
Sex String Sex
FormattedAddress String Address.
Type String Document type
MyKad identity card
MyPR permanent residence permit
MyTentera Military ID card
MyKAS Temporary ID card
POLIS Police ID card
IKAD labor ID card
MyKid Juvenile ID card
Birthday String Date of birth (currently this field only supports IKAD labor ID card and MyKad ID card)

NormalThailandIDCard

Thai Identity Card (mapped field result)

Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

Name Type Description
LicenseNumber String Identity number
FullName String Thai name
LastName String English name
FirstName String English name
Birthday String English birth date
FormattedAddress String Address.
ExpirationDate String Expiration date
IssuedDate String English birth date
RegistrationNumber String Serial number
Religion String Religious belief
ThaiBirthday String Date of birth in Thai
ThaiExpirationDate String Expiration date in Thai
ThaiIssueDate String Date of issue in Thai

OCRResult

Content of a single document in the document information

Used by actions: GetWebVerificationResultIntl.

Name Type Description
IsPass Boolean

Whether the identity authentication or OCR process is successful.
CardImageBase64 String

Base64 of the front image of the identity document
NormalCardInfo NormalCardInfo

ID document recognition result (when CheckMode value is 4, the OriginalCardInfo field is returned; in other scenarios, the current field is returned)
RequestId String

Request id
CardCutImageBase64 String

Base64 of the front cropped image of the identity document
CardBackCutImageBase64 String

Base64 of the edge-cropped image of the back of an identity document
WarnCardInfos Array of Integer

Alarm code

Enumeration value:

  • -9101: alarm for incomplete document border
  • -9102: alarm for document photocopy
  • -9103: alarm for document rephotographing
  • -9104: document PS alarm
  • -9107: document reflective alarm
  • -9108: alarm for blurry document
  • -9109: alarm capability not enabled
OriginalCardInfo String

Original document recognition information (when CheckMode value is 4, the current field will be returned)
HeadImageBase64 String

Portrait matting in the document
CardBackImageBase64 String

Base64 of the back image of the identity document

Person

AML Person object

Used by actions: RunAMLNameScreening, UpdateAMLCustomerProfile.

Name Type Required Description
FullName String No

Full name (either this or LastName is required). If FullName is filled, FirstName/MiddleName/LastName cannot be filled.
LastName String No

name (Either this field or FullName is required)
FirstName String No

First name (Option)
MiddleName String No

Middle name (Option)
IdentityNumber String No

ID number (Option)
DateOfBirth String No

Date of birth, format: YYYY-MM-DD, YYYY-MM, YYYY (Year-Month-Day separated by -)

Parameter format: YYYY-MM-DD
Gender String No

Gender: MALE / FEMALE / OTHER / NOT_KNOWN

Enumeration values:

  • MALE: male
  • FEMALE: female
  • OTHER: OTHER
  • NOT_KNOWN: NOT_KNOWN
Address String No

Address
Nationality String No

Nationality, ISO 3166-1 alpha-2 country code (Option)
Country String No

Country of residence, ISO 3166-1 alpha-2 country code (optional)

PhilippinesDrivingLicense

Philippines driving license

Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

Name Type Description
Name String Name
LastName String Last name
FirstName String First name
MiddleName String Middle name
Nationality String Nationality
Sex String Sex
Address String Address.
LicenseNo String ID number
ExpiresDate String Validity period.
AgencyCode String Organization code
Birthday String Date of birth

PhilippinesSSSID

Philippines SSSID

Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

Name Type Description
LicenseNumber String No.
FullName String Name
Birthday String Birthday

PhilippinesTinID

Philippines TinID

Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

Name Type Description
LicenseNumber String Code
FullName String Name
Address String Address.
Birthday String Birthday
IssueDate String Issue date

PhilippinesUMID

Philippines UMID

Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

Name Type Description
Surname String Last name
MiddleName String Middle name
GivenName String Name
Sex String Address.
Birthday String Birthday
Address String Address.
CRN String crn code

PhilippinesVoteID

Philippines voter card

Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

Name Type Description
VIN String VIN of Philippines VoteID
FirstName String Name
LastName String Last name
Birthday String Date of birth
CivilStatus String Marital status
Citizenship String Nationality
Address String Address.
PrecinctNo String Region.

RetrievalLivenessExtraInfo

Template retrieve detailed information

Used by actions: DetectAIFakeFaces.

Name Type Description
HitGroup String

Hit template type, among them Common-public library; Auto-Auto Clustering Library; Owner-custom template library
SimilarityScore Float

Similarity between the request image and the attack template hit. The similarity value ranges from 0 to 2. The smaller the value, the higher the probability of hitting the attack template. The default threshold is 0.6. When the SimilarityScore is ≥0.6, the judgment is as normal. When the SimilarityScore is <0.6, the judgment is an attack.
HitTemplate String

Template id of the cache hit

SingaporeIDCard

Singapore ID card

Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

Name Type Description
ChineseName String Chinese Name
FullName String English name
LicenseNumber String Identity number
Sex String Sex
Nationality String Country of birth
Birthday String Birthday
Address String Address (back field)
Race String Nationality (back field)
NRICCode String Nric number (back field)
PostCode String Post number (back field)
DateOfExpiration String Expires on (back field)
DateOfIssue String Issue date (field on the back)

TaiWanIDCard

Taiwan (China) ID card

Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

Name Type Description
FullName String Name.
LicenseNumber String Identity card
Sex String Sex
IssuedCountry String City of issuance
RegistrationNumber String Registration number

VerificationDetail

Detailed process information for verification

Used by actions: GetWebVerificationResultIntl.

Name Type Description
ErrorCode Integer Final result of this verification. 0 indicates that the verification is passed and the person is determined to be the same person.
ErrorMsg String Final result description of this verification
LivenessErrorCode Integer Liveness detection result of this verification. 0 indicates success.
LivenessErrorMsg String Description of the liveness detection result for this verification
CompareErrorCode Integer Result of this verification comparison. 0 indicates that the best face photo collected from the video stream and the uploaded image for comparison are determined to be the same person.
CompareErrorMsg String Result description of this verification comparison
ReqTimestamp Integer Verification timestamp (ms) this time
Similarity Float Similarity between the best face photo collected from the video stream in this verification and the uploaded image for comparison. Value range: [0.00, 100.00]. By default, the two are determined to be the same person when the similarity is at least 70.
Seq String Unique identifier for this verification
LivenessInfoTag Array of String Description of the detailed reason why the current request was rejected in the liveness phase. This parameter is returned only for the PLUS version of the eKYC service.
-Details as follows:
01-User eyes closed throughout
02 - User has not completed the specified action
03-Suspected rephotography attack
04-Suspected synthesis attack
05-Suspected fraud template
06-Suspected watermark
07-Reflection validation failed
08-Suspected midway change person
09: Poor face quality
10-distance check failed
11-Suspected adversarial sample attack
12-Mouth area suspected of attack traces
13-Eye area suspected to have attack traces
14-Eye or mouth covered
Note: This field may return null, indicating that no valid values can be obtained.
Example value: ["01"].

WebVerificationConfigIntl

eKYC Web related configuration

Used by actions: ApplyWebVerificationBizTokenIntl.

Name Type Required Description
AutoSkipStartPage Boolean No

Whether to skip the start verification webpage when starting verification. If true, directly enter the verification process. Default false. If the degradation policy is triggered, this configuration will not take effect.
AutoSkip Boolean No

Whether to skip the result display page and automatically jump to RedirectURL when verification is successful. Default false.
CheckMode Integer No

Detection mode. Parameter values are as follows:
1: OCR+liveness detection+face comparison;
2: liveness detection+face comparison;
3: liveness detection;
4: OCR;
Default value is 2.
IDCardType String No

Identity document type used for authentication. Currently supported:
1.HKIDCard: Hong Kong (China) identity card
2.MLIDCard: Malaysian identity card
3.IndonesiaIDCard: Indonesian Identity Card
4.PhilippinesVoteID: Philippines voter card
5.PhilippinesDrivingLicense: Philippines driving license
6.PhilippinesTinID: Philippines TinID
7.PhilippinesSSSID: Philippines SSSID
8.PhilippinesUMID: Philippines UMID
9.InternationalIDPassport: Passport for Hong Kong (China), Macao (China), and Taiwan (China) as well as overseas passport
10.ThailandIDCard: Thai Identity Card
11.SingaporeIDCard: Singapore ID card
12.MainlandIDCard: Mainland ID card
DisableCheckOcrWarnings Boolean No

Want to close document alarm, false by default (enable alarm detection). When enabled, the identity verification process will intercept based on the document alarm status. If you need to use document anti-counterfeiting functionality, contact us.
SecurityLevel Integer No

Security level of authentication:
1: Silent liveness;
2: Action liveness;
3: Light liveness;
4: Action + light liveness;
Default value is 3.
SkipPrivacyPolicy Boolean No

Whether to skip the privacy agreement webpage, default false. When SkipPrivacyPolicy is false, the privacy agreement webpage will show and the privacy agreement must be checked. When SkipPrivacyPolicy is true, the privacy agreement webpage will be skipped to directly enter the Live Face Process without the need to check the privacy agreement webpage.
IdCardCutReturn Boolean No

Default false. When false, show the original document image. When true, show the split document image.
ThemeColor String No

Frontend theme color in base 16 RGB format. Defaults to "#2d72f1". Uses default values if the format is incorrect.
Language String No

Internationalized language, defaults to en (English). Currently supported:
th: Thai;
en: English;
zh-cn: Simplified Chinese;
zh-tc: Traditional Chinese;
id: Indonesia;
AutoDowngrade Integer No

Automatic downgrade mode. Parameter values as follows:
1: Downgrade to silent liveness mode.
2: Disable downgrade mode.
Default value: 1.
ActionList String No

Control the action sequence. Action types are as follows:
"blink"
"mouth"
"nod"
"shake"
Choose 1-2 actions from the four.
Single action example: "blink"
Multi-action example: "blink,mouth".
Default value: blink
Input this parameter only when SecurityLevel is 2, 4, or 5 for different action types to take effect; otherwise, an API error occurs.
LivenessRetryLimit Integer No

Maximum liveness verification attempts. Value ranges from 1 to 99. Default value is 99.
LivenessTimeout Integer No

Control the liveness detection timeout period in seconds. The value ranges from 0 to 600. Default: 45 seconds.
SelectedWarningCodes String No

Select OCR alarms that require attention. When an OCR alarm is generated, the identity verification process will be interrupted. The default value is empty, indicating all alarms are monitored. This feature requires the parameter DisableCheckOcrWarnings=false. If the alarm is disabled, this parameter will not be effective.

Alarm code list and definitions:
-9101 Incomplete border alarm
-9102 Photocopies alarm
-9103 Alarm for rephotographing
-9104 ps alarm
-9107 Reflective alarm
-9108 Blurry alarm
-9109 Alarm not enabled
AllowExpiredDocument Boolean No

Whether to allow expired identity documents to enter the liveness detection process. This parameter is valid only when the document type is Hong Kong identity card (HKID).
true (default value): Allow expired Hong Kong identity card to enter the liveness detection process.
false: Reject expired Hong Kong identity card, not accessible to the liveness detection process.
Version String No

Service version, including basic version (BASIC) and PLUS version (PLUS).

Enumeration value:

  • BASIC: Basic version
  • PLUS: PLUS version

Default value: BASIC.

WebhookList

Webhook configuration list

Used by actions: ListEKYCWebhooks.

Name Type Required Description
WebhookId Integer No

Callback unique ID
WebhookName String No

Callback URL name
Scene String No

Callback enumeration scenario.
WebhookURL String No

Callback URL, must use HTTPS
AddTime String No

Addition Time

Parameter format: Format example: 2026-09-09 14:33:41
ModTime String No

Update time

Parameter format: Format example: 2026-09-09 14:33:41
SignatureKey String No

Callback request key
HasSignatureKey Boolean No

Existence of callback API key
Topik sebelumnya: DetectReflectLivenessAndCompareTopik selanjutnya: Error Codes

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan

Search
    Enter keywords to search documentation