Usuários

1. Criar Usuário (por Instância)

Descrição:

Cria um novo usuário no leitor de biometria facial, associando as informações biométricas a um perfil, utilizando o ID de uma instância de conexão ativa.

POST /api/v1/facialRecognitions/instances/{id}/users

Quando Usar:

Para cadastrar novos usuários no leitor de biometria facial em tempo real.
Para provisionar o acesso de uma pessoa a um dispositivo específico.

Criar um usuário (facial) no leitor de biometria facial por Instância conectada

post

Criar um usuário (facial) no leitor de biometria facial por Instância conectada

Indicando um 'PersonId' igual a zero, o novo usuário será criado com um Id gerado pelo sistema.

Autorizações

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int32Obrigatório

Id da instância conectada

Parâmetros de consulta

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Corpo

personLibraryIdinteger · int32Obrigatório

personIdinteger · int32Opcional

codestring | nuloOpcional

namestring | nuloOpcional

remarksstring | nuloOpcional

imageB64string | nuloOpcional

cardCodestring | nuloOpcional

passwordCodestring | nuloOpcional

timeTemplateIdsinteger · int32[] | nuloOpcional

Respostas

201

Quando ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

post

/api/v1/facialRecognitions/instances/{id}/users

POST /api/v1/facialRecognitions/instances/{id}/users HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 159

{
  "personLibraryId": 1,
  "personId": 1,
  "code": "text",
  "name": "text",
  "remarks": "text",
  "imageB64": "text",
  "cardCode": "text",
  "passwordCode": "text",
  "timeTemplateIds": [
    1
  ]
}

{
  "success": true,
  "failure": true,
  "data": {
    "response": {
      "responseURL": "text",
      "createdID": 1,
      "responseCode": 1,
      "subResponseCode": 1,
      "responseString": "text",
      "statusCode": 1,
      "statusString": "text",
      "data": {
        "num": 1,
        "personList": [
          {
            "personID": 1,
            "faceNum": 1,
            "faceList": [
              {
                "faceID": 1,
                "resultCode": 1,
                "resultString": "text",
                "repeatPersonID": 1,
                "repeatPersonName": "text"
              }
            ],
            "fingerprintNum": 1,
            "fingerprintList": [
              {
                "fingerprintID": 1,
                "resultCode": 1
              }
            ]
          }
        ]
      }
    }
  }
}

_{2. Criar Usuário (por ID)}

_Descrição:

Cria um novo usuário no leitor de biometria facial, associando as informações biométricas a um perfil, utilizando o ID do dispositivo registrado no sistema.

POST /api/v1/facialRecognitions/{id}/users

_{Quando Usar:}

Para cadastrar usuários em leitores remotos a partir de um sistema de gerenciamento central.
Para automatizar o provisionamento de acesso facial em múltiplos dispositivos.

Criar um usuário (facial) no leitor de biometria facial

post

Criar um usuário (facial) no leitor de biometria facial

Indicando um 'PersonId' igual a zero, o novo usuário será criado com um Id gerado pelo sistema.

Autorizações

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int64Obrigatório

Id do leitor de biometria facial

Parâmetros de consulta

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Corpo

personLibraryIdinteger · int32Obrigatório

personIdinteger · int32Opcional

codestring | nuloOpcional

namestring | nuloOpcional

remarksstring | nuloOpcional

imageB64string | nuloOpcional

cardCodestring | nuloOpcional

passwordCodestring | nuloOpcional

timeTemplateIdsinteger · int32[] | nuloOpcional

Respostas

201

Quando ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

post

/api/v1/facialRecognitions/{id}/users

POST /api/v1/facialRecognitions/{id}/users HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 159

{
  "personLibraryId": 1,
  "personId": 1,
  "code": "text",
  "name": "text",
  "remarks": "text",
  "imageB64": "text",
  "cardCode": "text",
  "passwordCode": "text",
  "timeTemplateIds": [
    1
  ]
}

{
  "success": true,
  "failure": true,
  "data": {
    "response": {
      "responseURL": "text",
      "createdID": 1,
      "responseCode": 1,
      "subResponseCode": 1,
      "responseString": "text",
      "statusCode": 1,
      "statusString": "text",
      "data": {
        "num": 1,
        "personList": [
          {
            "personID": 1,
            "faceNum": 1,
            "faceList": [
              {
                "faceID": 1,
                "resultCode": 1,
                "resultString": "text",
                "repeatPersonID": 1,
                "repeatPersonName": "text"
              }
            ],
            "fingerprintNum": 1,
            "fingerprintList": [
              {
                "fingerprintID": 1,
                "resultCode": 1
              }
            ]
          }
        ]
      }
    }
  }
}

