Id card recognition
This topic provides sample code for id card recognition in common programming languages and for common use cases.
-
For real-time assistance, start an online consultation.
-
If you have questions about API access or usage for the Alibaba Cloud Vision AI Platform, join our DingTalk group (ID: 23109592) to contact us.
Overview
For an overview of the id card recognition feature and its API parameters, see id card recognition.
SDK installation
For SDK dependencies for common programming languages, see SDK overview.
Configure environment variables
Configure the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables.
An Alibaba Cloud account has full access to all API operations. We recommend that you use a RAM user for API calls or routine O&M. For more information, see Create a RAM user.
Do not save your AccessKey ID or AccessKey Secret in project code. Otherwise, the AccessKey pair may be leaked and the security of all resources in your account may be compromised.
Configure environment variables on Linux and macOS
Open a terminal in IntelliJ IDEA.
Run the following commands to configure the environment variables.
Replace
<access_key_id>with the AccessKey ID of your RAM user and<access_key_secret>with the AccessKey Secret of your RAM user. If you need to configure more permissions, see Control access permissions using a RAM policy.export ALIBABA_CLOUD_ACCESS_KEY_ID=<access_key_id> export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<access_key_secret>
Configure environment variables on Windows
Create a new environment variable file, add the environment variables
ALIBABA_CLOUD_ACCESS_KEY_IDandALIBABA_CLOUD_ACCESS_KEY_SECRET, and set them to the AccessKey ID and AccessKey Secret that you have prepared. Then, restart the Windows operating system. The following example uses Windows 10.Open File Explorer, right-click This PC, and then select Properties.
In the left-side navigation pane, click Advanced system settings.
On the Advanced tab of the System Properties dialog box, click Environment Variables.
In the Environment Variables dialog box, click New.
In the New System Variable dialog box, add the environment variables
ALIBABA_CLOUD_ACCESS_KEY_IDandALIBABA_CLOUD_ACCESS_KEY_SECRET, and set them to the AccessKey ID and AccessKey Secret that you have prepared.Restart the Windows operating system for the configurations to take effect.
Sample code
OSS file in the Shanghai region
/*
Add the dependency.
<!-- https://mvnrepository.com/artifact/com.aliyun/ocr20191230 -->
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>ocr20191230</artifactId>
<version>${aliyun.ocr.version}</version>
</dependency>
*/
import com.aliyun.ocr20191230.models.RecognizeIdentityCardResponse;
import com.aliyun.tea.TeaModel;
public class RecognizeIdentityCard {
public static com.aliyun.ocr20191230.Client createClient(String accessKeyId, String accessKeySecret) throws Exception {
/*
Initialize the configuration object com.aliyun.teaopenapi.models.Config.
This object stores configuration parameters such as your AccessKey ID, AccessKey Secret, and endpoint.
*/
com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
.setAccessKeyId(accessKeyId)
.setAccessKeySecret(accessKeySecret);
// The endpoint of the service.
config.endpoint = "ocr.cn-shanghai.aliyuncs.com";
return new com.aliyun.ocr20191230.Client(config);
}
public static void main(String[] args_) throws Exception {
// For information about how to create an AccessKey ID and AccessKey Secret, see https://help.aliyun.com/document_detail/175144.html.
// If you use a RAM user's AccessKey, you must grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see https://help.aliyun.com/document_detail/145025.html.
// Read the AccessKey ID and AccessKey Secret from environment variables. You must configure environment variables before running the sample code.
String accessKeyId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
String accessKeySecret = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
com.aliyun.ocr20191230.Client client = RecognizeIdentityCard.createClient(accessKeyId, accessKeySecret);
com.aliyun.ocr20191230.models.RecognizeIdentityCardRequest recognizeIdentityCardRequest = new com.aliyun.ocr20191230.models.RecognizeIdentityCardRequest()
.setImageURL("http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/ocr/RecognizeIdentityCard/sfzbm1.jpg")
.setSide("back");
com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
try {
RecognizeIdentityCardResponse recognizeIdentityCardResponse = client.recognizeIdentityCardWithOptions(recognizeIdentityCardRequest, runtime);
// Get the complete response.
System.out.println(com.aliyun.teautil.Common.toJSONString(TeaModel.buildMap(recognizeIdentityCardResponse)));
// Get a specific field from the response.
System.out.println(recognizeIdentityCardResponse.getBody());
} catch (com.aliyun.tea.TeaException teaException) {
// Get the complete error message.
System.out.println(com.aliyun.teautil.Common.toJSONString(teaException));
// Get a specific field from the error message.
System.out.println(teaException.getCode());
}
}
}
# -*- coding: utf-8 -*-
# Install the dependency.
# pip install alibabacloud_ocr20191230
import os
from alibabacloud_ocr20191230.client import Client
from alibabacloud_ocr20191230.models import RecognizeIdentityCardRequest
from alibabacloud_tea_openapi.models import Config
from alibabacloud_tea_util.models import RuntimeOptions
config = Config(
# For information about how to create an AccessKey ID and AccessKey Secret, see https://help.aliyun.com/document_detail/175144.html.
# If you use a RAM user's AccessKey, you must grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see https://help.aliyun.com/document_detail/145025.html.
# Read the AccessKey ID and AccessKey Secret from environment variables. You must configure environment variables before running the sample code.
access_key_id=os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID'),
access_key_secret=os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET'),
# The endpoint of the service.
endpoint='ocr.cn-shanghai.aliyuncs.com',
# The ID of the region where the service is deployed.
region_id='cn-shanghai'
)
recognize_identity_card_request = RecognizeIdentityCardRequest(
image_url='http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/ocr/RecognizeIdentityCard/sfzbm1.jpg',
side='back'
)
runtime = RuntimeOptions()
try:
# Initialize the client.
client = Client(config)
response = client.recognize_identity_card_with_options(recognize_identity_card_request, runtime)
# Get the complete response.
print(response.body)
except Exception as error:
# Get the complete error message.
print(error)
# Get a specific field from the error message.
print(error.code)
<?php
// Install the dependency.
//composer require alibabacloud/ocr-20191230
use AlibabaCloud\SDK\Ocr\V20191230\Ocr;
use \Exception;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Ocr\V20191230\Models\RecognizeIdentityCardRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class RecognizeIdentityCard {
/**
* Initialize the client with an AccessKey ID and AccessKey Secret.
* @param string $accessKeyId
* @param string $accessKeySecret
* @return Ocr Client
*/
public static function createClient($accessKeyId, $accessKeySecret){
// Initialize the configuration object Darabonba\OpenApi\Models\Config.
// This object stores configuration parameters such as your AccessKey ID, AccessKey Secret, and endpoint.
$config = new Config([
"accessKeyId" => $accessKeyId,
"accessKeySecret" => $accessKeySecret
]);
// The endpoint of the service.
$config->endpoint = "ocr.cn-shanghai.aliyuncs.com";
return new Ocr($config);
}
/**
* @param string[] $args
* @return void
*/
public static function main($args){
// For information about how to create an AccessKey ID and AccessKey Secret, see https://help.aliyun.com/document_detail/175144.html.
// If you use a RAM user's AccessKey, you must grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see https://help.aliyun.com/document_detail/145025.html.
// Read the AccessKey ID and AccessKey Secret from environment variables. You must configure environment variables before running the sample code.
$accessKeyId = getenv('ALIBABA_CLOUD_ACCESS_KEY_ID');
$accessKeySecret = getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET');
$client = self::createClient($accessKeyId, $accessKeySecret);
$recognizeIdentityCardRequest = new RecognizeIdentityCardRequest([
"imageURL" => "http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/ocr/RecognizeIdentityCard/sfzbm1.jpg",
"side" => "back"
]);
$runtime = new RuntimeOptions([]);
try {
$resp = $client->recognizeIdentityCardWithOptions($recognizeIdentityCardRequest, $runtime);
# Get the complete response.
echo Utils::toJSONString($resp->body);
} catch (Exception $exception) {
# Get the complete error message.
echo Utils::toJSONString($exception);
# Get a specific field from the error message.
echo $exception->getCode();
}
}
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
require_once $path;
}
// $argv is a reserved parameter for array input. You do not need to modify it.
RecognizeIdentityCard::main(array_slice($argv, 1));
// Install the dependency.
// npm install @alicloud/ocr20191230
const OcrClient = require('@alicloud/ocr20191230');
const OpenapiClient = require('@alicloud/openapi-client');
const TeaUtil = require('@alicloud/tea-util');
let config = new OpenapiClient.Config({
// For information about how to create an AccessKey ID and AccessKey Secret, see https://help.aliyun.com/document_detail/175144.html.
// If you use a RAM user's AccessKey, you must grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see https://help.aliyun.com/document_detail/145025.html.
// Read the AccessKey ID and AccessKey Secret from environment variables. You must configure environment variables before running the sample code.
accessKeyId: process.env.ALIBABA_CLOUD_ACCESS_KEY_ID,
accessKeySecret: process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET
});
// The endpoint of the service.
config.endpoint = `ocr.cn-shanghai.aliyuncs.com`;
const client = new OcrClient.default(config);
let recognizeIdentityCardRequest = new OcrClient.RecognizeIdentityCardRequest({
side: "back",
imageURL: "http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/ocr/RecognizeIdentityCard/sfzbm1.jpg",
});
let runtime = new TeaUtil.RuntimeOptions({});
client.recognizeIdentityCardWithOptions(recognizeIdentityCardRequest, runtime)
.then(function (recognizeIdentityCardResponse) {
// Get the complete response.
console.log(recognizeIdentityCardResponse);
// Get a specific field from the response.
console.log(recognizeIdentityCardResponse.body.data);
}, function (error) {
// Get the complete error message.
console.log(error);
// Get a specific field from the error message.
console.log(error.data.Code);
})
/**
This project depends on github.com/alibabacloud-go/ocr-20191230/v3.
We recommend that you run the go mod tidy command to install the dependency.
*/
import (
"fmt"
openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
ocr20191230 "github.com/alibabacloud-go/ocr-20191230/v3/client"
util "github.com/alibabacloud-go/tea-utils/v2/service"
"github.com/alibabacloud-go/tea/tea"
)
func main() {
// For information about how to create an AccessKey ID and AccessKey Secret, see https://help.aliyun.com/document_detail/175144.html.
// If you use a RAM user's AccessKey, you must grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see https://help.aliyun.com/document_detail/145025.html.
// Read the AccessKey ID and AccessKey Secret from environment variables. You must configure environment variables before running the sample code.
accessKeyId := os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")
accessKeySecret := os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
// Initialize the configuration object &openapi.Config. This object stores configuration parameters such as your AccessKey ID, AccessKey Secret, and endpoint.
config := &openapi.Config{
AccessKeyId: tea.String(accessKeyId),
AccessKeySecret: tea.String(accessKeySecret),
}
// The endpoint of the service.
config.Endpoint = tea.String("ocr.cn-shanghai.aliyuncs.com")
client, err := ocr20191230.NewClient(config)
if err != nil {
panic(err)
}
recognizeIdentityCardRequest := &ocr20191230.RecognizeIdentityCardRequest{
ImageURL: tea.String("http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/ocr/RecognizeIdentityCard/sfzbm1.jpg"),
Side: tea.String("back"),
}
runtime := &util.RuntimeOptions{}
recognizeIdentityCardResponse, err := client.RecognizeIdentityCardWithOptions(recognizeIdentityCardRequest, runtime)
if err != nil {
// Get the complete error message.
fmt.Println(err.Error())
} else {
// Get the complete response.
fmt.Println(recognizeIdentityCardResponse)
}
}
// Install the dependency.
// dotnet add package AlibabaCloud.SDK.Ocr20191230
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Net;
using System.Threading.Tasks;
using AlibabaCloud.SDK.Ocr20191230.Models;
using Tea;
using Tea.Utils;
namespace AlibabaCloud.SDK.Sample
{
public class Sample
{
/**
* Initialize the client with an AccessKey ID and AccessKey Secret.
* @param accessKeyId
* @param accessKeySecret
* @return Client
* @throws Exception
*/
public static AlibabaCloud.SDK.Ocr20191230.Client CreateClient(string accessKeyId, string accessKeySecret)
{
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config
{
AccessKeyId = accessKeyId,
AccessKeySecret = accessKeySecret,
};
// The endpoint of the service.
config.Endpoint = "ocr.cn-shanghai.aliyuncs.com";
return new AlibabaCloud.SDK.Ocr20191230.Client(config);
}
public static void Main(string[] args)
{
// For information about how to create an AccessKey ID and AccessKey Secret, see https://help.aliyun.com/document_detail/175144.html.
// If you use a RAM user's AccessKey, you must grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see https://help.aliyun.com/document_detail/145025.html.
// Read the AccessKey ID and AccessKey Secret from environment variables. You must configure environment variables before running the sample code.
string accessKeyId = System.Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID");
string accessKeySecret = System.Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
AlibabaCloud.SDK.Ocr20191230.Client client = CreateClient(accessKeyId, accessKeySecret);
AlibabaCloud.SDK.Ocr20191230.Models.RecognizeIdentityCardRequest recognizeIdentityCardRequest = new AlibabaCloud.SDK.Ocr20191230.Models.RecognizeIdentityCardRequest
{
Side = "back",
ImageURL = "http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/ocr/RecognizeIdentityCard/sfzbm1.jpg",
};
AlibabaCloud.TeaUtil.Models.RuntimeOptions runtime = new AlibabaCloud.TeaUtil.Models.RuntimeOptions();
try
{
AlibabaCloud.SDK.Ocr20191230.Models.RecognizeIdentityCardResponse recognizeIdentityCardResponse = client.RecognizeIdentityCardWithOptions(recognizeIdentityCardRequest, runtime);
// Get the complete response.
Console.WriteLine(AlibabaCloud.TeaUtil.Common.ToJSONString(recognizeIdentityCardResponse.Body));
// Get a specific field from the response.
Console.WriteLine(AlibabaCloud.TeaUtil.Common.ToJSONString(recognizeIdentityCardResponse.Body.Data));
}
catch (TeaException error)
{
// Print the error if necessary.
AlibabaCloud.TeaUtil.Common.AssertAsString(error.Message);
}
catch (Exception _error)
{
TeaException error = new TeaException(new Dictionary<string, object>
{
{ "message", _error.Message }
});
// Print the error if necessary.
Console.WriteLine(error.Message);
}
}
}
}
Local file or public URL
/*
Add the dependency.
<!-- https://mvnrepository.com/artifact/com.aliyun/ocr20191230 -->
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>ocr20191230</artifactId>
<version>${aliyun.ocr.version}</version>
</dependency>
*/
import com.aliyun.ocr20191230.models.RecognizeIdentityCardResponse;
import com.aliyun.tea.TeaException;
import com.aliyun.tea.TeaModel;
import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;
import java.net.URL;
public class RecognizeIdentityCard {
public static com.aliyun.ocr20191230.Client createClient(String accessKeyId, String accessKeySecret) throws Exception {
/*
Initialize the configuration object com.aliyun.teaopenapi.models.Config.
This object stores configuration parameters such as your AccessKey ID, AccessKey Secret, and endpoint.
*/
com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
.setAccessKeyId(accessKeyId)
.setAccessKeySecret(accessKeySecret);
// The endpoint of the service.
config.endpoint = "ocr.cn-shanghai.aliyuncs.com";
return new com.aliyun.ocr20191230.Client(config);
}
public static void main(String[] args_) throws Exception {
// For information about how to create an AccessKey ID and AccessKey Secret, see https://help.aliyun.com/document_detail/175144.html.
// If you use a RAM user's AccessKey, you must grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see https://help.aliyun.com/document_detail/145025.html.
com.aliyun.ocr20191230.Client client = RecognizeIdentityCard.createClient("YOUR_ACCESS_KEY_ID", "YOUR_ACCESS_KEY_SECRET");
// Scenario 1: Use a local file.
// InputStream inputStream = new FileInputStream(new File("/tmp/RecognizeIdentityCard.png"));
// Scenario 2: Use a publicly accessible URL.
URL url = new URL("http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/ocr/RecognizeIdentityCard/sfzbm1.jpg");
InputStream inputStream = url.openConnection().getInputStream();
com.aliyun.ocr20191230.models.RecognizeIdentityCardAdvanceRequest recognizeIdentityCardAdvanceRequest = new com.aliyun.ocr20191230.models.RecognizeIdentityCardAdvanceRequest()
.setImageURLObject(inputStream)
.setSide("back");
com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
try {
RecognizeIdentityCardResponse recognizeIdentityCardResponse = client.recognizeIdentityCardAdvance(recognizeIdentityCardAdvanceRequest, runtime);
// Get the complete response.
System.out.println(com.aliyun.teautil.Common.toJSONString(TeaModel.buildMap(recognizeIdentityCardResponse)));
// Get a specific field from the response.
System.out.println(recognizeIdentityCardResponse.getBody());
} catch (com.aliyun.tea.TeaException teaException) {
// Get the complete error message.
System.out.println(com.aliyun.teautil.Common.toJSONString(teaException));
// Get a specific field from the error message.
System.out.println(teaException.getCode());
}
}
}
# -*- coding: utf-8 -*-
# Install the dependency.
# pip install alibabacloud_ocr20191230
import os
import io
from urllib.request import urlopen
from alibabacloud_ocr20191230.client import Client
from alibabacloud_ocr20191230.models import RecognizeIdentityCardAdvanceRequest
from alibabacloud_tea_openapi.models import Config
from alibabacloud_tea_util.models import RuntimeOptions
config = Config(
# For information about how to create an AccessKey ID and AccessKey Secret, see https://help.aliyun.com/document_detail/175144.html.
# If you use a RAM user's AccessKey, you must grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see https://help.aliyun.com/document_detail/145025.html.
# Read the AccessKey ID and AccessKey Secret from environment variables. You must configure environment variables before running the sample code.
access_key_id=os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID'),
access_key_secret=os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET'),
# The endpoint of the service.
endpoint='ocr.cn-shanghai.aliyuncs.com',
# The ID of the region where the service is deployed.
region_id='cn-shanghai'
)
# Scenario 1: Use a local file.
#img = open(r'/tmp/sfzbm1.jpg', 'rb')
# Scenario 2: Use a publicly accessible URL.
url = 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/ocr/RecognizeIdentityCard/sfzbm1.jpg'
img = io.BytesIO(urlopen(url).read())
recognize_identity_card_request = RecognizeIdentityCardAdvanceRequest(
image_urlobject=img,
side='back'
)
runtime = RuntimeOptions()
try:
# Initialize the client.
client = Client(config)
response = client.recognize_identity_card_advance(recognize_identity_card_request, runtime)
# Get the complete response.
print(response.body)
except Exception as error:
# Get the complete error message.
print(error)
# Get a specific field from the error message.
print(error.code)
<?php
// Install the dependency.
//composer require alibabacloud/ocr-20191230
use AlibabaCloud\SDK\Ocr\V20191230\Ocr;
use \Exception;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Ocr\V20191230\Models\RecognizeIdentityCardAdvanceRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
use GuzzleHttp\Psr7\Stream;
class RecognizeIdentityCardAdvance {
/**
* Initialize the client with an AccessKey ID and AccessKey Secret.
* @param string $accessKeyId
* @param string $accessKeySecret
* @return Ocr Client
*/
public static function createClient($accessKeyId, $accessKeySecret){
// Initialize the configuration object Darabonba\OpenApi\Models\Config.
// This object stores configuration parameters such as your AccessKey ID, AccessKey Secret, and endpoint.
$config = new Config([
"accessKeyId" => $accessKeyId,
"accessKeySecret" => $accessKeySecret
]);
// The endpoint of the service.
$config->endpoint = "ocr.cn-shanghai.aliyuncs.com";
return new Ocr($config);
}
/**
* @param string[] $args
* @return void
*/
public static function main($args){
// For information about how to create an AccessKey ID and AccessKey Secret, see https://help.aliyun.com/document_detail/175144.html.
// If you use a RAM user's AccessKey, you must grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see https://help.aliyun.com/document_detail/145025.html.
// Read the AccessKey ID and AccessKey Secret from environment variables. You must configure environment variables before running the sample code.
$accessKeyId = getenv('ALIBABA_CLOUD_ACCESS_KEY_ID');
$accessKeySecret = getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET');
$client = self::createClient($accessKeyId, $accessKeySecret);
// Scenario 1: Use a local file.
//$file = fopen('/tmp/sfzbm1.jpg', 'rb');
//$stream = new Stream($file);
// Scenario 2: Use a publicly accessible URL.
$file = fopen('http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/ocr/RecognizeIdentityCard/sfzbm1.jpg', 'rb');
$stream = new Stream($file);
$recognizeIdentityCardAdvanceRequest = new RecognizeIdentityCardAdvanceRequest([
"imageURLObject" => $stream,
"side" => "back"
]);
$runtime = new RuntimeOptions([]);
try {
$resp = $client->recognizeIdentityCardAdvance($recognizeIdentityCardAdvanceRequest, $runtime);
# Get the complete response.
echo Utils::toJSONString($resp->body);
} catch (Exception $exception) {
# Get the complete error message.
echo Utils::toJSONString($exception);
# Get a specific field from the error message.
echo $exception->getCode();
}
}
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
require_once $path;
}
// $argv is a reserved parameter for array input. You do not need to modify it.
RecognizeIdentityCardAdvance::main(array_slice($argv, 1));
// Install the dependency.
// npm install @alicloud/ocr20191230
const OcrClient = require('@alicloud/ocr20191230');
const OpenapiClient = require('@alicloud/openapi-client');
const TeaUtil = require('@alicloud/tea-util');
const fs = require('fs');
const http = require('http');
const https = require('https');
let config = new OpenapiClient.Config({
// For information about how to create an AccessKey ID and AccessKey Secret, see https://help.aliyun.com/document_detail/175144.html.
// If you use a RAM user's AccessKey, you must grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see https://help.aliyun.com/document_detail/145025.html.
// Read the AccessKey ID and AccessKey Secret from environment variables. You must configure environment variables before running the sample code.
accessKeyId: process.env.ALIBABA_CLOUD_ACCESS_KEY_ID,
accessKeySecret: process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET
});
// The endpoint of the service.
config.endpoint = `ocr.cn-shanghai.aliyuncs.com`;
const client = new OcrClient.default(config);
const getResponse = function (httpClient, url) {
return new Promise((resolve, reject) => {
httpClient.get(url, function (response) {
resolve(response);
})
})
}
const request = async function () {
try {
const client = new OcrClient.default(config);
let recognizeIdentityCardAdvanceRequest = new OcrClient.RecognizeIdentityCardAdvanceRequest();
// Scenario 1: Use a local file.
// const fileStream = fs.createReadStream('/tmp/sfzbm1.jpg');
// recognizeIdentityCardAdvanceRequest.imageURLObject = fileStream;
// recognizeIdentityCardAdvanceRequest.side = "back";
// Scenario 2: Use a publicly accessible URL.
const url = new URL("http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/ocr/RecognizeIdentityCard/sfzbm1.jpg");
const httpClient = (url.protocol == "https:") ? https : http;
recognizeIdentityCardAdvanceRequest.imageURLObject = await getResponse(httpClient, url);
recognizeIdentityCardAdvanceRequest.side = "back";
let runtime = new TeaUtil.RuntimeOptions({ });
client.recognizeIdentityCardAdvance(recognizeIdentityCardAdvanceRequest, runtime)
.then(function(recognizeIdentityCardResponse) {
// Get the complete response.
console.log(recognizeIdentityCardResponse);
// Get a specific field from the response.
console.log(recognizeIdentityCardResponse.body.data);
}, function(error) {
// Get the complete error message.
console.log(error);
// Get a specific field from the error message.
console.log(error.data.Code);
})
} catch (error) {
console.log(error);
}
}();
/**
This project depends on github.com/alibabacloud-go/ocr-20191230/v3.
We recommend that you run the go mod tidy command to install the dependency.
*/
package main
import (
"fmt"
openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
ocr20191230 "github.com/alibabacloud-go/ocr-20191230/v3/client"
util "github.com/alibabacloud-go/tea-utils/v2/service"
"github.com/alibabacloud-go/tea/tea"
"net/http"
)
func main() {
// For information about how to create an AccessKey ID and AccessKey Secret, see https://help.aliyun.com/document_detail/175144.html.
// If you use a RAM user's AccessKey, you must grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see https://help.aliyun.com/document_detail/145025.html.
// Read the AccessKey ID and AccessKey Secret from environment variables. You must configure environment variables before running the sample code.
accessKeyId := os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")
accessKeySecret := os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
// Initialize the configuration object &openapi.Config. This object stores configuration parameters such as your AccessKey ID, AccessKey Secret, and endpoint.
config := &openapi.Config{
AccessKeyId: tea.String(accessKeyId),
AccessKeySecret: tea.String(accessKeySecret),
}
// The endpoint of the service.
config.Endpoint = tea.String("ocr.cn-shanghai.aliyuncs.com")
client, err := ocr20191230.NewClient(config)
if err != nil {
panic(err)
}
// Scenario 1: Use a local file.
//file, err := os.Open("/tmp/RecognizeIdentityCard.jpg")
//if err != nil {
// fmt.Println("can not open file", err)
// panic(err)
//}
//recognizeIdentityCardAdvanceRequest := &ocr20191230.RecognizeIdentityCardAdvanceRequest{
// ImageURLObject: file,
// Side: tea.String("back"),
//}
// Scenario 2: Use a publicly accessible URL.
httpClient := http.Client{}
file, _ := httpClient.Get("http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/ocr/RecognizeIdentityCard/sfzbm1.jpg")
recognizeIdentityCardAdvanceRequest := &ocr20191230.RecognizeIdentityCardAdvanceRequest{
ImageURLObject: file.Body,
Side: tea.String("back"),
}
runtime := &util.RuntimeOptions{}
recognizeIdentityCardResponse, err := client.RecognizeIdentityCardAdvance(recognizeIdentityCardAdvanceRequest, runtime)
if err != nil {
// Get the complete error message.
fmt.Println(err.Error())
} else {
// Get the complete response.
fmt.Println(recognizeIdentityCardResponse)
}
}
// Install the dependency.
// dotnet add package AlibabaCloud.SDK.Ocr20191230
using System;
using System.Collections;
using System.Collections.Generic;
using System.Drawing;
using System.IO;
using System.Net;
using System.Threading.Tasks;
using AlibabaCloud.SDK.Imageenhan20190930.Models;
using AlibabaCloud.SDK.Ocr20191230.Models;
using Tea;
using Tea.Utils;
namespace AlibabaCloud.SDK.Sample
{
public class Sample
{
/**
* Initialize the client with an AccessKey ID and AccessKey Secret.
* @param accessKeyId
* @param accessKeySecret
* @return Client
* @throws Exception
*/
public static AlibabaCloud.SDK.Ocr20191230.Client CreateClient(string accessKeyId, string accessKeySecret)
{
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config
{
AccessKeyId = accessKeyId,
AccessKeySecret = accessKeySecret,
};
// The endpoint of the service.
config.Endpoint = "ocr.cn-shanghai.aliyuncs.com";
return new AlibabaCloud.SDK.Ocr20191230.Client(config);
}
public static void Main(string[] args)
{
// For information about how to create an AccessKey ID and AccessKey Secret, see https://help.aliyun.com/document_detail/175144.html.
// If you use a RAM user's AccessKey, you must grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see https://help.aliyun.com/document_detail/145025.html.
// Read the AccessKey ID and AccessKey Secret from environment variables. You must configure environment variables before running the sample code.
string accessKeyId = System.Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID");
string accessKeySecret = System.Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
AlibabaCloud.SDK.Ocr20191230.Client client = CreateClient(accessKeyId, accessKeySecret);
AlibabaCloud.SDK.Ocr20191230.Models.RecognizeIdentityCardAdvanceRequest recognizeIdentityCardAdvanceRequest = new AlibabaCloud.SDK.Ocr20191230.Models.RecognizeIdentityCardAdvanceRequest
();
// Scenario 1: Use a local file.
// System.IO.StreamReader file = new System.IO.StreamReader(@"/tmp/sfzbm1.jpg");
// recognizeIdentityCardAdvanceRequest.ImageURLObject = file.BaseStream;
// recognizeIdentityCardAdvanceRequest.Side = "back";
// Scenario 2: Use a publicly accessible URL.
HttpWebRequest request = (HttpWebRequest)WebRequest.Create("http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/ocr/RecognizeIdentityCard/sfzbm1.jpg");
WebResponse response = request.GetResponse();
Stream stream = response.GetResponseStream();
recognizeIdentityCardAdvanceRequest.ImageURLObject = stream;
recognizeIdentityCardAdvanceRequest.Side = "back";
AlibabaCloud.TeaUtil.Models.RuntimeOptions runtime = new AlibabaCloud.TeaUtil.Models.RuntimeOptions();
try
{
AlibabaCloud.SDK.Ocr20191230.Models.RecognizeIdentityCardResponse recognizeIdentityCardResponse = client.RecognizeIdentityCardAdvance(recognizeIdentityCardAdvanceRequest, runtime);
// Get the complete response.
Console.WriteLine(AlibabaCloud.TeaUtil.Common.ToJSONString(recognizeIdentityCardResponse.Body));
// Get a specific field from the response.
Console.WriteLine(AlibabaCloud.TeaUtil.Common.ToJSONString(recognizeIdentityCardResponse.Body.Data));
}
catch (TeaException error)
{
// Print the error if necessary.
AlibabaCloud.TeaUtil.Common.AssertAsString(error.Message);
}
catch (Exception _error)
{
TeaException error = new TeaException(new Dictionary<string, object>
{
{ "message", _error.Message }
});
// Print the error if necessary.
Console.WriteLine(error.Message);
}
}
}
}