Families

Finish Plaid Link for a family

Firm-side family relationships only. Select the firm with x-organization-id. Owners, Admins and Staff Admins access all firm families; Staff Members need independent family assignment. Company access does not grant family access. OAuth requires the broad mcp grant, not a narrow banking scope; API keys retain ordinary agent permission scopes. No accounting organizations, portal grants, invitations or charges are created. Writes require ordinary firm write entitlement. Cross-firm and inaccessible IDs return 404. Plaid Link runs in the browser: request a link token, open Plaid Link with it, then send the result to link-complete. Requires banking permission. New accounts arrive with no destination. A bank the person (or a linked company) already has connected returns 409 existing_plaid_institution; add accounts through that login instead.

post/families/{id}/accounts/link-complete

Request

  • Base URL: https://ledgerhq.pro/api/v1
  • URL: https://ledgerhq.pro/api/v1/families/{id}/accounts/link-complete
  • Auth: one of:
    • HTTP bearer and API key in header x-organization-id
    • HTTP bearer and API key in header x-organization-id

Path parameters

idstring uuid required

Request body

OR

Response

Success

successboolean
familyIdstring uuid
mode'connect' | 'update'
plaidItemIdstring uuid
institutionNamestring nullable
accountCountinteger
addedAccountsinteger
newAccountIdsstring[]

Connected accounts this Link session brought in, ready to route

Changes

No recorded changes to this operation across all 5 revisions of this API.