1. Visão Geral

O BioPass ID é um serviço online baseado em nuvem que fornece uma poderosa tecnologia multibiométrica para os desenvolvedores de qualquer serviço, software ou plataforma com acesso a Internet. O BioPass ID é implementado como Biometrics as a Service (biometria como um serviço) podendo otimizar estruturas existentes de forma rápida e fácil. Como se trata de um serviço de computação em nuvem, é possível dimensionar dinamicamente todos os requisitos de desempenho e de armazenamento, tornando a solução aplicável a uma ampla gama de cenários de uso.

1.1. Informações da Versão

Versão : 1.0.0

1.2. Informações de contato

Contato : Time da API do BioPassID
Email de contato : suporte@vsoft.com.br

1.3. Esquema URI

Host : (seu-dominio).biopassid.com
BasePath : /api
Schemes : HTTPS

1.4. Produz

  • application/json

2. Paths

2.1. Adição ou alteração de pessoa

POST /enroll

2.1.1. Descrição

Transforma as imagens de impressões digitais e/ ou face em modelos (templates) biométricos atrelando a um ID de identificação personalizado.

2.1.2. Parâmetros

Tipo Nome Descrição Esquema

FormData

CustomID
obrigatório

Código no cliente que representa a pessoa

string

FormData

Finger-1
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao polegar direito.

file

FormData

Finger-2
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao indicador direito.

file

FormData

Finger-3
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao médio direito.

file

FormData

Finger-4
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao anelar direito.

file

FormData

Finger-5
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao mínimo direito.

file

FormData

Finger-6
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao polegar esquerdo.

file

FormData

Finger-7
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao indicador esquerdo.

file

FormData

Finger-8
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao médio esquerdo.

file

FormData

Finger-9
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao anelar esquerdo.

file

FormData

Finger-10
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao mínimo esquerdo.

file

FormData

Face
opcional

Byte array com o arquivo de imagem da face.

file

2.1.3. Respostas

Código de status HTTP Descrição Esquema

200

Dados de resposta em caso de sucesso.

Resposta 200

401

Usuário e/ou senha inválidos ou não informados na requisição.

Nenhum conteúdo

415

Quando não for enviado Content-Type igual a multipart/form-data.

Nenhum conteúdo

500

Será retornado um objeto JSON com a descrição do erro.

Nenhum conteúdo

Resposta 200

Nome Descrição Esquema

CustomID
opcional

Código da pessoa enviado pelo solicitante

string

BioPassID
opcional

Código interno da pessoa no BioPassID

integer

2.1.4. Consome

  • multipart/form-data

2.2. Exclusão de pessoa

POST /delete

2.2.1. Descrição

Exclui uma determinada pessoa da base de dados.

2.2.2. Parâmetros

Tipo Nome Descrição Esquema

FormData

CustomID
obrigatório

Código no cliente que representa a pessoa

string

2.2.3. Respostas

Código de status HTTP Descrição Esquema

200

Dados de resposta em caso de sucesso.

Resposta 200

401

Usuário e/ou senha inválidos ou não informados na requisição.

Nenhum conteúdo

415

Quando não for enviado Content-Type igual a multipart/form-data.

Nenhum conteúdo

500

Será retornado um objeto JSON com a descrição do erro.

Nenhum conteúdo

Resposta 200

Nome Descrição Esquema

CustomID
opcional

Código da pessoa enviado pelo solicitante

string

2.2.4. Consome

  • multipart/form-data

2.3. Verificação de pessoa (1:1)

POST /verify

2.3.1. Descrição

Para validar a identidade de uma determinada pessoa a partir de uma ou várias imagens biométricas (uma ou várias impressões digitais com ou sem sua face) e seu número de identificação (ID).

2.3.2. Parâmetros

Tipo Nome Descrição Esquema

FormData

CustomID
obrigatório

Código no cliente que representa a pessoa

string

FormData

Finger-1
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao polegar direito.

file

FormData

Finger-2
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao indicador direito.

file

FormData

Finger-3
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao médio direito.

file

FormData

Finger-4
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao anelar direito.

file

FormData

Finger-5
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao mínimo direito.

file

FormData

Finger-6
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao polegar esquerdo.

file

FormData

Finger-7
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao indicador esquerdo.

file

FormData

Finger-8
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao médio esquerdo.

file

FormData

Finger-9
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao anelar esquerdo.

file

FormData

Finger-10
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao mínimo esquerdo.

file

FormData

Finger-X
opcional

Byte array com o arquivo de imagem da impressão digital com posição desconhecida.

file

FormData

Face
opcional

Byte array com o arquivo de imagem da face.

file

2.3.3. Respostas

Código de status HTTP Descrição Esquema

200

Dados de resposta em caso de sucesso.

Resposta 200

401

Usuário e/ou senha inválidos ou não informados na requisição.

Nenhum conteúdo

415

Quando não for enviado Content-Type igual a multipart/form-data.

