♻️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
Authorization*
string
API Key
User-Agent*
string
User Agent
Request Body
type*
string
Accepted values: SIGNUP | VALIDATION
{
"code": 200,
"result": "<token_here>"
}{
"code": 400,
"result": {
"msg": "`type` must be one of the following: SIGNUP,VALIDATION"
}
}{
"code": 500,
"result": {
"msg": "Invalid payload. It must contain 'faceA', 'faceB' and 'threshold'."
}
}{
"code": 403,
"result": {
"msg": "Invalid token."
}
}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
X-Tagshelf-Session*
string
Session Token
User-Agent*
string
User Agent
Request Body
status*
string
Accepted values: SUCCESS,FAILED,REVIEW
{
"code": 200,
"result": "<attempt_id here>"
}{
"code": 400,
"result": {
"msg": "`status` must be one of the following: SUCCESS,FAILED,REVIEW"
}
}{
"code": 500,
"result": {
"msg": "Invalid payload. It must contain 'faceA', 'faceB' and 'threshold'."
}
}{
"code": 403,
"result": {
"msg": "Invalid token."
}
}Last updated
Was this helpful?