Ledgersync

LedgerSync Rest API

Getting Started

Authentication

Authenticate

Logout an authenticated user

Authenticates an user by email

sign In Admin

Accounts

Add Bank Account Widget Integration

Add Lite Bank Account Widget Integration

Fix Bank Account Connection Integration

List Bank Accounts

List Sub-Accounts

Get Account Summary

Refresh Accounts

Update Account

Delete Bank Account

Clients

Add Client

List Clients

Update Client

Delete Client

Institutions

List institutions

Transactions

List Transactions

Transaction Status

Refresh Transactions

Refresh Historic Transactions

Statements

List Statements

Download Statement

Convert Statement

Checks

List Checks

Webhooks

Handling Webhooks

Webhooks Events

Retries

Testing

Change employee's password

Adds an employee to the customer

Updates employee details

Unlock employee access

Lock employee access

List all employees for the given customer

Deletes an employee

Change client password

Adds a client to a customer given the customer's token

Unlock client access

Lock client access

Returns the add account widget's URL

Refresh account statements

Refresh bank statements with MFA

OCR a PDF bank statement and return extracted transactions as JSON

Phone verification

setup user's password

reset user's password

Generate an AI rule suggestion for a single transaction

delete Customer

Ledgersync Rest API

Production

Sandbox

Generated server url

<p class="slate-p " >The Ledgersync Rest API provides developers with access to essential financial data retrieval and synchronization functionalities. Users can integrate this API to seamlessly fetch and update information related to transactions, accounts, and other financial data sources. This API serves as a vital resource for automating and streamlining financial data management processes within applications.</p><p class="slate-p " ></p><p class="slate-p " ></p>

The Ledgersync Rest API provides developers with access to essential financial data retrieval and synchronization functionalities. Users can integrate this API to seamlessly fetch and update information related to transactions, accounts, and other financial data sources. This API serves as a vital resource for automating and streamlining financial data management processes within applications.

<p class="slate-p" placeholder="Type / for widgets">Welcome to the Ledgersync documentation! This guide will quickly walk you through the essential steps needed to start using our API, including how to register for a customer account and authenticate your API requests. Additionally, we&apos;ll introduce you to our Sandbox environment, perfect for testing your integrations.</p><h4 class="slate-h4">Quick Start</h4><p class="slate-p" placeholder="Type / for widgets">Before integrating with our API in a live environment, we recommend experimenting with our Sandbox to safely test your implementations. Follow these steps to get started:</p><ol class="slate-ol"><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Register a Customer Account in the Live Environment</strong></span></div><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Visit <a href="https://ledgersyncappv2.com/sign-up" target="_new">https://ledgersyncappv2.com/sign-up</a> to create your customer account for the live environment. You will need to provide your email and password during registration.</div></li></ul></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Register for the Sandbox Environment</strong></span></div><ul class="slate-ul"><li class="slate-li"><div style="position:relative">For testing purposes, access our Sandbox environment at <a href="https://104.196.54.242.sslip.io/staging/sign-up" target="_new">https://104.196.54.242.sslip.io/staging/sign-up</a>. Register here to create a separate account for development and testing.</div></li></ul></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">API Authentication</strong></span></div><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Use the email and password from your registration (for both live and Sandbox environments) to authenticate your API requests. Remember, credentials for the live and Sandbox environments are separate and not interchangeable.</div></li></ul></li></ol><p class="slate-p" placeholder="Type / for widgets">

</p><p class="slate-p" placeholder="Type / for widgets">

</p><p class="slate-p" placeholder="Type / for widgets"></p>

Welcome to the Ledgersync documentation! This guide will quickly walk you through the essential steps needed to start using our API, including how to register for a customer account and authenticate your API requests. Additionally, we'll introduce you to our Sandbox environment, perfect for testing your integrations.

Before integrating with our API in a live environment, we recommend experimenting with our Sandbox to safely test your implementations. Follow these steps to get started:

