Create a hosted pick-and-connect link for a client

curl --request POST \
  --url https://api-sandbox.ledgersyncappv2.com/v3/clients/{client_id}/connect-session \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "redirect_url": "<string>"
}
'

{
  "url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z"
}

Clients

Create a hosted pick-and-connect link for a client

Returns a LedgerSync-hosted URL you email to an end-user (a member). They open it, search for their own bank, pick it, and connect it — no institution_id needed up front. This is the v3 replacement for the old “add/lite” widget for integrators who don’t want to build their own bank picker.

Call this with your normal API key. Optionally pass a redirect_url (which must be on your environment’s allowlist) to send the member back to your app after they finish connecting.

POST

clients

{client_id}

connect-session

Create a hosted pick-and-connect link for a client

curl --request POST \
  --url https://api-sandbox.ledgersyncappv2.com/v3/clients/{client_id}/connect-session \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "redirect_url": "<string>"
}
'

{
  "url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Pass your secret key in the Authorization header as a Bearer token: Authorization: Bearer sk_test_... (sandbox) or Bearer sk_live_... (production).

Keys are created in the developer portal and the plaintext secret is shown exactly once at creation. Treat them like passwords — never embed them in mobile apps or front-end code.

Path Parameters

client_id

string

required

Body

application/json

redirect_url

string<uri>

Where to send the member after a successful connect. Must exactly match one of your allowlisted redirect URLs for this environment. Omit to end on the connect widget's own success screen.

Response

A hosted connect link.

url

string<uri>

required

The LedgerSync-hosted page to send the member to.

expires_at

string<date-time>

required

When the link stops working. Revoke it earlier with DELETE if needed.

Mint a short-lived end-user token Revoke a hosted connect link

⌘I