Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

Skip to main content

Avenia API home page

Integration Guide
Website

Getting Started

Avenia API

Authentication Endpoints

Account Endpoints

KYC Endpoints

Documents Endpoints

GET
Get documents
GET
Get document by ID
POST
Post documents

Notifications Endpoints

Payment Session Endpoints

GET
Get payment session (public)

Public Utilities

GET
Public key for webhook signature verification
GET
Get quote configuration
POST
Validate liveness session

notifications

GET
Public key for webhook signature verification
GET
List webhooks
POST
Register webhook
PATCH
Update webhook
GET
Get webhook by ID
DEL
Delete webhook
GET
List webhook events
GET
Get webhook event by ID
GET
List webhook delivery attempts
PATCH
Acknowledge webhook attempts
GET
Get webhook attempt by ID
GET
Get email notification config
PUT
Update email notification config

auth

POST
Check if an email is already registered
POST
Create account
PATCH
Validate email
POST
Send password reset email
PATCH
Reset password with email token
POST
Login step 1 — sends 2FA email
POST
Validate login
POST
Refresh access token
POST
Validate sub-access invitation
POST
Logout (invalidate token)
PATCH
Change password
POST
Initialize TOTP MFA (returns secret + QR)
POST
Confirm TOTP setup
POST
Request TOTP removal (sends email)
POST
Confirm TOTP removal with email token
GET
List sub-accesses
POST
Create sub-access
PATCH
Update sub-access
GET
List approver sub-accesses
GET
Get sub-access by ID
DEL
Delete sub-access
GET
List sub-access blacklist
POST
Add to sub-access blacklist
DEL
Remove from sub-access blacklist
GET
List API keys
POST
Create API key
PATCH
Update API key
DEL
Delete API key

payment-session-public

GET
Get payment session (public)
GET
Public fixed-quote for a payment session
POST
Create payment-session ticket
GET
Get ticket bound to a payment session

account

GET
Get access info
GET
Get account info
GET
Get wallet balances
GET
Get current limits
GET
Get ledger statement
GET
Get user metadata (KYC/feature flags)
GET
List sub-accounts
POST
Create sub-account
GET
Get sub-account by ID

multi-sig

GET
List operations where the caller is an approver
GET
List operations requested by the caller
GET
Get multi-sig operation detail
POST
Approve multi-sig operation
POST
Execute multi-sig operation

beneficiaries

GET
List wallet beneficiaries
POST
Create wallet beneficiary
GET
Get wallet beneficiary by ID
DEL
Delete wallet beneficiary
GET
List BRL bank-account beneficiaries
POST
Create BRL bank-account beneficiary
GET
Get BRL bank-account beneficiary by ID
DEL
Delete BRL bank-account beneficiary
GET
List USD bank-account beneficiaries
POST
Create USD bank-account beneficiary
GET
Get USD bank-account beneficiary by ID
DEL
Delete USD bank-account beneficiary
GET
List ARS bank-account beneficiaries
POST
Create ARS bank-account beneficiary
GET
Get ARS bank-account beneficiary by ID
DEL
Delete ARS bank-account beneficiary
GET
List COP bank-account beneficiaries
POST
Create COP bank-account beneficiary
GET
List COP banks supported for beneficiary creation
GET
Get COP bank-account beneficiary by ID
DEL
Delete COP bank-account beneficiary
GET
List EUR bank-account beneficiaries
POST
Create EUR bank-account beneficiary
GET
Get EUR bank-account beneficiary by ID
DEL
Delete EUR bank-account beneficiary

quote

GET
Fixed-rate quote
GET
Get quote configuration

tickets

GET
List tickets
POST
Create ticket
GET
Get ticket by ID
GET
Get ticket receipt PDF
GET
Get ticket contract PDF
PATCH
Cancel a ticket

fiat-rails

GET
Get BRL fiat rail
GET
Resolve a PIX key or QR code
GET
Generate a static BR Code
GET
Resolve a Colombian BRE-B key

address

GET
Get address
PUT
Update address
POST
Submit proof of address via API
GET
List proof-of-address attempts
GET
Get proof-of-address attempt

proof-of-financial-capacity

POST
Submit proof of financial capacity via API
GET
List PoFC attempts
GET
Get PoFC attempt

ubos

GET
List UBOs
POST
Create UBO
GET
Get UBO
DEL
Delete UBO
PATCH
Update UBO

eod

GET
List EoD trades
POST
Create EoD trade
GET
Get EoD trade
GET
Get EoD limits
GET
Get EoD net position
POST
Settle EoD trades

payment-session-private

GET
List payment sessions
POST
Create payment session
GET
Get payment session (private)
GET
Get payment-session preferences
POST
Save payment-session preferences

kyc

GET
List KYC attempts
GET
Get KYC attempt
POST
Submit level-1 KYC/KYB via API
POST
Get level-1 KYC web-SDK URL
GET
List W-8BEN forms
POST
Submit W-8BEN form
GET
Get W-8BEN form by ID
POST
Start USD KYC/KYB
POST
Start EUR KYC/KYB
POST
Start COP KYC
POST
Import KYC token from another platform
POST
Validate liveness session

documents

GET
List uploaded documents
POST
Initiate document upload (returns presigned URLs)
GET
Get document by ID

Get BRL fiat rail

Bank Accounts

Get account bank accounts brl

Get BRL fiat rail

GET request to /v2/account/bank-accounts/brl

Get wallet balances Resolve a PIX key or QR code

⌘I

x github linkedin

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform