For AI agents: visit https://banking.docs.netevia.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Connect to Netevia Banking Services API
Guides
API Reference
v1.0
Connect to Netevia Banking Services API
Log In
API Reference
Log In
v1.0
Guides
API Reference
Lockbox
Overview
Authentication
Boarding
Boarding - Account
Set sms as default
post
Find Similar Profiles
get
Get account information after submit
get
Upload documents
post
Send docs upload confirmation
post
Create main business profile data
post
Get main profiles data
get
Create main perosnal profile data
post
Online Merchant Application
post
Online Personal Customer Application
post
Manage Online Merchant Application
post
Manage Online Personal Customer Application
post
Set agent's data
post
Send Personal customer data
post
Send Primary, Authorized person and Owners data
post
Get main profile data by ID
get
Get main profile data by UserName
get
Send data to complete sign up procedure
post
Search Business Profiles
get
Search Personal Profiles
get
Get linked Banking profile by mechantProfileID from Netevia
get
Set linked Banking profile by mechantProfileID from Netevia
post
Boarding - Financial accounts
Open financial accounts
post
Open Lockbox Financial Account (Non-Withdrawable Funds)
post
Get financial accounts with details
get
Get financial account number
get
Download Statements
get
Statements for all profile's accounts
post
Download Bank letter as PDF
get
Get financial account activity
post
Remove external account
post
Approve external account
post
Reject external account
post
Get profile's payees
get
Get external accounts
get
Get external account activity
get
Get external account balance
get
Boarding - Banking Cards
Reissue payment card
post
Cards Product Set
get
Get card product's settings
get
Issue payment card
post
Suspend banking card temporary
post
Unsuspend banking card
post
Close banking card
post
Get Payment cards list
get
Boarding - Authorized users
Disable MFA for the subuser's auth
post
Update Subprofile Phone Number
post
Get all Authorized users payment cards
get
Get all Authorized users with payment cards, financial accounts and accesses
get
Boarding - Rewards
Reward settings for profile
post
Boarding - Settings
Lock/Unlock customer temporary
post
Unlock access for the customer
post
Send ticket notification
post
Update Status main profile
post
Get Status Histories
get
Login History
get
Get devices
get
Disable MFA for the customer's authentication
post
Disable OTP for the customer's operations
post
Disable MFA for the subuser's auth
post
Disable OTP for the subuser's operations
post
Set settings for profile
post
Reset password and send email
post
Sign Up
Users registration
User Registration for Business Accounts
post
User Registration for Personal Accounts
post
Account verification
Upload new documents to make a final decision regarding account application
post
Upload new documents to our cloud to make a final decision regarding account application
post
Send docs upload confirmation
post
Send docs upload confirmation
post
Retrieve a list of required documents
get
Retrieve details about a specific product application
get
Sign In
AuthorizationControls
User Authorization Control Monitoring
post
User Authorization Control
get
User Authorization Control Deletion
del
Get User activities
get
User activity log
get
Restore username/password
Password Management
post
Login Nickname Management
post
Receive login(s) to email
post
Password Reset via OTP
post
Change User Password (Without OTP)
post
Remove a forgotten password and create another one
post
Restore login by email
post
AccountsSearch
Search for business account holders
post
Auth
Authentication
post
Account Recovery with OTP Verification
post
Account Unlock and OTP Validation
post
Authorize by Multi-Factor Authentication
post
Refresh token
post
Get linked user token
get
Get linked user vektor
get
Get original user's token
get
Exchange an existing authentication token for a new one
post
Get authentication from Google Authenticator
post
Set authenticator as MFA
post
Users
Receive account holder information
get
Get main profile
get
Check if login is free
get
Get login history report
get
Connection to April Tax service
get
Submit Additional Application
post
Retrieve a list of user upload sessions
get
Financial account
External Financial Accounts
Get connection history of external accounts(added thorugh plaid and finicity)
get
Get external account activity
get
Check external accounts limit
get
Get the list of external bank accounts
get
Refresh and get the external account's balance. On Plaid errors (e.g. access revoked, token expired) returns the Plaid error payload with the HTTP status forwarded from Plaid instead of a generic 404.
get
Exchanges Plaid's public token to access token
post
Applications connected to user's financial accounts
get
Salary solutions
Connect Direct Deposit
get
Get current direct deposit status for a user’s financial account
get
Enable/Disable EWA
post
Earned Wage Access
get
FinancialAccounts
Return financial accounts
get
Return financial accounts
get
Get only my open financial accounts
get
Get only my open financial accounts
get
Open financial account
post
Rename financial account
post
Get financial account numbers: will be remove to 1.03.2022
get
Check financial accounts limit
get
Get Cash flow at period
get
Get Cash flow at period
get
Get balances
get
Download bank details by financial account
get
Statements
Get statement data in json format for the period
get
Download statements in PDF, CSV, QBO format
get
Download statements in PDF
get
Download statements in CSV
get
Generate Comprehensive Account Statements for Specified Period
post
Statements for many accounts (will be sent a email)
post
Statement's periods
get
Lockbox
Banking Card
PaymentCards
Get Spending report for the card
post
Get Spending report for the card as xlsx file
post
Get list of Payment cards
get
Issue Virtual Payment card with required parameters
post
Get list of Payment cards V2
get
Get list of Payment Cards with pagination
get
Get list of Payment Cards
get
Get preview card designs
post
Resend Physical card
post
Request New Payment Cards (Virtual or Physical)
post
Issue Burner card with required parameters
post
Order Physical card with required parameters (V2)
post
Get Payment card ID
get
Get Payment card ID
get
Get Payment card details by ID and additional parameters
get
Get Payment card with limits data
get
Close Payment Card
post
Set PIN for payment card
post
Activate Payment card (Only for suspend card)
post
Temporary lock the card
post
Get Physical card order info
get
Cancel physical card order status
post
Payment card reissue
post
Payment card reissue
post
Get reissue address
get
Set reissue address
post
Get Payment Cards features
get
Add payment card to Google wallet
post
Add payment card to Apple wallet
post
Get payment cards
get
Set nickname for the payment card
post
Get all Authorized Users attachend payment cards
get
Get card designs
get
Create Virtual Payment Card via Partner System
post
Request Physical Payment Card via Partner
post
Get a list of deliveries and their cost
get
SpendRules
Set amount limit for 1 transaction
post
Set merchant country
post
Set merchant category
post
Set monthly amount limit
post
Set Daily ATM Withdrawal Limit
post
Get the "Daily ATM Withdrawal Limit"
get
Delete the "Daily ATM Withdrawal Limit"
del
Get the "Daily ATM Withdrawal Limit"
get
Get Spend rules by card
get
Get Spend rules by card
get
Detach all spend rules for card
post
Detach monthly limit for card
post
Detach all spend rules for card except monthly limit
post
Subscription
Retrieve a list of subscription related transactions
get
Terminate subscription
post
Get all Subscriptions by user
post
Get all Subscriptions by user from cache
post
Transfers
FundsMovement
Initiate Batch Transfer
post
Batch adding external banking account number - Payee
post
Initiate many ACH transfers from own account
post
Initiate many ACH transfers from own account
post
Initiate many transfers between financial accounts - Payee.
post
Initiate ACH transfer from own account
post
Initiate ACH transfer to own account
post
Initiate transfer funds between financial accounts with OTP
post
Add external banking account number - Payee
post
Add a new Netevia's account number - Payee.
post
Initiate transfer funds between financial accounts - Payee.
post
Initiate Transfer Between Financial Accounts
post
Transfer To/From Lockbox Financial Account
post
Delete external banking account number - Payee
del
Delete Netevia's account number - Payee.
post
Get the list of Payees.
get
Get Payee by financialAccountId
get
Get the list of external bank accounts V2
get
Get ACH transfers history
get
Get ACH transfer details
get
Confirm Operation with One Time Code Authentication
post
ScheduledTransfer
Delete scheduled transfer
del
Create scheduled transfer
post
Update scheduled transfer
put
Get scheduled transfers list
get
Search
Clients
get
Clients
post
Recent Payees
get
Get last 5 accounts after transfer points
get
Search business profile
get
Transactions
Transaction
Get transaction history
get
Set user's memo for card's transaction by ID
post
Get transaction's details report
get
Get details of Transaction by ID
get
Get Spending report for the card
get
Get last Financial account activity (with pagination)
post
Get last Financial account activity
post
Retrieve Recent Transactions by Financial Account
post
Get last Financial account activity
post
Get card spending
get
Get card balance information
get
TransactionEvents
Get last transaction event
get
Get last transaction event
post
Get last transaction events
post
Get authorization transactions
get
Get authorization transactions
post
Get authorization transactions
post
Get transactions with authorization status includes: [AUTHORIZATION_EVENT,AUTHORIZATION_AND_CLEAR_EVENT]
get
Files
Upload File by FileType in request
post
Upload public file
post
Get image
get
Get transaction image
get
Get user's document (SSN, Driving License etc.) by FileType in request
get
Perform deleting user's document (SSN, Driving License etc.) by FileType in request
post
Delete both types of images (UserIcon and TransactionIcon)
post
Get public file by id
get
Get CSV transfer file example
get
Validate CSV transfer file
post
Authorized users
Get sub users payment cards
get
SubProfiles
Get the list of Authorized users
get
Add new Authorized user
post
Remove Authorized user
post
Update Authorized user
post
Update Authorized user's address
post
Update Authorized user's phone
post
Update notification for Primary user
post
Attach payment card to Authorized user
post
Detach payment card to Authorized user
post
Get available user's cards (not Authorized user's cards)
get
Get Authorized user information from card ID
get
Attach financial account to Authorized user
post
Detach financial account to Authorized user
post
Get available financial accounts
get
Get Authorized users by user's ID
get
Check Authorized user is authorized
get
Create Payment Card for Authorized user
post
Teams
List of departments
get
Create a new department
post
Remove a department
del
Rename a department
put
Manage a department's team
post
Get Spending report for the department
post
Get Spending report for the department as xl file
post
Get Card Transactions for the department
post
UsersManagement
Get Authorized user access rights
get
Manage Authorized user access
post
Business Funding
Introduction to Business Funding
Create an Application
Request a Business Funding
get
Lead for request loan
get
Manage Business Funding
Hide Business Funding prequalified offer
post
Hide Business Funding data
post
Loan Settings API Models Overview
get
Lead and Loan Statuses
Loans documents
get
Connected accounts
LinkedAccount
Conected Account
get
Connection to customer’s account
get
Create access request
post
Access requests
get
Accept request
post
Delete conected account
del
Delete conected user
del
Retrieving Connection Requests
get
Creating User Connections
post
Removing User Connections
post
Rewards
UsersReward
Get rewards for user
get
Get rewards for user
get
Exchange points
post
Exchange points for gift card
post
Get user rewards activity
get
Get rewards for user as report
get
Get Rewards Report
get
Get rewards template for user
get
Transfer points between customers
post
Set Account for Rewards Deposit
post
Get user rewards in currency
get
Get user rewards in currency
get
Transfer points
post
Gift Cards
GiftCards
Gift card orders
get
Brands
get
Issue digital card
post
Restore Digital Card
del
Settings
Security
Turn on Multi-Factor Authentication for Signing In
post
Turn off Multi-Factor Authentication for Signing In
del
SetUp Common Multi-Factor Secret
post
Get access history
get
Remove Common Multi-Factor Secret
del
Get Connected Devices List
get
Delete Connected Device
del
Logout from the app
post
Change User Login (Without OTP)
post
Remove current password and create another one
post
Remove current password and create another one
post
Request QR code to add MFA in login process
get
Request Secret Key to add MFA for login, operation confirmation processes
get
Check if user already set up MFA TimeBased token or not
get
Unlink connected application
post
Customer's information
Business information
post
Change email address
post
Change phone for Account Holder
post
Change address (Street address, postal code, city, state) for user
post
Change email associated with Primary Authorized Person and/or Beneficial Owners.
post
Change phone number associated with Primary Authorized Person and/or Beneficial Owners.
post
Change address associated with Primary Authorized Person and/or Beneficial Owners.
post
Change phone for Persoanl Account Holder with OTP
post
Change personal address (Street address, postal code, city, state) for user with OTP
post
Change personal email address with OTP
post
CodeVerification
Sending a verification code
post
Validate a verification code
post
Check SMS Verification Code
post
Notifications
User's notifications
get
Count of new notifications grouped
get
Mark notifications as read
put
Get a list of special notifications by filter's params
get
Create a new special notification
post
Update a special notification
put
Delete a special notification
del
Get notification settings
get
Setup notification settings
post
Notification Settings Types
get
POST Notification Settings Types
post
Settings
Get operations confirmation settings
get
Set operations confirmation settings
post
Push token setup
post
Check exist push token device
get
Get default financial account for A2A transfers
get
Change default financial account for A2A transfers
post
Get notification settings
get
Notification settings setup
post
Search ATM
post
Get All localization languages
get
Allowed Modules
get
Get card product's settings
get
Get transfer's amount limits
get
Welcome
Get first name + last name of account holder
get
Customer Support
Create tickets
post
Create tickets
post
Support
Get FAQ
get
Get topics for tickets
get
Create tickets
post
Reopen ticket
post
Tickets
Get the list of all tickets
get
Get the list of new tickets
get
Get ticket
get
Add message to ticket
post
Add attachment to ticket
post
Get attachment by ticket
get
Update Requests
get
Report
Report
Display Spend Report data by customer
post
Retrieve a list of external accounts associated with specific users
post
Get Transactions (need access to Daily Spending Report)
post
Get external Transfers (need access to Daily Spending Report)
post
Get internal transfers (need access to Daily Spending Report)
post
Get inter Financial Account Transfers (need access to Daily Spending Report)
post
Employers Report
post
Get Cashflow history of the financial account at period
get
Get Balance history of the financial account at period
get
Get residuals report for external accounts connections
get
Get statement download links
get
UserReport
Get Spending report for the financial account group by Merchant Category
get
Get Spending report for the financial account group by Merchant Category
get
Get Spending report for the financial account group by Merchant Category as xlsx file
get
Webhooks
Webhooks for partners
Create partner's webhook
post
Generate new secret for partner's webhook
post
List of partner's webhooks
get
Partner's webhooks logs
get
Delete partner's webhook
del
Others
Enums
List of countries ISO 3166-1-alpha-3
get
List of merchant categories
get
List of merchant categories
get
List of delivery payments
get
List of card type payments
get
List of states
get
List of Reward history types
get
List of available API
get
List of available API for customer
get
List of available API for support user
get
List of External Connected Banks
get
Get all errors occur in the BankingAPI
get
Type of banners
get
Get all languages
get
Get all TicketTypes
get
Get restore states
get
Get webhook notififcation types
get
Widget
Approved clients
post
Clients with pending notes
post
Total rewards points awailable
post
Total Deposits/withdrawals
post
Total balance
get
Total Rewards points Converted
get
Count the clients who didn't spend anything on [Date]
get
Total spend amount by category
get
WebAPI
McpConnections
Lists the supported AI clients and the MCP server URL to connect them to.
get
Connects the current customer's account to the given AI client. Fixed-model vendors (e.g. Claude) need no request body. Dynamic-model vendors (e.g. ChatGPT) require the callback URL that vendor's own connector setup screen shows the customer.
post
Registers a custom MCP client (RFC 7591 shape) for anything not on the curated vendor list. This used to be an anonymous endpoint (McpOAuthController.Register) - open, unauthenticated Dynamic Client Registration is what the RFC describes, but it turned out to be a phishing vector: an anonymous caller could mint a client under any client_name and HTTPS redirect_uri, then send a victim a same-domain connect/mcp/authorize link before the victim ever intended to connect anything. Requiring the caller's own bank session first means a client can now only ever be created by someone already authenticated as themselves - it costs the fully anonymous, self-registering client flow the RFC describes, but nothing today depends on that.
post
Lists the current customer's own active MCP connections.
get
Disconnects one of the current customer's own connections - revokes any tokens already issued for it. The client itself stays registered so the customer can reconnect through it later. Only ever affects the caller's own connection.
del
PartnersLockboxFundingRules
All split funding rules of a lockbox account, active and inactive.
get
Create a split funding rule for a lockbox account of this partner's customer.
post
Replace the fields of an existing rule. The body is the one accepted on create.
post
Delete a rule. Deleted rules stop taking part in distribution immediately.
del
Flip IsActive on a rule and return it. Activating a rule that would push the sum of active percentages over 100% is rejected.
post
ExternalApiClients
/support/external-api-clients
post
/support/external-api-clients
get
/support/external-api-clients/{id}
post
/support/external-api-clients/{id}/enable
post
Kill switch - stops the client without a deploy.
post
ExternalProfileStatus
Set an application's banking status.
post
ProfileDocuments
Every stored document of the profile, business and personal, across every upload round - superseded versions included and flagged. Always the full set, never a delta.
get
Serves one document to the holder of a signed link. Anonymous by design - the link carries the authorization, so the caller needs no bearer token - but the link is only half of it: the client and the profile's status scope are both re-checked here, so a disabled client or a profile that moved out of scope stops working immediately rather than at the end of the link's life.
get
ProfileUnderwriting
/netevia/profile/{profileId}/underwriting
get
Utils
/api/utils/normalizeAddress
post
Powered by
Copy Page
Lockbox
Updated about 1 hour ago
Statement's periods
PaymentCards
Did this page help you?
Yes
No
Updated about 1 hour ago
Statement's periods
PaymentCards
Did this page help you?
Yes
No
