Skip to main content
POST
Create a hosted pick-and-connect link for a client

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.

sid
string
required

This session's opaque id. Pass it to DELETE /v3/clients/{client_id}/connect-session/{sid} to kill the link before it expires. It is also the link's credential, since the url carries it, so keep it server-side and never hand it to anyone you would not hand the link itself.

Example:

"9f2c4b7e1a8d6350f4e2c9b7a1d83e56"

url
string<uri>
required

The LedgerSync-hosted page to send the member to.

expires_at
string<date-time>
required

When the link stops working. To kill it sooner, call DELETE /v3/clients/{client_id}/connect-session/{sid} with the sid above.