_{3. Atualizar Usuário (por Instância)}

_Descrição:

Atualiza as informações de um usuário (facial) existente no leitor de biometria facial, como dados de perfil ou permissões, utilizando o ID de uma instância de conexão ativa.

PUT /api/v1/facialRecognitions/instances/{id}/users

_{Quando Usar:}

Para modificar as permissões de acesso de um usuário ou atualizar seus dados cadastrais em tempo real.
Para ajustar o perfil de um usuário em um leitor específico.

Atualizar um usuário (facial) no leitor de biometria facial por Instância conectada

put

Atualizar um usuário (facial) no leitor de biometria facial por Instância conectada

Indicando um 'PersonId' não existente, um novo usuário será criado.

Autorizações

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int32Obrigatório

Id da instância conectada

Parâmetros de consulta

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Corpo

personLibraryIdinteger · int32Obrigatório

personIdinteger · int32Opcional

codestring | nuloOpcional

namestring | nuloOpcional

remarksstring | nuloOpcional

imageB64string | nuloOpcional

cardCodestring | nuloOpcional

passwordCodestring | nuloOpcional

timeTemplateIdsinteger · int32[] | nuloOpcional

Respostas

201

Quando ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

put

/api/v1/facialRecognitions/instances/{id}/users

PUT /api/v1/facialRecognitions/instances/{id}/users HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 159

{
  "personLibraryId": 1,
  "personId": 1,
  "code": "text",
  "name": "text",
  "remarks": "text",
  "imageB64": "text",
  "cardCode": "text",
  "passwordCode": "text",
  "timeTemplateIds": [
    1
  ]
}

{
  "success": true,
  "failure": true,
  "data": {
    "response": {
      "responseURL": "text",
      "createdID": 1,
      "responseCode": 1,
      "subResponseCode": 1,
      "responseString": "text",
      "statusCode": 1,
      "statusString": "text",
      "data": {
        "num": 1,
        "personList": [
          {
            "personID": 1,
            "faceNum": 1,
            "faceList": [
              {
                "faceID": 1,
                "resultCode": 1,
                "resultString": "text",
                "repeatPersonID": 1,
                "repeatPersonName": "text"
              }
            ],
            "fingerprintNum": 1,
            "fingerprintList": [
              {
                "fingerprintID": 1,
                "resultCode": 1
              }
            ]
          }
        ]
      }
    }
  }
}

_{4. Atualizar Usuário (por ID)}

_Descrição:

Atualiza as informações de um usuário (facial) existente no leitor de biometria facial, como dados de perfil ou permissões, utilizando o ID do dispositivo registrado no sistema.

PUT /api/v1/facialRecognitions/{id}/users

_{Quando Usar:}

Para atualizar informações de usuários em leitores remotos a partir de um sistema de gerenciamento central.
Para aplicar alterações em políticas de acesso de usuários em múltiplos dispositivos de forma automatizada.

Atualizar um usuário (facial) no leitor de biometria facial

put

Atualizar um usuário (facial) no leitor de biometria facial

Indicando um 'PersonId' não existente, um novo usuário será criado.

Autorizações

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int64Obrigatório

Id do leitor de biometria facial

Parâmetros de consulta

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Corpo

personLibraryIdinteger · int32Obrigatório

personIdinteger · int32Opcional

codestring | nuloOpcional

namestring | nuloOpcional

remarksstring | nuloOpcional

imageB64string | nuloOpcional

cardCodestring | nuloOpcional

passwordCodestring | nuloOpcional

timeTemplateIdsinteger · int32[] | nuloOpcional

Respostas

201

Quando ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

put

/api/v1/facialRecognitions/{id}/users

PUT /api/v1/facialRecognitions/{id}/users HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 159

{
  "personLibraryId": 1,
  "personId": 1,
  "code": "text",
  "name": "text",
  "remarks": "text",
  "imageB64": "text",
  "cardCode": "text",
  "passwordCode": "text",
  "timeTemplateIds": [
    1
  ]
}

{
  "success": true,
  "failure": true,
  "data": {
    "response": {
      "responseURL": "text",
      "createdID": 1,
      "responseCode": 1,
      "subResponseCode": 1,
      "responseString": "text",
      "statusCode": 1,
      "statusString": "text",
      "data": {
        "num": 1,
        "personList": [
          {
            "personID": 1,
            "faceNum": 1,
            "faceList": [
              {
                "faceID": 1,
                "resultCode": 1,
                "resultString": "text",
                "repeatPersonID": 1,
                "repeatPersonName": "text"
              }
            ],
            "fingerprintNum": 1,
            "fingerprintList": [
              {
                "fingerprintID": 1,
                "resultCode": 1
              }
            ]
          }
        ]
      }
    }
  }
}

