SMsmileidentity
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

Request

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.

Request body multipart/form-data

selfie_imagestring binary required

JPEG selfie image used for biometric verification. Must be a clear, well-lit, front-facing photo.

liveness_imagesstring[] required

Array of JPEG liveness sequence images captured during the liveness check. These images are used for passive and active liveness verification.

countrystring required

ISO 3166-1 alpha-2 country code (uppercase). Can be provided via the token payload (bound at /v3/token) instead of the request body.

id_typestring required

ID document type (e.g., NIN, BVN, DRIVERS_LICENSE). Can be provided via the token payload (bound at /v3/token) instead of the request body.

id_numberstring required

ID document number. Must match the regex format for the country/id_type. Can be provided via the token payload (bound at /v3/token) instead of the request body.

callback_urlstring uri

URL to receive the async result callback. Falls back to partner default if omitted. Must be on the partner's allowed callback domains list. Can be provided via the token payload (bound at /v3/token) instead of the request body.

sandbox_resultnumber

Force a specific result code in sandbox/test environments. Only effective when the partner account is in sandbox mode.

partner_paramsobject

Arbitrary key-value metadata for partner reference.

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.

Changes

No recorded changes to this operation across all 1 revision of this API.