# ID identification

Interface should be called on the server side, not in the front end (Weixin Mini Program, web pages, APP, etc.) directly called, specific reference interface call guide

Interface name: idcardOcr

This interface provides the OCR identification function of the front and back of the body card.

This interface is a back-office interface and can be based on your own business undertaking,When used together with Weixin Mini Program photography, album selection, etc., it can complete the collection, upload, identification, information return, etc. of ID card photos, for business scenarios that require the collection of photos or text information based on physical cards or certificates such as ID card or bank card.

Support for authenticated subscription number, Service Account, Weixin Mini Program, Service Account can be directly called, the number is limited to 100 times / day.If there is a higher amount of call demand, you can go to service platform for purchase.

# 1. How to call

# HTTPS calls

POST https://api.weixin.qq.com/cv/ocr/idcard?access_token=ACCESS_TOKEN&img_url=IMG_URL

# Cloud Calls

  • Call method: ocr.idcard

  • The input and exit parameters are the same as the HTTPS call, which can be called in the cloud call documentation

# Third party invocation

  • This interface supports Third Party Platform generation business call.

  • The permission set to which this interface belongs is id: 117

  • When a service provider is authorized by one of the permissions set, it can call on behalf of the merchant by using authorizer_access_token , which can be viewed in the third-party call documentation.

# 2. Request parameters

# Query parametersQuery String parameters

Parameter NametypeRequired to fill inExampleIntroductions
access_tokenstringyesACCESS_TOCKENInterface invocation credentials, using access_token , authorizer_access_token
img_urlstringnoENCODE_URLTo detect the image url, pass this without passing the img parameter.

# Request BodyRequest Payload

Parameter NametypeRequired to fill inIntroductions
imgformdatanoForm-data in the media file identification, filename, filelength, content-type and other information, you do not need to pass this img_url.

# 3. Return Parameters

# Response Payload

Parameter NametypeIntroductions
errcodenumberError code
errmsgstringError message
typestringFront or Back, Front / Back
namestringReturn head to head, name
idstringBack in front, ID number
valid_datestringReturned back, validity period
addrstringBack directly, address
genderstringForward return, gender
nationalitystringReturning head to head, nationality

# 4. Note

  1. Image support using img parameter real-time upload, also support using img_url parameter transfer image address, by WeChat background download image recognition.
  2. File size limit: less than 2 M

# 5. Code examples

Example Requests

curl -F ‘img=@test.jpg’“https://api.weixin.qq.com/cv/ocr/idcard?type=photo&access_token=ACCESS_TOCKEN”

Return an example

{
  "errcode": 0,
  "errmsg": "ok",
  "type": "Front",
  "name": "张三",
  "id": "123456789012345678",
  "addr": "广东省广州市XXX",
  "gender": "男",
  "nationality": "汉"
}

# 6. Error code

The following is a list of error codes for this interface, other error codes can refer to General error codes

Error codeError DescriptionSolutions
-1system errorA system error
40001invalid credential  access_token isinvalid or not latestAppSecret error while getting access_token, or access_token is invalid.Developers should check that AppSecret is correct, or that they are calling interfaces for the appropriate Official Account
101000invalid image urlImage URL error
101001certificate not foundNo documents were detected
101002decode image failedImage size over limit, resp_type = 0: 2MB, resp_type = 1: 10MB
101003not enough market quota

# 7. Scope of application

How this interface can be invoked under different account types:
Weixin Mini Program Official Account Service Account
Certification only Certification only
  • ✔: The account can call this interface
  • Authentication only: means that only authenticated accounts are allowed to be invoked by the enterprise entity, and accounts that are not authenticated or do not support authentication cannot be invoked.
  • Other account types that are not expressly stated may not be called on this interface without special instructions;