For AI agents: visit https://docs.open-finance.ai/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
Home
Guides
API Reference
Changelog
Discussions
v1.0
Log In
API Reference
Log In
v1.0
Home
Guides
API Reference
Changelog
Discussions
My Requests
JUMP TO
My Requests
Auth
/token
Create access token
post
Data
/data/monthly-report/{userId}
Get a user's open banking report
get
Get a user's open banking report
get
/providers
Get all providers
get
Get all providers
get
/bank-branches
Get all bank branches
get
Get all bank branches
get
/account-verification
/account-number-verification
Check if a certain account is restricted
post
Check if a certain account is restricted
post
/payments/{paymentId}/refund
Refund a payment
post
Refund a payment
post
/aggregations
Get users by ids
post
Get users by ids
post
/aggregate/financial-data-email
Send financial data by email
post
Send financial data by email
post
/completion/wh/incoming
Send a link via whatsapp message
post
Send a link via whatsapp message
post
/connect/open-banking-init
Initiate a connection to open banking
post
Initiate a connection to open banking
post
/connect/open-banking-finalize
Finalize a connection to open banking
get
Finalize a connection to open banking
get
/payments
Create payment
post
Get payments by user
get
/payments/sandbox/{paymentId}
Update sandbox payment status
patch
Update sandbox payment status
patch
/payments/{paymentId}
Get payment by ID
get
/data/extended-securities
Get the list of positions and orders with extra information
get
Get the list of positions and orders with extra information
get
/payments/{paymentId}/status
Get payment status
get
/pay/open-banking-init
Initiate a payment with a provider
post
/atm/code/{paymentId}
Get ATM code status for a payment
get
Get ATM code status for a payment
get
/atm/verify
Verifies an ATM code
post
Verifies an ATM code
post
/financial-report/{customerId}
Create a financial report to a customer
post
Create a financial report to a customer
post
/financial-report/{jobId}
Get a financial report by jobId
get
Get a financial report by jobId
get
/decision/{customerId}
Create a decision report to a customer
post
Create a decision report to a customer
post
/decision/{jobId}
Get decision by jobId
get
Get decision by jobId
get
/decision-extended/{customerId}
Create a decision report to a customer
post
Create a decision report to a customer
post
/decision-extended/{jobId}
Get decision by jobId
get
Get decision by jobId
get
/connections
Create connection
post
Get connections by user
get
Create connection
post
Get connections by user
get
/connections/{connectionId}
Get connection by ID
get
Delete connection by ID (user scope)
del
Get connection by ID
get
Delete connection by ID (user scope)
del
/connections/{userId}/refresh
Refresh all connections data by user ID
get
Refresh all connections data by user ID
get
/connections/refresh/{connectionId}
Refresh a connection by its id
get
Refresh a connection by its id
get
/data/accounts
Get accounts by user
get
Get accounts by user
get
/data/accounts/{accountId}
Get account by ID
get
Get account by ID
get
/data/transactions
Get transactions by user
get
Get transactions by user
get
/data/transactions/{SK}
Get transactions by ID
get
Update a transaction by ID
patch
Get transactions by ID
get
Update a transaction by ID
patch
/merchants
Get all merchants
get
Create a merchant
post
Get all merchants
get
Create a merchant
post
/merchants/{merchantId}
Update a merchant
put
Get merchant by id
get
Delete merchant by ID
del
Update a merchant
put
Get merchant by id
get
Delete merchant by ID
del
/v2/mandates
Create a mandate resource
post
Create a mandate resource
post
/v2/mandates/{resourceId}
Get mandate by resource ID
get
Cancel/Delete a mandate
del
Get mandate by resource ID
get
Cancel/Delete a mandate
del
/v2/mandates/{resourceId}/status
Get mandate status
get
Get mandate status
get
/private-scoring/{customerId}
Create a private scoring job for a customer
post
Create a private scoring job for a customer
post
/private-scoring/{jobId}
Get private scoring results by jobId
get
Get private scoring results by jobId
get
/payments/{paymentId}
Cancel a payment
del
Get payment by ID
get
Cancel a payment
del
/data/accounts/{accountId}/balances/history
Get daily balance history for a checking account
get
/data/transaction-categories
Get the transaction category taxonomy
get
/payments
Create payment
post
Get payments by user
get
/payments/{paymentId}/status
Get payment status
get
/pay/open-banking-init
Initiate a payment with a provider
post
/decision-with-input/{customerId}
Create a decision-with-input job
post
/decision-with-input/{jobId}
Get a decision-with-input result
get
Loans
/customers
Create a customer
post
Get customers
get
/customers/{id}
Get customer by ID
get
Update a customer
patch
Delete customer by ID
del
/customers/osh/transactions
Update Customer OSH Transactions
patch
/customers/osh/accounts
Update OSH Account
patch
/customers/{customer_id}/osh/accounts/{account_id}
Get OSH Transactions for Customer Account
get
/customers/{id}/osh/accounts
Get OSH Accounts for Customer
get
/customers/{id}/files/checking-account
Upload "checking account" file to customer
post
/customers/{customerId}/osh/accounts/{accountId}
Delete OSH account and related transactions for a customer
del
/customers/{id}/files/balances
Get customer account balances
get
/customers/{id}/files/financial-relations
Get financial relations for a customer
get
/customers/{id}/files/invoices
Get invoices for a customer
get
/customers/{id}/files/other
Upload 'other' files to customer
post
Get "other" file links of customer
get
/customers/{id}/files/financial-report
Upload '6111' file to customer
post
/customers/{id}/files/invoice
Upload 'PCN' file to customer
post
/customers/{customerId}/files/invoice/{pcnId}
Delete a specific 'PCN' file for a customer
del
/customers/{id}/files/financial-report/share-with-agent
Share financial report with an agent
post
/customers/{customerId}/contacts/{contactId}
Get a contact by customerId and contactId
get
/credit-sessions
Create a credit request
post
/credit-sessions/create-with-agent
Create a credit request with agent contact linked
post
/credit-sessions/lead/{id}
Get credit leads by ID
get
Delete credit leads by ID
del
/credit-sessions/lead/user
Get credit leads of a user
get
/credit-sessions/lead/advisor
Get credit leads of an advisor
get
/credit-sessions/lead/org
Get credit leads of an organization
get
/credit-sessions/converted/{id}
Get credit requests by ID
get
Delete credit leads by ID
del
/credit-sessions/converted/user
Get credit requests of a user
get
/credit-sessions/converted/advisor
Get credit requests of an advisor
get
/credit-sessions/converted/org
Get credit requests of an organization
get
/credit-sessions/lead/{id}/files/other
Upload "other" files to credit lead
post
Get "other" file links of credit lead
get
/credit-sessions/converted/{id}/files/other
Upload "other" files to credit request
post
Get "other" file links of credit request
get
/credit-sessions/{id}/dnb/company-info-pdf
Get dnb company info pdf
post
Powered by
••••••2729
Endpoint
Method
Status
User Agent
