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. Supply the details required for that person’s or organisation’s role. Before making changes, read the section list and send its exact updatedAt value, in quotes, as If-Match. Use the returned ETag for your next change. A missing or outdated required revision returns 409; fetch the latest application before trying again.

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

If-Match
string
required

The exact updatedAt value from the application's section list, enclosed in quotes. Required for applications you manage. A missing or outdated required value returns 409 without changing the draft.

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

The managed business's ID. Keep your institution selected in the authentication headers.

Body

application/json

Details and additional answers for a person or organisation in the application. IDs and verification status are assigned by Ledig.

type
enum<string>
required
Available options:
individual,
company
ownershipPercentage
string
required
firstName
string
middleName
string | null
lastName
string
email
string
dateOfBirth
string
nationality
string
dualNationality
string | null
residenceCountry
string
resStreet
string | null
resCity
string | null
roles
string[]
taxCountry
string | null
taxIdType
string | null
taxIdNumber
string | null
companyName
string
companyCountry
string | null
companyRegistrationNumber
string | null
companyRegistrationDate
string | null

Response

Related party added.

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