All Products
Search
Document Center

ID Verification:SDK call example

Last Updated:Nov 26, 2024

This topic provides an example on how to call the ID Verification - KYC SDK to integrate ID Verification - KYC with an app to implement the FACE_VERIFY solution.

Install the SDK and download the source code

You can select a programming language for integration based on your business requirements.

Programming language

Environment requirement

SDK installation

GitHub source code address

Java

JDK 1.8 or later.

Download SDK for Java

Alibaba Cloud Green SDK for Java

Python

Python 3.0 or later.

Download SDK for Python

Alibaba Cloud Green SDK for Python

Typescript

Node.js 8.0 or later.

Download SDK for TypeScript

Alibaba Cloud Green SDK for Typescript

Go

Go 1.12.0 or later.

Download SDK for Go

Alibaba Cloud Green SDK for Go

PHP

PHP 5.6 or later.

Download SDK for PHP

Alibaba Cloud Green SDK for PHP

C#

.NET Framework 4.5.0 or later, or .NET Core 2.0 or later.

Download SDK for C#

Alibaba Cloud Green SDK for C#

C++

  • Install a compiler that supports C++ 11 or later:

    • Windows: Visual Studio 2015 or later.

    • Linux: GCC 4.9 or later.

  • Install CMake 3.0 or later.

  • Memory of 4 GB or more is recommended.

  • Install a dependency library. For more information, see Required dependency library.

Download SDK for C++

Alibaba Cloud Green SDK for C++

SDK call examples

This section provides the call examples in different programming languages.

Java

The following section describes the SDK dependencies used in this example. We recommend that you obtain the latest version of dependencies when you call the SDK.

<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>cloudauth_intl20220809</artifactId>
  <version>2.0.2</version>
</dependency>

Call example of the Initialize operation

import com.aliyun.cloudauth_intl20220809.Client;
import com.aliyun.cloudauth_intl20220809.models.InitializeRequest;
import com.aliyun.cloudauth_intl20220809.models.InitializeResponse;
import com.aliyun.teaopenapi.models.Config;
 
 
public class InitializeDemo {
 
 public static void main(String[] args) throws Exception {
 // Build client
 Config config = new Config();
 config.setAccessKeyId("your access key id");
 config.setAccessKeySecret("your access key secret");
 config.setEndpoint("cloudauth-intl.cn-hongkong.aliyuncs.com");
 config.setRegionId("cn-hongkong");
 Client client = new Client(config);
 
 // Build request
 InitializeRequest request = new InitializeRequest();
 request.setProductCode("FACE_VERIFY");
 request.setSceneCode("****");
 request.setMerchantBizId("****");
 request.setMerchantUserId("****");
 request.setMetaInfo("****");
 request.setSecurityLevel("****");
 //set facePictureBase64 or facePictureUrl when productCode is FACE_VERIFY
 request.setFacePictureBase64("****");
 request.setFacePictureUrl("****");
 
 // Invoke API
 InitializeResponse response = client.initialize(request);
 
 // Get result from response
 Integer statusCode = response.getStatusCode();
 String code = response.getBody().getCode();
 String transactionId = response.getBody().getResult().getTransactionId();
 }
 
}

Call example of the CheckResult operation

import com.aliyun.cloudauth_intl20220809.Client;
import com.aliyun.cloudauth_intl20220809.models.CheckResultRequest;
import com.aliyun.cloudauth_intl20220809.models.CheckResultResponse;
import com.aliyun.teaopenapi.models.Config;
 
 
public class CheckResultDemo {
 
 public static void main(String[] args) throws Exception {
 // Build client
 Config config = new Config();
 config.setAccessKeyId("your access key id");
 config.setAccessKeySecret("your access key secret");
 config.setEndpoint("cloudauth-intl.cn-hongkong.aliyuncs.com");
 config.setRegionId("cn-hongkong");
 Client client = new Client(config);
 
 // Build request
 CheckResultRequest request = new CheckResultRequest();
 
 request.setMerchantBizId("****");
 request.setTransactionId("****");
 request.setIsReturnImage("****");
 
 // Invoke API
 CheckResultResponse response = client.checkResult(request);
 
 // Get result from response
 Integer statusCode = response.getStatusCode();
 String code = response.getBody().getCode();
 String passed = response.getBody().getResult().getPassed();
 String subCode = response.getBody().getResult().getSubCode();
 String extFaceInfo = response.getBody().getResult().getExtFaceInfo();
 }
 
}

PHP

