List Person

GET

  https://api.apptenticate.com/api/v3/biometrics/recognizer/persons/

---

This request allows you to obtain the list of People within the project assigned for the Recognizer service

Request example

Shell

Request

curl --location 'https://api.apptenticate.com/api/v3/biometrics/recognizer/persons/' \
--header 'Authorization: Bearer <jwt_token>' \

Node

Instalación

npm install axios

Request

const axios = require('axios')

let config = {
  method: 'get',
  url: 'https://api.apptenticate.com/api/v3/biometrics/recognizer/persons/',
  headers: {
    Authorization: 'Bearer <jwt_token>'
  }
}

axios
  .request(config)
  .then((response) => {
    console.log(JSON.stringify(response.data))
  })
  .catch((error) => {
    console.log(error)
  })

Python

Instalación

python -m pip install requests

Request

import requests

url = "https://api.apptenticate.com/api/v3/biometrics/recognizer/persons/"

headers = {
  'Authorization': 'Bearer <jwt_token>'
}

response = requests.request("GET", url, headers=headers)

print(response.text)

Response data

If the person is created successfully, the service will return a JSON object with the following structure:

Pagination structure

Field	Type	Description
count	file	Number of personas registered in the project
next	string	URL to the next set of results. If there are no more results it is null
previous	string	URL to the previous set of results. If there are no previous results it is null
results	string	List of personas registered in the project.

Estructura de la persona

Field	Type	Description
id	file	Unique identifier within Recognizer, this is the one that allows you to update or delete the person
citizen_id	string	Identity card or some unique identifier of the person
name	string	Person's name
image	string	Person's image URL
is_blocked	bool	Indicates whether the person is blocked or not
created_at	string	Person's creation date
agreed_terms	bool	Indicates if the person accepted the Recognizer service terms and conditions

Example of successful response

status_code: 201

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 54275286,
      "citizen_id": "8-123-12345",
      "name": "Jhon Doe",
      "image": "https://img.com/media/faces/JhonDoe.jpeg",
      "is_blocked": false,
      "created_at": "2023-11-13T10:39:21.243991-05:00",
      "agreed_terms": false
    },
    {
      "id": 44646711,
      "citizen_id": "2343047",
      "name": "Ana Smith",
      "image": "https://img.com/media/faces/AnaSmith.jpeg",
      "is_blocked": false,
      "created_at": "2023-09-12T15:39:42.471251-05:00",
      "agreed_terms": true
    }
  ]
}