v1

latestOpenAPI 3.0.32026-07-23152665.5 KB

Biometric KYC

Submit Biometric KYC verification

Combines biometric selfie verification with KYC identity checks against the relevant ID authority. The selfie and liveness images are uploaded alongside identity details (country, id_type, id_number), validated at entry, then processed asynchronously. Results are delivered via callback URL.

post/v3/biometric_kyc

Headers

SmileID-Partner-IDstring required

Partner identifier (numeric, 3+ digits).

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. Required when your Smile ID account is configured to use SDK/partner secret HMAC authentication.

SmileID-Request-Signaturestring

HMAC signature of the raw HTTP request body, computed with your SDK/partner secret and the value of SmileID-Timestamp as salt. Required when your Smile ID account is configured to use SDK/partner secret HMAC authentication.

User-IDstring

Partner-provided user identifier. If omitted, a TypeID is generated automatically.

Response

Accepted — verification submitted 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.