Query results - ID Verification - Alibaba Cloud Documentation Center

This topic describes the API for querying the results of an asynchronous credential recognition task. Before you call this API, you must first submit a recognition task by calling the Submit task API.

API information

API name: CredentialGetResultIntl
Description: Uses AI to extract key information from a credential image or PDF file and supports forgery detection.
Request method: POST
Transport protocol: HTTPS
QPS limit: Each API has its own QPS limit. For more information, see QPS limits of ID Verification server-side APIs.
Endpoint:
Note
- Benefits of internal network access: An internal network is a private communication network connecting Alibaba Cloud products within the same region. If your application server is deployed in the same region, use the internal endpoint to access the ID Verification service for enhanced security and stability.
- Optimizing overseas access: Overseas network environments can be complex. Refer to Optimize server network latency to tune your integration and reduce network latency and request failures.
Asia Pacific SE 1 (Singapore)
- Public endpoint: cloudauth-intl.ap-southeast-1.aliyuncs.com
- Internal endpoint: cloudauth-intl-vpc.ap-southeast-1.aliyuncs.com

Online debugging and integration

Note

Before debugging and integration, read the Use OpenAPI document to learn how to call APIs on the OpenAPI platform and obtain the SDK.

You can use OpenAPI Explorer to debug this API and generate SDK sample code.

Request parameters

Parameter	Type	Required	Description	Example
TransactionId	String	Yes	The unique ID for the task. This value is returned by the CredentialSubmitIntlV2 API.	hksb7ba1b28130d24e015d6********

Response parameters

Parameter		Type	Description	Example
HTTP Status Code		Integer	The HTTP status code.	200
HTTP Body	RequestId	String	The request ID.	130A2C10-B9EE-4D84-88E3-5384FF039****
	Code	String	The return code. For more information, see Server-side HTTP status codes. Important This parameter indicates whether the API call was successful. For the verification result, check the fields in the Result object.	Success
	Message	String	The response message.	success
	Result.Status	String	The task status. Valid values: PROCESSING: The task is in progress. Continue polling. SUCCESS: The task was successful. FAILED: The task failed.	SUCCESS
	Result.SubCode	String	The verification result code. For more information, see Error codes for Result.SubCode.	200
	Result.ExtIdInfo	String	For the JSON format, see the example on the right. For more information, see Result.ExtIdInfo.	The data returned by this API depends on the value of the `OcrArea` parameter specified in the Submit task request. The rules are as follows: If the `OcrArea` request parameter is set to `0101`: `{ // When tampering detection is enabled (FraudCheck = true), spoofInfo is returned. "spoofInfo": { "spoofResult": "Y", "spoofType": ["PS", "SCREEN_PHOTO", "ORIGINAL_PHOTO"] }, "recInfo": { "address": "Yingfeng Subdistrict, Xiaoshan District, Hangzhou City, Zhejiang Province***", "name": "Zhang San" } }` If the `OcrArea` request parameter is set to `0301`: `{ // When tampering detection is enabled (FraudCheck = true), spoofInfo is returned. "spoofInfo": { "spoofResult": "Y", "spoofType": ["PS", "SCREEN_PHOTO", "ORIGINAL_PHOTO"] }, "recInfo": { "money": "$41.41" } }` If the `OcrArea` request parameter is set to `0401`: `{ "translateInfo": { "address_t": "1/176-C China", "name_t": "SSS SSS SSS" }, "standardInfo": { "date_of_issue_s": "2010-06-05" }, "spoofInfo": { "spoofResult": "Y", "spoofType": ["PS", "SCREEN_PHOTO", "ORIGINAL_PHOTO"] }, "checkInfo": { "address_rule": "Y", "date_of_issue_rule": "Y", "name_rule": "Y" }, "recInfo": { "address": "1/176-C China", "date_of_issue": "06/05/2010", "name": "SSS SSS SSS" } }`

Error codes for Result.SubCode

Error code	Billing	Description
200	Yes	Extraction successful.
204	Yes	Key information failed the validation rules specified in CheckRuleConfig.
211	Yes	Poor file quality or resolution. Ensure the file is clear, well-exposed, complete, unobstructed, and not significantly skewed.
212	Yes	The anti-spoofing check detected a risk. This may be caused by indicators such as screen photo, tampering, or photocopying.
213	Yes	Incorrect file type. Ensure the file type matches the DocType parameter.

Result.ExtIdInfo

Parameter

Type

Description

Example

recInfo

String

The key information extracted, returned in JSON format.

The JSON fields vary by credential type. For more information, see Credential field descriptions.

Note

If the extraction fails, this field is empty.

The data returned by this API depends on the value of the OcrArea parameter specified in the Submit task request. The rules are as follows:

If the OcrArea request parameter is set to 0101:

{
  "address": "Yingfeng Subdistrict, Xiaoshan District, Hangzhou City, Zhejiang Province***",
  "name": "Zhang San"
}

If the OcrArea request parameter is set to 0202:

 "recInfo":
  {
    "Registration Mark": "PV5721"  
  }

If the OcrArea request parameter is set to 0301:
```
{
  "money": "$41.41"
}
```

spoofInfo

String

The anti-spoofing check result, which includes the risk decision and risk type:

spoofResult:
- Y: A risk is detected.
- N: No risk detected
spoofType:
- PS: image editing
- SCREEN_PHOTO: photo of a screen
- SCREENSHOT: screenshot
- ORIGINAL_PHOTO: non-original image

This result is returned when tampering detection is enabled (that is, the FraudCheck parameter is set to true in the Submit task request).

{
  "spoofResult": "Y",
  "spoofType": [
    "PS"
  ]
}

Credential field descriptions

Credential type: Thai vehicle registration certificate (OcrArea=0201)

Field information:

Field	Type	Description
first_registration_date	String	Date of first registration
license_number	String	License plate number
registration_province	String	Registration province
vehicle_type	String	Vehicle type
make	String	Make
model	String	Model
color	String	Color
title_holder	String	Title holder
holder_id_number	String	ID number of the title holder
user_name	String	User
user_id_number	String	ID number of the user
displacement	String	Displacement
model_year	String	Model year
engine_number	String	Engine number
fuel_type	String	Fuel type
seating_capacity	String	Seating capacity
engine_specifications	String	Engine specifications
VIN	String	Vehicle Identification Number
vehicle_kerb_weight	String	Vehicle kerb weight
address	String	Address

Credential type: Hong Kong Vehicle Registration Document (OcrArea=0202)