Avenia API

https://integration-guide.avenia.io
Admin
Avenia API is a financial platform for fiat-to-crypto conversions, subaccount management, KYC/KYB...
Tokens:181,677
Snippets:1,273
Trust Score:6.4
Update:1 month ago
Show doc for...
Tokens:
Raw
### Get Access cURL Example

Source: https://integration-guide.avenia.io/docs/Avenia-Account-Management/accessesManagement

Example request to retrieve access information using a bearer token.

```bash
curl -X GET "https://api.sandbox.avenia.io:10952/v2/auth/accesses/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
```

--------------------------------

### cURL Example for Access Creation

Source: https://integration-guide.avenia.io/docs/Avenia-Account-Management/accessesManagement

A command-line example demonstrating how to send the POST request with authentication headers.

```bash
curl -X POST "https://api.sandbox.avenia.io:10952/v2/auth/accesses/" \
  -H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "Content-Type: application/json" \
  -d '{
    "otp": "999999",
    "email": "your.new.access.email@provider.com",
    "permissions": {
      "payOut": true,
      "viewOnly": false
    }
  }'
```

--------------------------------

### List Accesses cURL Example

Source: https://integration-guide.avenia.io/docs/Avenia-Account-Management/accessesManagement

Example cURL command to list accesses with email and permission filters.

```bash
curl -X GET "https://api.sandbox.avenia.io:10952/v2/auth/accesses?email=your.new.access.email@provider.com&payOut=true" \
  -H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
```

--------------------------------

### Example JSON Response for Account Balance

Source: https://integration-guide.avenia.io/docs/Export/template

This is an example of the JSON response detailing your account balances for various currency tokens.

```json
{
  "balances": {
    "BRLA": "9457.170326",
    "USDC": "0",
    "USDT": "42.07732"
  }
}

```

--------------------------------

### cURL Request Example

Source: https://integration-guide.avenia.io/docs/KYC/kycLevel1

Example command to fetch document status using cURL with an authorization header.

```bash
curl -X GET "https://api.sandbox.avenia.io:10952/v2/documents/9e37f9a8-611a-4cad-99fb-dd13268bdf4b" \
     -H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
```

--------------------------------

### cURL Example for Static BR Code Generation

Source: https://integration-guide.avenia.io/docs/Bank%20Accounts/staticBrCode

Use this cURL command to make a GET request to generate a static BR Code with a specified amount and reference label. Ensure your Authorization header is correctly set.

```curl
curl -X GET "https://api.sandbox.avenia.io:10952/v2/account/bank-accounts/brl/static-br-code?amount=10.00&referenceLabel=yourUniqueReference" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
```

--------------------------------

### cURL Request Example

Source: https://integration-guide.avenia.io/docs/KYB/kybCop

Example cURL command to submit the COP KYB request with authentication headers.

```bash
curl -X POST "https://api.sandbox.avenia.io:10952/v2/kyc/cop/api" \
     -H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
     -H "Content-Type: application/json" \
     -d '{
       "businessType": "llc",
       "businessIndustries": ["519290"],
       "proofOfRevenueDocId": "5f8d3c16-b2e7-4a9f-c834-1e6b0d5f2a91",
       "uboProofOfAddressDocs": [
         { "uboId": "9b5f722a-336a-4a60-82c5-a664657ba3e0", "uploadedDocumentId": "c4e9b27f-1a3d-4e8c-b561-7d2f0a9e4b38" }
       ]
     }'
```

--------------------------------

### Starting the Flask Development Server

Source: https://integration-guide.avenia.io/docs/Webhooks/verifyingWebhookAuthenticity

This code snippet shows how to start the Flask development server to listen for incoming webhook requests on port 8080.

```python
if __name__ == "__main__":
    logging.info("Listening on port 8080...")
    app.run(host='0.0.0.0', port=8080)

```

--------------------------------

### cURL Request for Account Statement

Source: https://integration-guide.avenia.io/docs/Avenia-Account-Management/accountStatement

Example command to fetch account statement data via a GET request.

```bash
curl -X GET "https://api.sandbox.avenia.io:10952/v2/account/statement"
```

--------------------------------

### KYB USD cURL Example

Source: https://integration-guide.avenia.io/docs/KYB/kybUsd

Example cURL command to submit the KYB USD request with authentication headers.

```bash
curl -X POST "https://api.sandbox.avenia.io:10952/v2/kyc/usd/api?subAccountId=a3f2c891-7b4d-4e6a-9d15-c82e0f3a1b57" \
     -H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
     -H "Content-Type: application/json" \
     -d '{
       "businessType": "llc",
       "businessIndustries": ["519290"],
       "proofOfRevenueDocId": "5f8d3c16-b2e7-4a9f-c834-1e6b0d5f2a91"
     }'
```

--------------------------------

### cURL Request Example

Source: https://integration-guide.avenia.io/docs/KYB/kybArs

Example command to submit the ARS KYB request using cURL.

```bash
curl -X POST "https://api.sandbox.avenia.io:10952/v2/kyc/ars/api" \
     -H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
     -H "Content-Type: application/json" \
     -d '{
       "businessType": "llc",
       "businessIndustries": ["519290"],
       "proofOfRevenueDocId": "5f8d3c16-b2e7-4a9f-c834-1e6b0d5f2a91",
       "uboProofOfAddressDocs": [
         { "uboId": "9b5f722a-336a-4a60-82c5-a664657ba3e0", "uploadedDocumentId": "c4e9b27f-1a3d-4e8c-b561-7d2f0a9e4b38" }
       ]
     }'
```

--------------------------------

### Get Address cURL Example

Source: https://integration-guide.avenia.io/docs/Avenia-Account-Management/addressApi

Example request using cURL, requiring a Bearer token for authorization.

```bash
curl -X GET "https://api.sandbox.avenia.io:10952/v2/account/address" \
     -H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
```

--------------------------------

### Ticket cURL Example

Source: https://integration-guide.avenia.io/docs/Usecases/pix2Stable&stable2pix

Example cURL command to execute the ticket operation.

```bash
curl -X POST "https://api.sandbox.avenia.io:10952/v2/account/tickets?subAccountId=1ee0a663-922b-4389-9f84-074ccff7085d" \
 -H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
 -H "Content-Type: application/json" \
 -d '{
 "quoteToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.quoteToken...."
 }'
```

--------------------------------

### Validate Access cURL Example

Source: https://integration-guide.avenia.io/docs/Avenia-Account-Management/accessesManagement

Example cURL command to validate an access invitation.

```bash
curl -X POST "https://api.sandbox.avenia.io:10952/v2/auth/accesses/validate/eyJhdXXXXXXXXXXXXXXX" \
  -H "Content-Type: application/json" \
  -d '{
    "password": "UseAStrongPassword123!",
    "confirmPassword": "UseAStrongPassword123!"
  }'
```

--------------------------------

### Quote Response Example

Source: https://integration-guide.avenia.io/docs/Export/template

This is an example of a successful quote response. It contains all the necessary information to create a payout ticket.

```json
{
  "quoteToken": "eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "inputCurrency": "USDC",
  "inputPaymentMethod": "POLYGON",
  "inputAmount": "10.1",
  "outputCurrency": "BRL",
  "outputPaymentMethod": "PIX-BRCODE",
  "outputAmount": "50",
  "markupAmount": "0",
  "markupCurrency": "",
  "blockchainSendMethod": "PERMIT",
  "inputThirdParty": false,
  "outputThirdParty": false,
  "appliedFees": [
    {
      "type": "Out Fee",
      "description": "Fees due to output currency and output payment method.",
      "amount": "0.5",
      "currency": "USDC"
    }
  ],
  "basePrice": "5",
  "pairName": "USDCBRL"
}
```

--------------------------------

### Login cURL Request

Source: https://integration-guide.avenia.io/docs/Usecases/payOutBrCode

Example cURL command to authenticate with email and password.

```bash
curl -X POST "https://api.sandbox.avenia.io:10952/v2/auth/login" \
 -H "Content-Type: application/json" \
 -d '{
     "email": "your.email@provider.com",
     "password": "UseAStrongPassword123!"
 }'
```

--------------------------------

### Quote Request Example

Source: https://integration-guide.avenia.io/docs/Sandbox%20Usecases/receiveMockFunds

A cURL command demonstrating how to request a quote for a PIX deposit.

```bash
curl -X GET "https://api.sandbox.avenia.io:10952/v2/account/quote/fixed-rate?inputCurrency=BRL&inputPaymentMethod=PIX&inputAmount=1000&outputCurrency=BRLA&outputPaymentMethod=INTERNAL&inputThirdParty=false&outputThirdParty=false&blockchainSendMethod=PERMIT"
```

--------------------------------

### Sample JSON Request Body

Source: https://integration-guide.avenia.io/docs/KYB/kybArs

Example of the JSON payload required for the business review.

```json
{
  "businessType": "llc",
  "businessIndustries": ["519290"],
  "proofOfRevenueDocId": "5f8d3c16-b2e7-4a9f-c834-1e6b0d5f2a91",
  "uboProofOfAddressDocs": [
    {
      "uboId": "9b5f722a-336a-4a60-82c5-a664657ba3e0",
      "uploadedDocumentId": "c4e9b27f-1a3d-4e8c-b561-7d2f0a9e4b38"
    }
  ]
}
```

--------------------------------

### cURL Example for Get Bre-B Info

Source: https://integration-guide.avenia.io/docs/Bank%20Accounts/bankAccountsCop

Example using cURL to make a GET request to the Bre-B Info endpoint. Ensure you replace the placeholder Authorization token with your actual token.

```curl
curl -X GET "https://api.sandbox.avenia.io:10952/v2/account/bank-accounts/cop/bre-b-info?breBKey=@CBW0ZWQT6" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
```

--------------------------------

### Initial Setup and Configuration

