SMsmileidentity
Smart Selfie Compare

Submit smart selfie compare

Compares a selfie image against a provided comparison image (document, ID photo, or portrait). The images are uploaded, validated at entry, then queued for async ML processing (passive liveness, face matching, optional active liveness with liveness images). Results are delivered via callback URL. If user_id is provided and the comparison passes, the user will be enrolled.

post/v3/compare

Request

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. If omitted, a TypeID is generated automatically.

Request body multipart/form-data

selfie_imagestring binary required

JPEG selfie image.

comparison_imagestring binary required

JPEG comparison image (ID card photo, ID photo, or portrait).

comparison_image_type'DOCUMENT' | 'ID_PHOTO' | 'PORTRAIT' required

Type of comparison image being submitted.

liveness_imagesstring[]

Optional array of JPEG liveness images. If omitted, active liveness check is skipped.

allow_new_enrollboolean

If true, allows re-enrollment for a user who is already enrolled.

user_idstring

Optional user identifier. If provided and the job passes, the user will be enrolled.

callback_urlstring uri

URL to receive the async result callback.

sandbox_resultnumber

Force a specific result code in sandbox mode.

partner_paramsobject

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.

Changes

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