Skip to main content

​
Quick Start Guide

Get up and running with Avenia API in just 5 minutes.

​
Step 1: Choose Your Environment

Sandbox - For testing (recommended for development) 
https://api.sandbox.avenia.io:10952/v2
Production - For live transactions 
https://api.avenia.io:8443/v2

​
Step 2: Login

Authenticate with your email and password to receive an authorization token: 
curl -X POST "https://api.sandbox.avenia.io:10952/v2/auth/login" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "your.email@provider.com",
    "password": "YourPassword123!"
  }'
You will receive an authorization token in your email.

​
Step 3: Validate Login

Validate your login using the token received in your email: 
curl -X POST "https://api.sandbox.avenia.io:10952/v2/auth/validate-login" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "your.email@provider.com",
    "emailToken": "874484"
  }'
You will receive your accessToken and refreshToken in the response.

​
Step 4: Get Account Info

Use your JWT access token to fetch your account information: 
curl -X GET "https://api.sandbox.avenia.io:10952/v2/account/account-info" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​
Expected Response

You should receive a response like: 
{
  "id": "00000000-0000-0000-0000-000000000000",
  "accountInfo": {
    "id": "11111111-1111-1111-1111-111111111111",
    "accountType": "INDIVIDUAL",
    "name": "Your Name",
    "countryTaxResidence": "BRA"
  },
  "wallets": [],
  "createdAt": "2025-02-18T17:00:39.854943Z"
}

​
Next Steps

Congratulations! You’ve made your first API call.