Source: https://integration-guide.avenia.io/docs/Security/apiKeysGuide

Import necessary libraries and define initial configuration variables for API requests. Ensure the timestamp is generated as a string of milliseconds.

```python
import time
import base64
import requests

from cryptography.hazmat.primitives import hashes, serialization
from cryptography.hazmat.primitives.asymmetric import padding

api_key = "dc96d0f8-ac73-4abe-ade3-c6d14e3e22fb"
endpoint = "https://api.sandbox.avenia.io:10952/v2/account/account-info"
method = "GET"
request_uri = "/v2/account/account-info"
body = ""
timestamp = str(int(time.time() * 1000))
```

--------------------------------

### Full Webhook Handler Implementation

Source: https://integration-guide.avenia.io/docs/Webhooks/verifyingWebhookAuthenticity

This comprehensive example demonstrates how to set up a Flask application to receive and verify incoming webhook requests. It includes fetching the public key, extracting the signature, and validating it against the request body.

```python
import base64
import json
import logging
import requests
from cryptography.hazmat.primitives import hashes
from cryptography.hazmat.primitives.asymmetric import padding, rsa
from cryptography.hazmat.primitives.serialization import load_pem_public_key
from flask import Flask, request, Response

app = Flask(__name__)
logging.basicConfig(level=logging.INFO)

def get_public_key():
    api = "https://api.sandbox.avenia.io:10952/v2/public-key"

    try:
        response = requests.get(api)
        response.raise_for_status()
        key_response = response.json()
        public_key_pem = key_response.get("publicKey")

        if not public_key_pem:
            raise ValueError("Empty public key received")

        public_key = load_pem_public_key(public_key_pem.encode())

        if not isinstance(public_key, rsa.RSAPublicKey):
            raise TypeError("Key is not RSA")

        return public_key

    except requests.RequestException as e:
        raise Exception(f"Failed to fetch public key: {str(e)}")
    except json.JSONDecodeError as e:
        raise Exception(f"Failed to parse response: {str(e)}")
    except (ValueError, TypeError) as e:
        raise Exception(str(e))

def verify_signature(body, signature_base64, public_key):
    try:
        signature = base64.b64decode(signature_base64)
        public_key.verify(
            signature,
            body,
            padding.PSS(
                mgf=padding.MGF1(hashes.SHA256()),
                salt_length=padding.PSS.MAX_LENGTH
            ),
            hashes.SHA256()
        )
        return True
    except Exception as e:
        logging.error("Verification error: %s", e)
        return False

@app.route('/', methods=['POST'])
def handler():
    try:
        public_key = get_public_key()
    except Exception as e:
        logging.error(f"Error obtaining public key: {str(e)}")
        return Response("Internal Server Error", status=500)

    signature_base64 = request.headers.get('Signature')
    if not signature_base64:
        return Response("Signature header is required", status=401)

    body = request.get_data()

    if verify_signature(body, signature_base64, public_key):
        return Response("Valid webhook received", status=200)
    else:
        return Response("Invalid signature", status=401)

if __name__ == "__main__":
    logging.info("Listening on port 8080...")
    app.run(host='0.0.0.0', port=8080)

```

--------------------------------

### Get Ticket by ID Request

Source: https://integration-guide.avenia.io/docs/Operations/quotesAndTickets

Example cURL request to retrieve a specific ticket.

```bash
curl -X GET "https://api.sandbox.avenia.io:10952/v2/account/tickets/TICKET-UUID-HERE" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
```

--------------------------------

### cURL Request Example

Source: https://integration-guide.avenia.io/docs/KYB/kybLevel1

A complete cURL command to initiate the KYB process with authorization headers.

```bash
curl -X POST "https://api.sandbox.avenia.io:10952/v2/kyc/new-level-1/web-sdk" \
     -H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
     -H "Content-Type: application/json" \
     -d '{
       "redirectUrl": "https://yourapp.com/kyb-complete"
     }'
```

--------------------------------

### Register Beneficiary Wallet via cURL

Source: https://integration-guide.avenia.io/docs/Beneficiaries-Wallets/walletsGuide

Example command to register a wallet using cURL, including authorization headers.

```bash
curl -X POST "https://api.sandbox.avenia.io:10952/v2/account/beneficiaries/wallets/" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
-d '{
  "alias": "ExampleAlias",
  "description": "Example description",
  "walletAddress": "0xXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "walletChain": "POLYGON",
  "walletMemo": "memooo"
}'
```

--------------------------------

### List past reports response structure

Source: https://integration-guide.avenia.io/docs/Avenia-Account-Management/asyncReports

Example JSON response body returned by the GET /v2/account/reports/{type} endpoint.

```json
{
  "reports": [
    {
      "jobId": "b3f1c9e2-8a4d-4e77-9c21-1a2b3c4d5e6f",
      "reportType": "transactions",
      "outputFormat": "csv",
      "periodStart": "2025-06-01",
      "periodEnd": "2025-06-30",
      "status": "success",
      "fileUrls": [ { "extension": "csv", "parts": [ /* ... */ ] } ],
      "createdAt": "2025-07-01T03:11:02Z",
      "updatedAt": "2025-07-01T03:12:44Z"
    }
  ]
}
```