<p class="slate-p" placeholder="Type / for widgets">Securing access to the LedgerSync is essential for protecting your data and ensuring that only authorized users can perform operations. Our API employs a token-based authentication system to facilitate this security measure.</p><h4 class="slate-h4">Obtaining Your Authentication Token</h4><ol class="slate-ol"><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Authenticate Endpoint</strong></span>: Begin by obtaining an authentication token. This is done by making a request to our authenticate endpoint using your registered email and password. Upon successful authentication, the system will provide you with an authentication token.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Extract Token</strong></span>: The response from the authenticate endpoint will include your authentication token. This token is vital for accessing other API endpoints and must be included in the headers of all subsequent API requests.</div></li></ol><h4 class="slate-h4">Using Your Authentication Token</h4><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Header Inclusion</strong></span>: For every API request after authentication, you need to include the provided authentication token in the request header. This serves as your access key to the API, validating your requests across all endpoints.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Token Management</strong></span>: It&apos;s important to manage your token responsibly. The token has an expiration timeframe, and once it expires, you will need to re-authenticate to obtain a new one. Keep your token secure and avoid sharing it publicly to prevent unauthorized access to your account.</div></li></ul><p class="slate-p" placeholder="Type / for widgets">

</p><p class="slate-p" placeholder="Type / for widgets"></p>

Securing access to the LedgerSync is essential for protecting your data and ensuring that only authorized users can perform operations. Our API employs a token-based authentication system to facilitate this security measure.

<p class="slate-p " >The Account API section allows users to retrieve detailed information about accounts within the Ledgersync system. Users can access account details, such as account numbers, types, and statuses, to easily manage and track financial information. This section provides essential data for seamless integration and efficient account management within the Ledgersync platform.</p><p class="slate-p " ></p>

The Account API section allows users to retrieve detailed information about accounts within the Ledgersync system. Users can access account details, such as account numbers, types, and statuses, to easily manage and track financial information. This section provides essential data for seamless integration and efficient account management within the Ledgersync platform.

<p class="slate-p" placeholder="Type / for widgets">This section is dedicated to guiding developers through the integration of the &quot;Add Bank Account&quot; widget provided by the Ledgersync API. Integrating this widget into your application empowers users to seamlessly add their bank accounts, enhancing user experience and streamlining the account management process.</p><h4 class="slate-h4">Overview</h4><p class="slate-p" placeholder="Type / for widgets">The &quot;Add Bank Account&quot; widget offers a user-friendly interface for users to link their bank accounts directly within your application, promoting a smooth and efficient onboarding experience. This integration is designed to complement your application&apos;s functionality, offering a direct, secure, and intuitive way for users to manage their financial accounts.</p><h4 class="slate-h4">Key Benefits</h4><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Improved User Experience</strong></span>: By incorporating the widget, users are presented with a straightforward and guided process for adding bank accounts, keeping them engaged and satisfied.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Simplified Account Management</strong></span>: The widget reduces complexities in the account addition process, minimizing user effort and potential for errors.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Secure and Trustworthy</strong></span>: With a focus on security, the widget ensures that user financial data is handled with the utmost care, maintaining privacy and trust.</div></li></ul><h4 class="slate-h4">Integration Process</h4><p class="slate-p" placeholder="Type / for widgets">By retrieving the URL for the &quot;Add Bank Account&quot; widget through the Ledgersync API, developers can effortlessly embed this functionality into their applications. The widget is designed to integrate seamlessly into your app&apos;s existing flow, ensuring a consistent and engaging user experience.</p><p class="slate-p" placeholder="Type / for widgets">The integration of the &quot;Add Bank Account&quot; widget signifies a step forward in providing users with a comprehensive, secure, and efficient tool for financial account management within your platform.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">See below example of returning JSON:</p><p class="slate-p" placeholder="Type / for widgets"><code class="slate-code">{  &quot;status&quot;: &quot;OK&quot;,  &quot;widgetUrl&quot;: &quot;https://connect.finicity.com?analytics=google%3AUA-123456789-1&amp;customerId=53829905&amp;partnerId=2445582741601&amp;redirectUri=https%3A%2F%2Fce5d9f86.ngrok.io%2Fapi%2Fpublic%2Fredirect-handler&amp;signature=4837879cbdab90530c5191bec7209719cbb25657d38b6d6e862f809d44aaf661&amp;timestamp=1589996840006&amp;ttl=1590004040006&amp;type=aggregation&amp;webhook=https%3A%2F%2Fce5d9f86.ngrok.io%2Fapi%2Fpublic%2Fwebhook-handler&amp;webhookContentType=application%2Fjson&quot;}</code></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

