For AI agents: the docs index is at https://docs.open-finance.ai/llms.txt. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Home Guides API Reference Changelog Discussions

v1.0

API Reference

v1.0Home Guides API Reference Changelog Discussions

My Requests

Auth

/token
- Create access tokenpost

Data

/data/monthly-report/{userId}
- Get a user's open banking reportget
- Get a user's open banking reportget
/providers
- Get all providersget
- Get all providersget
/bank-branches
- Get all bank branchesget
- Get all bank branchesget
/account-verification
/account-number-verification
- Check if a certain account is restrictedpost
- Check if a certain account is restrictedpost
/payments/{paymentId}/refund
- Refund a paymentpost
- Refund a paymentpost
/aggregations
- Get users by idspost
- Get users by idspost
/aggregate/financial-data-email
- Send financial data by emailpost
- Send financial data by emailpost
/completion/wh/incoming
- Send a link via whatsapp messagepost
- Send a link via whatsapp messagepost
/connect/open-banking-init
- Initiate a connection to open bankingpost
- Initiate a connection to open bankingpost
/connect/open-banking-finalize
- Finalize a connection to open bankingget
- Finalize a connection to open bankingget
/payments
- Create paymentpost
- Get payments by userget
/payments/sandbox/{paymentId}
- Update sandbox payment statuspatch
- Update sandbox payment statuspatch
/payments/{paymentId}
- Get payment by IDget
/data/extended-securities
- Get the list of positions and orders with extra informationget
- Get the list of positions and orders with extra informationget
/payments/{paymentId}/status
- Get payment statusget
/pay/open-banking-init
- Initiate a payment with a providerpost
/atm/code/{paymentId}
- Get ATM code status for a paymentget
- Get ATM code status for a paymentget
/atm/verify
- Verifies an ATM codepost
- Verifies an ATM codepost
/financial-report/{customerId}
- Create a financial report to a customerpost
- Create a financial report to a customerpost
/financial-report/{jobId}
- Get a financial report by jobIdget
- Get a financial report by jobIdget
/decision/{customerId}
- Create a decision report to a customerpost
- Create a decision report to a customerpost
/decision/{jobId}
- Get decision by jobIdget
- Get decision by jobIdget
/decision-extended/{customerId}
- Create a decision report to a customerpost
- Create a decision report to a customerpost
/decision-extended/{jobId}
- Get decision by jobIdget
- Get decision by jobIdget
/connections
/connections/{connectionId}
/connections/{userId}/refresh
- Refresh all connections data by user IDget
- Refresh all connections data by user IDget
/connections/refresh/{connectionId}
- Refresh a connection by its idget
- Refresh a connection by its idget
/data/accounts
- Get accounts by userget
- Get accounts by userget
/data/accounts/{accountId}
- Get account by IDget
- Get account by IDget
/data/transactions
- Get transactions by userget
- Get transactions by userget
/data/transactions/{SK}
/merchants
/merchants/{merchantId}
/v2/mandates
- Create a mandate resourcepost
- Create a mandate resourcepost
/v2/mandates/{resourceId}
/v2/mandates/{resourceId}/status
- Get mandate statusget
- Get mandate statusget
/private-scoring/{customerId}
- Create a private scoring job for a customerpost
- Create a private scoring job for a customerpost
/private-scoring/{jobId}
- Get private scoring results by jobIdget
- Get private scoring results by jobIdget
/payments/{paymentId}
/data/accounts/{accountId}/balances/history
- Get daily balance history for a checking accountget
/data/transaction-categories
- Get the transaction category taxonomyget
/payments
- Create paymentpost
- Get payments by userget
/payments/{paymentId}/status
- Get payment statusget
/pay/open-banking-init
- Initiate a payment with a providerpost
/decision-with-input/{customerId}
- Create a decision-with-input jobpost
/decision-with-input/{jobId}
- Get a decision-with-input resultget

Loans

/customers
- Create a customerpost
- Get customersget
/customers/{id}
/customers/osh/transactions
- Update Customer OSH Transactionspatch
/customers/osh/accounts
- Update OSH Accountpatch
/customers/{customer_id}/osh/accounts/{account_id}
- Get OSH Transactions for Customer Accountget
/customers/{id}/osh/accounts
- Get OSH Accounts for Customerget
/customers/{id}/files/checking-account
- Upload "checking account" file to customerpost
/customers/{customerId}/osh/accounts/{accountId}
- Delete OSH account and related transactions for a customerdel
/customers/{id}/files/balances
- Get customer account balancesget
/customers/{id}/files/financial-relations
- Get financial relations for a customerget
/customers/{id}/files/invoices
- Get invoices for a customerget
/customers/{id}/files/other
- Upload 'other' files to customerpost
- Get "other" file links of customerget
/customers/{id}/files/financial-report
- Upload '6111' file to customerpost
/customers/{id}/files/invoice
- Upload 'PCN' file to customerpost
/customers/{customerId}/files/invoice/{pcnId}
- Delete a specific 'PCN' file for a customerdel
/customers/{id}/files/financial-report/share-with-agent
- Share financial report with an agentpost
/customers/{customerId}/contacts/{contactId}
- Get a contact by customerId and contactIdget
/credit-sessions
- Create a credit requestpost
/credit-sessions/create-with-agent
- Create a credit request with agent contact linkedpost
/credit-sessions/lead/{id}
- Get credit leads by IDget
- Delete credit leads by IDdel
/credit-sessions/lead/user
- Get credit leads of a userget
/credit-sessions/lead/advisor
- Get credit leads of an advisorget
/credit-sessions/lead/org
- Get credit leads of an organizationget
/credit-sessions/converted/{id}
- Get credit requests by IDget
- Delete credit leads by IDdel
/credit-sessions/converted/user
- Get credit requests of a userget
/credit-sessions/converted/advisor
- Get credit requests of an advisorget
/credit-sessions/converted/org
- Get credit requests of an organizationget
/credit-sessions/lead/{id}/files/other
- Upload "other" files to credit leadpost
- Get "other" file links of credit leadget
/credit-sessions/converted/{id}/files/other
- Upload "other" files to credit requestpost
- Get "other" file links of credit requestget
/credit-sessions/{id}/dnb/company-info-pdf
- Get dnb company info pdfpost

Powered by

/account-verification

Updated over 1 year ago

Get all bank branches

/account-number-verification

Did this page help you?

Updated over 1 year ago

Get all bank branches

/account-number-verification

Did this page help you?