_{5. Obter Informações de Usuário (por Instância)}

_Descrição:

Retorna uma lista de todos os usuários (faciais) cadastrados no leitor de biometria facial, incluindo suas informações de perfil, utilizando o ID de uma instância de conexão ativa.

GET /api/v1/facialRecognitions/instances/{id}/users

_{Quando Usar:}

Para carregar a lista de usuários de um leitor específico para exibição ou gerenciamento.
Para realizar auditorias dos usuários cadastrados em um dispositivo.

Obter informações do usuário (facial) no leitor de biometria facial por Instância conectada

get

Obter informações do usuário (facial) no leitor de biometria facial por Instância conectada

Autorizações

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int32Obrigatório

Id da Instância conectada

Parâmetros de consulta

Limitinteger · int32OpcionalDefault: 6

OffSetinteger · int32OpcionalDefault: 0

PersonLibraryIdinteger · int32Obrigatório

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Respostas

200

Quando a obtenção das informações ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

get

/api/v1/facialRecognitions/instances/{id}/users

GET /api/v1/facialRecognitions/instances/{id}/users?PersonLibraryId=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": {
    "response": {
      "responseURL": "text",
      "createdID": 1,
      "responseCode": 1,
      "subResponseCode": 1,
      "responseString": "text",
      "statusCode": 1,
      "statusString": "text",
      "data": {
        "total": 1,
        "offset": 1,
        "personList": {
          "num": 1,
          "personInfoList": [
            {
              "personID": 1,
              "lastChange": 1,
              "isAdminRole": 1,
              "personCode": "text",
              "personName": "text",
              "remarks": "text",
              "featureExist": "text",
              "timeTemplateNum": 1,
              "timeTemplateList": [
                {
                  "beginTime": 1,
                  "endTime": 1,
                  "index": 1
                }
              ],
              "identificationNum": 1,
              "identificationList": [
                {
                  "type": 1,
                  "number": "text"
                }
              ],
              "imageNum": 1,
              "imageList": [
                {
                  "faceID": 1,
                  "name": "text",
                  "size": 1,
                  "data": "text"
                }
              ],
              "fingerprintNum": 1,
              "fingerprintList": [
                {
                  "fingerprintID": 1,
                  "manufacturer": "text",
                  "featureVersion": "text",
                  "featureSize": 1,
                  "feature": "text"
                }
              ]
            }
          ]
        }
      }
    }
  }
}

_{6. Obter Informações de Usuário (por ID)}

_Descrição:

Retorna uma lista de todos os usuários (faciais) cadastrados no leitor de biometria facial, incluindo suas informações de perfil, utilizando o ID do dispositivo registrado no sistema.

GET /api/v1/facialRecognitions/{id}/users

_{Quando Usar:}

Para consultar os usuários de um leitor a partir de um sistema central, mesmo que o dispositivo não esteja em uma sessão de instância ativa.
Para realizar auditorias ou backups dos perfis de usuários de múltiplos leitores.

Obter informações do usuário (facial) no leitor de biometria facial

get

Obter informações do usuário (facial) no leitor de biometria facial

Autorizações

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int64Obrigatório

Id do leitor de biometria facial

Parâmetros de consulta

Limitinteger · int32OpcionalDefault: 6

OffSetinteger · int32OpcionalDefault: 0

PersonLibraryIdinteger · int32Obrigatório

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Respostas

200

Quando a obtenção das informações ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

get

/api/v1/facialRecognitions/{id}/users

GET /api/v1/facialRecognitions/{id}/users?PersonLibraryId=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": {
    "response": {
      "responseURL": "text",
      "createdID": 1,
      "responseCode": 1,
      "subResponseCode": 1,
      "responseString": "text",
      "statusCode": 1,
      "statusString": "text",
      "data": {
        "total": 1,
        "offset": 1,
        "personList": {
          "num": 1,
          "personInfoList": [
            {
              "personID": 1,
              "lastChange": 1,
              "isAdminRole": 1,
              "personCode": "text",
              "personName": "text",
              "remarks": "text",
              "featureExist": "text",
              "timeTemplateNum": 1,
              "timeTemplateList": [
                {
                  "beginTime": 1,
                  "endTime": 1,
                  "index": 1
                }
              ],
              "identificationNum": 1,
              "identificationList": [
                {
                  "type": 1,
                  "number": "text"
                }
              ],
              "imageNum": 1,
              "imageList": [
                {
                  "faceID": 1,
                  "name": "text",
                  "size": 1,
                  "data": "text"
                }
              ],
              "fingerprintNum": 1,
              "fingerprintList": [
                {
                  "fingerprintID": 1,
                  "manufacturer": "text",
                  "featureVersion": "text",
                  "featureSize": 1,
                  "feature": "text"
                }
              ]
            }
          ]
        }
      }
    }
  }
}

