Ir para o conteúdo principal
Contrato OpenAPI v0.1.0: Alinhado ao arquivo contracts/openapi.yaml. Endpoints exclusivos do Console (/dashboard/v1) aguardam publicação complementar do backend.

Quickstart: Primeira Comparação

Siga os passos abaixo para executar sua primeira chamada autenticada a partir do seu backend.

1. Crie sua organização e gere uma API key

Acesse app.conformo.com.br, crie sua organização e gere uma chave no ambiente Sandbox com o escopo face:compare. Copie a chave imediatamente (ela é exibida uma única vez) e armazene na variável de ambiente CONFORMO_API_KEY.

2. Execute a requisição no servidor

Regra de segurança: Nunca coloque sua CONFORMO_API_KEY em código JavaScript executado no navegador ou em aplicativos móveis.
cURL
curl -X POST https://api.conformo.com.br/v1/face/compare \
  -H "X-API-Key: cf_test_sua_chave_aqui" \
  -H "Idempotency-Key: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d" \
  -F "source_image=@./foto_cadastro.jpg" \
  -F "target_image=@./nova_foto.jpg"

3. Interprete a resposta

Em caso de sucesso (200 OK), você receberá um JSON com o score e o status da comparação:

{
  "operation_id": "01933c2a-7b1e-7000-8000-000000000001",
  "processing_status": "completed",
  "status": "match",
  "result_code": "face_match",
  "similarity_score": 0.842,
  "engine_version": "1.0.0",
  "model_version": "2026.1",
  "policy_version": "2026-11",
  "execution_time_ms": 342,
  "billable": true,
  "credits_consumed_micros": 60000
}