ID Recognition API Reference

The standalone Carmen Worker serves the PR API under /pr22. Use POST /pr22/{region} to read an identity document and GET /pr22/capabilities to inspect supported scan modes and limits. Enable an appropriate PR engine and configure private transaction storage before calling the API.

The Worker defaults to API version 2.0. Send X-Api-Version: 2.0 and an explicit X-Scan-Mode for a portable structured contract. The modes, multipart inputs, transaction lifecycle and result shapes are explained in the ID Recognition API guide; the guide's Cloud URL and API-key example apply to the Cloud service, so use your Worker's own origin and access configuration instead.

Configure the private S3-compatible bucket, signed download endpoint, retention and optional AMQP notifications as described in Carmen Worker configuration. Worker AMQP can emit intermediate batch events; filter on isFinal for final events. Previously written artifacts remain unchanged.