tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
eKYC
    Documentation
    Download PDF

    ApplySdkVerificationToken

    Last updated: 2024-04-03 11:45:30
    Download PDF

      1. API Description

      Domain name for API request: faceid.tencentcloudapi.com.

      This API is used to apply for a token before calling the Identity Verification SDK service each time. This token is required for initiating the verification process and getting the result after the verification is completed.

      A maximum of 20 requests can be initiated per second for this API.

      We recommend you to use API Explorer
      Try it
      API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

      2. Input Parameters

      The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

      Parameter Name Required Type Description
      Action Yes String Common Params. The value used for this API: ApplySdkVerificationToken.
      Version Yes String Common Params. The value used for this API: 2018-03-01.
      Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-hongkong, ap-jakarta, ap-singapore.
      NeedVerifyIdCard Yes Boolean Whether ID card authentication is required. If not, only document OCR will be performed. Currently, authentication is available only when the value of IdCardType is HK.
      CheckMode No Integer The verification mode. Valid values:
      1: OCR + liveness detection + face comparison
      2: Liveness detection + face comparison
      3: Liveness detection
      Default value: 1
      SecurityLevel No Integer The security level of the verification. Valid values:
      1: Video-based liveness detection
      2: Motion-based liveness detection
      3: Reflection-based liveness detection
      4: Motion- and reflection-based liveness detection
      Default value: 4
      IdCardType No String The identity document type. Valid values:
      1. HK (default): Identity card of Hong Kong (China)
      2. ML: Malaysian identity card
      3. IndonesiaIDCard: Indonesian identity card
      4. PhilippinesVoteID: Philippine voters ID card
      5. PhilippinesDrivingLicense: Philippine driver's license
      6. PhilippinesTinID: Philippine TIN ID card
      7. PhilippinesSSSID: Philippine SSS ID card
      8. PhilippinesUMID: Philippine UMID card
      9. MLIDPassport: Passport issued in Hong Kong/Macao/Taiwan (China) or other countries/regions
      CompareImage No String The Base64-encoded value of the photo to compare, which is required only when CheckMode is set to 2.
      DisableChangeOcrResult No Boolean Whether to forbid the modification of the OCR result by users. Default value: false (modification allowed). (Currently, this parameter is not applied.)
      DisableCheckOcrWarnings No Boolean Whether to disable the OCR warnings. Default value: false (not disable), where OCR warnings are enabled and the OCR result will not be returned if there is a warning.
      This feature applies only to Hong Kong (China) identity cards, Malaysian identity cards, and passports.
      Extra No String A passthrough field, which is returned together with the verification result and can contain up to 1,024 bits.

      3. Output Parameters

      Parameter Name Type Description
      SdkToken String The token used to identify an SDK-based verification process. It is valid for 7,200s and can be used to get the verification result after the process is completed.
      RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

      4. Example

      Example1 Applying for a token

      This example shows you how to apply for a verification token.

      Input Example

      POST / HTTP/1.1
Host: faceid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ApplySdkVerificationToken
<Common request parameters>

{
    "CheckMode": 1,
    "SecurityLevel": 4,
    "NeedVerifyIdCard": true,
    "Extra": "fewfewf",
    "IdCardType": "HK"
}

      Output Example

      {
    "Response": {
        "SdkToken": "A561B769-C347-4724-A69A-6C3B3483E107",
        "RequestId": "d73c0c05-f7ff-419c-84cb-0756303b1925"
    }
}

      5. Developer Resources

      SDK

      TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

      Command Line Interface

      6. Error Code

      There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy