Jump to Content

Home Guides API Reference Changelog Discussions

v1.0

API Reference

v1.0Home Guides API Reference Changelog Discussions

Developer Dashboard

My Requests

Auth

/token
- Create access tokenpost

Data

/data/monthly-report/{userId}
- Get a user's open banking reportget
/providers
- Get all providersget
/bank-branches
- Get all bank branchesget
/account-verification
- Create account verification reportpost
- Get user account verification reportsget
/account-number-verification
- Check if a certain account is restrictedpost
/payments/{paymentId}/refund
- Refund a paymentpost
/aggregations
- Get users by idspost
/aggregate/financial-data-email
- Send financial data by emailpost
/completion/wh/incoming
- Send a link via whatsapp messagepost
/connect/open-banking-init
- Initiate a connection to open bankingpost
/connect/open-banking-finalize
- Finalize a connection to open bankingget
/payments
- Create paymentpost
- Get payments by userget
/payments/sandbox/{paymentId}
- Update sandbox payment statuspatch
/payments/{paymentId}
- Get payment by IDget
/data/extended-securities
- 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/generate
- Generates an ATM code for a specified paymentpost
/atm/verify
- Verifies an ATM codepost
/financial-report/{customerId}
- Create a financial report to a customerpost
/financial-report/{jobId}
- Get a financial report by jobIdget
/decision/{customerId}
- Create a decision report to a customerpost
/decision/{jobId}
- Get a financial report by jobIdget
/connections
- Create connectionpost
- Get connections by userget
/connections/{connectionId}
- Get connection by IDget
- Delete connection by ID (user scope)delete
/connections/{userId}/refresh
- Refresh all connections data by user IDget
/connections/refresh/{connectionId}
- Refresh a connection by its idget
/data/accounts
- Get accounts by userget
/data/accounts/{accountId}
- Get account by IDget
/data/transactions
- Get transactions by userget
/data/transactions/{SK}
- Get transactions by IDget
- Update a transaction by IDpatch
/merchants
- Get all merchantsget
- Create a merchantpost
/merchants/{merchantId}

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 customerdelete
/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 customerdelete
/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 IDdelete
/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 IDdelete
/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

Data

/providers
- Create multiple providerspost
- Get all providersget
/connections
- Create connectionpost
- Get connections by userget
/connections/{connectionId}
- Get connection by IDget
- Delete connection by ID (user scope)delete
/connections/{connectionId}/refresh
- Refresh connection data by IDget
- Delete connection by ID (user scope)delete
/org-connections
- Get connections by organizationget
/org-connections/{connectionId}
- Delete connection by ID (organization scope)delete
/connect/web
- Start scraping with credentialspost
/data/accounts
- Get accounts by userget
/data/accounts/{accountId}
- Get account by IDget
/data/org-accounts
- Get accounts by organizationget
/data/transactions
- Get transactions by userget
/data/transactions/{transactionId}
- Get transactions by IDget
/data/org-transactions
- Get transactions by organizationget

Payments

/pay/open-banking-init
- Create payment requestpost
/payments
- Get payment for userget
/payments/{paymentId}
- Get payment by idget
/payments/{paymentId}/status
- Get payment by id with live statusget

Powered by

Developer Dashboard

My Requests

Auth

/token
- Create access tokenpost

Data

/data/monthly-report/{userId}
- Get a user's open banking reportget
/providers
- Get all providersget
/bank-branches
- Get all bank branchesget
/account-verification
- Create account verification reportpost
- Get user account verification reportsget
/account-number-verification
- Check if a certain account is restrictedpost
/payments/{paymentId}/refund
- Refund a paymentpost
/aggregations
- Get users by idspost
/aggregate/financial-data-email
- Send financial data by emailpost
/completion/wh/incoming
- Send a link via whatsapp messagepost
/connect/open-banking-init
- Initiate a connection to open bankingpost
/connect/open-banking-finalize
- Finalize a connection to open bankingget
/payments
- Create paymentpost
- Get payments by userget
/payments/sandbox/{paymentId}
- Update sandbox payment statuspatch
/payments/{paymentId}
- Get payment by IDget
/data/extended-securities
- 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/generate
- Generates an ATM code for a specified paymentpost
/atm/verify
- Verifies an ATM codepost
/financial-report/{customerId}
- Create a financial report to a customerpost
/financial-report/{jobId}
- Get a financial report by jobIdget
/decision/{customerId}
- Create a decision report to a customerpost
/decision/{jobId}
- Get a financial report by jobIdget
/connections
- Create connectionpost
- Get connections by userget
/connections/{connectionId}
- Get connection by IDget
- Delete connection by ID (user scope)delete
/connections/{userId}/refresh
- Refresh all connections data by user IDget
/connections/refresh/{connectionId}
- Refresh a connection by its idget
/data/accounts
- Get accounts by userget
/data/accounts/{accountId}
- Get account by IDget
/data/transactions
- Get transactions by userget
/data/transactions/{SK}
- Get transactions by IDget
- Update a transaction by IDpatch
/merchants
- Get all merchantsget
- Create a merchantpost
/merchants/{merchantId}

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 customerdelete
/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 customerdelete
/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 IDdelete
/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 IDdelete
/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

Data

/providers
- Create multiple providerspost
- Get all providersget
/connections
- Create connectionpost
- Get connections by userget
/connections/{connectionId}
- Get connection by IDget
- Delete connection by ID (user scope)delete
/connections/{connectionId}/refresh
- Refresh connection data by IDget
- Delete connection by ID (user scope)delete
/org-connections
- Get connections by organizationget
/org-connections/{connectionId}
- Delete connection by ID (organization scope)delete
/connect/web
- Start scraping with credentialspost
/data/accounts
- Get accounts by userget
/data/accounts/{accountId}
- Get account by IDget
/data/org-accounts
- Get accounts by organizationget
/data/transactions
- Get transactions by userget
/data/transactions/{transactionId}
- Get transactions by IDget
/data/org-transactions
- Get transactions by organizationget

Payments

/pay/open-banking-init
- Create payment requestpost
/payments
- Get payment for userget
/payments/{paymentId}
- Get payment by idget
/payments/{paymentId}/status
- Get payment by id with live statusget

Powered by

Finalize a connection to open banking

get https://{API_PREFIX}.open-finance.ai/v2/connect/open-banking-finalize

Language

URL

Click Try It! to start a request and see the response here!