For AI agents: visit https://api.velmie.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Jump to Content

API Reference

Introduction

Welcome to Velmie API Documentation

Identity Registry

GeoIP
- Get GeoIP data for current IP.get
Identity
- Show identity profile.get
- Search identities.get
OIDC
- Completes the OIDC process by exchanging the authCode for an ID token.get
- Completes the OIDC process by exchanging the authCode for an ID token. (POST handler)post
Flow
- Returns a new flow for a specified identity type, flow class, and flow Tokenget
- Retrieves a response after service completed a task that required a redirect for OIDC process.get
Base
- Updates the specified base flow advancing it towards completion.patch
Login
- Updates the specified login flow advancing it towards completion.patch
Recovery
- Updates the specified recovery flow advancing it towards completion.patch
Registration
- Updates the specified registration flow advancing it towards completion.patch
SCA
- Updates the specified SCA flow advancing it towards completion.patch
Verification
- Resends the verification code to the user's email or phone.post
- Confirms the verification code sent to the user's email or phone.patch
Session

Customers Management

Contacts
- Get list by phonespost
Customers
Settings
- Update role verifications settingsput
- Get role verifications settingsget
Languages
- Get languagesget
Groups
- Delete customer groupdel
JWKS
- Retrieve JSON Web Key Set (JWKS)get

Customers Auth & Profile

Authentication
Customer language
- Set customer languagepatch
Password
Verifications

Business Users

Export
- Export transactions history to CSVget
- Export transactions report to CSVget
Transactions
Accounts
Invitations
Permissions
- Show a list of permissions.get
Positions
Users
Net Worth
- Get net worth for current userget

KYC

Admin
User

Accounts

Accounts
Account types
Earnings Accounts
- Show list of earnings accounts.get
- Get a earnings account by passed id.get
Transfer Fee
Settings
Transactions
Request Templates
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
Planned transactions
Limits
- Get current user's limits.get
Net Worth
- Returns user net worthget

Crypto Wallets

Cryptocurrency Addresses

Cards

Customer

Resources (external connections)

AccountProducts
- Show a list of account productsget
- Show an account product by keyget
Accounts
- Create an account.post
CardProducts
- Show a list of productsget
- Show a product by keyget
Cards
IFrames
- Generate an iFrame.post
KYC Attempt
- Show a list of KYC Attempt records.get
- Show KYC Attempt details.get
KYC
Transactions
- Show a list of transactions.get
- Show a transaction.get

Payment Requests

Requests
A2A Requests
P2P Requests
MWT Requests
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

Currencies

Currencies
Settings
- Shows current settings.get
- Updates settings.put
Rates
Icons
- Add iconpost
- Delete icondel

Legal Documents

Legal Documents

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
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

Crypto Keys

Cryptocurrency seeds
- Get all seeds.get
- Add new cryptocurrency seed.post

Passcodes

Passcode
- Validate the passcodepost
- Update passcodeput

Alerts

Admin customer configurations
- Get list of configurationsget
- Updated customer configurationsput
Customer configurations
- Get list of configurationsget
- Updated customer configurationsput
Configurations
Push tokens
Push Notifications
- Get list of push notification eventsget

Statements

Customer statements for admin
System statements
Customer statements

Settings

Config

Files

Files

Powered by

Init KYC

post

https://localhost/resources/private/v1/kyc/{level}

Path Params

level

string

required

The KYC level name.

Example: 'velmie-default'

Responses

Updated about 1 month ago

Show KYC Attempt details.

Show a list of KYC records.

Did this page help you?

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated about 1 month ago

Show KYC Attempt details.

Show a list of KYC records.

Did this page help you?