The following section describes the SDK dependencies used in this example. We recommend that you obtain the latest version of dependencies when you call the SDK.

  • (Recommended) Use Composer to manage project dependencies

    composer require alibabacloud/cloudauth-intl-20220809 2.0.2
  • Use the composer.json file

    {
      "require": {
        "alibabacloud/cloudauth-intl-20220809": "2.0.2"
      }
    }

Call example of the Initialize operation

<?php
namespace AlibabaCloud\SDK\Sample;
 
use AlibabaCloud\SDK\Cloudauthintl\V20220809\Models\InitializeRequest;
use AlibabaCloud\SDK\Cloudauthintl\V20220809\Cloudauthintl;
use Darabonba\OpenApi\Models\Config;
 
class Initialize {
 
 public static function main(){
 // Build client
 $config = new Config([
 "accessKeyId" => "your accessKeyId",
 "accessKeySecret" => "your accessKeySecret",
 "endpoint" => "cloudauth-intl.cn-hongkong.aliyuncs.com"
 ]);
 $client = new Cloudauthintl($config);
 
 // Build request
 $request = new InitializeRequest([
 "productCode"=>"FACE_VERIFY",
 "sceneCode"=>"****",
 "merchantBizId"=>"****",
 "merchantUserId"=>"****",
 "metaInfo"=>"{\"apdi****.0.0\"}",
 "facePictureBase64"=>"****",
 "facePictureUrl"=>"****",
 "securityLevel"=>"****"
 ]);
 
 // Invoke API
 $response = $client->initialize($request);
 
 // Get result
 var_dump($response->statusCode);
 var_dump($response->body->requestId);
 var_dump($response->body->result->transactionId);
 }
 
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
 require_once $path;
}
Initialize::main();

Call example of the CheckResult operation

<?php
namespace AlibabaCloud\SDK\Sample;
 
use AlibabaCloud\SDK\Cloudauthintl\V20220809\Models\CheckResultRequest;
use AlibabaCloud\SDK\Cloudauthintl\V20220809\Cloudauthintl;
use Darabonba\OpenApi\Models\Config;
 
class CheckResult {
 
 public static function main(){
 // Build client
 $config = new Config([
 "accessKeyId" => "your accessKeyId",
 "accessKeySecret" => "your accessKeySecret",
 "endpoint" => "cloudauth-intl.cn-hongkong.aliyuncs.com"
 ]);
 $client = new Cloudauthintl($config);
 
 // Build request
 $request = new CheckResultRequest([
 "merchantBizId"=>"***",
 "transactionId"=>"G00000****05816"
 ]);
 
 // Invoke API
 $response = $client->checkResult($request);
 
 // Get result
 var_dump($response->statusCode);
 var_dump($response->body->requestId);
 var_dump($response->body->result->passed);
 var_dump($response->body->result->subCode);
 var_dump($response->body->result->extFaceInfo);
 }
 
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
 require_once $path;
}
CheckResult::main();

Python

  • Install dependencies.

    pip install alibabacloud_tea_openapi==0.2.5
  • Install the SDK. We recommend that you obtain the latest version of dependencies when you call the SDK.

    pip install alibabacloud_cloudauth_intl20220809==2.0.2

Call example of the Initialize operation

from alibabacloud_cloudauth_intl20220809.client import Client as CloudauthClient
from alibabacloud_cloudauth_intl20220809 import models as cloudauth_models
from alibabacloud_tea_openapi import models as open_api_models


class Initialize:
    def __init__(self):
        pass

    @staticmethod
    def main() -> None:


        # Build client
        config = open_api_models.Config(
            access_key_id='your access_key_id',
            access_key_secret='your access_key_secret',
            endpoint="cloudauth-intl.cn-hongkong.aliyuncs.com"
        )
        client = CloudauthClient(config)


        # Build request
        request = cloudauth_models.InitializeRequest(
            merchant_biz_id="***",
            merchant_user_id="***",
            meta_info="{\"apdid****mVer\":\"1.0.0\"}",
            face_picture_base_64="dsfafdaf",
            face_picture_url="***",
            product_code="FACE_VERIFY",
            scene_code="1234567890",
            security_level="02"
        )

        # Invoke API
        response = client.initialize(request)

        # Get result
        print(response.status_code)
        print(response.body.request_id)
        print(response.body.result.transaction_id)


if __name__ == '__main__':
    Initialize.main()

Call example of the CheckResult operation

