Skip to main content
POST
Node.js
Required scope: merchants:write Use your institution’s credentials and keep your institution selected in the business headers. The businessId in the path identifies the business whose application you manage. Your institution must have managed-business access and an active relationship with that business. You can complete its application before that business is approved. The application must still be editable. Anyone with the link can edit and submit this application, including its documents, without creating an account. The link does not give access to balances, payments or the dashboard and expires after seven days. To replace an active link, first read its status and send replaceSessionId. A missing or outdated replacement ID returns 409. Replacing the link also ends access through the old link. The URL is returned once and is not emailed automatically. Share it only with the intended applicant; do not store it in logs.

Authorizations

Authorization
string
header
required

A user access token from sign-in. Send Authorization: Bearer followed by the token. Use this only on endpoints that list BearerAuth.

Headers

X-Ledig-Business-Id
string

The business you are acting for. For a managed business, your institution must be authorised to act for it and API-key requests must use HMAC v2. Set this header explicitly; a business ID in the body does not select the business.

Minimum string length: 1
X-Ledig-Acting-Business-Id
string

Your institution's business ID when acting for a managed business. It must match your API key's owner or an institution you belong to. HMAC v2 signs the trimmed value, or an empty string when omitted.

Minimum string length: 1

Path Parameters

businessId
string
required

Body

application/json
replaceSessionId
string<uuid>

Response

One-time disclosure of the sharing URL.

status
string
required
Allowed value: "success"
data
object
required
message
string