_{7. Apagar Usuário (por Instância)}

_Descrição:

Apaga um usuário (facial) específico do leitor de biometria facial, removendo suas informações de perfil e dados biométricos, utilizando o ID de uma instância de conexão ativa.

DELETE /api/v1/facialRecognitions/instances/{id}/users

_{Quando Usar:}

Para remover o acesso de um usuário a um leitor específico em tempo real.
Para limpar perfis de usuários que não são mais necessários no dispositivo.

Apagar usuário (facial) no leitor de biometria facial por Instância conectada

delete

Apagar usuário (facial) no leitor de biometria facial por Instância conectada

Autorizações

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int32Obrigatório

Id da Instância conectada

Parâmetros de consulta

PersonIdinteger · int32Obrigatório

PersonLibraryIdinteger · int32Obrigatório

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Respostas

200

Quando a obtenção das informações ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

delete

/api/v1/facialRecognitions/instances/{id}/users

DELETE /api/v1/facialRecognitions/instances/{id}/users?PersonId=1&PersonLibraryId=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": {
    "response": {
      "responseURL": "text",
      "createdID": 1,
      "responseCode": 1,
      "subResponseCode": 1,
      "responseString": "text",
      "statusCode": 1,
      "statusString": "text",
      "data": "text"
    }
  }
}

_{8. Apagar Usuário (por ID)}

_Descrição:

Apaga um usuário (facial) específico do leitor de biometria facial, removendo suas informações de perfil e dados biométricos, utilizando o ID do dispositivo registrado no sistema.

DELETE /api/v1/facialRecognitions/{id}/users

_{Quando Usar:}

Para remover usuários de leitores remotos a partir de um sistema de gerenciamento central.
Para automatizar a remoção de perfis de usuários obsoletos em múltiplos dispositivos.

Apagar usuário (facial) no leitor de biometria facial

delete

Apagar usuário (facial) no leitor de biometria facial

Autorizações

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int64Obrigatório

Id do leitor de biometria facial

Parâmetros de consulta

PersonIdinteger · int32Obrigatório

PersonLibraryIdinteger · int32Obrigatório

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Respostas

200

Quando a obtenção das informações ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

delete

/api/v1/facialRecognitions/{id}/users

DELETE /api/v1/facialRecognitions/{id}/users?PersonId=1&PersonLibraryId=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": {
    "response": {
      "responseURL": "text",
      "createdID": 1,
      "responseCode": 1,
      "subResponseCode": 1,
      "responseString": "text",
      "statusCode": 1,
      "statusString": "text",
      "data": "text"
    }
  }
}

_{9. Obter Informações de Usuário (por Instância)}

_Descrição:

Retorna as informações detalhadas de um usuário (facial) específico, identificado pelo seu personId, no leitor de biometria facial, utilizando o ID de uma instância de conexão ativa.

GET /api/v1/facialRecognitions/instances/{id}/users/{personId}

_{Quando Usar:}

Para consultar os detalhes de um usuário específico para verificação ou depuração.
Para exibir as informações de um usuário em uma interface de gerenciamento.

Obter informações de usuários por Id (facial) no leitor de biometria facial por Instância conectada

get

Obter informações de usuários por Id (facial) no leitor de biometria facial por Instância conectada

Autorizações

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int32Obrigatório

Id da Instância conectada

personIdinteger · int32Obrigatório

Person Id

Parâmetros de consulta

personLibraryIdinteger · int32Obrigatório

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Respostas

200

Quando a obtenção das informações ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

get

/api/v1/facialRecognitions/instances/{id}/users/{personId}

GET /api/v1/facialRecognitions/instances/{id}/users/{personId}?personLibraryId=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": {
    "response": {
      "responseURL": "text",
      "createdID": 1,
      "responseCode": 1,
      "subResponseCode": 1,
      "responseString": "text",
      "statusCode": 1,
      "statusString": "text",
      "data": {
        "total": 1,
        "offset": 1,
        "personList": {
          "num": 1,
          "personInfoList": [
            {
              "personID": 1,
              "lastChange": 1,
              "personCode": "text",
              "personName": "text",
              "remarks": "text",
              "featureExist": "text",
              "timeTemplateNum": 1,
              "timeTemplateList": [
                {
                  "beginTime": 1,
                  "endTime": 1,
                  "index": 1
                }
              ],
              "identificationNum": 1,
              "identificationList": [
                {
                  "type": 1,
                  "number": "text"
                }
              ],
              "imageNum": 1,
              "imageList": [
                {
                  "faceID": 1,
                  "name": "text",
                  "size": 1,
                  "data": null
                }
              ]
            }
          ]
        }
      }
    }
  }
}