from alibabacloud_cloudauth_intl20220809.client import Client as CloudauthClient
from alibabacloud_cloudauth_intl20220809 import models as cloudauth_models
from alibabacloud_tea_openapi import models as open_api_models
 
 
class CheckResult:
 def __init__(self):
 pass
 
 @staticmethod
 def main() -> None:
 # Build client
 config = open_api_models.Config(
 access_key_id='your access_key_id',
 access_key_secret='your access_key_secret',
 endpoint="cloudauth-intl.cn-hongkong.aliyuncs.com"
 )
 client = CloudauthClient(config)
 
 # Build request
 request = cloudauth_models.CheckResultRequest(
 transaction_id="****",
 merchant_biz_id="****"
 )
 
 # Invoke API
 response = client.check_result(request)
 
 # Get result
 print(response.status_code)
 print(response.body.request_id)
 print(response.body.result.passed)
 print(response.body.result.sub_code)
 print(response.body.result.ext_face_info) 
 
 
if __name__ == '__main__':
 CheckResult.main()

Go

  • Install dependencies.

    go get github.com/alibabacloud-go/darabonba-openapi
    go get github.com/alibabacloud-go/tea
  • Install the SDK. We recommend that you obtain the latest version of dependencies when you call the SDK.

    git clone --branch v2.0.2 github.com/alibabacloud-go/cloudauth-intl-20220809/v2

Call example of the Initialize operation

package main

import (
 "fmt"
 openapi "github.com/alibabacloud-go/darabonba-openapi/client"
 cloudauth "github.com/alibabacloud-go/cloudauth-intl-20220809/client"
 "github.com/alibabacloud-go/tea/tea"
)

func main() {
 config := &openapi.Config{
 AccessKeyId: tea.String("your AccessKeyId"),
 AccessKeySecret: tea.String("your AccessKeySecret"),
 Endpoint: tea.String("cloudauth-intl.cn-hongkong.aliyuncs.com"),
 }
 client, _ := cloudauth.NewClient(config)

 request := &cloudauth.InitializeRequest{
 ProductCode : tea.String("****"),
 SceneCode : tea.String("****"),
 MetaInfo : tea.String("{\"apdidT****.0.0\"}"),
 FacePictureBase64 : tea.String("****"),
 FacePictureUrl : tea.String("****"),
 MerchantBizId : tea.String("****"),
 MerchantUserId : tea.String("****"),
 SecurityLevel : tea.String("****"),
 }

 response, err := client.Initialize(request)

 if err != nil{
 fmt.Println(err)
 return
 }
 fmt.Println(*response.Body.RequestId)
 fmt.Println(*response.Body.Result.TransactionId)

}

Call example of the CheckResult operation

package main

import (
 "fmt"
 openapi "github.com/alibabacloud-go/darabonba-openapi/client"
 cloudauth "github.com/alibabacloud-go/cloudauth-intl-20220809/client"
 "github.com/alibabacloud-go/tea/tea"
)

func main() {
 config := &openapi.Config{
 AccessKeyId: tea.String("your AccessKeyId"),
 AccessKeySecret: tea.String("your AccessKeySecret"),
 Endpoint: tea.String("cloudauth-intl.cn-hongkong.aliyuncs.com"),
 }
 client, _ := cloudauth.NewClient(config)

 request := &cloudauth.CheckResultRequest{
 MerchantBizId : tea.String("****"),
 TransactionId : tea.String("G00****00911"),
 }

 response, err := client.CheckResult(request)

 if err != nil{
 fmt.Println(err)
 return
 }
 fmt.Println(*response.Body.RequestId)
 fmt.Println(*response.Body.Result.Passed)
 fmt.Println(*response.Body.Result.SubCode)
 fmt.Println(*response.Body.Result.ExtFaceInfo)

}

.NET

The following section describes the SDK dependencies used in this example. We recommend that you obtain the latest version of dependencies when you call the SDK.

  • Use the .NET CLI to install the SDK

    dotnet add package AlibabaCloud.SDK.Cloudauth-intl20220809 --version 2.0.2
  • Use an installation package to install the SDK

    Install-Package AlibabaCloud.SDK.Cloudauth_intl20220809 -Version 2.0.2

Call example of the Initialize operation

using AlibabaCloud.SDK.Cloudauth_intl20220809.Models;
 
