# Verificação por imagem - 1:N (Ainda não disponível)

# Início

Este documento descreve a integração do endpoint de busca de imagem 1:N, com suporte para criação e verificação de registros de identidade utilizando imagens de usuários, para empresas autorizadas.

# Autenticação

É obrigatório o envio do Token através do header Authorization incluindo a palavra 'Bearer'.

# Exemplo

  • Respostas - Status Code:
Code Descrição
200 Sucesso
400 Falha ao realizar ação, possuindo uma mensagem no data do response
401 Erro no Token
500 Erro no servidor
// ajax
$.ajax({
  url: 'ENDPOINT',
  headers: {
    'Authorization': `Bearer ${TOKEN DA EMPRESA}`,
  },
  method: 'MÉTODO DO ENDPOINT',
  data: PARAMETROS,
  success: function(data){
    console.log('success: '+data);
  }
});

// axios
axios({
  method: 'MÉTODO DO ENDPOINT',
  url: ENDPOINT,
  data: PARAMETROS,
  headers: { 'Authorization': `Bearer ${TOKEN DA EMPRESA}` }
});

# Ambientes de Integração

# Sandbox

Ambiente de testes e desenvolvimento:

URL

https://api.sandbox.biodoc.com.br/api

# Produção

Ambiente de produção:

URL

https://api.biodoc.com.br/api

# Endpoints

Nesta sessão, abordaremos os Endpoints disponíveis para a troca de informação entre seu sistema e o BioDoc.

ATENÇÃO

Caso necessite de alguma informação não disponível nos endpoints da API, entre em contato com nosso Suporte para que possamos evoluir os retornos de nossa API.

# Endpoints

# /recognize/register

  • Descrição: Endpoint para criar um novo registro de identidade no modelo de busca 1:N, associando os detalhes do usuário e sua imagem, vinculado à empresa autorizada.
  • Método: POST
  • Formato dos parâmetros: JSON (corpo da requisição)

# Parâmetros da Requisição

Parâmetro Descrição Formato Obrigatório
card_id Número identificador do cartão do beneficiário string Sim
image Imagem do beneficiário em base64 Base64 Sim
name Nome do beneficiário string Sim
// Exemplo do corpo da requisição

{
  "card_id": "99990123456789012",
  "image": "imagem em base64",
  "name": "Nome do Usuário"
}

# Respostas

201 - Registro criado com sucesso
Exemplo:

{
  "message": "Usuário registrado com sucesso"
}

400 - Erro de validação ou requisição inválida
Exemplo:

{
  "code": "ERR_INVALID_REQUEST",
  "error": "Formato do payload inválido"
}

422 - Falha no processamento do registro
Exemplo:

{
  "code": "ERR_REGISTRATION_FAILED",
  "error": "Falha ao registrar o usuário"
}

# /recognize/verify

  • Descrição: Endpoint para verificar a identidade do usuário por meio de uma imagem, realizando uma busca 1:N.
  • Método: POST
  • Formato dos parâmetros: JSON (corpo da requisição)

# Parâmetros da Requisição

Parâmetro Descrição Formato Obrigatório
image Imagem em base64 para verificação de identidade Base64 Sim
// Exemplo do corpo da requisição

{
  "image": "imagem em base64"
}

# Respostas

200 - Verificação bem-sucedida
Exemplo:

{
  "card_id": "99990123456789012",
  "card_name": "Nome do Usuário",
  "image_url": "https://imagem.com/usuario123"
}

400 - Erro de validação ou requisição inválida
Exemplo:

{
  "code": "ERR_INVALID_REQUEST",
  "error": "Formato de imagem inválido"
}

422 - Falha na verificação de identidade
Exemplo:

{
  "code": "ERR_VERIFICATION_FAILED",
  "error": "Identidade do usuário não pôde ser verificada"
}

← Manejo de Erros e Retornos da API →