For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
StatusDashboard
  • Getting Started
    • Introduction
    • Authentication
    • Rate Limits
    • Error Handling
  • Guides
    • Cash-In (Receiving Payments)
    • Cash-Out (Sending Payments)
    • PIX Keys Management
    • Webhooks Integration
    • MED (Special Returns)
  • API Reference
      • POSTGenerate Bearer Token
LogoLogo
StatusDashboard
API ReferenceAuthentication

Generate Bearer Token

POST
https://api.brzip.com.br/api/v1/auth/bearer-token
POST
/api/v1/auth/bearer-token
$curl -X POST https://api.brzip.com.br/api/v1/auth/bearer-token \
>     -H "x-key-id: key_abc123def456" \
>     -H "x-secret-key: sec_xyz789ghi012" \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{
2  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJrZXlfYWJjMTIzZGVmNDU2Iiwic2NvcGVzIjpbInBpeDprZXlzOnJlYWQiLCJwaXg6a2V5czp3cml0ZSIsInBpeDpiYWxhbmNlOnJlYWQiLCJwaXg6Y2FzaG91dDp3cml0ZSIsIndlYmhvb2tzOnJlYWQ",
3  "expiresIn": 3600,
4  "scopes": [
5    "pix:keys:read",
6    "pix:keys:write",
7    "pix:balance:read",
8    "pix:cashout:write",
9    "webhooks:read",
10    "webhooks:write"
11  ],
12  "refreshToken": "365d1f9d-ba6f-4643-8759-6654fa0ec947"
13}
Generate a JWT Bearer Token using your API Key credentials. **Authentication:** Pass your credentials via headers `x-key-id` and `x-secret-key`. **Request body:** Optionally specify the `scopes` array to limit the token's permissions. If omitted, the token includes all scopes available to your API Key. The returned token should be included in the `Authorization` header as `Bearer <token>` for all subsequent requests.
Was this page helpful?
Previous

Health Check

Next
Built with

Generate a JWT Bearer Token using your API Key credentials.

Authentication: Pass your credentials via headers x-key-id and x-secret-key.

Request body: Optionally specify the scopes array to limit the token’s permissions. If omitted, the token includes all scopes available to your API Key.

The returned token should be included in the Authorization header as Bearer <token> for all subsequent requests.

Headers

x-key-idstringRequired
Your API Key ID, provided after account approval.
x-secret-keystringRequired
Your API Secret Key, provided after account approval.

Request

This endpoint expects an object.
scopeslist of enumsOptional
List of scopes to include in the token. If omitted, all scopes available to the API Key are included.

Response

Token generated successfully
tokenstring
JWT Bearer Token to use in the Authorization header.
expiresIninteger
Token expiration time in seconds.
scopeslist of strings
List of scopes included in the token.
refreshTokenstring
Token to refresh the Bearer Token when it expires.

Errors

401
Unauthorized Error