Jump to Content
Home
Guides
API Reference
Changelog
Discussions
v1.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.0
Home
Guides
API Reference
Changelog
Discussions
Create a customer
Search
JUMP TO
Developer Dashboard
My Requests
Auth
/token
Create access token
post
Data
/data/monthly-report/{userId}
Get a user's open banking report
get
/providers
Get all providers
get
/bank-branches
Get all bank branches
get
/account-verification
Create account verification report
post
Get user account verification reports
get
/account-number-verification
Check if a certain account is restricted
post
/payments/{paymentId}/refund
Refund a payment
post
/aggregations
Get users by ids
post
/aggregate/financial-data-email
Send financial data by email
post
/completion/wh/incoming
Send a link via whatsapp message
post
/connect/open-banking-init
Initiate a connection to open banking
post
/connect/open-banking-finalize
Finalize a connection to open banking
get
/payments
Create payment
post
Get payments by user
get
/payments/sandbox/{paymentId}
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
/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
/atm/verify
Verifies an ATM code
post
/financial-report/{customerId}
Create a financial report to a customer
post
/financial-report/{jobId}
Get a financial report by jobId
get
/decision/{customerId}
Create a decision report to a customer
post
/decision/{jobId}
Get decision by jobId
get
/decision-extended/{customerId}
Create a decision report to a customer
post
/decision-extended/{jobId}
Get decision by jobId
get
/connections
Create connection
post
Get connections by user
get
/connections/{connectionId}
Get connection by ID
get
Delete connection by ID (user scope)
delete
/connections/{userId}/refresh
Refresh all connections data by user ID
get
/connections/refresh/{connectionId}
Refresh a connection by its id
get
/data/accounts
Get accounts by user
get
/data/accounts/{accountId}
Get account by ID
get
/data/transactions
Get transactions by user
get
/data/transactions/{SK}
Get transactions by ID
get
Update a transaction by ID
patch
/merchants
Get all merchants
get
Create a merchant
post
/merchants/{merchantId}
Update a merchant
put
Get merchant by id
get
Delete merchant by ID
delete
Loans
/customers
Create a customer
post
Get customers
get
/customers/{id}
Get customer by ID
get
Update a customer
patch
Delete customer by ID
delete
/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
delete
/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
delete
/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
delete
/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
delete
/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
Data
/providers
Create multiple providers
post
Get all providers
get
/connections
Create connection
post
Get connections by user
get
/connections/{connectionId}
Get connection by ID
get
Delete connection by ID (user scope)
delete
/connections/{connectionId}/refresh
Refresh connection data by ID
get
Delete connection by ID (user scope)
delete
/org-connections
Get connections by organization
get
/org-connections/{connectionId}
Delete connection by ID (organization scope)
delete
/connect/web
Start scraping with credentials
post
/data/accounts
Get accounts by user
get
/data/accounts/{accountId}
Get account by ID
get
/data/org-accounts
Get accounts by organization
get
/data/transactions
Get transactions by user
get
/data/transactions/{transactionId}
Get transactions by ID
get
/data/org-transactions
Get transactions by organization
get
Payments
/pay/open-banking-init
Create payment request
post
/payments
Get payment for user
get
/payments/{paymentId}
Get payment by id
get
/payments/{paymentId}/status
Get payment by id with live status
get
Powered by
Create a customer
post
https://{API_PREFIX}.open-finance.ai/v3/loans/customers
Language
Shell
Node
Ruby
PHP
Python
Credentials
OAuth2
OAuth2
Authenticate
Bearer
Log in to use your API keys
URL
Base URL
https://
api
.open-finance.ai/v3/loans
/customers
RESPONSE
Click
Try It!
to start a request and see the response here!