Validar documento
POST/v1/validate
Confere o formato e os dígitos verificadores de um CPF ou CNPJ (inclusive o CNPJ alfanumérico), só com cálculo. Não consulta nenhuma base: não confirma que o documento existe nem de quem é.
Corpo da requisição
- documentstringobrigatório
- CPF ou CNPJ, com ou sem pontuação.
Gratuito: não consome crédito e não consulta nenhuma base de dados. Vale o limite de requisições do seu plano.
- Com o corpo correto a resposta é sempre 200, mesmo que o documento seja inválido: leia
valid,format_validecheck_digit_valid. - Campos de
data:document(sem pontuação),type(CPF,CNPJounullquando o tamanho não bate),format_valid,check_digit_validevalid. - Sem o campo
documentem texto, a resposta é 400 com o códigoINVALID_DOCUMENT.
cURL
1curl -X POST https://api.brazid.com/v1/validate \2 -H "x-api-key: $BRAZID_API_KEY" \3 -H "Content-Type: application/json" \4 -d '{"document":"529.982.247-25"}'
1const res = await fetch('https://api.brazid.com/v1/validate', {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 "document": "529.982.247-25"9 }),10});11 12const data = await res.json();13console.log(res.status, data);
1import os2import requests3 4res = requests.post(5 "https://api.brazid.com/v1/validate",6 headers={"x-api-key": os.environ["BRAZID_API_KEY"]},7 json={8 "document": "529.982.247-25"9 },10)11 12print(res.status_code, res.json())
1$ch = curl_init("https://api.brazid.com/v1/validate");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 => '{"document":"529.982.247-25"}',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 "document": "52998224725",5 "type": "CPF",6 "format_valid": true,7 "check_digit_valid": true,8 "valid": true9 }10}
200 OK · valid: false
1{2 "success": true,3 "data": {4 "document": "52998224724",5 "type": "CPF",6 "format_valid": true,7 "check_digit_valid": false,8 "valid": false9 }10}