Busca de Rosto

Procure por fotos do mesmo rosto que foram adicionadas por fotos

1. Adicionar imagem de rosto

Exemplo de código:

curl --location --request POST 'https://api.ekycpro.com/v1/addface' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-API-Key: AbcdEfgh' \
--data-urlencode 'img=BASE64_ENCODE_VALUE'

Resposta para adicionar rosto com sucesso com um rosto na imagem

{
  "status": "OK",
  "message": [
    {
      "name": "ID0",
      "person_id": "4fbd9474-e09f-4e7d-9a2f-06fa1167f67e"
    }
  ]
}

Resposta para adicionar rosto com sucesso com dois rostos na imagem

{
  "status": "OK",
  "message": [
    {
      "name": "ID1",
      "person_id": "c4b38db9-0721-4703-bf4d-306d176dd455"
    },
    {
      "name": "ID2",
      "person_id": "2c8460fa-3a44-4250-9542-a1e523f21a26"
    }
  ]
}

Resposta para falha na detecção de rosto

{
  "status": "FACE_DETECT_FAILED",
  "message": "check input image and retry"
}

Resposta para erro no servidor

{
  "status": "FAIL",
  "message": "please try again later"
}

Resposta para formato de imagem inválido

{
  "status": "IMAGE_INVALID_FORMAT",
  "message": "image format not support"
}

Resposta para imagem maior que 2M

{
  "status": "IMAGE_INVALID_SIZE",
  "message": "image larger than 2M"
}

Requisição HTTP

POST http://api.ekycpro.com/v1/addface

Parâmetros da requisição

parâmetro	descrição
img	string, use base64 para codificar a imagem do rosto
name	string, informação anexada ao rosto adicionado, menos de 128 caracteres, combinação de números e letras
facedb	opcional, string, ID do facedb. se você precisar abrir o facedb, entre em contato com o pessoal de negócios para fornecer informações adicionais do facedb

Formato da resposta

campos	descrição
status	código de status, se status for OK, a imagem do rosto foi adicionada com sucesso
message	algumas mensagens do resultado da adição person_id: este é o ID pessoal único que você adicionou name: o nome pessoal de entrada

Código de status

status	descrição
OK	charge, imagem do rosto adicionada com sucesso, adicionar rosto é gratuito
FACE_DETECT_FAILED	charge, falha na detecção do rosto
IMAGE_INVALID_SIZE	free, imagem maior que 2M
IMAGE_INVALID_FORMAT	free, formato de imagem inválido, o formato da imagem deve ser um dos jpeg/jpg/png/bmp
INVALID_REQUEST	free, parâmetros de requisição inválidos
FAIL	free, outros erros

2. Buscar o mesmo rosto

Exemplo de código:

curl --location --request POST 'https://api.ekycpro.com/v1/searchface' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-API-Key: AbcdEfgh' \
--data-urlencode 'img=BASE64_ENCODE_VALUE'

Resposta para obter rostos semelhantes

{
  "status": "OK",
  "message": [
    {
      "confidence": 100,
      "name": "NAME",
      "person_id": "154fa1b2-9a21-4e67-8ea3-075c76162900"
    },
    {
      "confidence": 80,
      "name": "",
      "person_id": "4fbd9474-e09f-4e7d-9a2f-06fa1167f67e"
    }
  ]
}

Resposta para não obter rostos semelhantes

{
  "status": "NO_SIMILAR_FACE",
  "message": "no similar face in db"
}

Resposta para falha na detecção de rosto

{
  "status": "FACE_DETECT_FAILED",
  "message": "check input image and retry"
}

Resposta para formato de imagem inválido

{
  "status": "IMAGE_INVALID_FORMAT",
  "message": "image format not support"
}

Resposta para imagem maior que 2M

{
  "status": "IMAGE_INVALID_SIZE",
  "message": "image larger than 2M"
}

Resposta para erro no servidor

{
  "status": "FAIL",
  "message": "please try again later"
}

Requisição HTTP

POST http://api.ekycpro.com/v1/searchface

Parâmetros da requisição

parâmetro	descrição
img	string, a codificação base64 da imagem do rosto
facedb	opcional, string, ID do facedb. se você precisar abrir o facedb, entre em contato com o pessoal de negócios para fornecer informações adicionais do facedb

Formato da resposta

campos	descrição
status	código de status
message	algumas mensagens do resultado da busca de rosto confidence: este é o nível de confiança do rosto buscado, o intervalo é [0, 100]. Confiança maior que 80 será listada, e um máximo de 50 itens semelhantes será listado. Em situações reais, a confiança precisa ser definida em torno de 95 pontos para garantir precisão suficiente. person_id: este é o ID pessoal único que você adicionou name: a informação pessoal de entrada

Código de status

status	descrição
OK	charge, busca de imagem do rosto com sucesso
NO_SIMILAR_FACE	charge, nenhum rosto semelhante no banco de dados
FACE_DETECT_FAILED	charge, falha na detecção do rosto
IMAGE_INVALID_SIZE	free, imagem maior que 2M
IMAGE_INVALID_FORMAT	free, formato de imagem inválido, o formato da imagem deve ser um dos jpeg/jpg/png/bmp
INVALID_REQUEST	free, parâmetros de requisição inválidos
FAIL	free, outros erros

3. Excluir rosto

Exemplo de código:

curl --location --request POST 'https://api.ekycpro.com/v1/delface' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-API-Key: AbcdEfgh' \
--data-urlencode 'person_id=personId'

Resposta para exclusão de rosto com sucesso

{
  "status": "OK",
  "message": "successfully deleted face"
}

Resposta para ID de pessoa não existente

{
  "status": "PERSON_ID_NOT_EXIST",
  "message": "check input person id"
}

Resposta para erro no servidor

{
  "status": "FAIL",
  "message": "please try again later"
}

Requisição HTTP

POST http://api.ekycpro.com/v1/delface

Parâmetros da requisição

parâmetro	descrição
person_id	string, ID da pessoa
facedb	opcional, string, ID do facedb. se você precisar abrir o facedb, entre em contato com o pessoal de negócios para fornecer informações adicionais do facedb

Formato da resposta

campos	descrição
status	código de status
message	descrição do erro

Código de status

status	descrição
OK	free, rosto excluído com sucesso
PERSON_ID_NOT_EXIST	free, ID da pessoa de entrada não existe
INVALID_REQUEST	free, parâmetros de requisição inválidos
FAIL	free, outros erros