Let's get to work!

Actions are performed using Jobs‌.

A Job is an instance of an Action or a combination of Actions performed on images and/or other data. Jobs are a useful tool in combining and performing multiple Actions at once.

Jobs are a short cut for you to complete your objective. We categorize Jobs using a Job Type. Job Types represent set of commonly combined Actions where most Job types perform a set of actions but some may offer a single Action.

When You Start Development, First, decide on which Actions you wish to perform Second, choose a Product (integration method) that supports those Actions. Finally, run Jobs that perform the relevant Actions.

Job Types

job_typeis the classifier that tells Smile Identity what kind of Job you are running. Each job type is numbered so the system knows what set of Actions to execute.

The most common job types are:

  • Register a face with an ID (Job Type 1, previously "enroll," via Web API or SDK)

  • Authenticate a face (Job Type 2, via Web API or SDK)

  • Validate an ID (Job Type 5, via either ID API or Web API)

Most other job types are variations on one of these three types, and some use different configurations.For example, you may wish to send a job that requires a higher threshold to be approved. In order to do so, you would use one of the variations. You may supply an optional job_type parameter to the auth_smile endpoint. Similarly, when you implement your own auth_smile endpoint, you can return alternate values in the partner_params.

All valid job types are listed below. Any value for job_type that is not in the following list will result in an error preventing the job from running.

Valid Job Types:


Register with ID

Verify an ID

Take a Selfie

Compare the Selfie with the ID Authority Photo



Take a Selfie

Compare the Selfie with the Selfie provided during a successful Registration


Register without ID

Take a Selfie


ID Validation

Verify an ID


Update Photo

Take a Selfie

Compare the Selfie with the Selfie provided during a successful Registration