Skip to navigation

Renew the FaceTec session token

Issues a new FaceTec session token for a pending method: facetec_sdk verification. Tokens live 10 minutes at the provider; the one returned by the create is enough when the camera opens right away. Call this route when the app comes back from background, when /facetec/process answered facetec_session_expired, or right before opening the camera after a long wait. It can be called at any time while the verification is PENDING.

Throttle: at most 1 renewal every 5 seconds and 30 per verification (429 facetec_session_renewal_limited).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

verificationIdstringRequired
Standalone identity verification identifier returned by the creation endpoint.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.
X-FaceTec-User-AgentstringOptional

Value of FaceTecSDK.createFaceTecAPIUserAgentString("") from the SDK. Recommended.

Idempotency-KeystringOptional

Optional client-generated idempotency token (recommended for safe retries).

X-Request-TimestampstringRequired

Unix seconds. Required on the signed host; tolerance is 300s either way (403 request_timestamp_skew).

X-Content-SHA256stringRequired

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.

X-Request-SignaturestringRequired

Detached JWS (<protected>..<signature>, ES256 or PS256) over METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256.

Response

New session token.
verificationIdstring
sessionTokenstring
sessionTokenExpiresAtdatetime
attemptsRemaininginteger

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error