🙆Users
Get User by ID
GET https://api.tagshelf.com/v1/2face/users/:id
Gets the information of a user by its 2Face ID
Path Parameters
Name
Type
Description
id*
string
id of the requested user.
Headers
Name
Type
Description
Authorization*
string
API Key
User-Agent*
string
User Agent
{
"code": 200,
"result": {
"_id": "62788b3bd69719bec16af83d",
"documentId": "RD5556679",
"documentType": "PASSPORT",
"metadata": {
"fullname": "John Doe",
"yourDataGoesHere": "data"
},
"attempt": "627889fcd69719bec16af823",
"createdAt": "2022-05-09T03:32:11.748Z",
"updatedAt": "2022-05-09T03:32:11.748Z",
"__v": 0,
"id": "62788b3bd69719bec16af83d"
}
}
{
"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."
}
}Get User by Document ID
GET https://api.tagshelf.com/v1/2face/users/document/:documentId
Gets the information of a user by its Document ID
Path Parameters
Name
Type
Description
documentId*
string
documentIdof the requested user.
Headers
Name
Type
Description
Authorization*
string
API Key
User-Agent*
string
User Agent
{
"code": 200,
"result": {
"_id": "62788b3bd69719bec16af83d",
"documentId": "RD5556679",
"documentType": "PASSPORT",
"metadata": {
"fullname": "John Doe",
"yourDataGoesHere": "data"
},
"attempt": "627889fcd69719bec16af823",
"createdAt": "2022-05-09T03:32:11.748Z",
"updatedAt": "2022-05-09T03:32:11.748Z",
"__v": 0,
"id": "62788b3bd69719bec16af83d"
}
}
{{
"code": 404,
"result": {
"msg": "No entity found by ID: 62788b3bd69719bec16af83d"
}
}{
"code": 500,
"result": {
"msg": "Invalid payload. It must contain 'faceA', 'faceB' and 'threshold'."
}
}{
"code": 403,
"result": {
"msg": "Invalid token."
}
}Last updated
Was this helpful?