Consume an approved identity verification
Atomically marks an approved verification as consumed. purpose and
referenceId must exactly match the values stored at creation, the
status must be APPROVED, and the call must arrive no later than
consumableUntil.
The exact retry — same verificationId, purpose and referenceId —
is idempotent and returns the already-consumed result. A different
purpose/reference, a competing consume, a non-approved terminal state
or an expired consumption window returns 409.
Requires a master M2M credential, the identity_verification.manage
scope and X-Tenant-Id.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Headers
Optional client-generated idempotency token (recommended for safe retries).
Unix seconds. Required on the signed host; tolerance is 300s either way (403 request_timestamp_skew).
Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns 400 body_hash_mismatch.
Detached JWS (<protected>..<signature>, ES256 or PS256) over METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256.
Request
Must exactly equal the referenceId supplied at creation.
Response
Caller-owned journey identifier supplied at creation.
How the person is captured. link (default) opens the provider’s
hosted page via verificationLink; facetec_sdk means your app
embeds the FaceTec SDK v10 and sends captures to /facetec/process.
Only for method: facetec_sdk. none = liveness only (proves a live
person, not who they are); dracma (default) = liveness + 1:1 face
match against DracmaTrust’s reference for the CPF; image = liveness
- 1:1 face match against the
referenceImageyou send in/facetec/process.
Present only while status is PENDING and method is link.
Failed captures still allowed. Only for method: facetec_sdk.
Per-capability result, read separately from the aggregate status.
faceMatch.result is not_performed when referenceMatch is none:
an APPROVED in that mode only proves liveness.
Provider-normalized reason when the journey failed or expired; otherwise null or omitted.
Terminal transition time for APPROVED, FAILED or EXPIRED.
Last instant at which an approved result may be consumed. Set for APPROVED.
First successful consume time; null or omitted until consumption.