tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

Data Types

Last updated: 2024-11-01 17:05:31

    Address

    Used by actions: GetCardVerificationResult, GetSdkVerificationResult, GetWebVerificationResultIntl.

    Name Type Description
    Country String Nationality.
    PostalCode String Post code.
    Subdivision String Subregion.
    City String City.
    FormattedAddress String Complete address.
    LineOne String The first line of address.
    LineTwo String The second line of address.
    LineThree String The third line of address.
    LineFour String The fourth line of address.
    LineFive String The fifth line of address.

    AttackRiskDetail

    Suspected attack detail

    Used by actions: DetectAIFakeFaces.

    Name Type Description
    Type String Suspected attack trace types
    SuspectedSpoofingAttack: Suspected spoofing attack
    SuspectedSynthesisImage: Suspected synthesis image SuspectedSynthesisVideo: Suspected synthesis video SuspectedeAnomalyAttack: Suspected anomaly attack SuspectedAdversarialAttack: Suspected adversarial attack SuspectedBlackIndustry: Suspected batch generation attack
    SuspectedWatermark: Suspected watermark

    CardInfo

    License OCR result

    Used by actions: GetCardVerificationResult.

    Name Type Description
    HKIDCard HKIDCard Hong Kong ID Card
    Note: This field may return null, indicating that no valid values can be obtained.
    MLIDCard MLIDCard Malaysia ID Card
    Note: This field may return null, indicating that no valid values can be obtained.
    PhilippinesVoteID PhilippinesVoteID Philippines VoteID Card
    Note: This field may return null, indicating that no valid values can be obtained.
    IndonesiaIDCard IndonesiaIDCard Indonesia ID Card
    Note: This field may return null, indicating that no valid values can be obtained.
    PhilippinesDrivingLicense PhilippinesDrivingLicense Philippines Driving License
    Note: This field may return null, indicating that no valid values can be obtained.
    PhilippinesTinID PhilippinesTinID Philippines TinID
    Note: This field may return null, indicating that no valid values can be obtained.
    PhilippinesSSSID PhilippinesSSSID Philippines SSSID
    Note: This field may return null, indicating that no valid values can be obtained.
    PhilippinesUMID PhilippinesUMID Philippines UMID
    Note: This field may return null, indicating that no valid values can be obtained.
    InternationalIDPassport InternationalIDPassport ID Cards of Hong Kong, Macao and Taiwan (China), and International Passport
    Note: This field may return null, indicating that no valid values can be obtained.
    GeneralCard GeneralCard General license information
    Note: This field may return null, indicating that no valid values can be obtained.
    IndonesiaDrivingLicense IndonesiaDrivingLicense Indonesia Driving License
    Note: This field may return null, indicating that no valid values can be obtained.
    ThailandIDCard ThailandIDCard Thailand ID Card
    Note: This field may return null, indicating that no valid values can be obtained.
    SingaporeIDCard SingaporeIDCard Singapore ID Card
    Note: This field may return null, indicating that no valid values can be obtained.
    MacaoIDCard MacaoIDCard Macao ID Card
    Note: This field may return null, indicating that no valid values can be obtained.
    TaiWanIDCard TaiWanIDCard TaiWan ID Card
    Note: This field may return null, indicating that no valid values can be obtained.
    JapanIDCard JapanIDCard Japan ID Card
    Note: This field may return null, indicating that no valid values can be obtained.

    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/Macao/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.

    CompareResult

    The description of a single comparison result.

    Used by actions: GetSdkVerificationResult.

    Name Type Description
    ErrorCode String The final verification result code.
    0: Success.
    1001: Failed to call the liveness detection engine.
    1004: Face detection failed.
    2004: The uploaded face image is too large or too small.
    2012: The face is not fully exposed.
    2013: No face is detected.
    2014: The resolution of the uploaded image is too low . Please upload a new one.
    2015: Face comparison failed.
    2016: The similarity did not reach the passing standard.
    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 is valid for 10 minutes.
    LiveErrorCode String The liveness detection result code.
    0: Success.
    1001: Failed to call the liveness detection engine.
    1004: Face detection failed.
    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 uploaded face image is too large or too small.
    2012: The face is not fully exposed.
    2013: No face is detected.
    2014: The resolution of the uploaded image is too low . Please upload a new one.
    2015: Face comparison failed.
    2016: The similarity did not reach the passing standard.
    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.

    EditDetail

    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

    Used by actions: DetectAIFakeFaces.

    Name Type Required Description
    EncryptList Array of String Yes
    CiphertextBlob String Yes
    Iv String Yes
    Algorithm String No
    TagList Array of String No

    ExtraInfo

    Used by actions: DetectAIFakeFaces.

    Name Type Description
    RetrievalLivenessExtraInfo Array of RetrievalLivenessExtraInfo

    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 liscense information.

    Used by actions: GetCardVerificationResult, GetSdkVerificationResult, GetWebVerificationResultIntl.

    Name Type Description
    LicenseNumber String License number
    Note: This field may return null, indicating that no valid values can be obtained.
    PersonalNumber String Personal number, which is returned when it is a passport
    Note: This field may return null, indicating that no valid values can be obtained.
    PassportCodeFirst String The first line of passport machine reading code
    Note: This field may return null, indicating that no valid values can be obtained.
    PassportCodeSecond String The first line of passport machine reading code
    Note: This field may return null, indicating that no valid values can be obtained.
    ExpirationDate String Date of expiry in the format of YYYY-MM-DD
    Note: This field may return null, indicating that no valid values can be obtained.
    DueDate String Valid date in the format of YYYY-MM-DD
    Note: This field may return null, indicating that no valid values can be obtained.
    IssuedDate String Date of issue in the format of YYYY-MM-DD
    Note: This field may return null, indicating that no valid values can be obtained.
    IssuedAuthority String Issuing authority
    Note: This field may return null, indicating that no valid values can be obtained.
    IssuedCountry String Issuing country, which is returned following the ISO 3166 country coding specification
    Note: This field may return null, indicating that no valid values can be obtained.
    Example: MYS
    FullName String Full Name
    Note: This field may return null, indicating that no valid values can be obtained.
    FirstName String First name
    Note: This field may return null, indicating that no valid values can be obtained.
    LastName String Last name
    Note: This field may return null, indicating that no valid values can be obtained.
    Sex String Gender on the license
    - M: male
    - F: female
    - X: other gender
    Note: This field may return null, indicating that no valid values can be obtained.
    Example: M
    Age String Age. 0 indicates that no valid information is obtained.
    Example: 0
    Birthday String Birthday
    Note: This field may return null, indicating that no valid values can be obtained.
    BirthPlace String Birth place
    Note: This field may return null, indicating that no valid values can be obtained.
    Nationality String Nationality, which is returned following the ISO 3166 country coding specification
    Note: This field may return null, indicating that no valid values can be obtained.
    Example: IND
    RegistrationNumber String Registration number
    Note: This field may return null, indicating that no valid values can be obtained.
    Address Address Address
    Note: This field may return null, indicating that no valid values can be obtained.

    HKIDCard

    Hong Kong ID card.

    Used by actions: GetCardVerificationResult.

    Name Type Description
    CnName String
    EnName String English name
    Note: This field may return null, indicating that no valid values can be obtained.
    Example: SAN, Nan
    TelexCode String Telex code correspondint to the Chinese name
    Note: This field may return null, indicating that no valid values can be obtained.
    Sex String Gender: "Male-M" or "Female-F"
    Note: This field may return null, indicating that no valid values can be obtained.
    Birthday String Birthday
    Note: This field may return null, indicating that no valid values can be obtained.
    Example: 01-01-2001
    Permanent String Permanent resident ID card: 0-non-permanent; 1-permanent; -1-unknown
    Note: This field may return null, indicating that no valid values can be obtained.
    IdNum String ID card number
    Note: This field may return null, indicating that no valid values can be obtained.
    Example: C000000(E)
    Symbol String Lisence symbol, which is the symbol below Birthday. Example: "***AZ"
    Note: This field may return null, indicating that no valid values can be obtained.
    FirstIssueDate String The first date of issue
    Note: This field may return null, indicating that no valid values can be obtained.
    CurrentIssueDate String The current date of issue
    Note: This field may return null, indicating that no valid values can be obtained.

    HMTPermit

    Exit/entry permit (card) for traveling to and from Hong Kong, Macao, or Taiwan

    Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

    Name Type Description
    Name String Name
    EnglishName String English name
    Number String License number
    Sex String Gender
    ValidDate String Valid date
    IssueAuthority String Issued authority
    IssueAddress String Issued address
    Birthday String Birthday

    IndonesiaDrivingLicense

    Indonesia driving license.

    Used by actions: GetCardVerificationResult, GetSdkVerificationResult, GetWebVerificationResultIntl.

    Name Type Description
    LastName String Last name
    Note: This field may return null, indicating that no valid values can be obtained.
    FirstName String First name
    Note: This field may return null, indicating that no valid values can be obtained.
    LicenseNumber String License number
    Note: This field may return null, indicating that no valid values can be obtained.
    Birthday String Birthday
    Note: This field may return null, indicating that no valid values can be obtained.
    Address String Address
    Note: This field may return null, indicating that no valid values can be obtained.
    ExpirationDate String Expiration date
    Note: This field may return null, indicating that no valid values can be obtained.
    IssuedDate String Date of issue
    Note: This field may return null, indicating that no valid values can be obtained.
    IssuedCountry String Issuing country
    Note: This field may return null, indicating that no valid values can be obtained.

    IndonesiaIDCard

    Indonesia ID card.

    Used by actions: GetCardVerificationResult.

    Name Type Description
    NIK String License number
    Note: This field may return null, indicating that no valid values can be obtained.
    Nama String Name
    Note: This field may return null, indicating that no valid values can be obtained.
    TempatTglLahir String Birth place/Birthday
    Note: This field may return null, indicating that no valid values can be obtained.
    JenisKelamin String Gender
    Note: This field may return null, indicating that no valid values can be obtained.
    GolDarah String Blood type
    Note: This field may return null, indicating that no valid values can be obtained.
    Alamat String Address
    Note: This field may return null, indicating that no valid values can be obtained.
    RTRW String Street
    Note: This field may return null, indicating that no valid values can be obtained.
    KelDesa String Village
    Note: This field may return null, indicating that no valid values can be obtained.
    Kecamatan String Region
    Note: This field may return null, indicating that no valid values can be obtained.
    Agama String Religious beliefs
    Note: This field may return null, indicating that no valid values can be obtained.
    StatusPerkawinan String Marital status
    Note: This field may return null, indicating that no valid values can be obtained.
    Perkerjaan String Job
    Note: This field may return null, indicating that no valid values can be obtained.
    KewargaNegaraan String Nationality
    Note: This field may return null, indicating that no valid values can be obtained.
    BerlakuHingga String ID card validity period
    Note: This field may return null, indicating that no valid values can be obtained.
    IssuedDate String Date of issue
    Note: This field may return null, indicating that no valid values can be obtained.
    Provinsi String Province
    Note: This field may return null, indicating that no valid values can be obtained.
    Kota String City
    Note: This field may return null, indicating that no valid values can be obtained.

    InternationalIDPassport

    ID cards of Hong Kong, Macao and Taiwan (China), and international passport.

    Used by actions: GetCardVerificationResult, GetSdkVerificationResult, GetWebVerificationResultIntl.

    Name Type Description
    LicenseNumber String Passport ID
    Note: This field may return null, indicating that no valid values can be obtained.
    FullName String Full name
    Note: This field may return null, indicating that no valid values can be obtained.
    Surname String Last name
    Note: This field may return null, indicating that no valid values can be obtained.
    GivenName String First name
    Note: This field may return null, indicating that no valid values can be obtained.
    Birthday String Birthday
    Note: This field may return null, indicating that no valid values can be obtained.
    Sex String Gender (F-Female, M-Male)
    Note: This field may return null, indicating that no valid values can be obtained.
    DateOfExpiration String Expiration date
    Note: This field may return null, indicating that no valid values can be obtained.
    IssuingCountry String Issuing country
    Note: This field may return null, indicating that no valid values can be obtained.
    NationalityCode String Nationality code
    Note: This field may return null, indicating that no valid values can be obtained.
    PassportCodeFirst String The first line at the bottom, the MRZ Code sequence
    Note: This field may return null, indicating that no valid values can be obtained.
    PassportCodeSecond String The second line at the bottom, the MRZ Code sequence
    Note: This field may return null, indicating that no valid values can be obtained.

    JapanIDCard

    Japan ID card.

    Used by actions: GetCardVerificationResult, GetSdkVerificationResult, GetWebVerificationResultIntl.

    Name Type Description
    FullName String Full name
    Note: This field may return null, indicating that no valid values can be obtained.
    LicenseNumber String License number
    Note: This field may return null, indicating that no valid values can be obtained.
    Age String Age
    Note: This field may return null, indicating that no valid values can be obtained.
    Birthday String Birthday
    Note: This field may return null, indicating that no valid values can be obtained.
    ExpirationDate String Expire date
    Note: This field may return null, indicating that no valid values can be obtained.
    FormattedAddress String Address
    Note: This field may return null, indicating that no valid values can be obtained.

    MLIDCard

    Malaysia ID card.

    Used by actions: GetCardVerificationResult.

    Name Type Description
    Name String Full Name
    Note: This field may return null, indicating that no valid values can be obtained.
    ID String License number
    Note: This field may return null, indicating that no valid values can be obtained.
    Sex String Gender
    Note: This field may return null, indicating that no valid values can be obtained.
    Address String Address
    Note: This field may return null, indicating that no valid values can be obtained.
    Type String Lisence type
    MyKad ID card
    MyPR Permanent resident ID card
    MyTentera Military ID card
    MyKAS Temporary ID card
    POLIS Police ID card
    IKAD Labor ID card
    MyKid Juvenile ID card
    Example: MyKad
    Birthday String Birthday (Currently, this filed only supports IKAD labor ID card and MyKad ID card)
    Note: This field may return null, indicating that no valid values can be obtained.

    MacaoIDCard

    Macao ID Card

    Used by actions: GetCardVerificationResult, GetSdkVerificationResult, GetWebVerificationResultIntl.

    Name Type Description
    FirstName String First name
    Note: This field may return null, indicating that no valid values can be obtained.
    LastName String Last name
    Note: This field may return null, indicating that no valid values can be obtained.
    Birthday String Birthday
    Note: This field may return null, indicating that no valid values can be obtained.
    ExpirationDate String Expiration date
    Note: This field may return null, indicating that no valid values can be obtained.
    LicenseNumber String License number
    Note: This field may return null, indicating that no valid values can be obtained.
    Sex String Sex
    Note: This field may return null, indicating that no valid values can be obtained.
    Age String Age
    Note: This field may return null, indicating that no valid values can be obtained.
    IssuedCountry String Issued country
    Note: This field may return null, indicating that no valid values can be obtained.
    Field1 String MRZ1 on card
    Note: This field may return null, indicating that no valid values can be obtained.
    Field2 String MRZ2 on card
    Note: This field may return null, indicating that no valid values can be obtained.

    MainlandIDCard

    Mainland ID Card OCR

    Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

    Name Type Required Description
    FullName String No Chinese name
    Note: This field may return null, indicating that no valid values can be obtained.
    Sex String No Sex
    Note: This field may return null, indicating that no valid values can be obtained.
    Nation String No Nation
    Note: This field may return null, indicating that no valid values can be obtained.
    Birthday String No Birthday
    Note: This field may return null, indicating that no valid values can be obtained.
    LicenseNumber String No License number
    Note: This field may return null, indicating that no valid values can be obtained.
    FormattedAddress String No Address
    Note: This field may return null, indicating that no valid values can be obtained.

    NormalCardInfo

    License OCR result

    Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

    Name Type Description
    HKIDCard NormalHKIDCard Hong Kong ID Card
    Note: This field may return null, indicating that no valid values can be obtained.
    MLIDCard NormalMLIDCard Malaysia ID Card
    Note: This field may return null, indicating that no valid values can be obtained.
    PhilippinesVoteID PhilippinesVoteID Philippines VoteID Card
    Note: This field may return null, indicating that no valid values can be obtained.
    IndonesiaIDCard NormalIndonesiaIDCard Indonesia ID Card
    Note: This field may return null, indicating that no valid values can be obtained.
    PhilippinesDrivingLicense PhilippinesDrivingLicense Philippines Driving License
    Note: This field may return null, indicating that no valid values can be obtained.
    PhilippinesTinID PhilippinesTinID Philippines TinID
    Note: This field may return null, indicating that no valid values can be obtained.
    PhilippinesSSSID PhilippinesSSSID Philippines SSSID
    Note: This field may return null, indicating that no valid values can be obtained.
    PhilippinesUMID PhilippinesUMID Philippines UMID
    Note: This field may return null, indicating that no valid values can be obtained.
    InternationalIDPassport InternationalIDPassport ID Cards of Hong Kong, Macao and Taiwan (China), and International Passport
    Note: This field may return null, indicating that no valid values can be obtained.
    GeneralCard GeneralCard General license information
    Note: This field may return null, indicating that no valid values can be obtained.
    IndonesiaDrivingLicense IndonesiaDrivingLicense Indonesia Driving License
    Note: This field may return null, indicating that no valid values can be obtained.
    ThailandIDCard NormalThailandIDCard Thailand ID Card
    Note: This field may return null, indicating that no valid values can be obtained.
    SingaporeIDCard SingaporeIDCard Singapore ID Card
    Note: This field may return null, indicating that no valid values can be obtained.
    MacaoIDCard MacaoIDCard Macao ID Card
    Note: This field may return null, indicating that no valid values can be obtained.
    MainlandIDCard MainlandIDCard Mainland ID Card
    Note: This field may return null, indicating that no valid values can be obtained.
    JapanIDCard JapanIDCard Japan ID Card
    Note: This field may return null, indicating that no valid values can be obtained.
    TaiWanIDCard TaiWanIDCard Taiwan ID Card
    Note: This field may return null, indicating that no valid values can be obtained.
    HMTPermitCard HMTPermit exit/entry permit (card) for traveling to and from Hong Kong, Macao, or Taiwan.
    Note: This field may return null, indicating that no valid values can be obtained.

    NormalHKIDCard

    Hong Kong ID card.

    Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

    Name Type Description
    ChineseName String Chinese name
    Note: This field may return null, indicating that no valid values can be obtained.
    FullName String English name
    Note: This field may return null, indicating that no valid values can be obtained.
    Example: SAN, Nan
    RegistrationNumber String Telex code correspondint to the Chinese name
    Note: This field may return null, indicating that no valid values can be obtained.
    Sex String Gender: "Male-M" or "Female-F"
    Note: This field may return null, indicating that no valid values can be obtained.
    Birthday String Birthday
    Note: This field may return null, indicating that no valid values can be obtained.
    Example: 01-01-2001
    Permanent String Permanent resident ID card: 0-non-permanent; 1-permanent; -1-unknown
    Note: This field may return null, indicating that no valid values can be obtained.
    LicenseNumber String ID card number
    Note: This field may return null, indicating that no valid values can be obtained.
    Example: C000000(E)
    Symbol String Lisence symbol, which is the symbol below Birthday. Example: "***AZ"
    Note: This field may return null, indicating that no valid values can be obtained.
    IssuedDate String The first date of issue
    Note: This field may return null, indicating that no valid values can be obtained.
    CurrentIssueDate String The current date of issue
    Note: This field may return null, indicating that no valid values can be obtained.

    NormalIndonesiaIDCard

    Indonesia ID card.

    Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

    Name Type Description
    LicenseNumber String License number
    Note: This field may return null, indicating that no valid values can be obtained.
    FullName String Name
    Note: This field may return null, indicating that no valid values can be obtained.
    Birthday String Birth place/Birthday
    Note: This field may return null, indicating that no valid values can be obtained.
    Sex String Gender
    Note: This field may return null, indicating that no valid values can be obtained.
    BloodType String Blood type
    Note: This field may return null, indicating that no valid values can be obtained.
    FormattedAddress String Address
    Note: This field may return null, indicating that no valid values can be obtained.
    Street String Street
    Note: This field may return null, indicating that no valid values can be obtained.
    Village String Village
    Note: This field may return null, indicating that no valid values can be obtained.
    Area String Region
    Note: This field may return null, indicating that no valid values can be obtained.
    Religion String Religious beliefs
    Note: This field may return null, indicating that no valid values can be obtained.
    MaritalStatus String Marital status
    Note: This field may return null, indicating that no valid values can be obtained.
    Occupation String Job
    Note: This field may return null, indicating that no valid values can be obtained.
    Nationality String Nationality
    Note: This field may return null, indicating that no valid values can be obtained.
    DueDate String ID card validity period
    Note: This field may return null, indicating that no valid values can be obtained.
    IssuedDate String Date of issue
    Note: This field may return null, indicating that no valid values can be obtained.
    Province String Province
    Note: This field may return null, indicating that no valid values can be obtained.
    City String City
    Note: This field may return null, indicating that no valid values can be obtained.

    NormalMLIDCard

    Malaysia ID card.

    Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

    Name Type Description
    FullName String Full Name
    Note: This field may return null, indicating that no valid values can be obtained.
    LicenseNumber String License number
    Note: This field may return null, indicating that no valid values can be obtained.
    Sex String Gender
    Note: This field may return null, indicating that no valid values can be obtained.
    FormattedAddress String Address
    Note: This field may return null, indicating that no valid values can be obtained.
    Type String Lisence type
    MyKad ID card
    MyPR Permanent resident ID card
    MyTentera Military ID card
    MyKAS Temporary ID card
    POLIS Police ID card
    IKAD Labor ID card
    MyKid Juvenile ID card
    Example: MyKad
    Birthday String Birthday (Currently, this filed only supports IKAD labor ID card and MyKad ID card)
    Note: This field may return null, indicating that no valid values can be obtained.

    NormalThailandIDCard

    Thailand ID Card

    Used by actions: GetSdkVerificationResult, GetWebVerificationResultIntl.

    Name Type Description
    LicenseNumber String LicenseNumber
    Note: This field may return null, indicating that no valid values can be obtained.
    FullName String Thailand name
    Note: This field may return null, indicating that no valid values can be obtained.
    LastName String Last name
    Note: This field may return null, indicating that no valid values can be obtained.
    FirstName String First name
    Note: This field may return null, indicating that no valid values can be obtained.
    Birthday String Birthday
    Note: This field may return null, indicating that no valid values can be obtained.
    FormattedAddress String Address
    Note: This field may return null, indicating that no valid values can be obtained.
    ExpirationDate String Expiration date
    Note: This field may return null, indicating that no valid values can be obtained.
    IssuedDate String Issued date
    Note: This field may return null, indicating that no valid values can be obtained.
    RegistrationNumber String Registration number
    Note: This field may return null, indicating that no valid values can be obtained.
    Religion String Religion
    Note: This field may return null, indicating that no valid values can be obtained.
    ThaiBirthday String Birthday in Thai
    Note: This field may return null, indicating that no valid values can be obtained.
    ThaiExpirationDate String Expiration date in Thai
    Note: This field may return null, indicating that no valid values can be obtained.
    ThaiIssueDate String Issued date in Thai
    Note: This field may return null, indicating that no valid values can be obtained.

    OCRResult

    The content of a single license in the license information.

    Used by actions: GetWebVerificationResultIntl.

    Name Type Description
    IsPass Boolean Is the indentity verification or OCR process passed
    CardImageBase64 String The Base64 of ID card image
    Note: This field may return null, indicating that no valid values can be obtained.
    NormalCardInfo NormalCardInfo OCR result of the ID card.
    RequestId String The request id
    CardCutImageBase64 String Base64 of cropped image of ID card
    CardBackCutImageBase64 String Base64 of the cropped image on the reverse side of the ID card
    WarnCardInfos Array of Integer Card Warning Information

    -9101 Alarm for covered certificate,
    -9102 Alarm for photocopied certificate,
    -9103 Alarm for photographed certificate,
    -9104 Alarm for PS certificate,
    -9107 Alarm for reflective certificate,
    -9108 Alarm for blurry image,
    -9109 This capability is not enabled.

    PhilippinesDrivingLicense

    Philippines driving license

    Used by actions: GetCardVerificationResult, GetSdkVerificationResult, GetWebVerificationResultIntl.

    Name Type Description
    Name String Full Name
    Note: This field may return null, indicating that no valid values can be obtained.
    LastName String Last name

    Note: This field may return null, indicating that no valid values can be obtained.
    FirstName String First name
    Note: This field may return null, indicating that no valid values can be obtained.
    MiddleName String Middle name
    Note: This field may return null, indicating that no valid values can be obtained.
    Nationality String Nationality
    Note: This field may return null, indicating that no valid values can be obtained.
    Sex String Gender
    Note: This field may return null, indicating that no valid values can be obtained.
    Address String Address
    Note: This field may return null, indicating that no valid values can be obtained.
    LicenseNo String License number
    Note: This field may return null, indicating that no valid values can be obtained.
    ExpiresDate String Date of expiry
    Note: This field may return null, indicating that no valid values can be obtained.
    AgencyCode String Agency code
    Note: This field may return null, indicating that no valid values can be obtained.
    Birthday String Birthday
    Note: This field may return null, indicating that no valid values can be obtained.

    PhilippinesSSSID

    Philippines SSSID Card

    Used by actions: GetCardVerificationResult, GetSdkVerificationResult, GetWebVerificationResultIntl.

    Name Type Description
    LicenseNumber String License number
    Note: This field may return null, indicating that no valid values can be obtained.
    FullName String Full name
    Note: This field may return null, indicating that no valid values can be obtained.
    Birthday String Birthday
    Note: This field may return null, indicating that no valid values can be obtained.

    PhilippinesTinID

    Philippines TinID Card

    Used by actions: GetCardVerificationResult, GetSdkVerificationResult, GetWebVerificationResultIntl.

    Name Type Description
    LicenseNumber String License number
    Note: This field may return null, indicating that no valid values can be obtained.
    FullName String Full name
    Note: This field may return null, indicating that no valid values can be obtained.
    Address String Address
    Note: This field may return null, indicating that no valid values can be obtained.
    Birthday String Birthday
    Note: This field may return null, indicating that no valid values can be obtained.
    IssueDate String Date of issue
    Note: This field may return null, indicating that no valid values can be obtained.

    PhilippinesUMID

    Philippines UMID Card

    Used by actions: GetCardVerificationResult, GetSdkVerificationResult, GetWebVerificationResultIntl.

    Name Type Description
    Surname String Surname
    Note: This field may return null, indicating that no valid values can be obtained.
    MiddleName String Middle Name
    Note: This field may return null, indicating that no valid values can be obtained.
    GivenName String First name
    Note: This field may return null, indicating that no valid values can be obtained.
    Sex String Gender
    Note: This field may return null, indicating that no valid values can be obtained.
    Birthday String Birthday
    Note: This field may return null, indicating that no valid values can be obtained.
    Address String Address
    Note: This field may return null, indicating that no valid values can be obtained.
    CRN String CRN code
    Note: This field may return null, indicating that no valid values can be obtained.

    PhilippinesVoteID

    Philippines VoteID Card

    Used by actions: GetCardVerificationResult, GetSdkVerificationResult, GetWebVerificationResultIntl.

    Name Type Description
    VIN String VIN of Philippines VoteID
    Note: This field may return null, indicating that no valid values can be obtained.
    FirstName String First name
    Note: This field may return null, indicating that no valid values can be obtained.
    LastName String Last name
    Note: This field may return null, indicating that no valid values can be obtained.
    Birthday String Birthday
    Note: This field may return null, indicating that no valid values can be obtained.
    CivilStatus String Civil status
    Note: This field may return null, indicating that no valid values can be obtained.
    Citizenship String Nationality
    Note: This field may return null, indicating that no valid values can be obtained.
    Address String Address
    Note: This field may return null, indicating that no valid values can be obtained.
    PrecinctNo String Region
    Note: This field may return null, indicating that no valid values can be obtained.

    RetrievalLivenessExtraInfo

    Used by actions: DetectAIFakeFaces.

    Name Type Description
    HitGroup String
    SimilarityScore Float
    HitTemplate String

    SingaporeIDCard

    Singapore ID Card

    Used by actions: GetCardVerificationResult, GetSdkVerificationResult, GetWebVerificationResultIntl.

    Name Type Description
    ChineseName String Chinese name
    Note: This field may return null, indicating that no valid values can be obtained.
    FullName String English name
    Note: This field may return null, indicating that no valid values can be obtained.
    LicenseNumber String License number
    Note: This field may return null, indicating that no valid values can be obtained.
    Sex String Gender
    Note: This field may return null, indicating that no valid values can be obtained.
    Nationality String Nationality
    Note: This field may return null, indicating that no valid values can be obtained.
    Birthday String Birthday
    Note: This field may return null, indicating that no valid values can be obtained.
    Address String Address (on the back)
    Note: This field may return null, indicating that no valid values can be obtained.
    Race String Race (on the back)
    Note: This field may return null, indicating that no valid values can be obtained.
    NRICCode String NRIC number (on the back)
    Note: This field may return null, indicating that no valid values can be obtained.
    PostCode String Post number (on the front)
    Note: This field may return null, indicating that no valid values can be obtained.
    DateOfExpiration String Date of expiry (on the back)
    Note: This field may return null, indicating that no valid values can be obtained.
    DateOfIssue String Date of issue (on the back)
    Note: This field may return null, indicating that no valid values can be obtained.

    TaiWanIDCard

    Taiwan ID card.

    Used by actions: GetCardVerificationResult, GetSdkVerificationResult, GetWebVerificationResultIntl.

    Name Type Description
    FullName String Full name
    Note: This field may return null, indicating that no valid values can be obtained.
    LicenseNumber String License number
    Note: This field may return null, indicating that no valid values can be obtained.
    Sex String Gender
    Note: This field may return null, indicating that no valid values can be obtained.
    IssuedCountry String Issued country
    Note: This field may return null, indicating that no valid values can be obtained.
    RegistrationNumber String Registration number
    Note: This field may return null, indicating that no valid values can be obtained.

    ThailandIDCard

    Thailand ID Card

    Used by actions: GetCardVerificationResult.

    Name Type Description
    LastName String Last name
    Note: This field may return null, indicating that no valid values can be obtained.
    FirstName String First name
    Note: This field may return null, indicating that no valid values can be obtained.
    LicenseNumber String License number
    Note: This field may return null, indicating that no valid values can be obtained.
    DateOfBirth String Birthday
    Note: This field may return null, indicating that no valid values can be obtained.
    DateOfExpiry String Date of expiry
    Note: This field may return null, indicating that no valid values can be obtained.
    DateOfIssue String Date of issue
    Note: This field may return null, indicating that no valid values can be obtained.
    IssuedCountry String Issuing country
    Note: This field may return null, indicating that no valid values can be obtained.

    VerificationDetail

    The details of the verification process.

    Used by actions: GetWebVerificationResult, GetWebVerificationResultIntl.

    Name Type Description
    ErrorCode Integer The final result of this verification. 0 indicates that the person is the same as that in the photo.
    Note: This field may return null, indicating that no valid values can be obtained.
    ErrorMsg String The description of the final verification result.
    Note: This field may return null, indicating that no valid values can be obtained.
    LivenessErrorCode Integer The result of this liveness detection process. 0 indicates success.
    Note: This field may return null, indicating that no valid values can be obtained.
    LivenessErrorMsg String The result description of this liveness detection process.
    Note: This field may return null, indicating that no valid values can be obtained.
    CompareErrorCode Integer The result of this comparison process. 0 indicates that the person in the best face screenshot collected from the video stream is the same as that in the uploaded image for comparison.
    Note: This field may return null, indicating that no valid values can be obtained.
    CompareErrorMsg String The result description of this comparison process.
    Note: This field may return null, indicating that no valid values can be obtained.
    ReqTimestamp Integer The timestamp (ms) of this verification process.
    Note: This field may return null, indicating that no valid values can be obtained.
    Similarity Float The similarity of the best face screenshot collected from the video stream and the uploaded image for comparison in this verification process. Value range: [0.00, 100.00]. By default, the person in the screenshot is determined to be the same person in the image if the similarity is greater than or equal to 70.
    Note: This field may return null, indicating that no valid values can be obtained.
    Seq String Unique ID of this verification process.
    Note: This field may return null, indicating that no valid values can be obtained.

    WebVerificationConfigIntl

    eKYC Web related configuration

    Used by actions: ApplyWebVerificationBizTokenIntl.

    Name Type Required Description
    AutoSkipStartPage Boolean No When starting verification, whether to skip the starting verification page. If true, enter the verification process directly. The default is false. This configuration will not take effect if the downgrade policy is triggered.
    AutoSkip Boolean No When the verification passed, whether to skip the result page and automatically jump to RedirectURL. The default value is false.
    Example value: false
    CheckMode Integer No Detection mode, parameter values are as follows:
    1: OCR+living detection & face comparison;
    2: Living detection & face comparison;
    3: Living detection;
    The default value is 2.
    Example value: 3
    IDCardType String No The type of lisence used for verification. The following types are supported.
    1.HKIDCard: Hong Kong (China) ID card
    2.MLIDCard: Malaysia ID card
    3.IndonesiaIDCard: Indonesia ID card
    4.PhilippinesVoteID: Philippines VoteID card
    5.PhilippinesDrivingLicense: Philippines driving license
    6.PhilippinesTinID: Philippines TinID card
    7.PhilippinesSSSID: Philippines SSSID card
    8.PhilippinesUMID: Philippines UMID card
    9.InternationalIDPassport: ID cards of Hong Kong, Macao and Taiwan (China), and international passport.
    10.IndonesiaDrivingLicense:Indonesia driving license
    11.ThailandIDCard: Thailand ID card
    12.ThailandDrivingLicense: Thailand driving license
    13.MLDrivingLicense: Malaysia driving license
    14.SingaporeIDCard: Singapore ID card
    15.SingaporeDrivingLicense: Singapore driving license
    16.JapanIDCard: Japan ID card
    17.JapanDrivingLicense: Japan driving license
    18.PhilippinesIDCard: Philippines ID card
    19.MainlandIDCard: Mainland ID card
    20.MacaoIDCard: Macao ID card
    Example: HKIDCard
    DisableCheckOcrWarnings Boolean No Whether to turn off document alarms, the default is false (the alarm detection function is turned on). When enabled, the identity authentication process will be intercepted based on the alarm status of the certificate. If you need to use the document authentication function, please contact us.
    SecurityLevel Integer No Liveness security level: 1:Silent mode;2:Action mode;3:Lighting mode;4:Action+Lighting mode;5:Action+Lighting(High security) mode; default value is 3
    SkipPrivacyPolicy Boolean No Whether to skip the agreement page, the default is false. When SkipPrivacyPolicy is false, the agreement page will be displayed and the privacy agreement needs to be checked; when SkipPrivacyPolicy is true, the agreement page will be skipped and the liveness process will be entered directly without checking the privacy agreement page.
    IdCardCutReturn Boolean No The default value is false. If it is false, the original ID image will be displayed. If it is true, the cut ID image will be displayed.
    ThemeColor String No Front-end theme color, in the format of RGB hexadecimal color code. The default value is "#2d72+1". If the format is incorrect, the default value color will be used.
    Language String No International language, the default value is en (English). Currently supported: th: Thai; en: English; zh-cn: Simplified Chinese; zh-tc: Tradionnal Chinese; id: Bahasa Indonesia.
    AutoDowngrade Integer No Automatic downgrade mode, with the following parameter values: 1: Downgrade to silent live mode; 2: Disable downgrade mode. The default value is 1.
    ActionList String No This interface is used to control th action sequences.
    Action types are as follows:
    "blink"
    "mouth"
    "nod"
    "shake"
    You can choose 1-2 actions out of the four.
    Single action example: "blink"
    Multiple action example: "blink,mouth"
    The default value is blink. The different action types passed in this parameter take effect only when the SecurityLevel is 2, 4, or 5; otherwise, the interface reports an error.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy