Skip to navigation

Relay one biometry SDK round

Forwards one SDK blob and returns the blob the SDK expects next. Body limit is 5 MB.

Path parameters

tokenstringRequired
Opaque capture token from the accreditation link or from the issue endpoint.

Headers

X-FaceTec-User-AgentstringOptional

Optional. Value of FaceTecSDK.createFaceTecAPIUserAgentString("") when your SDK provides it; forwarded to the provider.

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.
Idempotency-KeystringOptional

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

Request

This endpoint expects an object.
requestBlobstringRequired
sessionTokenstringRequired
featurestringOptional

Response

Opaque blob for the SDK plus the round status.
responseBlobstringOptional
statusstringOptional
retryAllowedbooleanOptional

Errors

409
Conflict Error