Jump to Content
API Reference
API Reference
Search
API Reference
Welcome to Velmie API Documentation
All
Pages
Start typing to search…
JUMP TO
Introduction
Welcome to Velmie API Documentation
Customers Management
Contacts
Get list by phones
post
Customers
Reset password
post
Get list of customers
get
Create customer
post
Update customer
put
Settings
Update role verifications settings
put
Get role verifications settings
get
Languages
Get languages
get
Groups
Delete customer group
del
JWKS
Retrieve JSON Web Key Set (JWKS)
get
Customers Auth & Profile
Authentication
Current customer
get
Sign In action
post
Sign Up
post
Sign Out
del
Refresh token
get
Current customer by Temp Token
get
Customer language
Set customer language
patch
Password
Request to reset password
post
Reset password
post
Change Password
post
Verifications
Send verification sms.
post
Update unconfirmed phone number.
put
Check phone code.
put
Send verification email.
post
Update unconfirmed email.
put
Check email code.
put
KYC
Admin
Get countries list
get
Get tiers by country code
get
Get tier for admin by id
get
User
Get the current tier of the user
get
Get tiers available for the user
get
Get tier of the user by id
get
Accounts
Accounts
Create a new account.
post
Show list of accounts for active user.
get
Update an existing account by id as admin.
put
Shows an account by passed id.
get
Show list of accounts for admins.
get
Responds with a file with accounts.
get
Get a new account number.
post
Account types
Create a new account type as an admin.
post
Show list of account types.
get
Update an existing account type as an admin by passed id.
put
Shows an account type by passed id.
get
Delete an existing account type as an admin by passed id.
del
Earnings Accounts
Show list of earnings accounts.
get
Get a earnings account by passed id.
get
Transfer Fee
Creates new trasnfer fee.
post
Get transfer fee.
get
Delete transfer fee
del
Update transfer fee.
post
Get transfer fees list.
get
Get transfer fees list.
get
Get transfer fee parameters list.
get
Settings
Get settings list.
get
Updates settings.
post
Retrieve setting by name.
get
Updates setting by name.
post
Transactions
Fetch transaction by id.
get
Shows list of transactions for current user.
get
Responds with a file with transactions for account.
get
Shows history of transactions for user.
get
Request Templates
Shows list of saved P2P templates.
get
Shows list of saved templates.
get
Shows list of saved MWT templates.
get
Deletes a request template by id.
del
Countries
Shows list of all countries.
get
Shows a country by passed id.
get
Payment periods
Shows list of all payment periods.
get
Payment methods
SHows list of all payment methods.
get
MIT bank accounts
Create a new MIT bank account as an admin.
post
Show list of MIT bank accounts.
get
Update an existing MIT bank account as an admin by passed id.
put
Shows an MIT bank account by passed id.
get
Delete a MIT bank account by id as an admin.
del
Shows an MIT bank account by an account id.
get
Shows an MIT bank account by an account id.
get
Planned transactions
Get list of planned transactions(only root)
get
Get a planned transaction by id(only root)
get
Responds with a file with planned transactions(only root)
get
Limits
Get current user's limits.
get
Net Worth
Returns user net worth
get
Crypto Wallets
Cryptocurrency Addresses
Bind cryptocurrency public address to the given account.
post
Get address by ID.
get
Get address by account ID.
get
Get list of addresses by account IDs.
get
Cards
Customer
Create a new card
post
Get all customer's cards
get
Activate a card
post
Freeze a card
post
Unfreeze a card
post
Get card details
get
Update card's 3DS settings
patch
Close a card
post
Get transactions of a card
get
Payment Requests
Requests
Show a request details.
get
Update convertion rate as an admin.
patch
Executes pending request.
post
Cancels pending request.
post
Updates requests from csv file.
post
Imports requests from csv file.
post
Show list of requests.
get
Shows list of requests for user.
get
Responds with a file with requests for admins.
get
A2A Requests
Makes request evaluation for A2A.
post
Creates a new A2A request.
post
Makes evaluation of A2A request.
post
Creates a new A2A request.
post
P2P Requests
Makes evaluation request for P2P.
post
Creates a new P2P request.
post
Makes evaluation of P2P request.
post
Creates a new P2P request.
post
MWT Requests
Makes evaluation of MWT request.
post
Creates a new MWT Request.
post
Makes evaluation request for MWT.
post
Creates a new MWT request.
post
Credit Account Requests
Makes an evaluation of CA request.
post
Creates a new CA request.
post
Debit Account Requests
Makes an evaluation of DA request.
post
Creates a new DA request.
post
Deduct Earnings Account Requests
Makes an evaluation of DEA request.
post
Creates a new DEA request.
post
Cryptocurrency Withdraw Requests
Makes request evaluation for CW.
post
Creates a new CW request.
post
Money Requests
Creates a new money request.
post
Get money request.
get
Mark as old.
put
Get incoming money request.
get
Get outgoing money request.
get
Makes an evaluation of P2P request by a money request.
post
Creates a new P2P request by a money request.
post
Currencies
Currencies
Shows a currency by passed id.
get
Shows list of currencies.
get
Shows a main currency.
get
Creates a new currency(only root).
post
Shows a list of currencies.
get
Updates currencies by passed ids.
put
Shows currency by passed id.
get
Settings
Shows current settings.
get
Updates settings.
put
Rates
Shows list of rates for current main currency.
get
Shows rate and exchange margin for two currencies.
get
Updates rates.
put
Icons
Add icon
post
Delete icon
del
Legal Documents
Legal Documents
Get effective legal document version by type and language.
get
Create a new version of a document.
post
Get localizations
get
Get document by id with content
get
Get acceptance status of current effective documents for user
get
Logs
Export
Responds with a file with transactions log.
get
Responds with a file with information log.
get
System logs
Shows a list of system logs.
get
Shows a single log by id.
get
Access Management
Group
Shows a list of admin groups.
get
Creates a new admin group.
post
Updates an admin group.
post
Shows a group by id.
get
Deletes a group.
del
Category
Shows a three of actions.
get
Permission
Shows a list of all permissions for spicified user.
get
Shows specific permission for a user.
get
Customer
Shows specific permission for a user.
get
Shows a list of customer groups.
get
Shows a list of all permissions for spicified user.
get
Crypto Keys
Cryptocurrency seeds
Get all seeds.
get
Add new cryptocurrency seed.
post
Passcodes
Passcode
Validate the passcode
post
Update passcode
put
Alerts
Admin customer configurations
Get list of configurations
get
Updated customer configurations
put
Customer configurations
Get list of configurations
get
Updated customer configurations
put
Configurations
Shows a list of all configurations.
get
Updates configurations.
put
Returns tokens list.
get
Push tokens
Add a new push token to the system.
post
Delete push token from the system.
post
Get list of push tokens for a particular user
get
Push Notifications
Get list of push notification events
get
Statements
Customer statements for admin
Get a list transactions of an account
get
Responds with a file with transactions of account
get
Get list all transactions of customer
get
Responds with a file with all transactions of customer
get
Get list balances of customer
get
Responds with a file with balances of customer
get
System statements
Get list all transactions
get
Responds with a file with all transactions
get
Get list interests
get
Responds with a file with interests
get
Get list manual transactions
get
Responds with a file with manual transactions
get
Get list balances
get
Responds with a file with balances
get
Get a list of accounts with an maturity dates
get
Responds with a file with accounts with an maturity dates
get
Get list of transfers
get
Responds with a file with outgoing transfers
get
Get list access logs
get
Responds with a file with access logs
get
Get list of earnings transactions
get
Responds with a file with earnings transactions
get
Get system overview data
get
Responds with a file with overview data
get
Customer statements
Get list account transactions
get
Responds with a file with account transactions
get
Get list all transactions
get
Responds with a file with all transactions
get
Get list accounts balances
get
Responds with a file with accounts balances
get
Settings
Config
Update config
put
Get private list of configs by section
get
Get private list of configs
get
Get private config
get
Get public list of configs by section
get
Get public list of configs
get
Get public config
get
Files
Files
Returns file info by id.
get
Deletes file by id.
del
Uploads public file.
post
Uploads private file.
post
Uploads file visible by admins.
post
Returns a list of user files by uid. Available for admins with "view_admin_profiles" permission if {uid} belongs to an admin user or "view_user_profiles" permission if {uid} belongs to a client.
get
Returns binary file directly.
get
Returns public binary file directly.
get
Uploads profile image.
post
Powered by
Welcome to Velmie API Documentation
Ask AI