--------------------------------

### Initiate Access Creation Request

Source: https://integration-guide.avenia.io/docs/Avenia-Account-Management/aboutLogin

The first step of access creation requires an admin to send a POST request with the new user's email and OTP.

```http
https://api.sandbox.avenia.io:10952/v2/auth/accesses/
```

```json
{
  "otp": "999999",
  "email": "your.new.access.email@provider.com",
  "permissions": {
    "payOut": true
  }
}
```

```bash
curl -X POST "https://api.sandbox.avenia.io:10952/v2/auth/accesses/" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
-d '{
  "otp": "999999",
  "email": "your.new.access.email@provider.com",
  "permissions": {
    "payOut": true
  }
}'
```

--------------------------------

### Fetch Beneficiary Wallets with cURL

Source: https://integration-guide.avenia.io/docs/Beneficiaries-Wallets/walletsGuide

Example request demonstrating filtering by alias, address, chain, and timestamps, along with pagination using a cursor.

```bash
curl -X GET "https://api.sandbox.avenia.io:10952/v2/account/beneficiaries/wallets/?alias=ExampleAlias&walletAddress=0xXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&walletChain=POLYGON&createdAfter=1700000000000&createdBefore=1800000000000&cursor=NEXT_CURSOR" \
-H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
```

--------------------------------

### POST /v2/kyc/import-token/

Source: https://integration-guide.avenia.io/docs/KYC/kycSumsubSharedToken

Imports a Sumsub share token to initiate KYC processing for an individual user.

```APIDOC
## POST /v2/kyc/import-token/

### Description
Imports a valid, unused Sumsub share token to transfer KYC verification results from your Sumsub account to the platform. The process is asynchronous, and final results are delivered via webhook.

### Method
POST

### Endpoint
/v2/kyc/import-token/?subAccountId={sub-account-id}

### Parameters
#### Query Parameters
- **subAccountId** (string) - Optional - Required if performing this flow for a Subaccount.

#### Request Body
- **importToken** (string) - Required - The Sumsub share token generated for an applicant with GREEN review status.

### Request Example
{
  "importToken": "your-sumsub-share-token"
}

### Response
#### Success Response (200)
- **id** (string) - The KYC attempt UUID.
- **message** (string) - Status message confirming the token was imported and processing has begun.

#### Response Example
{
  "id": "kyc-attempt-uuid",
  "message": "token imported successfully: processing KYC"
}
```

--------------------------------

### Update Access cURL Example

Source: https://integration-guide.avenia.io/docs/Avenia-Account-Management/accessesManagement

Example request to update access permissions using a PATCH method.

```bash
curl -X PATCH "https://api.sandbox.avenia.io:10952/v2/auth/accesses/" \
  -H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "00000000-0000-0000-0000-000000000000",
    "otp": "999999",
    "permissions": {
      "payOut": true,
      "viewOnly": false
    }
  }'
```

--------------------------------

### Request USD KYC via cURL

Source: https://integration-guide.avenia.io/docs/KYC/kycUsd

Examples for initiating USD KYC for a main account or a specific subaccount.

```bash
curl -X POST "https://api.sandbox.avenia.io:10952/v2/kyc/usd/api" \
     -H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
```

```bash
curl -X POST "https://api.sandbox.avenia.io:10952/v2/kyc/usd/api?subAccountId=1ee0a663-922b-4389-9f84-074ccff7085d" \
     -H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
```

--------------------------------

### Building and Sending the Request

Source: https://integration-guide.avenia.io/docs/Security/apiKeysGuide

Construct the request headers including the API key, timestamp, and signature. Then, send the GET request to the specified endpoint.

```python
print("Headers:")
print("X-API-Key:", api_key)
print("X-API-Timestamp:", timestamp)
print("X-API-Signature:", signature_base64)

headers = {
    "X-API-Key": api_key,
    "X-API-Timestamp": timestamp,
    "X-API-Signature": signature_base64,
}

response = requests.get(endpoint, headers=headers)

print("Status:", response.status_code)
print("Response:", response.text)
```

--------------------------------

### Create API Key cURL Example

Source: https://integration-guide.avenia.io/docs/Security/apiKeysManagements

Use this cURL command to create a new API key. Ensure you include your public key, a name for the key, and an OTP for verification. The response will contain the new API key's UUID.

```bash
curl -X POST "https://api.sandbox.avenia.io:10952/v2/auth/api-keys/" \
  -H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "Content-Type: application/json" \
  -d '{  
  "name": "first api key",  
  "publicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArtMQzJdnJKaFdPfj8n0H\nkHE/eI8yliI5KZhXls=....Il2iAJMmsjFclJHEioLGn8ei/eRhgLdRovbG6MledEjO7bNYOs9\nsQIDAQAB\n-----END PUBLIC KEY-----",  
  "otp": "888888",  
  "whitelistedIPs": ["0.0.0.0/0"]  
}'  

```

