Account details
GET/v1/me
Shows the account that owns the key: name, environment (production or test), plan and credit balance.
Header
- x-api-keyheaderrequired
- Your API key.
Free: it uses no credit.
namecomes from the tax details (company name or name) and isnulluntil the sign-up is complete.credits_remainingadds the cycle allowance and add-on credits. Here the balance always appears, even with the option turned off in the settings, which only applies to lookups.- In the sandbox
environmentistestand the balance is the real one, which does not change.
cURL
1curl https://api.brazid.com/v1/me \2 -H "x-api-key: $BRAZID_API_KEY"
1const res = await fetch('https://api.brazid.com/v1/me', {2 headers: { 'x-api-key': process.env.BRAZID_API_KEY },3});4 5const data = await res.json();6console.log(res.status, data);
1import os2import requests3 4res = requests.get(5 "https://api.brazid.com/v1/me",6 headers={"x-api-key": os.environ["BRAZID_API_KEY"]},7)8 9print(res.status_code, res.json())
1$ch = curl_init("https://api.brazid.com/v1/me");2curl_setopt_array($ch, [3 CURLOPT_RETURNTRANSFER => true,4 CURLOPT_HTTPHEADER => ["x-api-key: " . getenv("BRAZID_API_KEY")],5]);6 7$data = json_decode(curl_exec($ch), true);8$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
200 OK
1{2 "success": true,3 "data": {4 "name": "Empresa Exemplo LTDA",5 "environment": "production",6 "plan": {7 "id": "PRO_200",8 "name": "Pro 200"9 },10 "monthly_credits": 200,11 "credits_remaining": 187,12 "period_end": "2026-11-12T00:00:00.000Z"13 }14}