ID Verification:Synchronous call - CREDENTIAL_RECOGNITION

Name

Type

Required

Description

Example

ProductCode

string

Yes

The value is fixed to CREDENTIAL_RECOGNITION.

CREDENTIAL_RECOGNITION

CredentialOcrPictureBase64

string

No

The Base64-encoded image. If you use this method, check the image size to ensure it is not too large.

-

CredentialOcrPictureUrl

string

No

The URL of the image. The URL must be an HTTP or HTTPS link that is accessible from the public network.

https://***

DocType

string

Yes

The credential type:

• 01: Transaction receipt. This includes images of various electronic bills, such as water, electricity, gas, and credit card bills.

• 03: Transaction record for a transfer.

01

OcrArea

string

Yes

The extraction type:

• 0101: Address and name module from an electronic bill. The address and name modules are extracted through intelligent analysis.

• 0301: Amount from a transaction record for a transfer.

0101

FraudCheck

string

Yes

Specifies whether to enable tampering detection.

• true: Enable

• false: Disable

true

Name

Type

Description

Example

HTTP Status Code

Integer

The HTTP status code.

200

HTTP Body

RequestId

String

The request ID.

130A2C10-B9EE-4D84-88E3-5384FF039****

Result.TransactionId

String

The unique ID for the entire process.

hksb7ba1b28130d24e015d694361b****

Code

String

Return codes.

Success

Message

String

The response message.

success

Result.Success

String

The extraction result:

• S: Success

• F: Failed

S

Result.SubCode

String

A description of the verification result. For more information, see ResultObject.SubCode error codes.

200

Result.ExtIdInfo

String

For the JSON format, see the example on the right. For more information, see Result.ExtIdInfo.

• If the OcrArea request parameter is set to 0101:

  {
    // If tampering detection is enabled (FraudCheck = true), spoofInfo is returned.
    "spoofInfo":
    {
      "spoofResult": "Y",
      "spoofType": "PS,SCREEN_PHOTO,ORIGINAL_PHOTO"
    },
    "recInfo":
    {
      "address": "Yingfeng Street, Xiaoshan District, Hangzhou, Zhejiang Province***",
      "name": "John Doe"
    }
  }

• If the OcrArea request parameter is set to 0301:

  {
    // If tampering detection is enabled (FraudCheck = true), spoofInfo is returned.
    "spoofInfo":
    {
      "spoofResult": "Y",
      "spoofType": "PS,SCREEN_PHOTO,ORIGINAL_PHOTO"
    },
    "recInfo":
    {
      "money": "$41.41"
    }
  }

HTTP status code

Code

Message description

200

Success

The request was successful.

400

MissingParameter

A parameter is empty.

400

InvalidParameter

The parameter is invalid.

403

Forbidden.RAMUserAccessDenied

The RAM user must be granted the AliyunAntCloudAuthFullAccess permission. For more information, see Grant permissions to a RAM user to access the service.

403

Forbidden.AccountAccessDenied

Your account has an overdue payment. Add funds to your account and try again.

403

Throttling.Api

The request is blocked by API throttling.

500

InternalError

An internal system error occurred. Contact engineers for troubleshooting.

Error code

Billed

Description and suggestion

200

Yes

Extraction successful.

213

Yes

No text was extracted.

Name

Type

Description

Example

recInfo

String

The extracted key information.

• If the OcrArea request parameter is set to 0101:

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

• If the OcrArea request parameter is set to 0301:

  {
    "money": "$41.41"
  }

spoofInfo

String

The result of the credential anti-spoofing check. It includes the risk assessment result and risk type:

• spoofResult:

  • Y: Risk detected

  • N: Normal

• spoofType:

  • PS: The image was edited with software.

  • SCREEN_PHOTO: The image is a photo of a screen.

  • SCREENSHOT: The image is a screenshot.

  • ORIGINAL_PHOTO: The image is not the original one.

This result is returned when tampering detection is enabled (the FraudCheck request parameter is set to true).

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