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" C# / .NET
using var client = new HttpClient { Timeout = TimeSpan.FromSeconds(15) };
client.DefaultRequestHeaders.Add("X-API-Key", Environment.GetEnvironmentVariable("CONFORMO_API_KEY"));
client.DefaultRequestHeaders.Add("Idempotency-Key", Guid.NewGuid().ToString());
using var form = new MultipartFormDataContent();
form.Add(new StreamContent(File.OpenRead("foto_cadastro.jpg")), "source_image", "foto_cadastro.jpg");
form.Add(new StreamContent(File.OpenRead("nova_foto.jpg")), "target_image", "nova_foto.jpg");
var response = await client.PostAsync("https://api.conformo.com.br/v1/face/compare", form);
var json = await response.Content.ReadAsStringAsync();
Console.WriteLine(json); JavaScript (Node.js)
import fs from "node:fs";
import crypto from "node:crypto";
const form = new FormData();
form.append("source_image", new Blob([fs.readFileSync("foto_cadastro.jpg")], { type: "image/jpeg" }), "foto_cadastro.jpg");
form.append("target_image", new Blob([fs.readFileSync("nova_foto.jpg")], { type: "image/jpeg" }), "nova_foto.jpg");
const response = await fetch("https://api.conformo.com.br/v1/face/compare", {
method: "POST",
headers: {
"X-API-Key": process.env.CONFORMO_API_KEY ?? "",
"Idempotency-Key": crypto.randomUUID(),
},
body: form,
signal: AbortSignal.timeout(15000),
});
if (!response.ok) {
const problem = await response.json();
throw new Error(`[${problem.error_code}] ${problem.title} (request_id: ${problem.request_id})`);
}
const result = await response.json();
console.log(result); Python
import os
import uuid
import requests
with open("foto_cadastro.jpg", "rb") as src, open("nova_foto.jpg", "rb") as tgt:
res = requests.post(
"https://api.conformo.com.br/v1/face/compare",
headers={
"X-API-Key": os.environ["CONFORMO_API_KEY"],
"Idempotency-Key": str(uuid.uuid4()),
},
files={"source_image": src, "target_image": tgt},
timeout=15,
)
res.raise_for_status()
print(res.json()) 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
}