Skip to main content
Send an image of the front of an ID (and the back if needed), and ID-OCR recognizes the ID type and returns the printed fields.
  • If you also send the back and it is recognized, 2 sides are billed. If the back is not recognized, 1 side is billed.
  • If the front cannot be recognized, the call returns 502 ID_NOT_RECOGNIZED and is not billed.

Notes

  • Which fields are returned depends on the ID type, issuing country, and recognition result. Treat every field as optional.
  • Recognized values and confidence can change for the same image when the engine changes. Store engineVersion with the result.

Billing

The billing unit is recognition, and count is the number of recognized sides. Check the values actually applied in the response’s billing.

Specification

ID-OCR specification

Check the endpoint, request and response fields with examples, and errors.
For errors that apply to all APIs, see Error Codes.