Domain name for API request: ocr.intl.tencentcloudapi.com.
This API is used to obtain document recognition results.
A maximum of 20 requests can be initiated per second for this API.
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: GetCardVerificationExternalResult. |
| Version | Yes | String | Common Params. The value used for this API: 2018-11-19. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-singapore. |
| CardVerificationToken | Yes | String | Initiates the recognition interface and returns a unique token. |
| Parameter Name | Type | Description |
|---|---|---|
| Status | String | Verification status. Valid values: PROCESSING ABNORMAL COMPLETED |
| WarnInfo | Array of String | Anti-counterfeiting information. - ScreenshotSuspected: The image is a screenshot. - RetakeSuspected: The image is taken from another screen. - PaperCopy: The image is a black and white, or color photocopy. - FakeSuspected: The image of the card, or the information on the card has been edited or altered. - PoorImageQuality: The image is bad quality. - InformationVerificationFailed: Information verification failed based on OCR recognition results - TooManyCards: Multiple cards present in the frame. - IncompleteCard: Captured document is incomplete. - OtherWarning: Document's authenticity is not verified for various reasons. Note: This field may return null, indicating that no valid values can be obtained. |
| CardInfo | GeneralCard | Front-side document recognition results. Note: This field may return null, indicating that no valid values can be obtained. |
| BackCardInfo | GeneralCard | Back-side document recognition results. Note: This field may return null, indicating that no valid values can be obtained. |
| CardVerificationToken | String | The token passed in the input parameters. |
| HeadImageBase64 | String | Base64-encoded head image from the document. If ReturnHeadImage was set to false or not provided in the request, this field returns an empty string. If ReturnHeadImage was set to true and this field returns an empty string, indicating a failure to extract the head image extraction failed. Please check the input document photo. |
| 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. |
POST / HTTP/1.1
Host: ocr.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetCardVerificationExternalResult
<Common request parameters>
{
"CardVerificationToken": "9943345f-a690-4220-a749-9c68518f2e17"
}
{
"Response": {
"CardInfo": {
"Address": {
"City": "",
"Country": "",
"FormattedAddress": "",
"LineFive": "",
"LineFour": "",
"LineOne": "",
"LineThree": "",
"LineTwo": "",
"PostalCode": "",
"Subdivision": ""
},
"Age": "",
"BirthPlace": "SAN FELIPE ZBS",
"Birthday": "1997/10/01",
"DueDate": "",
"ExpirationDate": "2033/10/19",
"FirstName": "IVY ROSE",
"FirstNameLocal": "IVY ROSE",
"FullName": "GOLIMLIM EREDIA IVY ROSE",
"FullNameLocal": "GOLIMLIM EREDIA IVY ROSE",
"IssuedAuthority": "DFA TARLAC",
"IssuedCountry": "Philippines",
"IssuedDate": "2023/10/20",
"LastName": "GOLIMLIM",
"LastNameLocal": "GOLIMLIM",
"LicenseNumber": "P5784986C",
"Nationality": "PHL",
"PassportCodeFirst": "",
"PassportCodeSecond": "",
"PersonalNumber": "P5784986C",
"RegistrationNumber": "",
"Sex": "FEMALE"
},
"CardVerificationToken": "9943345f-a690-4220-a749-9c68518f2e17",
"Nationality": "PHL",
"Status": "PASSED",
"WarnInfo": null,
"RequestId": "d4413701-8afc-48e1-920f-defd04157c65"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.OcrFailed | OCR recognition failed. This error may be caused by unstable network connections, service anomalies, or other issues. |
| FailedOperation.UnKnowError | Unknown error. |
| FailedOperation.UnOpenError | The service has not been activated. |
| InvalidParameterValue.InvalidParameterValueLimit | Incorrect parameter value. |
| ResourceUnavailable.InArrears | The account has insufficient balance. |
| ResourceUnavailable.ResourcePackageRunOut | The resource package has been exhausted. |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários