Biometria
=========

API de biometria de voz.

Temos dois ambientes disponíveis para executar suas requisições:

- staging: https://staging-api.alabiabot.com/biometrics
- production: https://api.alabiabot.com/biometrics

Para encontrar os tokens de acesso, você precisa acessar:

- staging: https://staging.alabiabot.com/#/token
- production: https://www.alabiabot.com/#/token


.. http:post:: /create
   
   Criar um usuário de biometria

   :form name: o nome de usuário a ser criado
   :form cpf: o CPF do usuário a ser criado
   :query access_token: JWT de serviço, que pode ser gerado pela interface.

   :status 200: usuário criado
   :status 400: erro na requisição

.. http:post:: /upload
   
   Enviar um exemplo de voz referente ao usuário

   :form audio: um árquivo de áudio com um exemplo da voz do usuário, no formato wav com sample rate de 16KHz e bit rate de 16.
   :form cpf: o CPF do usuário a ser associado
   :query access_token: JWT de serviço, que pode ser gerado pela interface.

   :status 200: áudio gravado
   :status 409: áudio muito curto
   :status 400: erro na requisição


.. http:post:: /retrieve
   
   Verifica uma voz enviada contra todas as vozes da organização na base de dados

   :form audio: um árquivo de áudio com um exemplo da voz do usuário, no formato wav com sample rate de 16KHz e bit rate de 16.
   :query access_token: JWT de serviço, que pode ser gerado pela interface.

   :status 200: Devolve o usuário reconhecido
   :status 400: erro na requisição


.. http:post:: /verify
   
   Verifica uma voz enviada contra a voz de um usuário específico da base de dados

   :form audio: um árquivo de áudio com um exemplo da voz do usuário, no formato wav com sample rate de 16KHz e bit rate de 16.
   :form cpf: o CPF do usuário a ser verificado
   :query access_token: JWT de serviço, que pode ser gerado pela interface.

   :status 200: Devolve o usuário reconhecido
   :status 400: erro na requisição

..
   .. http:post:: /list
      
      Recuperar os usuário cadastrados dentro de uma organização
      
      :query access_token: JWT de serviço, que pode ser gerado pela interface.
      
      :status 200: Devolve a lista de usuários