--------------------------------

### List All API Keys cURL Example

Source: https://integration-guide.avenia.io/docs/Security/apiKeysManagements

This cURL command retrieves a list of all API keys associated with your account. It requires an Authorization header with your bearer token.

```bash
curl -X GET "https://api.sandbox.avenia.io:10952/v2/auth/api-keys/" \
  -H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"  

```

--------------------------------

### Generate Quote cURL Example

Source: https://integration-guide.avenia.io/docs/Usecases/pix2Stable&stable2pix

Example cURL command to request a quote, requiring the subaccount ID and relevant payment parameters.

```bash
curl -X GET "https://api.sandbox.avenia.io:10952/v2/account/quote/fixed-rate?subAccountId=1ee0a663-922b-4389-9f84-074ccff7085d&inputCurrency=USDM&inputPaymentMethod=INTERNAL&outputCurrency=BRL&outputPaymentMethod=PIX-BRCODE&inputThirdParty=false&outputThirdParty=false&blockchainSendMethod=PERMIT&outputBrCode=00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/fe6d7d3c6d014a9fb9db61cf40a0ee4c5204000053039865802BR5925Ada%20Capital%20Gestao%20de%20Rec6009Sao%20Paulo62070503***6304E066" \
 -H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
```

--------------------------------

### Example JSON Response for Account Statement

Source: https://integration-guide.avenia.io/docs/Export/template

This example shows the structure of the account statement logs, including transaction details and timestamps.

```json
{
  "logs": [
    {
      "id": "04d3b592-40cc-44ed-9370-65852842bdd6",
      "token": "BRLA",
      "balanceChange": "100",
      "finalBalance": "9357.170326",
      "description": "[DEBIT] Process ticket output: BRLA delivery",
      "createdAt": "2025-04-01T23:06:34.440381Z"
    },
    {
      "id": "1412d736-d35f-4c98-9d73-3449f4845fea",
      "token": "BRLA",
      "balanceChange": "800",
      "finalBalance": "9257.170326",
      "description": "[DEBIT] Process ticket output: BRLA delivery",
      "createdAt": "2025-04-01T23:01:34.335504Z"
    }
  ],
  "cursor": "MjgzLTE3NDM1MTU4MjA4MDY="
}

```

--------------------------------

### Validate TOTP Setup

Source: https://integration-guide.avenia.io/docs/Security/mfaGuide

Use this endpoint to confirm your TOTP setup by providing the OTP from your authenticator app and the email verification token.

```HTTP
https://api.sandbox.avenia.io:10952/v2/auth/mfa/totp/validate  
```

```json
{
  "otp": "697919",
  "emailToken": "999999"
}
```

```curl
curl -X POST "https://api.sandbox.avenia.io:10952/v2/auth/mfa/totp/validate" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
-d '{
  "otp": "697919",
  "emailToken": "999999"
}'  
```

--------------------------------

### Request COP KYC via cURL

Source: https://integration-guide.avenia.io/docs/KYC/kycCop

Examples for initiating COP KYC for a main account or a specific subaccount.

```bash
curl -X POST "https://api.sandbox.avenia.io:10952/v2/kyc/cop/api" \
     -H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
```

```bash
curl -X POST "https://api.sandbox.avenia.io:10952/v2/kyc/cop/api?subAccountId=1ee0a663-922b-4389-9f84-074ccff7085d" \
     -H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
```

--------------------------------

### Sample JSON Response for Account Info

Source: https://integration-guide.avenia.io/docs/Export/template

This is an example of the JSON response you will receive when requesting account information.

```json
{
  "id": "00000000-0000-0000-0000-000000000000",
  "accountInfo": {
    "id": "11111111-1111-1111-1111-111111111111",
    "accountType": "INDIVIDUAL",
    "name": "xxxxx",
    "countrySubdivisionTaxResidence": "BR-SP",
    "countryTaxResidence": "BRA",
    "identityStatus": "CONFIRMED",
    "fullName": "xxxxx",
    "birthdate": "9999-99-30T00:00:00Z",
    "taxId": "99999999999"
  },
  "wallets": [
    {
      "id": "be85cef0-d70a-47cc-9847-9014570efed5",
      "walletAddress": "0xXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "chain": "EVM"
    }
  ],
  "pixKey": "11111111-1111-1111-1111-111111111111",
  "brCode": "00020126740014br.gov.bcb.pix01365c2c61a1-134b-4c34-958f-ea3122ac717f0212Avenia Deposit5204000053039865802BR5917Avenia API Ltda6009Sao Paulo621005060000016304DBD5",
  "createdAt": "2025-02-18T17:00:39.854943Z"
}

```

--------------------------------

### Account Statement HTTP GET Request

Source: https://integration-guide.avenia.io/docs/Export/template