_{10. Obter Informações de Usuário (por ID)}

_Descrição:

Retorna as informações detalhadas de um usuário (facial) específico, identificado pelo seu personId, no leitor de biometria facial, utilizando o ID do dispositivo registrado no sistema.

GET /api/v1/facialRecognitions/{id}/users/{personId}

_{Quando Usar:}

Para consultar os detalhes de um usuário específico de um leitor remoto a partir de um sistema central.
Para auditar as configurações de um usuário em um dispositivo específico.

Obter informações de usuários por Id (facial) no leitor de biometria facial

get

Obter informações de usuários por Id (facial) no leitor de biometria facial

Autorizações

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int64Obrigatório

Id do leitor de biometria facial

personIdinteger · int32Obrigatório

Parâmetros de consulta

personLibraryIdinteger · int32Obrigatório

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Respostas

200

Quando a obtenção das informações ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

get

/api/v1/facialRecognitions/{id}/users/{personId}

GET /api/v1/facialRecognitions/{id}/users/{personId}?personLibraryId=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": {
    "response": {
      "responseURL": "text",
      "createdID": 1,
      "responseCode": 1,
      "subResponseCode": 1,
      "responseString": "text",
      "statusCode": 1,
      "statusString": "text",
      "data": {
        "total": 1,
        "offset": 1,
        "personList": {
          "num": 1,
          "personInfoList": [
            {
              "personID": 1,
              "lastChange": 1,
              "personCode": "text",
              "personName": "text",
              "remarks": "text",
              "featureExist": "text",
              "timeTemplateNum": 1,
              "timeTemplateList": [
                {
                  "beginTime": 1,
                  "endTime": 1,
                  "index": 1
                }
              ],
              "identificationNum": 1,
              "identificationList": [
                {
                  "type": 1,
                  "number": "text"
                }
              ],
              "imageNum": 1,
              "imageList": [
                {
                  "faceID": 1,
                  "name": "text",
                  "size": 1,
                  "data": null
                }
              ]
            }
          ]
        }
      }
    }
  }
}

_{11. Obter Informações de Usuário por Filtro (por Instância)}

_Descrição:

Retorna uma lista de usuários (faciais) cadastrados no leitor de biometria facial, aplicando filtros específicos para refinar a busca, utilizando o ID de uma instância de conexão ativa.

GET /api/v1/facialRecognitions/instances/{id}/users/filters

_{Quando Usar:}

Para buscar usuários com base em critérios específicos (ex: nome, departamento) em um leitor conectado.
Para popular listas de usuários filtradas em uma interface de gerenciamento.

Obter informações de usuários por filtro (facial) no leitor de biometria facial por Instância conectada

get

Obter informações de usuários por filtro (facial) no leitor de biometria facial por Instância conectada

QryTypeId: ICCard, EmployeeID, PersonName, PersonID
SearchOffset: número da página (início em 0)
Data: valor de acordo com QryTypeId escolhido

Autorizações

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int32Obrigatório

Id da Instância conectada

Parâmetros de consulta

QryTypeIdstring · enumObrigatórioValores possíveis:

SearchOffsetinteger · int32Obrigatório

DatastringObrigatório

PersonLibraryIdinteger · int32Obrigatório

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Respostas

200

Quando a obtenção das informações ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

get

/api/v1/facialRecognitions/instances/{id}/users/filters

GET /api/v1/facialRecognitions/instances/{id}/users/filters?QryTypeId=ICCard&SearchOffset=1&Data=text&PersonLibraryId=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": {
    "response": {
      "responseURL": "text",
      "createdID": 1,
      "responseCode": 1,
      "subResponseCode": 1,
      "responseString": "text",
      "statusCode": 1,
      "statusString": "text",
      "data": {
        "total": 1,
        "offset": 1,
        "personList": {
          "num": 1,
          "personInfoList": [
            {
              "personID": 1,
              "lastChange": 1,
              "personCode": "text",
              "personName": "text",
              "remarks": "text",
              "featureExist": "text",
              "timeTemplateNum": 1,
              "timeTemplateList": [
                {
                  "beginTime": 1,
                  "endTime": 1,
                  "index": 1
                }
              ],
              "identificationNum": 1,
              "identificationList": [
                {
                  "type": 1,
                  "number": "text"
                }
              ],
              "imageNum": 1,
              "imageList": [
                {
                  "faceID": 1,
                  "name": "text",
                  "size": 1,
                  "data": null
                }
              ]
            }
          ]
        }
      }
    }
  }
}