namespace Demo
{
 public class InitializeDemo
 {
 public static void Main(string[] args) {
 // Build client
 AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config()
 {
 AccessKeyId = "your access key id",
 AccessKeySecret = "your access key secret",
 Endpoint = "cloudauth-intl.cn-hongkong.aliyuncs.com",
 };
 AlibabaCloud.SDK.Cloudauth_intl20220809.Client client = new AlibabaCloud.SDK.Cloudauth_intl20220809.Client(config);
 
 
 // Build request
 AlibabaCloud.SDK.Cloudauth_intl20220809.Models.InitializeRequest request = new AlibabaCloud.SDK.Cloudauth_intl20220809.Models.InitializeRequest
 {
 ProductCode = "FACE_VERIFY",
 SceneCode = "****",
 MerchantBizId = "****",
 MerchantUserId = "****"
 MetaInfo = "****",
 FacePictureBase64 = "****",
 FacePictureUrl = "****",
 SecurityLevel = "****",
 };
 
 // Invoke API
 InitializeResponse response = client.Initialize(request);
 
 // Get result
 Console.WriteLine(response.StatusCode);
 Console.WriteLine(response.Body.RequestId);
 Console.WriteLine(response.Body.Code);
 Console.WriteLine(response.Body.Message);
 Console.WriteLine(response.Body.Result.TransactionId);
 }
 }
}

Call example of the CheckResult operation

using AlibabaCloud.SDK.Cloudauth_intl20220809.Models;

namespace Demo
{
 public class CheckResultDemo
 {
 public static void Main(string[] args)
 {
 // Build client
 AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config()
 {
 AccessKeyId = "your access key id",
 AccessKeySecret = "your access key secret",
 Endpoint = "cloudauth-intl.cn-hongkong.aliyuncs.com",
 };
 AlibabaCloud.SDK.Cloudauth_intl20220809.Client client = new AlibabaCloud.SDK.Cloudauth_intl20220809.Client(config);


 // Build request
 AlibabaCloud.SDK.Cloudauth_intl20220809.Models.CheckResultRequest request = new AlibabaCloud.SDK.Cloudauth_intl20220809.Models.CheckResultRequest
 {
 TransactionId = "****",
 MerchantBizId = "****",
 };

 // Invoke API
 CheckResultResponse response = client.CheckResult(request);

 // Get result
 Console.WriteLine(response.StatusCode);
 Console.WriteLine(response.Body.RequestId);
 Console.WriteLine(response.Body.Code);
 Console.WriteLine(response.Body.Message);
 Console.WriteLine(response.Body.Result.Passed);
 Console.WriteLine(response.Body.Result.SubCode);
 Console.WriteLine(response.Body.Result.ExtFaceInfo); 
 }
 }
}

Node.js

  • Install dependencies.

    npm install @alicloud/openapi-client
  • Install the SDK. We recommend that you obtain the latest version of dependencies when you call the SDK.

    npm install @alicloud/cloudauth-intl20220809@2.0.2

Call example of the Initialize operation

const {Config} = require("@alicloud/openapi-client");
const CloudAuth = require("@alicloud/cloudauth-intl20220809");
const Client = CloudAuth.default;
 
async function main(){
 
 // Build client
 const config = new Config({
 accessKeyId: "your accessKeyId",
 accessKeySecret: "your accessKeySecret",
 endpoint: "cloudauth-intl.cn-hongkong.aliyuncs.com"
 });
 const client = new Client(config);
 
 // Build request
 const request = new CloudAuth.InitializeRequest({
 productCode: "FACE_VERIFY",
 sceneCode: "***",
 metaInfo : "***",
 facePictureBase64 : "***",
 facePictureUrl : "***",
 merchantBizId : "***",
 merchantUserId : "***",
 securityLevel:  "***",
 });
 
 // Invoke API
 const response = await client.initialize(request);
 
 // Get result
 console.log(response.body.requestId);
 console.log(response.body.result.transactionId);
 
}
 
main().then(function (response) {});

Call example of the CheckResult operation

const {Config} = require("@alicloud/openapi-client");
const CloudAuth = require("@alicloud/cloudauth-intl20220809");
const Client = CloudAuth.default;
 
async function main(){
 
 // Build client
 const config = new Config({
 accessKeyId: "your accessKeyId",
 accessKeySecret: "your accessKeySecret",
 endpoint: "cloudauth-intl.cn-hongkong.aliyuncs.com"
 });
 const client = new Client(config);
 
 // Build request
 const request = new CloudAuth.CheckResultRequest({
 merchantBizId: "XXXX",
 transactionId: "G00000****500911"
 });
 
 // Invoke API
 const response = await client.checkResult(request);
 
 // Get result
 console.log(response.body.requestId);
 console.log(response.body.result.passed);
 console.log(response.body.result.subCode);
 console.log(response.body.result.extFaceInfo);
}
 
main().then(function (response) {});