Jump to Content
Home
Product Guide
API Reference
Status Page
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
Home
Product Guide
API Reference
Status Page
/v1/business-loans/sse
Search
All
Pages
Start typing to search…
JUMP TO
CORE RESOURCES
Application IP Config Endpoints
/v1/ipconfig/get-all
get
/v1/ipconfig/add-ip
post
/v1/ipconfig/delete-by-id/{id}
del
/v1/ipconfig/delete-by-cidr
del
Custom Domain Configuration
Fetch all custom domain configurations
get
Fetch custom domain configuration by ID
get
Fetches the application's domain name
get
Create a new custom domain configuration
post
Update existing custom domain configuration
put
Notifications
Notification Service Endpoints
Mark Notification as Seen
patch
Mark All Notifications as Seen
patch
Get Latest Paged Notifications
get
Events & Subscriptions
Event Endpoints
Get All Events
get
Webhook Endpoints
Get a Webhook
get
Create a Webhook
post
Delete a Webhook
del
Edit a Webhook
patch
Get All Webhooks
get
Subscriptions Endpoints
Update the template in external customer subscription.
put
Get All Subscriptions
get
Create New Subscription
post
Add Config to Subscription
post
Create a new external customer subscription.
post
Update Subscription Status
patch
Get Subscription by ID
get
Get All Subscriptions by Subscription Configuration ID
get
Remove Config from Subscription
del
Available Subscriptions Endpoints
Get Subscription Configuration by ID
get
Get All Available Subscriptions
get
Get Available Subscription by ID
get
Get All Available Subscriptions by resource name.
get
Subscription Config Endpoints
Create Email Subscription Configuration
post
Create a new external email subscription configuration.
post
Update Subscription Configuration by ID
patch
Update replyToAddress in a subscription config.
patch
Update ccAddress in a subscription config.
patch
Update bccAddress in a subscription config.
patch
Get All Subscription Configurations
get
Fetches all external subscription configurations for an app.
get
Communications - Emails
Save a new email template.
post
Get email template by id.
get
Delete email template by id.
del
Update email template by id.
patch
Fetch all existing email templates (excluding default templates).
get
Fetch all existing email templates for a resource.
get
Fetch all variables available in a template for this module.
get
Fetch all default pre-existing templates.
get
Fetch all default templates by resource only.
get
CONNECT
Consent Endpoints
Return Ledger ID
get
Return consent URL
get
Return consent status
get
Revoke connection
post
Process third-party consent
post
Ledger Account Endpoints
Find a ledger account by ID
get
Find all ledger accounts
get
External Account Endpoints
Find external accounts by Ledger ID
get
Find an external account by ID
get
Find bank accounts by External Account ID
get
Find cards by External Account ID
get
Find other accounts by External Account ID
get
Payment Endpoints
Find a payment by ID
get
Find payments by Ledger ID
get
Batch Payments
Find Batch Payment by ID
get
Find Batch Payments by Ledger ID
get
Settlement Endpoints
Find settlements by Ledger ID
get
Find a settlement by ID
get
Find related transactions by Settlement ID
get
Dispute Endpoints
Find a dispute by ID
get
Find disputes by Ledger ID
get
Customer Endpoints
Find a customer by ID
get
Find customers by Ledger ID
get
Billing Invoice Endpoints
Find a Billing Invoice by ID
get
Find Billing Invoices by Ledger ID
get
Find Billing Invoice Line Items by Ledger ID
get
Find Billing Invoice Line Items by Billing Invoice ID
get
Find a Billing Invoice Line Item by ID
get
Bank Institutions Endpoints
/v1/bank-institutions/sync-plaid-institutions
post
/v1/bank-institutions/{providerType}
get
Bank Account Balance Endpoints
/v1/bank-account-balance/export/by-ledger/{ledgerAccountId}
get
/v1/bank-account-balance/by-ledger/{ledgerAccountId}
get
Bank Transaction Endpoints
Find Bank Account transactions by Ledger ID
get
Bank Statement Endpoints
/v1/bank-statement/export-json
get
/v1/bank-statement/export-excel
get
INSIGHTS
Business Profile Insights
Find Credit Report for a Business
get
Find Company House information for a Business
get
Cash Flow insights by Ledger Account Id
get
Payment Insights Endpoints
Get Payment Insights
get
Get settlement summary for various timelines
get
Get settlement summary for various timelines
get
CAPITAL
Lead Lifecycle Management Endpoints
Find a lead origination by lead id
get
Update lead origination
put
Create lead origination
post
Find a lead details by id
get
Update lead details
put
Update lead status
put
Find a lead details by application id and institution account id
get
Create lead details
post
Qualified Lead for Automated
post
Find a lead details by ledger account id
get
Find all leads
get
Find a lead details by application id and institution account id
get
Verifies the entity exists or not by application id and institution account id or email or contact number
get
Business Onboarding - KYC/KYB Endpoints
Update business details
put
Update business details by business Id
put
Endpoint to update the individual contact
put
Endpoint to update the company contact
put
Endpoint to update the company address
put
Endpoint to update the individual contact address
put
Endpoint to update the company contact address
put
Find all business details by platform/application
get
Create business details
post
Endpoint to create the individual contact address
post
Endpoint to add the company contact address
post
Endpoint to add the individual contact
post
Endpoint to add the company contact
post
Endpoint to add the company address
post
Create business details
post
Fetch all role types
get
Fetch all regions
get
Fetch all legal entity types
get
Fetch all industry code type
get
Fetch all contact types
get
Find a business details by ledger account id and business Id, if available
get
Endpoint to fetch the individual contacts
get
Endpoint to get the individual contact addresses
get
Endpoint to fetch the company contacts
get
Endpoint to fetch the company contact address
get
Endpoint to fetch the company addresses
get
Fetch all address types
get
Endpoint to delete the individual contact address
del
Endpoint to delete the individual contact
del
Endpoint to delete the company contact
del
Endpoint to delete the company address
del
Endpoint to delete the company contact address
del
Deal Flow Endpoints
Find a merchant flow by id
get
Update merchant flow
put
Update merchant flow current step by merchant flow id
put
/v1/merchant-flow/vulnerability-assessment/{id}
put
/v1/merchant-flow/merchant-document/{id}
put
/v1/merchant-flow/vulnerability-assessment
post
/v1/merchant-flow/merchant-document
post
/v1/merchant-flow/merchant-document/generate-qr
post
/v1/merchant-flow/merchant-document/download-zip
post
Find a merchant flow by ledger account id
get
Create merchant flow
post
Create new funding proposal for given proposal name.
post
Fetch the merchant profiles by ledger account id
get
/v1/merchant-flow/vulnerability-assessment/by-ledger-id/{ledgerAccountId}
get
/v1/merchant-flow/merchant-document/by-ledger-id/{ledgerAccountId}
get
Find a merchant flow deals by ledger account id
get
/v1/merchant-flow/general-proposal-pdf/document-link
get
Fetch all available funding products and lender configurations for eMCA and business loan products.
get
/v1/merchant-flow/export/general-proposal-pdf
get
Find all merchant flows
get
/v1/merchant-advance/{lendingType}/{advanceId}
get
Capital Orchestration Step Reference Data
Get all orchestration steps
get
MCA - Lending Product Endpoints
MCA Configuration Endpoints
/v1/emca-flow/configurations/recipient-details
put
/v1/emca-flow/configurations/capital-provider
get
/v1/emca-flow/configurations/capital-provider
post
/v1/emca-flow/configurations/capital-provider
patch
/v1/emca-flow/configurations/application-platform
get
/v1/emca-flow/configurations/application-platform
post
/v1/emca-flow/configurations/application-platform
patch
/v1/emca-flow/capital-provider/funding-product
post
/v1/emca-flow/capital-provider/funding-product
patch
/v1/emca-flow/configurations/email-recipients
get
Retrieve all capital providers
get
/v1/emca-flow/configurations/capital-provider/{id}
get
/v1/emca-flow/configurations/application-platform/{id}
get
/v1/emca-flow/capital-provider/{capitalProviderPartnerName}/funding-product
get
/v1/emca-flow/capital-provider/funding-product/{id}
get
MCA Orchestration Endpoints
Get merchant token from approved UUID
put
Get merchant token
put
Update selected quote in capital application
put
Update current step in MCA orchestration
put
/v1/emca/quote
post
Submit eMCA application to lender.
post
Fetch capital application by id
patch
Fetch application document by id
patch
Retrieve best quote.
get
Get quote by id
get
Fetch merchant token and campaign link
get
Retrieve filtered and sorted quotes.
get
Fetch all offers
get
Fetch all advances for merchant
get
Fetch institution settings for merchant commerce platform
get
Fetch capital application by emcaFlowId
get
Fetch selected capital application
get
Fetch all application documents
get
Fetch advance by id
get
Fetch repayment transactions against given advance
get
Fetch 365 finance loan application status
get
MCA Reporting Endpoints
Get all portfolio
get
Get filtered and sorted quotes
get
Get all quotes
get
Get portfolio count by currentStep overview
get
Get all merchants with at least one capital account
get
Get all advances for given merchant
get
Get all eMCA applications
get
Get advance( or capital account) by advance id
get
Get all repayment transactions for given advance
get
Fetch all campaigns
get
Business Loan - Lending Product Endpoints
/v1/business-loans/update-document/{id}
put
/v1/business-loans/update-current-step
put
Updates an existing offer.
put
Adds a new offer and returns the UUID of the newly added offer in db.
post
/v1/business-loans/loan-application/{loanApplicationId}/update-privacy-policy-consent-status
put
Fetch All Filter Sets
get
/v1/business-loans/filters/filter-sets
put
Add New Filter Set
post
Remove Filter Set
del
Update mode of application submission and recipient details, if available for given commerce platform and lender combination.
put
/v1/business-loans/submit-loan-application/{businessFlowId}
post
/v1/business-loans/save-document
post
/v1/business-loans/offers/select/{offerId}
post
/v1/business-loans/loan-application
post
Get Commerce Platform Offer Conditions
get
Save or Update Offer Conditions
post
/v1/business-loans/filters
del
Get Filters And Ranks
get
Save or Update Filters and Ranks
post
/v1/business-loans/customer/upload-document
post
/v1/business-loans/configurations/loan-provider
get
/v1/business-loans/configurations/loan-provider
post
/v1/business-loans/configurations/loan-provider
patch
/v1/business-loans/configurations/loan-provider/funding-product
post
/v1/business-loans/configurations/loan-provider/funding-product
patch
/v1/business-loans/configurations/application-platform
get
/v1/business-loans/configurations/application-platform
post
/v1/business-loans/configurations/application-platform
patch
/v1/business-loans/sse
get
/v1/business-loans/repayment-schedule
get
/v1/business-loans/quotes
get
/v1/business-loans/quotes-exploration
get
/v1/business-loans/quote/{id}
get
/v1/business-loans/offers
get
/v1/business-loans/offer/{quoteId}/documents-to-upload
get
/v1/business-loans/login-link
get
/v1/business-loans/loan-application/{loanApplicationId}
get
/v1/business-loans/loan-account
get
Fetch all offers
get
/v1/business-loans/funding-transactions
get
Get Commerce Platform Offer Conditions Default
get
/v1/business-loans/filters/default
del
/v1/business-loans/documents-for-quote/{quoteId}
get
/v1/business-loans/documents-for-loan-application/{loanApplicationId}
get
/v1/business-loans/configurations/loan-providers
get
/v1/business-loans/configurations/loan-provider/{loanProviderPartnerName}/funding-product
get
/v1/business-loans/configurations/loan-provider/{id}
get
/v1/business-loans/configurations/loan-provider/funding-product/{id}
get
Fetch mode of application submission and recipient details, if present for given commerce platform and lender name.
get
/v1/business-loans/configurations/application-platform/{id}
get
/v1/business-loans/application-summary/{businessFlowId}
get
/v1/business-loans/delete-document/{documentId}
del
Notes/Action - Ops Housekeeping Endpoints
/v1/crm/notes/{id}
get
/v1/crm/notes/{id}
put
/v1/crm/notes/{id}
del
/v1/crm/notes
post
/v1/crm/notes/business/{ledgerAccountId}
get
Powered by
/v1/business-loans/sse
get
https://app.wearegroov.io/api/v1/business-loans/sse
Language
Shell
Node
Ruby
PHP
Python
Response
Click
Try It!
to start a request and see the response here!