_{12. Obter Informações de Usuário por Filtro (Facial) (por ID)}

_Descrição:

Retorna uma lista de usuários (faciais) cadastrados no leitor de biometria facial, aplicando filtros específicos para refinar a busca, utilizando o ID do dispositivo registrado no sistema.

GET /api/v1/facialRecognitions/{id}/users/filters

_{Quando Usar:}

Para buscar usuários em leitores remotos a partir de um sistema de gerenciamento central, com base em critérios específicos.
Para gerar relatórios de usuários filtrados em múltiplos dispositivos.

Obter informações de usuários por filtro (facial) no leitor de biometria facial

get

Obter informações de usuários por filtro (facial) no leitor de biometria facial

QryTypeId: ICCard, EmployeeID, PersonName, PersonID
SearchOffset: número da página (início em 0)
Data: valor de acordo com QryTypeId escolhido

Autorizações

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int64Obrigatório

Id do leitor de biometria facial

Parâmetros de consulta

QryTypeIdstring · enumObrigatórioValores possíveis:

SearchOffsetinteger · int32Obrigatório

DatastringObrigatório

PersonLibraryIdinteger · int32Obrigatório

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Respostas

200

Quando a obtenção das informações ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

get

/api/v1/facialRecognitions/{id}/users/filters

GET /api/v1/facialRecognitions/{id}/users/filters?QryTypeId=ICCard&SearchOffset=1&Data=text&PersonLibraryId=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": {
    "response": {
      "responseURL": "text",
      "createdID": 1,
      "responseCode": 1,
      "subResponseCode": 1,
      "responseString": "text",
      "statusCode": 1,
      "statusString": "text",
      "data": {
        "total": 1,
        "offset": 1,
        "personList": {
          "num": 1,
          "personInfoList": [
            {
              "personID": 1,
              "lastChange": 1,
              "personCode": "text",
              "personName": "text",
              "remarks": "text",
              "featureExist": "text",
              "timeTemplateNum": 1,
              "timeTemplateList": [
                {
                  "beginTime": 1,
                  "endTime": 1,
                  "index": 1
                }
              ],
              "identificationNum": 1,
              "identificationList": [
                {
                  "type": 1,
                  "number": "text"
                }
              ],
              "imageNum": 1,
              "imageList": [
                {
                  "faceID": 1,
                  "name": "text",
                  "size": 1,
                  "data": null
                }
              ]
            }
          ]
        }
      }
    }
  }
}

_{13. Obter Informações da Biblioteca do Usuário (por Instância)}

_Descrição:

Retorna informações sobre a biblioteca de usuários (facial) armazenada no leitor de biometria facial, como status e capacidade, utilizando o ID de uma instância de conexão ativa.

GET /api/v1/facialRecognitions/instances/{id}/libraries/users

_{Quando Usar:}

Para verificar o estado da base de dados de usuários faciais em um leitor conectado.
Para monitorar a capacidade de armazenamento de usuários no dispositivo.

Obter informações da biblioteca do usuário (facial) no leitor de biometria facial por Instância conectada

get

Obter informações da biblioteca do usuário (facial) no leitor de biometria facial por Instância conectada

Autorizações

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int32Obrigatório

Id da Instância conectada

Parâmetros de consulta

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Respostas

200

Quando a obtenção das informações ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

get

/api/v1/facialRecognitions/instances/{id}/libraries/users

GET /api/v1/facialRecognitions/instances/{id}/libraries/users HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": {
    "response": {
      "responseURL": "text",
      "createdID": 1,
      "responseCode": 1,
      "subResponseCode": 1,
      "responseString": "text",
      "statusCode": 1,
      "statusString": "text",
      "data": {
        "num": 1,
        "libList": [
          {
            "id": 1,
            "type": 1,
            "personNum": 1,
            "memberNum": 1,
            "faceNum": 1,
            "lastChange": "2026-01-20T17:28:26.013Z",
            "name": "text",
            "belongIndex": "text"
          }
        ]
      }
    }
  }
}

_{14. Obter Informações da Biblioteca do Usuário (Facial) (por ID)}

_Descrição:

Retorna informações sobre a biblioteca de usuários (facial) armazenada no leitor de biometria facial, como status e capacidade, utilizando o ID do dispositivo registrado no sistema.

GET /api/v1/facialRecognitions/{id}/libraries/users

_{Quando Usar:}

Para verificar o estado da base de dados de usuários faciais em leitores remotos a partir de um sistema central.
Para monitorar a capacidade de armazenamento de usuários em múltiplos dispositivos.

Obter informações da biblioteca do usuário (facial) no leitor de biometria facial