Nenhum conteúdo

500

Será retornado um objeto JSON com a descrição do erro.

Nenhum conteúdo

Resposta 200

Nome Descrição Esquema

CustomID
opcional

Código da pessoa enviado pelo solicitante

string

Match
opcional

True para verificação com sucesso e False para verificação mal sucedida

boolean

MatchDetails
opcional

MatchDetails

MatchDetails

Nome Descrição Esquema

NonMatchedFingers
opcional

Lista com dedos que não coincidiram

< integer > array

FaceMatched
opcional

Booleano que informa se a face enviada coincidiu

boolean

2.3.4. Consome

  • multipart/form-data

2.4. Identificação de pessoa (1:N)

POST /identify

2.4.1. Descrição

Para pesquisar em toda a base de dados a existência de uma determinada pessoa a partir de uma ou várias imagens biométricas (uma ou várias impressões digitais com ou sem sua face).

2.4.2. Parâmetros

Tipo Nome Descrição Esquema

FormData

CustomID
obrigatório

Código no cliente que representa a pessoa

string

FormData

Finger-1
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao polegar direito.

file

FormData

Finger-2
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao indicador direito.

file

FormData

Finger-3
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao médio direito.

file

FormData

Finger-4
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao anelar direito.

file

FormData

Finger-5
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao mínimo direito.

file

FormData

Finger-6
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao polegar esquerdo.

file

FormData

Finger-7
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao indicador esquerdo.

file

FormData

Finger-8
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao médio esquerdo.

file

FormData

Finger-9
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao anelar esquerdo.

file

FormData

Finger-10
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao mínimo esquerdo.

file

FormData

Finger-X
opcional

Byte array com o arquivo de imagem da impressão digital com posição desconhecida.

file

FormData

Face
opcional

Byte array com o arquivo de imagem da face.

file

2.4.3. Respostas

Código de status HTTP Descrição Esquema

200

Dados de resposta em caso de sucesso.

Resposta 200

401

Usuário e/ou senha inválidos ou não informados na requisição.

Nenhum conteúdo

415

Quando não for enviado Content-Type igual a multipart/form-data.

Nenhum conteúdo

500

Será retornado um objeto JSON com a descrição do erro.

Nenhum conteúdo

Resposta 200

Nome Descrição Esquema

Match
opcional

True para identificação com sucesso e False para identificação mal sucedida

boolean

Result
opcional

Lista de pessoas coincidentes, caso Match seja True

< Result > array

Result

Nome Descrição Esquema

CustomID
opcional

Código encontrado

string

Score
opcional

Valor de similaridade com a pessoa encontrada. Quanto maior, mais parecido.

integer

MatchDetails
opcional

< MatchDetails > array

MatchDetails

Nome Descrição Esquema

NonMatchedFingers
opcional

Lista com dedos que não coincidiram

< integer > array

FaceMatched
opcional

Booleano que informa se a face enviada coincidiu

boolean

2.4.4. Consome

  • multipart/form-data

2.5. Atualização ou remoção de item de informação biométrica da pessoa

POST /update

2.5.1. Descrição

Troca a informação biométrica dos itens informados e remove os que forem enviados como um array vazio.

2.5.2. Parâmetros

Tipo Nome Descrição Esquema

FormData

CustomID
obrigatório

Código no cliente que representa a pessoa

string

FormData

Finger-1
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao polegar direito.

file

FormData

Finger-2
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao indicador direito.

file

FormData

Finger-3
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao médio direito.

file

FormData

Finger-4
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao anelar direito.

file

FormData

Finger-5
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao mínimo direito.

file

FormData

Finger-6
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao polegar esquerdo.

file

FormData

Finger-7
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao indicador esquerdo.

file

FormData

Finger-8
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao médio esquerdo.

file

FormData

Finger-9
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao anelar esquerdo.

file

FormData

Finger-10
opcional

Byte array com o arquivo de imagem da impressão digital correspondente ao mínimo esquerdo.

file

FormData

Face
opcional

Byte array com o arquivo de imagem da face.

file

2.5.3. Respostas

Código de status HTTP Descrição Esquema

200

Dados de resposta em caso de sucesso.

Resposta 200

401

Usuário e/ou senha inválidos ou não informados na requisição.

Nenhum conteúdo

415

Quando não for enviado Content-Type igual a multipart/form-data.

Nenhum conteúdo

500

Será retornado um objeto JSON com a descrição do erro.

Nenhum conteúdo

Resposta 200

Nome Descrição Esquema

CustomID
opcional

Código da pessoa enviado pelo solicitante

string

BioPassID
opcional

Código interno da pessoa no BioPassID

integer

2.5.4. Consome

  • multipart/form-data

3. Segurança

3.1. basic

Todos os métodos expostos na API do BioPassID são autenticados por Basic Authentication. Os dados de acesso serão fornecidos no momento da criação da conta no serviço.

Tipo : basic