search

👷Jobs

The endpoints that are use for facial and document verification are asynchronous. Use the endpoints in this section to consult their result.

The different status responses a job can have are:

Status
Description
Code

Queued

The job is currently on the waiting line to be processed by the pipeline.

0

In Progress

The job is currently being processed in the designated workflow.

1

Succeeded

The job has passed all of the required validations of its designated workflow.

2

Failed

The job did not pass the required validations of its designated workflow.

3

Invalid

The job is missing critical information and the validations could not be started.

4

hashtag
Start Job

POST https://api.tagshelf.com/v1/2face/jobs/start/:workflowName

This endpoint allows the application to start a job by specifying the affected workflow and desired parameters.

hashtag
Path Parameters

Name
Type
Description

workflowName*

string

Name of the workflow you want to execute.

hashtag
Headers

Name
Type
Description

X-Tagshelf-Session*

string

Session Token

User-Agent*

string

User Agent

hashtag
Request Body

Name
Type
Description

<field>

String

Any field that it's required by the workflow, which is defined at the workflow when the workflow is created

{
    "code": 200,
    "result": "62a736d6de4b359377f73450" //Job ID
}

hashtag
Get by ID

GET https://api.tagshelf.com/v1/2face/jobs/:id

Returns the information of a specific job given its ID. This endpoint is useful for implementations that require polling.

hashtag
Path Parameters

Name
Type
Description

*

string

id of the requested user.

hashtag
Headers

Name
Type
Description

Authorization*

string

API Key

User-Agent*

string

User Agent

PreviousSession ManagementNextFaces

Last updated

Was this helpful?