v1

latestOpenAPI 3.0.32026-07-23152665.5 KB

Biometric Authentication

Submit biometric authentication

Authenticates a user by comparing a submitted selfie against their enrolled image. The selfie and liveness images are uploaded, validated at entry, then queued for async ML processing (passive liveness, active liveness, face matching). Results are delivered via callback URL. Supports use_enrolled_image: true to skip selfie/liveness upload and re-use the enrolled image for the comparison (useful for server-side re-verification).

post/v3/authentication

Headers

SmileID-Source-SDKstring

Source SDK identifier.

SmileID-Source-SDK-Versionstring

Source SDK version.

SmileID-Timestampstring date-time

ISO 8601 timestamp used as the salt when computing SmileID-Request-Signature.

SmileID-Request-Signaturestring

HMAC signature of the raw HTTP request body.

User-IDstring

Partner-provided user identifier override.

Response

Accepted — job queued for async processing.

status'accepted' required

Acceptance status for queued verification requests.

messagestring required

Human-readable acceptance message.

job_idstring required

TypeID format verification identifier for tracking.

user_idstring required

TypeID format user identifier, or partner-provided user identifier.

created_atstring date-time required

ISO 8601 timestamp of when the verification was created.