get

Obter informações da biblioteca do usuário (facial) no leitor de biometria facial

Autorizações

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int64Obrigatório

Id do leitor de biometria facial

Parâmetros de consulta

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Respostas

200

Quando a obtenção das informações ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

get

/api/v1/facialRecognitions/{id}/libraries/users

GET /api/v1/facialRecognitions/{id}/libraries/users HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": {
    "response": {
      "responseURL": "text",
      "createdID": 1,
      "responseCode": 1,
      "subResponseCode": 1,
      "responseString": "text",
      "statusCode": 1,
      "statusString": "text",
      "data": {
        "num": 1,
        "libList": [
          {
            "id": 1,
            "type": 1,
            "personNum": 1,
            "memberNum": 1,
            "faceNum": 1,
            "lastChange": "2026-01-20T17:28:26.013Z",
            "name": "text",
            "belongIndex": "text"
          }
        ]
      }
    }
  }
}

15.Obter Captura de Imagem Instantânea (por Instância)

Descrição:

Envia um comando para o leitor de biometria facial capturar e retornar uma imagem instantânea (snapshot) do que está sendo visualizado pela câmera, utilizando o ID de uma instância de conexão ativa.

POST /api/v1/facialRecognitions/instances/{id}/snapshots

Quando Usar:

Para verificar o campo de visão da câmera do leitor ou para fins de depuração.
Para obter a imagem facial de um novo usuário em tempo real, a ser utilizada posteriormente para o registro do usuário em outro endpoint.
Para obter uma imagem de auditoria de um evento específico em tempo real.

Obter a captura de imagem instantânea no aparelho de biometria facial por Instância conectada

post

Obter a captura de imagem instantânea no aparelho de biometria facial por Instância conectada

Autorizações

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int32Obrigatório

Id da instância conectada

Parâmetros de consulta

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Respostas

201

Quando ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

post

/api/v1/facialRecognitions/instances/{id}/snapshots

POST /api/v1/facialRecognitions/instances/{id}/snapshots HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": {
    "snapshotSize": 1,
    "snapshotJpg": "text"
  }
}

16. Obter Captura de Imagem Instantânea (por ID)

Descrição:

Envia um comando para o leitor de biometria facial capturar e retornar uma imagem instantânea (snapshot) do que está sendo visualizado pela câmera, utilizando o ID do dispositivo registrado no sistema.

POST /api/v1/facialRecognitions/{id}/snapshots

Quando Usar:

Para obter uma imagem de um leitor remoto a partir de um sistema de gerenciamento central, para verificação ou auditoria.
Para integrar a captura de imagens com sistemas de monitoramento de segurança.
Para obter a imagem facial de um novo usuário em tempo real, a ser utilizada posteriormente para o registro do usuário em outro endpoint.

Obter a captura de imagem instantânea no aparelho de biometria facial

post

Obter a captura de imagem instantânea no aparelho de biometria facial

Autorizações

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int64Obrigatório

Id do leitor de biometria facial

Parâmetros de consulta

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Respostas

200

Quando a obtenção das informações ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

post

/api/v1/facialRecognitions/{id}/snapshots

POST /api/v1/facialRecognitions/{id}/snapshots HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": {
    "snapshotSize": 1,
    "snapshotJpg": "text"
  }
}

AnteriorInformações PróximoAssinaturas

Atualizado há 3 meses

hashtag1. Criar Usuário (por Instância)

hashtagDescrição:

hashtagQuando Usar:

hashtagCriar um usuário (facial) no leitor de biometria facial por Instância conectada

hashtag2. Criar Usuário (por ID)

hashtagDescrição:

hashtagQuando Usar:

hashtagCriar um usuário (facial) no leitor de biometria facial

hashtag3. Atualizar Usuário (por Instância)

hashtagDescrição:

hashtagQuando Usar:

hashtagAtualizar um usuário (facial) no leitor de biometria facial por Instância conectada

hashtag4. Atualizar Usuário (por ID)

hashtagDescrição:

hashtagQuando Usar:

hashtagAtualizar um usuário (facial) no leitor de biometria facial

hashtag5. Obter Informações de Usuário (por Instância)

hashtagDescrição:

hashtagQuando Usar:

hashtagObter informações do usuário (facial) no leitor de biometria facial por Instância conectada

hashtag6. Obter Informações de Usuário (por ID)

hashtagDescrição:

hashtagQuando Usar:

hashtagObter informações do usuário (facial) no leitor de biometria facial

hashtag7. Apagar Usuário (por Instância)

hashtagDescrição:

hashtagQuando Usar:

hashtagApagar usuário (facial) no leitor de biometria facial por Instância conectada