This section is dedicated to guiding developers through the integration of the "Add Bank Account" widget provided by the Ledgersync API. Integrating this widget into your application empowers users to seamlessly add their bank accounts, enhancing user experience and streamlining the account management process.

The "Add Bank Account" widget offers a user-friendly interface for users to link their bank accounts directly within your application, promoting a smooth and efficient onboarding experience. This integration is designed to complement your application's functionality, offering a direct, secure, and intuitive way for users to manage their financial accounts.

By retrieving the URL for the "Add Bank Account" widget through the Ledgersync API, developers can effortlessly embed this functionality into their applications. The widget is designed to integrate seamlessly into your app's existing flow, ensuring a consistent and engaging user experience.

The integration of the "Add Bank Account" widget signifies a step forward in providing users with a comprehensive, secure, and efficient tool for financial account management within your platform.

The username associated with the account being added.

username

The redirect URI to which the user will be redirected after completing the account addition process.

redirectUri

A unique authentication token provided during the authentication process for access to the add account widget's url.

Auth-Token

The status of the account addition process.

status

widgetUrl

Returns the add account URL widget to be invoked by the client when the call succeed, returning code 200, grab the content of widgetUrl and make a call to this url. 

Unauthorized. Bad credentials or the authentication system is down

<p class="slate-p" placeholder="Type / for widgets">Add Lite provides the capability to design custom screens that enable users to choose their financial institution (FI) and account. </p><p class="slate-p" placeholder="Type / for widgets">To utilize Add Lite, you must provide an institutionId. You can obtain this by conducting a search through the institutions endpoint using a search term provided by your customer. After a customer selects an institution from the generated list, you will acquire the necessary institutionId for the Connect Lite endpoint.</p><p class="slate-p" placeholder="Type / for widgets">

