♻️Session Management

Create Session

POST https://api.tagshelf.com/v1/2face/session

Generates a session token that represents an attempt to sign up or validation. Some endpoints need this token to be passed as a header.

Headers

Name	Type	Description
Authorization*	string	API Key
User-Agent*	string	User Agent

Request Body

Name	Type	Description
type*	string	Accepted values: SIGNUP | VALIDATION

200: OK Request Succesful

{
    "code": 200,
    "result": "<token_here>"
}

400: Bad Request Invalid payload

401: Unauthorized Missing API Key

500: Internal Server Error Something went wrong with the service. Please contact support.

403: Forbidden Invalid API Key

Close Session

POST https://api.tagshelf.com/v1/2face/session/close

After the process of facial authentication is completed. The session needs to be closed in order to create an user or perform any following action related to the session. The endpoint expect an status that determines whether the session was successful or failed based on the clients' criteria. the status can also be REVIEW if it's desired to submit the session for manual review in the backofice panel This endpoint returns an Attempt ID that you can use to register the user with Users

Headers

Name	Type	Description
X-Tagshelf-Session*	string	Session Token
User-Agent*	string	User Agent

Request Body

Name	Type	Description
status*	string	Accepted values: SUCCESS,FAILED,REVIEW

200: OK Request Succesful

{
    "code": 200,
    "result": "<attempt_id here>"
}

400: Bad Request Invalid payload

401: Unauthorized Missing API Key

500: Internal Server Error Something went wrong with the service. Please contact support.

403: Forbidden Invalid API Key