Retrieve your account statement logs to track all balance changes. You can pass `subAccountId` to get the statement for a specific sub-account.

```http
https://api.sandbox.avenia.io:10952/v2/account/statement  

```

--------------------------------

### Account Balance Example JSON Response

Source: https://integration-guide.avenia.io/docs/Export/infiniaMigrationGuide

This JSON object shows the available balances for each currency, such as BRLA, USDC, and USDT.

```json
{
  "balances": {
    "BRLA": "9457.170326",
    "USDC": "0",
    "USDT": "42.07732"
  }
}
```

--------------------------------

### Get Fixed-Rate Quote for Stablecoin Transfer

Source: https://integration-guide.avenia.io/docs/Usecases/pix2Stable&onChainTransfer

Use this GET request to obtain a fixed-rate quote for transferring stablecoins. Ensure all required parameters like currencies, amounts, and payment methods are correctly specified.

```http
https://api.sandbox.avenia.io:10952/v2/account/quote/fixed-rate
```

```curl
curl -X GET "https://api.sandbox.avenia.io:10952/v2/account/quote/fixed-rate?inputCurrency=USDT&inputPaymentMethod=INTERNAL&outputAmount=100&outputCurrency=USDT&outputPaymentMethod=INTERNAL&inputThirdParty=false&outputThirdParty=false&blockchainSendMethod=PERMIT" \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.quoteToken...."
```

--------------------------------

### Request EUR KYC via cURL

Source: https://integration-guide.avenia.io/docs/KYC/kycEur

Examples for initiating EUR KYC for a main account or a specific subaccount using cURL.

```bash
curl -X POST "https://api.sandbox.avenia.io:10952/v2/kyc/eur/api" \
     -H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
```

```bash
curl -X POST "https://api.sandbox.avenia.io:10952/v2/kyc/eur/api?subAccountId=1ee0a663-922b-4389-9f84-074ccff7085d" \
     -H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
```

--------------------------------

### Get All Webhooks

Source: https://integration-guide.avenia.io/docs/Webhooks/webhookManagement

Retrieve a list of all registered webhooks.

```APIDOC
## Get all webhooks

### Description
Retrieves a list of all webhooks that have been registered.

### Method
GET

### Endpoint
https://api.sandbox.avenia.io:10952/v2/notifications/webhooks/

### cUrl Example
```bash
curl -X GET "https://api.sandbox.avenia.io:10952/v2/notifications/webhooks/" \
-H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
```

### Response
#### Success Response (200)
- **webhooks** (array) - A list of webhook objects, each containing id, url, subscriptions, createdAt, and updatedAt.

### Response Example
```json
{
  "webhooks": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "url": "https://webhook.invalid.new/",
      "subscriptions": [
        "TICKET"
      ],
      "createdAt": "2025-02-11T20:29:17.97777Z",
      "updatedAt": "2025-02-11T20:29:17.97777Z"
    }
  ]
}
```
```

--------------------------------

### GET /v2/account/address

Source: https://integration-guide.avenia.io/docs/Avenia-Account-Management/addressApi

Retrieves the current account address.

```APIDOC
## GET /v2/account/address

### Description
Retrieves the current account address.

### Method
GET

### Endpoint
/v2/account/address
```

--------------------------------

### Download Ticket Receipt

Source: https://integration-guide.avenia.io/docs/Operations/ticket-receipt

This example shows how to download a ticket receipt without specifying a sub-account. The output is saved to 'ticket-receipt.pdf'.

```curl
curl -X GET \
  "https://api.sandbox.avenia.io:10952/v2/account/tickets/{ticket-id}/receipt" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -o ticket-receipt.pdf  

```

--------------------------------

### Complete Python Code for API Key Authentication

Source: https://integration-guide.avenia.io/docs/Security/apiKeysGuide

This complete script integrates all the steps: configuration, string signing, private key loading, signature generation, and making the authenticated API request.

```python
import time
import base64
import requests

from cryptography.hazmat.primitives import hashes, serialization
from cryptography.hazmat.primitives.asymmetric import padding

# Configuration
api_key = "dc96d0f8-ac73-4abe-ade3-c6d14e3e22fb"
endpoint = "https://api.sandbox.avenia.io:10952/v2/account/account-info"
method = "GET"
request_uri = "/v2/account/account-info"
body = ""
timestamp = str(int(time.time() * 1000))

# Create string to sign
string_to_sign = timestamp + method + request_uri # + body if the request contains a body

# Load private key
with open("private_key.pem", "rb") as key_file:
    private_key = serialization.load_pem_private_key(
        key_file.read(),
        password=None,
    )

# Generate signature
signature = private_key.sign(
    string_to_sign.encode("utf-8"),
    padding.PKCS1v15(),
    hashes.SHA256()
)
signature_base64 = base64.b64encode(signature).decode("utf-8")

# Prepare headers
headers = {
    "X-API-Key": api_key,
    "X-API-Timestamp": timestamp,
    "X-API-Signature": signature_base64,
}

# Make the request
response = requests.get(endpoint, headers=headers)

# Print results
print("Status:", response.status_code)
print("Response:", response.text)
```

