SMsmileidentity
Document Verification

Submit Document Verification

Verifies a user's identity by comparing a selfie against a document image. The selfie and liveness images are uploaded alongside a document photo (front, and optionally back). The id_type is optional — the document type is auto-classified if not provided. Results are delivered asynchronously via callback URL.

post/v3/document_verification

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 liveness verification.

documentstring binary required

Front of the identity document (JPEG or PNG). Used for document verification.

document_backstring binary

Back of the identity document (JPEG or PNG). Optional. Provide when the document has relevant information on the back (e.g., barcodes, MRZ on some document types).

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

ID document type (e.g., DRIVERS_LICENSE, NATIONAL_ID). Optional for standard Document Verification — the document type is auto-classified if not provided. 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.

partner_paramsobject

Arbitrary key-value metadata for partner reference.

Response

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