hashtag8. Apagar Usuário (por ID)

hashtagDescrição:

hashtagQuando Usar:

hashtagApagar usuário (facial) no leitor de biometria facial

hashtag9. Obter Informações de Usuário (por Instância)

hashtagDescrição:

hashtagQuando Usar:

hashtagObter informações de usuários por Id (facial) no leitor de biometria facial por Instância conectada

hashtag10. Obter Informações de Usuário (por ID)

hashtagDescrição:

hashtagQuando Usar:

hashtagObter informações de usuários por Id (facial) no leitor de biometria facial

hashtag11. Obter Informações de Usuário por Filtro (por Instância)

hashtagDescrição:

hashtagQuando Usar:

hashtagObter informações de usuários por filtro (facial) no leitor de biometria facial por Instância conectada

hashtag12. Obter Informações de Usuário por Filtro (Facial) (por ID)

hashtagDescrição:

hashtagQuando Usar:

hashtagObter informações de usuários por filtro (facial) no leitor de biometria facial

hashtag13. Obter Informações da Biblioteca do Usuário (por Instância)

hashtagDescrição:

hashtagQuando Usar:

hashtagObter informações da biblioteca do usuário (facial) no leitor de biometria facial por Instância conectada

hashtag14. Obter Informações da Biblioteca do Usuário (Facial) (por ID)

hashtagDescrição:

hashtagQuando Usar:

hashtagObter informações da biblioteca do usuário (facial) no leitor de biometria facial

hashtag15.Obter Captura de Imagem Instantânea (por Instância)

hashtagDescrição:

hashtagQuando Usar:

hashtagObter a captura de imagem instantânea no aparelho de biometria facial por Instância conectada

hashtag16. Obter Captura de Imagem Instantânea (por ID)

hashtagDescrição:

hashtagQuando Usar:

hashtagObter a captura de imagem instantânea no aparelho de biometria facial

1. Criar Usuário (por Instância)

Descrição:

Quando Usar:

Criar um usuário (facial) no leitor de biometria facial por Instância conectada

_{2. Criar Usuário (por ID)}

_Descrição:

_{Quando Usar:}

Criar um usuário (facial) no leitor de biometria facial

_{3. Atualizar Usuário (por Instância)}

_Descrição:

_{Quando Usar:}

Atualizar um usuário (facial) no leitor de biometria facial por Instância conectada

_{4. Atualizar Usuário (por ID)}

_Descrição:

_{Quando Usar:}

Atualizar um usuário (facial) no leitor de biometria facial

_{5. Obter Informações de Usuário (por Instância)}

_Descrição:

_{Quando Usar:}

Obter informações do usuário (facial) no leitor de biometria facial por Instância conectada

_{6. Obter Informações de Usuário (por ID)}

_Descrição:

_{Quando Usar:}

Obter informações do usuário (facial) no leitor de biometria facial

_{7. Apagar Usuário (por Instância)}

_Descrição:

_{Quando Usar:}

Apagar usuário (facial) no leitor de biometria facial por Instância conectada

_{8. Apagar Usuário (por ID)}

_Descrição:

_{Quando Usar:}

Apagar usuário (facial) no leitor de biometria facial

_{9. Obter Informações de Usuário (por Instância)}

_Descrição:

_{Quando Usar:}

Obter informações de usuários por Id (facial) no leitor de biometria facial por Instância conectada

_{10. Obter Informações de Usuário (por ID)}

_Descrição:

_{Quando Usar:}

Obter informações de usuários por Id (facial) no leitor de biometria facial

_{11. Obter Informações de Usuário por Filtro (por Instância)}

_Descrição:

_{Quando Usar:}

Obter informações de usuários por filtro (facial) no leitor de biometria facial por Instância conectada

_{12. Obter Informações de Usuário por Filtro (Facial) (por ID)}

_Descrição:

_{Quando Usar:}

Obter informações de usuários por filtro (facial) no leitor de biometria facial

_{13. Obter Informações da Biblioteca do Usuário (por Instância)}

_Descrição:

_{Quando Usar:}

Obter informações da biblioteca do usuário (facial) no leitor de biometria facial por Instância conectada

_{14. Obter Informações da Biblioteca do Usuário (Facial) (por ID)}

_Descrição:

_{Quando Usar:}

Obter informações da biblioteca do usuário (facial) no leitor de biometria facial

15.Obter Captura de Imagem Instantânea (por Instância)

Descrição:

Quando Usar:

Obter a captura de imagem instantânea no aparelho de biometria facial por Instância conectada

16. Obter Captura de Imagem Instantânea (por ID)

Descrição:

Quando Usar:

Obter a captura de imagem instantânea no aparelho de biometria facial