--------------------------------

### GET /v2/account/quote/fixed-rate

Source: https://integration-guide.avenia.io/docs/Usecases/pix2Stable&stable2pix

Retrieves a quote for a BRL withdrawal from a subaccount.

```APIDOC
## GET /v2/account/quote/fixed-rate

### Description
Retrieves a quote for a BRL withdrawal operation from a subaccount.

### Method
GET

### Endpoint
https://api.sandbox.avenia.io:10952/v2/account/quote/fixed-rate

### Parameters
#### Query Parameters
- **subAccountId** (string) - Required - ID of the subaccount paying the brCode.
- **inputCurrency** (string) - Required - Currency used by the subaccount for payment.
- **inputPaymentMethod** (string) - Required - Payment method (e.g., INTERNAL).
- **outputCurrency** (string) - Required - Currency in which the brCode will be paid (BRL).
- **outputPaymentMethod** (string) - Required - Payment method for the payout (PIX).
- **inputThirdParty** (boolean) - Required - Indicates if funds come from the subaccount itself.
- **outputThirdParty** (boolean) - Required - Set to true if the brCode is paid to a third party.
- **blockchainSendMethod** (string) - Required - Specifies that the transfer is automatically handled by Avenia API.

### Response
#### Success Response (200)
- **quoteToken** (string) - Token for the quote.
- **id** (string) - Unique identifier for the quote.
- **inputAmount** (string) - Amount in input currency.
- **outputAmount** (string) - Amount in output currency.
```

--------------------------------

### GET /v2/account/balances

Source: https://integration-guide.avenia.io/docs/Usecases/pix2Stable&stable2pix

Retrieves the current balances for a specified subaccount.

```APIDOC
## GET /v2/account/balances

### Description
Retrieves all current balances for a subaccount. The subAccountId parameter is required to identify the account performing the operation.

### Method
GET

### Endpoint
https://api.sandbox.avenia.io:10952/v2/account/balances

### Parameters
#### Query Parameters
- **subAccountId** (string) - Required - The unique identifier of the subaccount.

### Response
#### Success Response (200)
- **balances** (object) - A map of currency codes to their respective balance amounts.

#### Response Example
{
  "balances": {
    "BRLA": "0",
    "USDC": "0",
    "USDT": "0",
    "USDM": "165.00000"
  }
}
```

--------------------------------

### GET /v2/account/quote/fixed-rate

Source: https://integration-guide.avenia.io/docs/Sandbox%20Usecases/simulateCopDeposit

Retrieves a quote for a COP deposit transaction.

```APIDOC
## GET /v2/account/quote/fixed-rate

### Description
Retrieves a fixed-rate quote for converting COP to USDC.

### Method
GET

### Endpoint
https://api.sandbox.avenia.io:10952/v2/account/quote/fixed-rate

### Query Parameters
- **inputCurrency** (string) - Required - The input currency (e.g., COP)
- **inputPaymentMethod** (string) - Required - The payment method (e.g., BANK-TRANSFER)
- **inputAmount** (number) - Required - The amount to deposit (keep under 700,000 COP for auto-settlement)
- **outputCurrency** (string) - Required - The output currency (e.g., USDC)
- **outputPaymentMethod** (string) - Required - The output payment method
- **inputThirdParty** (boolean) - Required - Whether the input is third party
- **outputThirdParty** (boolean) - Required - Whether the output is third party
- **blockchainSendMethod** (string) - Required - The blockchain send method
```

--------------------------------

### Create Deposit Ticket

Source: https://integration-guide.avenia.io/docs/Sandbox%20Usecases/simulateCopDeposit

Submit a ticket using the quote token to initiate the deposit process.

```bash
curl -X POST "https://api.sandbox.avenia.io:10952/v2/account/tickets/" \
  -H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "Content-Type: application/json" \
  -d '{
    "quoteToken": "eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "ticketBlockchainOutput": {
      "walletAddress": "0xabcdefabcdefabcdefabcdefabcdefabcdefabcd"
    }
  }'
```

```json
{
  "id": "e0a5b2f2-c0d7-486c-a3dd-cb32a1715c51",
  "depositUrl": "https://checkout.example.com/63144f74-52ac-48a8-a25c-7c5491dbbcbf",
  "expiration": "2026-05-01T13:26:12.307Z"
}
```

--------------------------------

### Register Beneficiary Account via cURL

Source: https://integration-guide.avenia.io/docs/Beneficiaries-Bank-Accounts/beneficiariesBankAccountsGuideBrl

Example of a POST request to register a bank account using manual banking details.

```bash
curl -X POST "https://api.sandbox.avenia.io:10952/v2/account/beneficiaries/bank-accounts/brl/" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
-d '{
  "alias": "example bank",
  "description": "Creation of my first bank account in Avenia",
  "userName": "Jane Doe",
  "bankCode": "260",
  "branchCode": "1234",
  "accountNumber": "12345678",
  "accountType": "savings",
  "taxId": "12345678901"
}'
```

