ident-yAPI reference

API changes

v1.0.0 · 13 October 2026

Initial API: document OCR (one or two sides), document authenticity, face liveness and face comparison. Separate production and sandbox credentials, multipart JPEG/PNG uploads, JSON responses, explicit quotas and Retry-After.

Versioning and notifications

Changes are published on this page with the updated OpenAPI contract. New optional response fields may be added within v1; integrations should ignore fields they do not use. Breaking request or response changes require a new major URL, such as /api/v2, and a migration plan.

When access is issued, agree a technical contact and notification channel with the API operator. Planned breaking changes and deprecation notices are sent through that channel before migration; critical security notices are sent as soon as possible. Keep that contact current.

Download the current OpenAPI contract