Starting a new integration? Use v3. These pages cover the v2 API for integrations that are already built on it. New integrations should start with the v3 API.
GET /api/v2/client/list returns all of your clients when you sign in with the login you created at sign-up, and only the clients assigned to an employee when you sign in as that employee.
Base URLs
Sandbox
https://staging.ledgersyncappv2.comA separate LedgerSync environment for building and testing. Create a login at staging.ledgersyncappv2.com/sign-up.Production
https://ledgersyncappv2.comYour clients’ real bank data. Create a login at ledgersyncappv2.com/sign-up./api/v2/. They do not share logins or data: a login you create in the sandbox does not exist in production, so sign up in each. When you sign up, the email address you enter becomes your username. Try your integration in the sandbox first; Testing covers what it offers.
The sandbox address in the old v2 docs,
104.196.54.242.sslip.io, no longer works. Use https://staging.ledgersyncappv2.com.Sign in first
Every call outside/api/v2/public/ needs a token. Get one by signing in:
authToken starts with Bearer. Send that whole value in an Auth-Token header on every other call. It lasts 30 minutes, then you sign in again. Authentication has the details, the errors and logout.
How an integration reads data
Reading a client’s transactions takes three calls after sign-in, and each one hands you the values the next one needs. The snippets assume two variables:1
List your clients
clients has a username. That username is how every other endpoint names the client. When you sign in with the login you created at sign-up, the list also includes that login itself, under its own username.2
List the client's bank accounts
banks. Each bank carries its source, the data provider behind it, and its accounts, each with an id. Trimmed:id together with its bank’s source.3
List each account's transactions
source and the account’s id as accountId. Leave source out and the call reads FINICITY data, so an MX account comes back 200 with no transactions and no error. Results are newest first and paged: page starts at 0, and rowsPerPage is 10, 20 or 50 (default 50).Endpoint groups
Every endpoint, with its parameters and responses, is in the API reference pages of this tab. In short:Where to go next
Authentication
Sign in, send the token, and sign in again every 30 minutes.
Transactions
The transaction list in full: parameters, dates and paging for each source.
Transaction status
The status values each source returns on a transaction.
Testing
Build against the sandbox before you go live.
v3 API
Starting a new integration? Start here.