```bash
curl -X POST "https://api.sandbox.avenia.io:10952/v2/account/beneficiaries/bank-accounts/brl/" -H "Content-Type: application/json" -H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" -d '{
  "alias": "example bank",
  "description": "Creation of my first bank account in Avenia",
  "userName": "Jane Doe",
  "bankCode": "260",
  "branchCode": "1234",
  "accountNumber": "12345678",
  "accountType": "savings",
  "taxId": "12345678901"
}'
```

--------------------------------

### Get Event By ID

Source: https://integration-guide.avenia.io/docs/Webhooks/webhookManagement

Retrieves a specific event by its ID.

```APIDOC
## GET /v2/notifications/webhooks/events/{EVENT_ID_HERE}

### Description
Retrieves a specific event by its ID.

### Method
GET

### Endpoint
/v2/notifications/webhooks/events/EVENT_ID_HERE

### Response
#### Success Response (200)
- **event** (object) - The event object.

#### Response Example
```json
{
  "event": {
    "id": "00000000-0000-0000-0000-000000000000",
    "subscription": "TICKET",
    "data": {
      "id": "11111111-1111-1111-1111-111111111111",
      "exampleKey": "exampleValue"
    },
    "createdAt": "2025-02-11T20:30:44.042643Z",
    "EventType": ""
  }
}
```
```

--------------------------------

### GET /v2/account/sub-accounts

Source: https://integration-guide.avenia.io/docs/Avenia%20Subaccounts/subAccountManagement

Lists all subaccounts associated with the main account.

```APIDOC
## GET /v2/account/sub-accounts

### Description
Retrieves a list of all subaccounts associated with the main account.

### Method
GET

### Endpoint
https://api.sandbox.avenia.io:10952/v2/account/sub-accounts

### Parameters
#### Query Parameters
- **name** (string) - Optional - Search for names containing specific characters
- **cursor** (string) - Optional - Pagination cursor to advance through results

### Response
#### Success Response (200)
- **cursor** (string) - Pagination cursor
- **subAccount** (array) - List of subaccount objects

#### Response Example
{
  "cursor": "MTEwLTE3NDMwMjkzNTUyODE=",
  "subAccount": [
    {
      "subAccountId": "2eea0102-dabe-4ab6-8707-0817aa52dfe4",
      "mainAccountId": "3657c184-854c-4a71-98b0-9fc8e2960ba8",
      "createdAt": "2025-03-27T09:59:59.099865Z",
      "accountInfo": {
        "id": "87b3ab56-463c-4207-ae31-4d2bd26dc66a",
        "accountType": "INDIVIDUAL",
        "name": "Ada Doe"
      }
    }
  ]
}
```

--------------------------------

### Submit KYB EUR cURL Example

Source: https://integration-guide.avenia.io/docs/KYB/kybEur

A complete cURL command to submit the KYB EUR request.

```bash
curl -X POST "https://api.sandbox.avenia.io:10952/v2/kyc/eur/api?subAccountId=a3f2c891-7b4d-4e6a-9d15-c82e0f3a1b57" \
     -H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
     -H "Content-Type: application/json" \
     -d '{
       "businessType": "llc",
       "businessIndustries": ["519290"],
       "proofOfRevenueDocId": "5f8d3c16-b2e7-4a9f-c834-1e6b0d5f2a91"
     }'
```

--------------------------------

### GET /v2/account/tickets/{ticket-id}

Source: https://integration-guide.avenia.io/docs/Operations/quotesAndTickets

Retrieve a specific ticket by its unique identifier.

```APIDOC
## GET /v2/account/tickets/{ticket-id}

### Description
Retrieve a specific ticket by its unique identifier.

### Method
GET

### Endpoint
/v2/account/tickets/{ticket-id}

### Parameters
#### Path Parameters
- **ticket-id** (string) - Required - The unique identifier of the ticket
```

--------------------------------

### cURL Example for Login

Source: https://integration-guide.avenia.io/docs/Avenia-Account-Management/login

This cURL command demonstrates how to send a login request to the Avenia API. It includes the necessary headers and a JSON payload.

```bash
curl -X POST "https://api.sandbox.avenia.io:10952/v2/auth/login" \
-H "Content-Type: application/json" \
-d '{
  "email": "your.email@provider.com",
  "password": "UseAStrongPassword123!"
}'
```

--------------------------------

### GET /v2/account/tickets/{id}

Source: https://integration-guide.avenia.io/docs/Sandbox%20Usecases/simulateCopDeposit

Polls the status of a specific deposit ticket.

```APIDOC
## GET /v2/account/tickets/{id}

### Description
Polls the status of a ticket to check for transitions from UNPAID to PAID.

### Method
GET

### Endpoint
https://api.sandbox.avenia.io:10952/v2/account/tickets/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the ticket
```
Tokens:
Raw