Biometria

Detecção e recorte de rosto

Encontra o maior rosto da imagem e devolve só o recorte, em JPEG.

Motor própriotempo real
POST/api/v1/oracle/face/crop

Sobre esta API

Encontra o maior rosto da imagem e devolve só o recorte, em JPEG — para avatar, miniatura na ficha do cliente ou para arquivar só o rosto do documento.

Envie a imagem em file — foto, HEIC ou PDF; do PDF, vale a primeira página. A resposta é a imagem, não JSON: o log_id vem no header X-Api4devs-Log-Id.

Tecnologia

Motor próprio · Atualização: tempo real

Requisição

POST /api/v1/oracle/face/crop

Autenticação HTTP Basic: public_key:secret_key em Base64. Guarde a chave secreta no servidor.

CabeçalhoDescrição
Authorization
Obrigatório
Chave de API em Basic: public_key:secret_key em Base64.
X-Project-Id
Opcional
Projeto que recebe a chamada. Sem ele, vale o projeto padrão da conta.
Idempotency-Key
Opcional
Repetir a mesma chave em até 24 horas devolve a resposta anterior, sem executar nem cobrar de novo.

Parâmetros

CampoTipo e localDescrição
file
Obrigatório
filefileImagem, HEIC ou PDF contendo um rosto.
curl --request POST 'https://api.apifordevs.com/api/v1/oracle/face/crop' \
  --user "afd_live_pk_...:$AFD_SECRET_KEY" \
  --header "X-Project-Id: $AFD_PROJECT_ID" \
  --form 'file=@./file.jpg'

Campos de resposta

Campos e tipos publicados no catálogo desta API.

Exemplo de resposta

{}

Respostas e cobrança

HTTPDescriçãoCobrança
200Sucesso.Sujeita à cobrança
400

bad_request

live_key_cannot_use_dev_mode

Arquivo ou parâmetro que a rota não consegue processar, projeto inválido, ou dev_mode=true com chave de produção.Sem cobrança
401

unauthorized

Credencial ausente, inválida ou revogada.Sem cobrança
402

payment_required

Saldo insuficiente ou limite de gasto diário atingido.Sem cobrança
403

forbidden

ip_not_allowed

test_key_cannot_run_live

E-mail da conta não verificado, chave sem escopo para o serviço, IP fora da allowlist do projeto ou chave de teste sem dev_mode=true.Sem cobrança
409

conflict

Requisição com a mesma Idempotency-Key ainda em andamento.Sem cobrança
413

payload_too_large

Arquivo acima de 20 MB.Sem cobrança
422

validation_error

Parâmetro obrigatório ausente ou fora do formato, ou Idempotency-Key repetida com outro conteúdo.Sem cobrança
429

rate_limit_exceeded

Limite de requisições por minuto da chave atingido.Sem cobrança
500

internal_error

Falha interna.Sem cobrança
503

service_unavailable

Serviço desativado ou temporariamente indisponível.Sem cobrança

Casos de uso

Foto de perfil padronizada

Gerar avatar recortado a partir da foto que o usuário enviou.

Menos imagem pessoal guardada

Recortar o rosto do documento antes de arquivar, reduzindo o que se guarda de imagem pessoal.

Notas de integração

  • A resposta é image/jpeg, sem envelope JSON. X-Api4devs-Log-Id e os headers de cota voltam mesmo assim.
SUA PRÓXIMA ENTREGA

Qual é a sua próxima integração?

Encontre a API que resolve o próximo passo do seu produto.