Quickstart
From a new account to your first response in three steps.
Create your account
Sign up in the dashboard and confirm your email. API keys are only released after confirmation. The free plan includes 20 lookups per cycle, no card needed.
Create an API key
In the dashboard, open API keys and create one. Copy the value right away: it is shown only once and starts with
brz_live_.Make your first request
Send the CPF and date of birth to
POST /v1/cpf, with your key in thex-api-keyheader.
What next?
Store the key in an environment variable on your server, handle the errors in the error table and, for long lists, use the batch lookup. Want to test before spending credits? Use the 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}