Consulta de CPF
POST/v1/cpf
Consulta um CPF informando também a data de nascimento. A resposta pode refletir uma consulta feita há até 30 dias à fonte oficial.
Corpo da requisição
- cpfstringobrigatório
- CPF com 11 dígitos, com ou sem pontuação.
- birthdatestringobrigatório
- Data de nascimento do titular, no formato
AAAA-MM-DD. Se não conferir com a da fonte oficial, a resposta é 404.
Só a resposta 200 cobra 1 crédito.
- A ordem das verificações é: formato do CPF e da data (400), dígitos verificadores (422), saldo (402) e, por fim, a consulta (fonte oficial).
- Quando a fonte oficial está indisponível, a resposta é 503 e nada é cobrado.
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}
404 Not Found
1{2 "error": "CPF not found"3}