</p><h4 class="slate-h4"></h4><p class="slate-p" placeholder="Type / for widgets">See below example of returning JSON:</p><p class="slate-p" placeholder="Type / for widgets"><code class="slate-code">{  &quot;status&quot;: &quot;OK&quot;,  &quot;widgetUrl&quot;: &quot;https://connect.finicity.com?analytics=google%3AUA-123456789-1&amp;customerId=53829905&amp;partnerId=2445582741601&amp;redirectUri=https%3A%2F%2Fce5d9f86.ngrok.io%2Fapi%2Fpublic%2Fredirect-handler&amp;signature=4837879cbdab90530c5191bec7209719cbb25657d38b6d6e862f809d44aaf661×tamp=1589996840006&amp;ttl=1590004040006&amp;type=aggregation&amp;webhook=https%3A%2F%2Fce5d9f86.ngrok.io%2Fapi%2Fpublic%2Fwebhook-handler&amp;webhookContentType=application%2Fjson&quot;}</code></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Add Lite provides the capability to design custom screens that enable users to choose their financial institution (FI) and account. 

To utilize Add Lite, you must provide an institutionId. You can obtain this by conducting a search through the institutions endpoint using a search term provided by your customer. After a customer selects an institution from the generated list, you will acquire the necessary institutionId for the Connect Lite endpoint.

institutionId

Bank-data provider: FINICITY (default) or MX. Omit for Finicity.

source

Returns the add account URL widget to be invoked by the client

Set the optional **source** field to **MX** to connect a bank via MX (for banks Finicity does not support); omit it (or use FINICITY) for the default Finicity flow. When **source=MX**, widgetUrl is an MX Connect URL (moneydesktop.com) loaded with the MX Connect widget instead of the Finicity SDK below; omit institutionId to let the user search for their bank in the widget.

When the call succeed, returning code 200, grab the content of widgetUrl and make a call to this url. See below:

Example of returning JSON:
{
  "status": "OK",
  "widgetUrl": "https://connect.finicity.com?analytics=google%3AUA-123456789-1&customerId=53829905&partnerId=2445582741601&redirectUri=https%3A%2F%2Fce5d9f86.ngrok.io%2Fapi%2Fpublic%2Fredirect-handler&signature=4837879cbdab90530c5191bec7209719cbb25657d38b6d6e862f809d44aaf661&timestamp=1589996840006&ttl=1590004040006&type=aggregation&webhook=https%3A%2F%2Fce5d9f86.ngrok.io%2Fapi%2Fpublic%2Fwebhook-handler&webhookContentType=application%2Fjson"
}

** Include the below script on your page ** 
	<script&nbsp;src="https://connect.finicity.com/assets/sdk/finicity-connect.min.js"></script>

** Make this call to trigger the widget ** 
			window['finicityConnect']['connectIFrame']('**ADD THE CONTENT OF widgetUrl HERE**', {
                            success: () => {
                                console.log('success');
                            },
                            cancel : () => {
                                console.log('cancel');
                            },
                            error  : () => {
                                console.log('error');
                            },
                            loaded : () => {
                                console.log('loaded');
                            }
                        });


<p class="slate-p" placeholder="Type / for widgets">This section elaborates on integrating the &quot;Fix Account Connection&quot; feature via the Ledgersync API. This crucial functionality provides users with a straightforward method to address and resolve issues related to their bank account connections directly within your application.</p><h4 class="slate-h4">Overview</h4><p class="slate-p" placeholder="Type / for widgets">The &quot;Fix Account Connection&quot; feature is designed to enhance user confidence and application reliability by offering a direct pathway to rectify connection issues with financial institutions. By accessing this feature, users are guided through a seamless process to update credentials, resolve multi-factor authentication (MFA) challenges, or re-establish lost connections, ensuring uninterrupted access to their financial data.</p><h4 class="slate-h4">Key Scenarios</h4><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Lost Financial Institution Connection</strong></span>: Automatically prompts users to re-establish connection without navigating away from your application, maintaining a smooth user experience.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Credential Updates</strong></span>: Facilitates the update of user credentials directly within the widget, ensuring continued access to their account information.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Expired MFA Challenges</strong></span>: Allows users to promptly address and update expired MFA challenges, securing their account access and data integrity.</div></li></ul><h4 class="slate-h4">Integration Benefits</h4><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Enhanced User Trust</strong></span>: By enabling users to quickly fix connection issues, your application builds greater trust and reliability.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Seamless User Experience</strong></span>: The widget integrates directly into your app&apos;s flow, allowing users to resolve issues without disrupting their experience.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Secure and Efficient</strong></span>: Ensures that sensitive user information is handled securely while providing an efficient pathway to fix connectivity issues.</div></li></ul><h4 class="slate-h4">Implementation</h4><p class="slate-p" placeholder="Type / for widgets">Integrating the &quot;Fix Account Connection&quot; widget through the Ledgersync API allows developers to embed this essential feature seamlessly into their applications. Designed to address specific connection issues, the widget guides users to the relevant account screen with an error prompt for a targeted fix, streamlining the resolution process.</p><p class="slate-p" placeholder="Type / for widgets">This integration not only simplifies the management of financial account connections but also reinforces the security and efficiency of user interactions with your platform.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

This section elaborates on integrating the "Fix Account Connection" feature via the Ledgersync API. This crucial functionality provides users with a straightforward method to address and resolve issues related to their bank account connections directly within your application.

The "Fix Account Connection" feature is designed to enhance user confidence and application reliability by offering a direct pathway to rectify connection issues with financial institutions. By accessing this feature, users are guided through a seamless process to update credentials, resolve multi-factor authentication (MFA) challenges, or re-establish lost connections, ensuring uninterrupted access to their financial data.

Integrating the "Fix Account Connection" widget through the Ledgersync API allows developers to embed this essential feature seamlessly into their applications. Designed to address specific connection issues, the widget guides users to the relevant account screen with an error prompt for a targeted fix, streamlining the resolution process.

This integration not only simplifies the management of financial account connections but also reinforces the security and efficiency of user interactions with your platform.

The bankAccountId body parameter represents the unique identifier for the bank account associated with the account fix action.

bankAccountId

The redirectUri parameter specifies the URI to which the user should be redirected after the account fix process is completed.

The Auth-Token header parameter is used for authentication purposes to verify the identity of the user making the request.

<p class="slate-p" placeholder="Type / for widgets">This section allows users to retrieve a list of all accounts associated with a specific username. By accessing this endpoint, users can efficiently manage and view all accounts linked to a particular user profile.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

This section allows users to retrieve a list of all accounts associated with a specific username. By accessing this endpoint, users can efficiently manage and view all accounts linked to a particular user profile.

An authentication token required to access the specified endpoint.

The unique identifier for the user whose accounts you want to list.

banks

The status of the response returned after querying the accounts.

<p class="slate-p " >This section allows users to retrieve a list of all sub-accounts associated with a specific bank account for a given username. By accessing this endpoint, users can conveniently view and manage all related sub-accounts within the Ledgersync system.</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

This section allows users to retrieve a list of all sub-accounts associated with a specific bank account for a given username. By accessing this endpoint, users can conveniently view and manage all related sub-accounts within the Ledgersync system.

A unique authentication token required for the authentication process.

The username of the account for which sub-accounts are being listed.

The unique identifier of the bank account associated with the sub-account.

bank_account_id

subAccounts

<p class="slate-p" placeholder="Type / for widgets">This section allows users to retrieve a concise summary of a specific bank account. Users can access key information such as account status and relevant messages pertaining to the account summary retrieval process. This functionality provides a quick overview of the account&apos;s status and relevant details for easy reference.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

This section allows users to retrieve a concise summary of a specific bank account. Users can access key information such as account status and relevant messages pertaining to the account summary retrieval process. This functionality provides a quick overview of the account's status and relevant details for easy reference.

Authentication token required for authentication and authorization--------

Unique identifier for the bank account whose summary is being retrieved

Indicates the status of the account summary retrieval process--------

customerId

bankAccount

name

addedBy

institutionUrl

accounts

<p class="slate-p" placeholder="Type / for widgets">This section allows users to refresh all accounts data associated with a specific bank account ID. By using this functionality, users can ensure that the most up-to-date information from the bank account is retrieved and synchronized with the system. This helps maintain accurate and current financial data for the specified bank account.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

This section allows users to refresh all accounts data associated with a specific bank account ID. By using this functionality, users can ensure that the most up-to-date information from the bank account is retrieved and synchronized with the system. This helps maintain accurate and current financial data for the specified bank account.

A token used for authentication and authorization purposes

The unique identifier for the bank account associated with the account refresh operation

addOn

A message indicating the status of the account refresh operation

message

The current status of the account refresh operation

<p class="slate-p" placeholder="Type / for widgets">The &quot;Update Account&quot; section allows users to modify the details of a specific account associated with a bank account. By providing the necessary information such as the unique bank account identifier and the new account name, users can easily update the account information. The response will indicate the status and provide a message confirming the success of the account update process.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

The "Update Account" section allows users to modify the details of a specific account associated with a bank account. By providing the necessary information such as the unique bank account identifier and the new account name, users can easily update the account information. The response will indicate the status and provide a message confirming the success of the account update process.

Unique identifier for the bank account associated with the account

Authentication token required for authorization purposes

Current status of the account update operation

A message indicating the result of the account update process

<p class="slate-p" placeholder="Type / for widgets">The Delete Bank Account section allows users to remove a specific bank account and its sub-accounts from the Ledgersync system. By utilizing this functionality, users can effectively manage their list of connected financial institutions and streamline their account information. This feature ensures accurate data maintenance and organization within the Ledgersync platform.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

The Delete Bank Account section allows users to remove a specific bank account and its sub-accounts from the Ledgersync system. By utilizing this functionality, users can effectively manage their list of connected financial institutions and streamline their account information. This feature ensures accurate data maintenance and organization within the Ledgersync platform.

Authentication token required for authorization during the deletion process.

The unique identifier of the bank account and its sub-accounts to be deleted.

A status response parameter indicating the success or failure of the bank account deletion process.

A message response parameter indicating the outcome of the bank account deletion request.

<p class="slate-p" placeholder="Type / for widgets">The Clients section in Ledgersync allows users to retrieve detailed information about clients, such as their contact details, account status, and transaction history. By accessing this section, users can efficiently manage client data and gain insights into their financial relationships.</p>

The Clients section in Ledgersync allows users to retrieve detailed information about clients, such as their contact details, account status, and transaction history. By accessing this section, users can efficiently manage client data and gain insights into their financial relationships.

<p class="slate-p " >The Transaction API section in Ledgersync allows users to retrieve detailed information about financial transactions within their account. With this API, users can access essential data related to each transaction, enabling them to track and manage their financial activity effectively.</p><p class="slate-p " ></p><p class="slate-p " ></p>

The Transaction API section in Ledgersync allows users to retrieve detailed information about financial transactions within their account. With this API, users can access essential data related to each transaction, enabling them to track and manage their financial activity effectively.

<p class="slate-p" placeholder="Type / for widgets">The Statement API section in Ledgersync allows users to retrieve detailed financial statements and transaction data. Users can access comprehensive information about their accounts and transactions, enabling them to efficiently manage their financial records and analyze their financial performance. This API section empowers users with valuable insights into their financial health and facilitates seamless integration with other financial tools.</p>

The Statement API section in Ledgersync allows users to retrieve detailed financial statements and transaction data. Users can access comprehensive information about their accounts and transactions, enabling them to efficiently manage their financial records and analyze their financial performance. This API section empowers users with valuable insights into their financial health and facilitates seamless integration with other financial tools.

<p class="slate-p" placeholder="Type / for widgets">The Checks API allows users to retrieve detailed information about checks, including their status, amount, and payment details. With this API, users can easily access and manage check data for efficient tracking and reconciliation processes.</p>

The Checks API allows users to retrieve detailed information about checks, including their status, amount, and payment details. With this API, users can easily access and manage check data for efficient tracking and reconciliation processes.

<p class="slate-p" placeholder="Type / for widgets">Webhooks allow your application to receive real-time notifications about specific events that occur within our platform. By setting up webhooks, your system can automatically respond to these events, enabling seamless integration and efficient workflows.</p><p class="slate-p" placeholder="Type / for widgets">

</p><p class="slate-p" placeholder="Type / for widgets"></p>

Webhooks allow your application to receive real-time notifications about specific events that occur within our platform. By setting up webhooks, your system can automatically respond to these events, enabling seamless integration and efficient workflows.

This section designed to assist developers in thoroughly testing their integration with our API using simulated financial institution data. This ensures that your application can gracefully handle various scenarios, from successful connections to handling errors and multi-factor authentication (MFA) challenges.

To facilitate effective testing, we recommend using "Finbank" within the widget to simulate bank connections. Finbank is a fictional financial institution available in the testing environment that mimics real bank behavior, allowing you to test different user scenarios without connecting to actual banks.

Below is a table of usernames, passwords, and the expected outcomes when using these credentials in the testing environment. These accounts cover a range of scenarios, including successful connections, handling of various MFA types, and error simulations.

currentPassword

password

Authentication token provided during the authentication process

User does not have permission to change password

email

employeeId

Employee was successfully updated

You are not allowed to update employee

Employee not found

employees

Employee was successfully deleted

You are not allowed to delete employee

token

fromApi

mobile

Returns the add account URL widget to be invoked by the client

When the call succeed, returning code 200, grab the content of widgetUrl and make a call to this url

<h2 class="slate-h2 " >Refresh account statements</h2><p class="slate-p " >Refreshes account with the latest statements from the bank account.</p><h2 class="slate-h2 " >Params</h2><p class="slate-p " ><strong class="slate-bold">bankAccountId</strong>: Id of the bank account to be refreshed.
<strong class="slate-bold">requestParts</strong>: List of accounts to be refreshed.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">accountId</strong>: Account id to be refreshed.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">pullIndex</strong>: Represents the month to be refreshed.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Ex. 1= last month, 2= two months, 3= three months ago and so on.</div></li><li class="slate-li " ><div style="position:relative">Min/Max allowed: 1-6</div></li></ul></li></ul><p class="slate-p " ><span style="color:red">*</span><span style="color:red"><strong class="slate-bold">Only 1 refresh is allowed per bank account in a period of 24 hours.</strong></span></p><h2 class="slate-h2 " >Handling response with MFA (Multi Factor Authentication)</h2><p class="slate-p " >Some accounts are configured with MFA to improve security, so if you get a MFA challenge (Http Code - 203) you need to render the questions in your app and call  <strong class="slate-bold">/api/v2/statements/refresh/mfa</strong> with a proper answer.</p><h2 class="slate-h2 " >MFA Challenge types</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">text</strong>: Challenge text. E.g <em class="slate-italic">Enter name of your first pet</em>.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">image</strong>: Base64 encoded image with text to be rendered by your application. E.g. <em class="slate-italic">data:image/png;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/…</em></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">choices</strong>: Multiple choice challenge with text/value.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">imageChoices</strong>: Multiple choice challenge with base64 image/value.</div></li></ul>

Refreshes account with the latest statements from the bank account.

: Id of the bank account to be refreshed.


Only 1 refresh is allowed per bank account in a period of 24 hours.

Handling response with MFA (Multi Factor Authentication)

Some accounts are configured with MFA to improve security, so if you get a MFA challenge (Http Code - 203) you need to render the questions in your app and call  

accountId

requestParts

userInterface

refreshCaller

responseList

errorMsg

Some statements require MFA. Need to call */api/v2/statements/refresh/mfa* with the answer to the MFA challenge

## Refresh account statements with MFA (Multi Factor Authentication)

This API should be called only when the call to **/api/v2/statements/refresh** returns a MFA challenge, Http code: **203** or when the call to this API returns another MFA challenge.

## Params

**bankAccountId**: Id of the bank account to be refreshed.
**accountId**: Id of the account to be refreshed.
**pullIndex**: Represents the month to be refreshed. Please use the same value provided during the call to **/api/v2/statements/refresh**.
**mfaRequest**: MFA challenge that could be a simple question, an image, a multiple choice question or multiple images.
- **mfaSession**: Provided in the response of **/api/v2/statements/refresh**
 - **mfaBody**: Wrapper for questions.
    - **questions**: Represents different types of challenges.
        - **text**: Challenge text. E.g *Enter name of your first pet*.
        - **image**: Not required.
        - **choices**: Not required.
        - **imageChoices**: Not required.
        - **answer**: Answer to the question in text format.

pullIndex

mfaChallenge

Runs the standard bank-statement OCR pipeline (Gemini Vision / Google Document OCR) against the uploaded PDF and returns the extracted transactions plus reconciliation status.

Files larger than 20 MB are processed asynchronously: the response returns `async_processing=true` with no transactions, and a download link is emailed to the address provided in the `email` form field. The `email` parameter is required for files larger than 20 MB.

Sections