Inicio rápido
De la cuenta creada a la primera respuesta en tres pasos.
Cree su cuenta
Regístrese en el panel y confirme el correo. La clave de API solo se libera tras la confirmación. El plan gratuito incluye 20 consultas por ciclo, sin tarjeta.
Genere una clave de API
En el panel, abra Claves de API y cree una. Copie el valor en el momento: se muestra una sola vez y empieza con
brz_live_.Haga la primera consulta
Envíe el CPF y la fecha de nacimiento a
POST /v1/cpf, con la clave en el encabezadox-api-key.
¿Y después?
Guarde la clave en una variable de entorno de su servidor, trate los errores de la tabla de errores y, para listas grandes, use la consulta por lotes. ¿Quiere probar antes de gastar créditos? Use el sandbox.
cURL
1curl -X POST https://api.brazid.com/v1/cpf \2 -H "x-api-key: $BRAZID_API_KEY" \3 -H "Content-Type: application/json" \4 -d '{"cpf":"529.982.247-25","birthdate":"1982-11-26"}'
1const res = await fetch('https://api.brazid.com/v1/cpf', {2 method: 'POST',3 headers: {4 'x-api-key': process.env.BRAZID_API_KEY,5 'Content-Type': 'application/json',6 },7 body: JSON.stringify({8 "cpf": "529.982.247-25",9 "birthdate": "1982-11-26"10 }),11});12 13const data = await res.json();14console.log(res.status, data);
1import os2import requests3 4res = requests.post(5 "https://api.brazid.com/v1/cpf",6 headers={"x-api-key": os.environ["BRAZID_API_KEY"]},7 json={8 "cpf": "529.982.247-25",9 "birthdate": "1982-11-26"10 },11)12 13print(res.status_code, res.json())
1$ch = curl_init("https://api.brazid.com/v1/cpf");2curl_setopt_array($ch, [3 CURLOPT_RETURNTRANSFER => true,4 CURLOPT_CUSTOMREQUEST => "POST",5 CURLOPT_HTTPHEADER => [6 "x-api-key: " . getenv("BRAZID_API_KEY"),7 "Content-Type: application/json",8 ],9 CURLOPT_POSTFIELDS => '{"cpf":"529.982.247-25","birthdate":"1982-11-26"}',10]);11 12$data = json_decode(curl_exec($ch), true);13$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
200 OK
1{2 "success": true,3 "data": {4 "cpf": "52998224725",5 "name": "MARIA SOUZA LIMA",6 "birthdate": "26/11/1982",7 "day": 26,8 "month": 11,9 "year": 1982,10 "situation": "REGULAR",11 "social_name": null,12 "registration_date": "12/03/2004"13 },14 "credits_remaining": 1915}