import { createHmac } from "node:crypto";// Node.js 18+. Set credentials and resource values on your server.function required(name) { const value = process.env[name]; if (!value) throw new Error(`Set ${name} before running this example.`); return value;}const baseUrl = process.env.LEDIG_API_BASE_URL ?? "https://api-sandbox.ledig.io";const method = "POST";const businessId = required("LEDIG_BUSINESS_ID");const path = `/v1/managed-businesses/${encodeURIComponent(businessId)}/onboarding/owners`;const pathWithQuery = path;// Use this owner's real details and country IDs from the ownership options.const body = { "type": "individual", "firstName": "Alex", "lastName": "Example", "email": "alex@example.com", "roles": [ "beneficial_owner" ], "nationality": required("LEDIG_OWNER_NATIONALITY_ID"), "residenceCountry": required("LEDIG_OWNER_RESIDENCE_COUNTRY_ID"), "resStreet": "10 Example Road", "resCity": "Example City", "ownershipPercentage": "100"};const rawBody = JSON.stringify(body);const headers = { "Accept": "application/json" };headers["Content-Type"] = "application/json";// Use the exact updatedAt from your latest GET /onboarding/sections.headers["If-Match"] = JSON.stringify(required("LEDIG_ONBOARDING_REVISION"));const timestamp = Math.floor(Date.now() / 1000).toString();const payload = `${timestamp}.${method}.${pathWithQuery}.${rawBody}`;headers["x-ledig-key"] = required("LEDIG_API_KEY");headers["x-ledig-timestamp"] = timestamp;headers["x-ledig-signature"] = "v1=" + createHmac("sha256", required("LEDIG_API_SECRET")) .update(payload).digest("base64");const response = await fetch(`${baseUrl}${pathWithQuery}`, { method, headers, body: rawBody,});const result = await response.json();// Use result in your application; do not log credentials or upload links.console.log(response.status);
{
"status": "error",
"code": "BAD_REQUEST",
"message": "Check the request fields and try again."
}
{
"status": "error",
"code": "UNAUTHORIZED",
"message": "Authentication is required."
}
{
"status": "error",
"code": "FORBIDDEN",
"message": "You do not have permission to perform this action."
}
{
"status": "error",
"code": "NOT_FOUND",
"message": "The requested resource was not found."
}
{
"status": "error",
"code": "CONFLICT",
"message": "The request conflicts with the current state of this resource."
}
{
"status": "error",
"code": "RATE_LIMITED",
"message": "Too many requests. Wait before trying again."
}
Managed businesses
Add an owner or related person
Add a person or organisation required by a business application.
POST
/
v1
/
managed-businesses
/
{businessId}
/
onboarding
/
owners
Node.js
import { createHmac } from "node:crypto";// Node.js 18+. Set credentials and resource values on your server.function required(name) { const value = process.env[name]; if (!value) throw new Error(`Set ${name} before running this example.`); return value;}const baseUrl = process.env.LEDIG_API_BASE_URL ?? "https://api-sandbox.ledig.io";const method = "POST";const businessId = required("LEDIG_BUSINESS_ID");const path = `/v1/managed-businesses/${encodeURIComponent(businessId)}/onboarding/owners`;const pathWithQuery = path;// Use this owner's real details and country IDs from the ownership options.const body = { "type": "individual", "firstName": "Alex", "lastName": "Example", "email": "alex@example.com", "roles": [ "beneficial_owner" ], "nationality": required("LEDIG_OWNER_NATIONALITY_ID"), "residenceCountry": required("LEDIG_OWNER_RESIDENCE_COUNTRY_ID"), "resStreet": "10 Example Road", "resCity": "Example City", "ownershipPercentage": "100"};const rawBody = JSON.stringify(body);const headers = { "Accept": "application/json" };headers["Content-Type"] = "application/json";// Use the exact updatedAt from your latest GET /onboarding/sections.headers["If-Match"] = JSON.stringify(required("LEDIG_ONBOARDING_REVISION"));const timestamp = Math.floor(Date.now() / 1000).toString();const payload = `${timestamp}.${method}.${pathWithQuery}.${rawBody}`;headers["x-ledig-key"] = required("LEDIG_API_KEY");headers["x-ledig-timestamp"] = timestamp;headers["x-ledig-signature"] = "v1=" + createHmac("sha256", required("LEDIG_API_SECRET")) .update(payload).digest("base64");const response = await fetch(`${baseUrl}${pathWithQuery}`, { method, headers, body: rawBody,});const result = await response.json();// Use result in your application; do not log credentials or upload links.console.log(response.status);
{
"status": "error",
"code": "BAD_REQUEST",
"message": "Check the request fields and try again."
}
{
"status": "error",
"code": "UNAUTHORIZED",
"message": "Authentication is required."
}
{
"status": "error",
"code": "FORBIDDEN",
"message": "You do not have permission to perform this action."
}
{
"status": "error",
"code": "NOT_FOUND",
"message": "The requested resource was not found."
}
{
"status": "error",
"code": "CONFLICT",
"message": "The request conflicts with the current state of this resource."
}
{
"status": "error",
"code": "RATE_LIMITED",
"message": "Too many requests. Wait before trying again."
}
Required scope:merchants:writeUse 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.
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
Show child attributes
message
string
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Ledig Payments","description":"Receive funds, manage balances, convert currencies and send payments with Ledig's payments API.","colors":{"primary":"#4361EE","light":"#4361EE","dark":"#8DA1FF"},"logo":{"light":"https://mintcdn.com/ledig/kOFkh89JDbhYVCSA/logo/light.svg?fit=max\u0026auto=format\u0026n=kOFkh89JDbhYVCSA\u0026q=85\u0026s=36e926371f686474be67796eb9056852","dark":"https://mintcdn.com/ledig/kOFkh89JDbhYVCSA/logo/dark.svg?fit=max\u0026auto=format\u0026n=kOFkh89JDbhYVCSA\u0026q=85\u0026s=eb4c8cbd824a8a1f030a02d846130873"},"favicon":"https://mintcdn.com/ledig/kOFkh89JDbhYVCSA/favicon.svg?fit=max\u0026auto=format\u0026n=kOFkh89JDbhYVCSA\u0026q=85\u0026s=75402fa9c148e3cf31e176f089455db8","api":{"playground":{"display":"simple","proxy":false},"examples":{"autogenerate":false}},"navbar":{"links":[{"href":"mailto:support@ledig.io","label":"Support"},{"href":"https://www.ledig.io","label":"Website"}],"primary":{"type":"button","label":"Request access","href":"https://www.ledig.io/contact"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ledig","hasAudioNarration":false,"actualSubdomain":"ledig","customDomains":[],"gitSource":{"type":"github","owner":"ledig-tech","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":"","_id":"6ad88f0730a73012893740ea"},"entitlements":{},"buildId":"6afb0709b31d8d74aeececda","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API reference","count":50},{"language":"default","tag":"Managed businesses","count":18},{"language":"default","tag":"Guides","count":16},{"language":"default","tag":"Build","count":7},{"language":"default","tag":"Deposit wallets","count":6},{"language":"default","tag":"Getting started","count":5},{"language":"default","tag":"Recipients","count":5},{"language":"default","tag":"Payment options","count":4},{"language":"default","tag":"Balances","count":3},{"language":"default","tag":"Currencies and rates","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/managed-businesses/add-an-owner-or-related-person","slug":"/api-reference/managed-businesses/add-an-owner-or-related-person","pageMetadata":{"title":"Add an owner or related person","description":"Add a person or organisation required by a business application.","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/managed-businesses/{businessId}/onboarding/owners","href":"/api-reference/managed-businesses/add-an-owner-or-related-person","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Add a person or organisation required by a business application.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Required scope:`}),` `,_jsx(_components.code,{children:`merchants:write`})]}),`\n`,_jsx(_components.p,{children:`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.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Add an owner or related person","description":"Add a person or organisation required by a business application.","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/managed-businesses/{businessId}/onboarding/owners","href":"/api-reference/managed-businesses/add-an-owner-or-related-person","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Managed businesses"],"operationId":"parentManagedAddOnboardingOwner","summary":"Add an owner or related person","description":"Add a person or organisation required by a business application.","security":["85fe4cc8-2b23-45fe-81d5-c33f89ce09ba","49793a6a-8bbd-45b6-b6b1-e48e398069f6"],"parameters":["a221418d-444a-4765-80ea-2417943d648d"],"requestBody":"d63e2b37-2bbe-4f1c-8e7d-e4aca30022d1","responses":{"201":"5b9cac66-68e0-4f43-97e5-87e88f281790","400":"94e3f02d-54ef-4cb0-a5b2-defdf3f89969","401":"9fd90791-2433-46ad-96e5-136b0f5379ae","403":"7985fd91-033f-4671-bad6-fbcb5a9f64b4","404":"acdd842b-5586-49ea-9081-46361d2084da","409":"1029dff5-cf9f-4795-81bc-5ec660dd5344","429":"a67d6576-ea3b-4f10-a417-f822dd11e1ce"},"x-scope":"merchants:write","x-mint":{"content":"**Required scope:** `merchants:write`\n\nUse 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."},"x-codeSamples":[{"lang":"javascript","label":"Node.js","source":"import { createHmac } from \"node:crypto\";\n\n// Node.js 18+. Set credentials and resource values on your server.\nfunction required(name) {\n const value = process.env[name];\n if (!value) throw new Error(`Set ${name} before running this example.`);\n return value;\n}\n\nconst baseUrl = process.env.LEDIG_API_BASE_URL ?? \"https://api-sandbox.ledig.io\";\nconst method = \"POST\";\nconst businessId = required(\"LEDIG_BUSINESS_ID\");\nconst path = `/v1/managed-businesses/${encodeURIComponent(businessId)}/onboarding/owners`;\nconst pathWithQuery = path;\n// Use this owner's real details and country IDs from the ownership options.\nconst body = {\n \"type\": \"individual\",\n \"firstName\": \"Alex\",\n \"lastName\": \"Example\",\n \"email\": \"alex@example.com\",\n \"roles\": [\n \"beneficial_owner\"\n ],\n \"nationality\": required(\"LEDIG_OWNER_NATIONALITY_ID\"),\n \"residenceCountry\": required(\"LEDIG_OWNER_RESIDENCE_COUNTRY_ID\"),\n \"resStreet\": \"10 Example Road\",\n \"resCity\": \"Example City\",\n \"ownershipPercentage\": \"100\"\n};\nconst rawBody = JSON.stringify(body);\nconst headers = { \"Accept\": \"application/json\" };\nheaders[\"Content-Type\"] = \"application/json\";\n// Use the exact updatedAt from your latest GET /onboarding/sections.\nheaders[\"If-Match\"] = JSON.stringify(required(\"LEDIG_ONBOARDING_REVISION\"));\nconst timestamp = Math.floor(Date.now() / 1000).toString();\nconst payload = `${timestamp}.${method}.${pathWithQuery}.${rawBody}`;\nheaders[\"x-ledig-key\"] = required(\"LEDIG_API_KEY\");\nheaders[\"x-ledig-timestamp\"] = timestamp;\nheaders[\"x-ledig-signature\"] = \"v1=\" + createHmac(\"sha256\", required(\"LEDIG_API_SECRET\"))\n .update(payload).digest(\"base64\");\n\nconst response = await fetch(`${baseUrl}${pathWithQuery}`, {\n method,\n headers,\n body: rawBody,\n});\nconst result = await response.json();\n// Use result in your application; do not log credentials or upload links.\nconsole.log(response.status);"}],"method":"post","type":"path","servers":["c1543be6-0781-4dcb-bc86-b1b22b949bd2","e6ca68e6-66bd-44af-bc94-74b08e2d343a"],"path":"/v1/managed-businesses/{businessId}/onboarding/owners","baseUrlOptions":["https://api-sandbox.ledig.io","https://api.ledig.io"],"title":"Add an owner or related person","codeSamples":[{"label":"Node.js","lang":"javascript","source":"import { createHmac } from \"node:crypto\";\n\n// Node.js 18+. Set credentials and resource values on your server.\nfunction required(name) {\n const value = process.env[name];\n if (!value) throw new Error(`Set ${name} before running this example.`);\n return value;\n}\n\nconst baseUrl = process.env.LEDIG_API_BASE_URL ?? \"https://api-sandbox.ledig.io\";\nconst method = \"POST\";\nconst businessId = required(\"LEDIG_BUSINESS_ID\");\nconst path = `/v1/managed-businesses/${encodeURIComponent(businessId)}/onboarding/owners`;\nconst pathWithQuery = path;\n// Use this owner's real details and country IDs from the ownership options.\nconst body = {\n \"type\": \"individual\",\n \"firstName\": \"Alex\",\n \"lastName\": \"Example\",\n \"email\": \"alex@example.com\",\n \"roles\": [\n \"beneficial_owner\"\n ],\n \"nationality\": required(\"LEDIG_OWNER_NATIONALITY_ID\"),\n \"residenceCountry\": required(\"LEDIG_OWNER_RESIDENCE_COUNTRY_ID\"),\n \"resStreet\": \"10 Example Road\",\n \"resCity\": \"Example City\",\n \"ownershipPercentage\": \"100\"\n};\nconst rawBody = JSON.stringify(body);\nconst headers = { \"Accept\": \"application/json\" };\nheaders[\"Content-Type\"] = \"application/json\";\n// Use the exact updatedAt from your latest GET /onboarding/sections.\nheaders[\"If-Match\"] = JSON.stringify(required(\"LEDIG_ONBOARDING_REVISION\"));\nconst timestamp = Math.floor(Date.now() / 1000).toString();\nconst payload = `${timestamp}.${method}.${pathWithQuery}.${rawBody}`;\nheaders[\"x-ledig-key\"] = required(\"LEDIG_API_KEY\");\nheaders[\"x-ledig-timestamp\"] = timestamp;\nheaders[\"x-ledig-signature\"] = \"v1=\" + createHmac(\"sha256\", required(\"LEDIG_API_SECRET\"))\n .update(payload).digest(\"base64\");\n\nconst response = await fetch(`${baseUrl}${pathWithQuery}`, {\n method,\n headers,\n body: rawBody,\n});\nconst result = await response.json();\n// Use result in your application; do not log credentials or upload links.\nconsole.log(response.status);"}],"requiredOnlyExamples":false,"disableCodeSampleGeneration":true,"requestExampleType":"codeSamples","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"a221418d-444a-4765-80ea-2417943d648d":{"in":"header","name":"If-Match","required":true,"description":"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.","schema":{"type":"string","isRequired":true,"description":"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.","uniqueKey":"","typeLabel":"string"},"example":"\"2026-01-15T10:00:00.000Z\""},"e0b6c416-57cf-4ad9-a14d-6911a8f55e6e":{"in":"path","name":"businessId","required":true,"schema":{"type":"string","isRequired":true,"description":"The managed business's ID. Keep your institution selected in the authentication headers.","uniqueKey":"","typeLabel":"string"},"description":"The managed business's ID. Keep your institution selected in the authentication headers.","example":"business_example_001"},"55fa20e8-cdb9-46b5-8302-2f1b0059cdc1":{"in":"header","name":"X-Ledig-Business-Id","required":false,"description":"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.","schema":{"type":"string","minLength":1,"isRequired":false,"description":"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.","uniqueKey":"","typeLabel":"string"},"example":"institution_example_001"},"e2da5d39-5cea-4f11-be7e-3aac8551d954":{"in":"header","name":"X-Ledig-Acting-Business-Id","required":false,"description":"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.","schema":{"type":"string","minLength":1,"isRequired":false,"description":"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.","uniqueKey":"","typeLabel":"string"},"example":"institution_example_001"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"description":"Details and additional answers for a person or organisation in the application. IDs and verification status are assigned by Ledig.","required":["type","ownershipPercentage"],"properties":{"type":{"type":"string","enum":["individual","company"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"ownershipPercentage":{"type":"string","isRequired":true,"uniqueKey":"ownershipPercentage","typeLabel":"string"},"firstName":{"type":"string","uniqueKey":"firstName","typeLabel":"string"},"middleName":{"oneOf":[{"type":"string","uniqueKey":"middleName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"middleName.oneOf.1","typeLabel":"null"}],"uniqueKey":"middleName","typeLabel":"string | null"},"lastName":{"type":"string","uniqueKey":"lastName","typeLabel":"string"},"email":{"type":"string","uniqueKey":"email","typeLabel":"string"},"dateOfBirth":{"type":"string","uniqueKey":"dateOfBirth","typeLabel":"string"},"nationality":{"type":"string","uniqueKey":"nationality","typeLabel":"string"},"dualNationality":{"oneOf":[{"type":"string","uniqueKey":"dualNationality.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"dualNationality.oneOf.1","typeLabel":"null"}],"uniqueKey":"dualNationality","typeLabel":"string | null"},"residenceCountry":{"type":"string","uniqueKey":"residenceCountry","typeLabel":"string"},"resStreet":{"oneOf":[{"type":"string","uniqueKey":"resStreet.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"resStreet.oneOf.1","typeLabel":"null"}],"uniqueKey":"resStreet","typeLabel":"string | null"},"resCity":{"oneOf":[{"type":"string","uniqueKey":"resCity.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"resCity.oneOf.1","typeLabel":"null"}],"uniqueKey":"resCity","typeLabel":"string | null"},"roles":{"type":"array","items":{"type":"string","uniqueKey":"roles.items.[INDEX]","typeLabel":"string"},"uniqueKey":"roles","typeLabel":"string[]"},"taxCountry":{"oneOf":[{"type":"string","uniqueKey":"taxCountry.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"taxCountry.oneOf.1","typeLabel":"null"}],"uniqueKey":"taxCountry","typeLabel":"string | null"},"taxIdType":{"oneOf":[{"type":"string","uniqueKey":"taxIdType.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"taxIdType.oneOf.1","typeLabel":"null"}],"uniqueKey":"taxIdType","typeLabel":"string | null"},"taxIdNumber":{"oneOf":[{"type":"string","uniqueKey":"taxIdNumber.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"taxIdNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"taxIdNumber","typeLabel":"string | null"},"companyName":{"type":"string","uniqueKey":"companyName","typeLabel":"string"},"companyCountry":{"oneOf":[{"type":"string","uniqueKey":"companyCountry.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"companyCountry.oneOf.1","typeLabel":"null"}],"uniqueKey":"companyCountry","typeLabel":"string | null"},"companyRegistrationNumber":{"oneOf":[{"type":"string","uniqueKey":"companyRegistrationNumber.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"companyRegistrationNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"companyRegistrationNumber","typeLabel":"string | null"},"companyRegistrationDate":{"oneOf":[{"type":"string","uniqueKey":"companyRegistrationDate.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"companyRegistrationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"companyRegistrationDate","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"type":"individual","firstName":"Alex","lastName":"Example","email":"alex@example.com","roles":["beneficial_owner"],"nationality":"country_nationality_example_001","residenceCountry":"country_residence_example_001","resStreet":"10 Example Road","resCity":"Example City","ownershipPercentage":"100"},"examples":{"Example":{"title":"Example","value":{"type":"individual","firstName":"Alex","lastName":"Example","email":"alex@example.com","roles":["beneficial_owner"],"nationality":"country_nationality_example_001","residenceCountry":"country_residence_example_001","resStreet":"10 Example Road","resCity":"Example City","ownershipPercentage":"100"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"5b9cac66-68e0-4f43-97e5-87e88f281790":{"description":"Related party added.","content":{"application/json":{"schema":{"type":"object","required":["data","status"],"properties":{"status":{"type":"string","const":"success","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"data":{"type":"object","additionalProperties":false,"required":["sectionKey","sectionOrder","status","currentSection","progressPercent","data"],"properties":{"sectionKey":{"type":"string","isRequired":true,"uniqueKey":"data.sectionKey","typeLabel":"string"},"sectionOrder":{"type":"integer","isRequired":true,"uniqueKey":"data.sectionOrder","typeLabel":"integer"},"status":{"type":"string","isRequired":true,"uniqueKey":"data.status","typeLabel":"string"},"currentSection":{"type":"string","isRequired":true,"uniqueKey":"data.currentSection","typeLabel":"string"},"progressPercent":{"type":"integer","isRequired":true,"uniqueKey":"data.progressPercent","typeLabel":"integer"},"data":{"oneOf":[{"type":"object","required":["kind","documents"],"properties":{"kind":{"type":"string","const":"documents","isRequired":true,"uniqueKey":"data.data.oneOf.0.kind","typeLabel":"string"},"documents":{"type":"array","items":{"type":"object","additionalProperties":false,"description":"A receipt for a document attached to the application.","required":["id","applicationId","businessProfileId","requirementType","originalFileName","mimeType","status","createdAt","updatedAt"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.data.oneOf.0.documents.items.[INDEX].id","typeLabel":"string"},"applicationId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.data.oneOf.0.documents.items.[INDEX].applicationId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.data.oneOf.0.documents.items.[INDEX].applicationId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.data.oneOf.0.documents.items.[INDEX].applicationId","typeLabel":"string | null"},"businessProfileId":{"type":"string","isRequired":true,"uniqueKey":"data.data.oneOf.0.documents.items.[INDEX].businessProfileId","typeLabel":"string"},"requirementType":{"type":"string","isRequired":true,"uniqueKey":"data.data.oneOf.0.documents.items.[INDEX].requirementType","typeLabel":"string"},"originalFileName":{"type":"string","isRequired":true,"uniqueKey":"data.data.oneOf.0.documents.items.[INDEX].originalFileName","typeLabel":"string"},"mimeType":{"type":"string","isRequired":true,"uniqueKey":"data.data.oneOf.0.documents.items.[INDEX].mimeType","typeLabel":"string"},"status":{"type":"string","enum":["pending_upload","uploaded","accepted","rejected","needs_replacement","expired"],"isRequired":true,"uniqueKey":"data.data.oneOf.0.documents.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","isRequired":true,"uniqueKey":"data.data.oneOf.0.documents.items.[INDEX].createdAt","typeLabel":"string"},"updatedAt":{"type":"string","isRequired":true,"uniqueKey":"data.data.oneOf.0.documents.items.[INDEX].updatedAt","typeLabel":"string"},"documentKind":{"type":"string","uniqueKey":"data.data.oneOf.0.documents.items.[INDEX].documentKind","typeLabel":"string"},"sizeBytes":{"type":"integer","uniqueKey":"data.data.oneOf.0.documents.items.[INDEX].sizeBytes","typeLabel":"integer"},"uploadedAt":{"type":"string","uniqueKey":"data.data.oneOf.0.documents.items.[INDEX].uploadedAt","typeLabel":"string"},"reviewedAt":{"type":"string","uniqueKey":"data.data.oneOf.0.documents.items.[INDEX].reviewedAt","typeLabel":"string"},"validation":{"type":"object","additionalProperties":false,"required":["status"],"properties":{"status":{"type":"string","const":"valid","isRequired":true,"uniqueKey":"data.data.oneOf.0.documents.items.[INDEX].validation.status","typeLabel":"string"}},"uniqueKey":"data.data.oneOf.0.documents.items.[INDEX].validation","typeLabel":"object"},"validationFailure":{"type":"object","additionalProperties":false,"required":["reasonCode"],"properties":{"reasonCode":{"type":"string","enum":["document_unreadable","document_type_mismatch","document_password_protected","document_limits_exceeded"],"isRequired":true,"uniqueKey":"data.data.oneOf.0.documents.items.[INDEX].validationFailure.reasonCode","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.data.oneOf.0.documents.items.[INDEX].validationFailure","typeLabel":"object"}},"uniqueKey":"data.data.oneOf.0.documents.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.data.oneOf.0.documents","typeLabel":"object[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.data.oneOf.0","typeLabel":"object"},{"type":"object","description":"The applicant's saved answers and related people or organisations. Each section has its own fields.","required":["kind","value"],"properties":{"kind":{"type":"string","enum":["company","activity","ownership","regulation","review"],"isRequired":true,"uniqueKey":"data.data.oneOf.1.kind","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"data.data.oneOf.1.value.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"isRequired":true,"uniqueKey":"data.data.oneOf.1.value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.data.oneOf.1.value","typeLabel":"object | null"},"relatedParties":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"data.data.oneOf.1.relatedParties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.data.oneOf.1.relatedParties","typeLabel":"object[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.data.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.data","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"success","data":{"sectionKey":"ownership","sectionOrder":3,"status":"in_progress","currentSection":"ownership","progressPercent":0,"data":{"kind":"ownership","value":null,"relatedParties":[{"id":"owner_example_001","type":"individual","firstName":"Alex","lastName":"Example","ownershipPercentage":"100"}]}}},"examples":{"Example":{"title":"Example","value":{"status":"success","data":{"sectionKey":"ownership","sectionOrder":3,"status":"in_progress","currentSection":"ownership","progressPercent":0,"data":{"kind":"ownership","value":null,"relatedParties":[{"id":"owner_example_001","type":"individual","firstName":"Alex","lastName":"Example","ownershipPercentage":"100"}]}}}}},"exampleType":"examples"}},"headers":{"ETag":{"description":"The quoted edit revision to send as If-Match with your next application change.","schema":{"type":"string"}}},"exampleType":"examples"},"94e3f02d-54ef-4cb0-a5b2-defdf3f89969":{"description":"The request is invalid. Check the error message and submitted fields.","content":{"application/json":{"schema":{"type":"object","required":["status","message","code"],"properties":{"status":{"type":"string","const":"error","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"oneOf":[{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["validationCode","reasonCode","retryable"],"properties":{"validationCode":{"type":"string","enum":["document_unreadable","document_type_mismatch","document_password_protected","document_limits_exceeded"],"isRequired":true,"uniqueKey":"details.oneOf.0.validationCode","typeLabel":"enum\u003cstring>"},"reasonCode":{"type":"string","enum":["document_unreadable","document_type_mismatch","document_password_protected","document_limits_exceeded"],"isRequired":true,"uniqueKey":"details.oneOf.0.reasonCode","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"details.oneOf.0.retryable","typeLabel":"boolean"},"documentId":{"type":"string","maxLength":128,"uniqueKey":"details.oneOf.0.documentId","typeLabel":"string"},"requirementType":{"type":"string","uniqueKey":"details.oneOf.0.requirementType","typeLabel":"string"},"maxSizeBytes":{"type":"integer","minimum":1,"maximum":1073741824,"description":"Maximum accepted file size in bytes, when supplied with HTTP 413.","uniqueKey":"details.oneOf.0.maxSizeBytes","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"details.oneOf.0","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["reason"],"properties":{"reason":{"type":"string","enum":["current_password_incorrect","unsupported_asset_network","recipient_unavailable","recipient_incompatible","payout_method_unavailable","payout_method_incompatible","network_unavailable","quote_expired","quote_already_used","quote_changed","invoice_required","invoice_invalid","amount_invalid","amount_precision_invalid","onboarding_revision_required","onboarding_revision_changed","onboarding_document_kind_mismatch"],"isRequired":true,"uniqueKey":"details.oneOf.1.reason","typeLabel":"enum\u003cstring>"},"precision":{"type":"integer","minimum":0,"maximum":18,"description":"Allowed number of decimal places when reason is amount_precision_invalid.","uniqueKey":"details.oneOf.1.precision","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"details.oneOf.1","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["period","sourceCurrency","requested","remaining","limit","resetsAt","timezone"],"properties":{"period":{"type":"string","enum":["daily","monthly"],"isRequired":true,"uniqueKey":"details.oneOf.2.period","typeLabel":"enum\u003cstring>"},"sourceCurrency":{"type":"string","pattern":"^[A-Z][A-Z0-9]{1,19}$","isRequired":true,"uniqueKey":"details.oneOf.2.sourceCurrency","typeLabel":"string"},"requested":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]+)?$","isRequired":true,"uniqueKey":"details.oneOf.2.requested","typeLabel":"string"},"remaining":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]+)?$","isRequired":true,"uniqueKey":"details.oneOf.2.remaining","typeLabel":"string"},"limit":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]+)?$","isRequired":true,"uniqueKey":"details.oneOf.2.limit","typeLabel":"string"},"resetsAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"details.oneOf.2.resetsAt","typeLabel":"string\u003cdate-time>"},"timezone":{"type":"string","const":"UTC","isRequired":true,"uniqueKey":"details.oneOf.2.timezone","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"details.oneOf.2","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["sourceCurrency","minimumAmount","maximumAmount"],"properties":{"sourceCurrency":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.3.sourceCurrency","typeLabel":"string"},"minimumAmount":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.3.minimumAmount","typeLabel":"string"},"maximumAmount":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.3.maximumAmount","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"details.oneOf.3","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["currency","requestedUsd","limitUsd"],"properties":{"currency":{"type":"string","const":"USD","isRequired":true,"uniqueKey":"details.oneOf.4.currency","typeLabel":"string"},"requestedUsd":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.4.requestedUsd","typeLabel":"string"},"limitUsd":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.4.limitUsd","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"details.oneOf.4","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["currency","requestedUsd","remainingUsd","resetsAt","timezone"],"properties":{"currency":{"type":"string","const":"USD","isRequired":true,"uniqueKey":"details.oneOf.5.currency","typeLabel":"string"},"requestedUsd":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.5.requestedUsd","typeLabel":"string"},"remainingUsd":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.5.remainingUsd","typeLabel":"string"},"resetsAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"details.oneOf.5.resetsAt","typeLabel":"string\u003cdate-time>"},"timezone":{"type":"string","const":"UTC","isRequired":true,"uniqueKey":"details.oneOf.5.timezone","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"details.oneOf.5","typeLabel":"object"}],"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"error","code":"BAD_REQUEST","message":"Check the request fields and try again."},"examples":{"Example":{"title":"Example","value":{"status":"error","code":"BAD_REQUEST","message":"Check the request fields and try again."}}},"exampleType":"examples"}},"exampleType":"examples"},"9fd90791-2433-46ad-96e5-136b0f5379ae":{"description":"Authentication is missing, invalid or expired. Check your credentials and request signature.","content":{"application/json":{"schema":{"type":"object","required":["status","message","code"],"properties":{"status":{"type":"string","const":"error","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"oneOf":[{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["validationCode","reasonCode","retryable"],"properties":{"validationCode":{"type":"string","enum":["document_unreadable","document_type_mismatch","document_password_protected","document_limits_exceeded"],"isRequired":true,"uniqueKey":"details.oneOf.0.validationCode","typeLabel":"enum\u003cstring>"},"reasonCode":{"type":"string","enum":["document_unreadable","document_type_mismatch","document_password_protected","document_limits_exceeded"],"isRequired":true,"uniqueKey":"details.oneOf.0.reasonCode","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"details.oneOf.0.retryable","typeLabel":"boolean"},"documentId":{"type":"string","maxLength":128,"uniqueKey":"details.oneOf.0.documentId","typeLabel":"string"},"requirementType":{"type":"string","uniqueKey":"details.oneOf.0.requirementType","typeLabel":"string"},"maxSizeBytes":{"type":"integer","minimum":1,"maximum":1073741824,"description":"Maximum accepted file size in bytes, when supplied with HTTP 413.","uniqueKey":"details.oneOf.0.maxSizeBytes","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"details.oneOf.0","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["reason"],"properties":{"reason":{"type":"string","enum":["current_password_incorrect","unsupported_asset_network","recipient_unavailable","recipient_incompatible","payout_method_unavailable","payout_method_incompatible","network_unavailable","quote_expired","quote_already_used","quote_changed","invoice_required","invoice_invalid","amount_invalid","amount_precision_invalid","onboarding_revision_required","onboarding_revision_changed","onboarding_document_kind_mismatch"],"isRequired":true,"uniqueKey":"details.oneOf.1.reason","typeLabel":"enum\u003cstring>"},"precision":{"type":"integer","minimum":0,"maximum":18,"description":"Allowed number of decimal places when reason is amount_precision_invalid.","uniqueKey":"details.oneOf.1.precision","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"details.oneOf.1","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["period","sourceCurrency","requested","remaining","limit","resetsAt","timezone"],"properties":{"period":{"type":"string","enum":["daily","monthly"],"isRequired":true,"uniqueKey":"details.oneOf.2.period","typeLabel":"enum\u003cstring>"},"sourceCurrency":{"type":"string","pattern":"^[A-Z][A-Z0-9]{1,19}$","isRequired":true,"uniqueKey":"details.oneOf.2.sourceCurrency","typeLabel":"string"},"requested":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]+)?$","isRequired":true,"uniqueKey":"details.oneOf.2.requested","typeLabel":"string"},"remaining":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]+)?$","isRequired":true,"uniqueKey":"details.oneOf.2.remaining","typeLabel":"string"},"limit":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]+)?$","isRequired":true,"uniqueKey":"details.oneOf.2.limit","typeLabel":"string"},"resetsAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"details.oneOf.2.resetsAt","typeLabel":"string\u003cdate-time>"},"timezone":{"type":"string","const":"UTC","isRequired":true,"uniqueKey":"details.oneOf.2.timezone","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"details.oneOf.2","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["sourceCurrency","minimumAmount","maximumAmount"],"properties":{"sourceCurrency":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.3.sourceCurrency","typeLabel":"string"},"minimumAmount":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.3.minimumAmount","typeLabel":"string"},"maximumAmount":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.3.maximumAmount","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"details.oneOf.3","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["currency","requestedUsd","limitUsd"],"properties":{"currency":{"type":"string","const":"USD","isRequired":true,"uniqueKey":"details.oneOf.4.currency","typeLabel":"string"},"requestedUsd":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.4.requestedUsd","typeLabel":"string"},"limitUsd":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.4.limitUsd","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"details.oneOf.4","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["currency","requestedUsd","remainingUsd","resetsAt","timezone"],"properties":{"currency":{"type":"string","const":"USD","isRequired":true,"uniqueKey":"details.oneOf.5.currency","typeLabel":"string"},"requestedUsd":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.5.requestedUsd","typeLabel":"string"},"remainingUsd":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.5.remainingUsd","typeLabel":"string"},"resetsAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"details.oneOf.5.resetsAt","typeLabel":"string\u003cdate-time>"},"timezone":{"type":"string","const":"UTC","isRequired":true,"uniqueKey":"details.oneOf.5.timezone","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"details.oneOf.5","typeLabel":"object"}],"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"error","code":"UNAUTHORIZED","message":"Authentication is required."},"examples":{"Example":{"title":"Example","value":{"status":"error","code":"UNAUTHORIZED","message":"Authentication is required."}}},"exampleType":"examples"}},"exampleType":"examples"},"7985fd91-033f-4671-bad6-fbcb5a9f64b4":{"description":"Your account is inactive, the business selection is missing, or your credentials do not have the required permission.","content":{"application/json":{"schema":{"type":"object","required":["status","message","code"],"properties":{"status":{"type":"string","const":"error","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"oneOf":[{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["validationCode","reasonCode","retryable"],"properties":{"validationCode":{"type":"string","enum":["document_unreadable","document_type_mismatch","document_password_protected","document_limits_exceeded"],"isRequired":true,"uniqueKey":"details.oneOf.0.validationCode","typeLabel":"enum\u003cstring>"},"reasonCode":{"type":"string","enum":["document_unreadable","document_type_mismatch","document_password_protected","document_limits_exceeded"],"isRequired":true,"uniqueKey":"details.oneOf.0.reasonCode","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"details.oneOf.0.retryable","typeLabel":"boolean"},"documentId":{"type":"string","maxLength":128,"uniqueKey":"details.oneOf.0.documentId","typeLabel":"string"},"requirementType":{"type":"string","uniqueKey":"details.oneOf.0.requirementType","typeLabel":"string"},"maxSizeBytes":{"type":"integer","minimum":1,"maximum":1073741824,"description":"Maximum accepted file size in bytes, when supplied with HTTP 413.","uniqueKey":"details.oneOf.0.maxSizeBytes","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"details.oneOf.0","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["reason"],"properties":{"reason":{"type":"string","enum":["current_password_incorrect","unsupported_asset_network","recipient_unavailable","recipient_incompatible","payout_method_unavailable","payout_method_incompatible","network_unavailable","quote_expired","quote_already_used","quote_changed","invoice_required","invoice_invalid","amount_invalid","amount_precision_invalid","onboarding_revision_required","onboarding_revision_changed","onboarding_document_kind_mismatch"],"isRequired":true,"uniqueKey":"details.oneOf.1.reason","typeLabel":"enum\u003cstring>"},"precision":{"type":"integer","minimum":0,"maximum":18,"description":"Allowed number of decimal places when reason is amount_precision_invalid.","uniqueKey":"details.oneOf.1.precision","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"details.oneOf.1","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["period","sourceCurrency","requested","remaining","limit","resetsAt","timezone"],"properties":{"period":{"type":"string","enum":["daily","monthly"],"isRequired":true,"uniqueKey":"details.oneOf.2.period","typeLabel":"enum\u003cstring>"},"sourceCurrency":{"type":"string","pattern":"^[A-Z][A-Z0-9]{1,19}$","isRequired":true,"uniqueKey":"details.oneOf.2.sourceCurrency","typeLabel":"string"},"requested":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]+)?$","isRequired":true,"uniqueKey":"details.oneOf.2.requested","typeLabel":"string"},"remaining":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]+)?$","isRequired":true,"uniqueKey":"details.oneOf.2.remaining","typeLabel":"string"},"limit":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]+)?$","isRequired":true,"uniqueKey":"details.oneOf.2.limit","typeLabel":"string"},"resetsAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"details.oneOf.2.resetsAt","typeLabel":"string\u003cdate-time>"},"timezone":{"type":"string","const":"UTC","isRequired":true,"uniqueKey":"details.oneOf.2.timezone","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"details.oneOf.2","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["sourceCurrency","minimumAmount","maximumAmount"],"properties":{"sourceCurrency":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.3.sourceCurrency","typeLabel":"string"},"minimumAmount":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.3.minimumAmount","typeLabel":"string"},"maximumAmount":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.3.maximumAmount","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"details.oneOf.3","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["currency","requestedUsd","limitUsd"],"properties":{"currency":{"type":"string","const":"USD","isRequired":true,"uniqueKey":"details.oneOf.4.currency","typeLabel":"string"},"requestedUsd":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.4.requestedUsd","typeLabel":"string"},"limitUsd":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.4.limitUsd","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"details.oneOf.4","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["currency","requestedUsd","remainingUsd","resetsAt","timezone"],"properties":{"currency":{"type":"string","const":"USD","isRequired":true,"uniqueKey":"details.oneOf.5.currency","typeLabel":"string"},"requestedUsd":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.5.requestedUsd","typeLabel":"string"},"remainingUsd":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.5.remainingUsd","typeLabel":"string"},"resetsAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"details.oneOf.5.resetsAt","typeLabel":"string\u003cdate-time>"},"timezone":{"type":"string","const":"UTC","isRequired":true,"uniqueKey":"details.oneOf.5.timezone","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"details.oneOf.5","typeLabel":"object"}],"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"error","code":"FORBIDDEN","message":"You do not have permission to perform this action."},"examples":{"Example":{"title":"Example","value":{"status":"error","code":"FORBIDDEN","message":"You do not have permission to perform this action."}}},"exampleType":"examples"}},"exampleType":"examples"},"acdd842b-5586-49ea-9081-46361d2084da":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"type":"object","required":["status","message","code"],"properties":{"status":{"type":"string","const":"error","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"oneOf":[{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["validationCode","reasonCode","retryable"],"properties":{"validationCode":{"type":"string","enum":["document_unreadable","document_type_mismatch","document_password_protected","document_limits_exceeded"],"isRequired":true,"uniqueKey":"details.oneOf.0.validationCode","typeLabel":"enum\u003cstring>"},"reasonCode":{"type":"string","enum":["document_unreadable","document_type_mismatch","document_password_protected","document_limits_exceeded"],"isRequired":true,"uniqueKey":"details.oneOf.0.reasonCode","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"details.oneOf.0.retryable","typeLabel":"boolean"},"documentId":{"type":"string","maxLength":128,"uniqueKey":"details.oneOf.0.documentId","typeLabel":"string"},"requirementType":{"type":"string","uniqueKey":"details.oneOf.0.requirementType","typeLabel":"string"},"maxSizeBytes":{"type":"integer","minimum":1,"maximum":1073741824,"description":"Maximum accepted file size in bytes, when supplied with HTTP 413.","uniqueKey":"details.oneOf.0.maxSizeBytes","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"details.oneOf.0","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["reason"],"properties":{"reason":{"type":"string","enum":["current_password_incorrect","unsupported_asset_network","recipient_unavailable","recipient_incompatible","payout_method_unavailable","payout_method_incompatible","network_unavailable","quote_expired","quote_already_used","quote_changed","invoice_required","invoice_invalid","amount_invalid","amount_precision_invalid","onboarding_revision_required","onboarding_revision_changed","onboarding_document_kind_mismatch"],"isRequired":true,"uniqueKey":"details.oneOf.1.reason","typeLabel":"enum\u003cstring>"},"precision":{"type":"integer","minimum":0,"maximum":18,"description":"Allowed number of decimal places when reason is amount_precision_invalid.","uniqueKey":"details.oneOf.1.precision","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"details.oneOf.1","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["period","sourceCurrency","requested","remaining","limit","resetsAt","timezone"],"properties":{"period":{"type":"string","enum":["daily","monthly"],"isRequired":true,"uniqueKey":"details.oneOf.2.period","typeLabel":"enum\u003cstring>"},"sourceCurrency":{"type":"string","pattern":"^[A-Z][A-Z0-9]{1,19}$","isRequired":true,"uniqueKey":"details.oneOf.2.sourceCurrency","typeLabel":"string"},"requested":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]+)?$","isRequired":true,"uniqueKey":"details.oneOf.2.requested","typeLabel":"string"},"remaining":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]+)?$","isRequired":true,"uniqueKey":"details.oneOf.2.remaining","typeLabel":"string"},"limit":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]+)?$","isRequired":true,"uniqueKey":"details.oneOf.2.limit","typeLabel":"string"},"resetsAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"details.oneOf.2.resetsAt","typeLabel":"string\u003cdate-time>"},"timezone":{"type":"string","const":"UTC","isRequired":true,"uniqueKey":"details.oneOf.2.timezone","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"details.oneOf.2","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["sourceCurrency","minimumAmount","maximumAmount"],"properties":{"sourceCurrency":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.3.sourceCurrency","typeLabel":"string"},"minimumAmount":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.3.minimumAmount","typeLabel":"string"},"maximumAmount":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.3.maximumAmount","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"details.oneOf.3","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["currency","requestedUsd","limitUsd"],"properties":{"currency":{"type":"string","const":"USD","isRequired":true,"uniqueKey":"details.oneOf.4.currency","typeLabel":"string"},"requestedUsd":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.4.requestedUsd","typeLabel":"string"},"limitUsd":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.4.limitUsd","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"details.oneOf.4","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["currency","requestedUsd","remainingUsd","resetsAt","timezone"],"properties":{"currency":{"type":"string","const":"USD","isRequired":true,"uniqueKey":"details.oneOf.5.currency","typeLabel":"string"},"requestedUsd":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.5.requestedUsd","typeLabel":"string"},"remainingUsd":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.5.remainingUsd","typeLabel":"string"},"resetsAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"details.oneOf.5.resetsAt","typeLabel":"string\u003cdate-time>"},"timezone":{"type":"string","const":"UTC","isRequired":true,"uniqueKey":"details.oneOf.5.timezone","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"details.oneOf.5","typeLabel":"object"}],"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"error","code":"NOT_FOUND","message":"The requested resource was not found."},"examples":{"Example":{"title":"Example","value":{"status":"error","code":"NOT_FOUND","message":"The requested resource was not found."}}},"exampleType":"examples"}},"exampleType":"examples"},"1029dff5-cf9f-4795-81bc-5ec660dd5344":{"description":"The request conflicts with an existing resource or a newer saved version.","content":{"application/json":{"schema":{"type":"object","required":["status","message","code"],"properties":{"status":{"type":"string","const":"error","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"oneOf":[{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["validationCode","reasonCode","retryable"],"properties":{"validationCode":{"type":"string","enum":["document_unreadable","document_type_mismatch","document_password_protected","document_limits_exceeded"],"isRequired":true,"uniqueKey":"details.oneOf.0.validationCode","typeLabel":"enum\u003cstring>"},"reasonCode":{"type":"string","enum":["document_unreadable","document_type_mismatch","document_password_protected","document_limits_exceeded"],"isRequired":true,"uniqueKey":"details.oneOf.0.reasonCode","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"details.oneOf.0.retryable","typeLabel":"boolean"},"documentId":{"type":"string","maxLength":128,"uniqueKey":"details.oneOf.0.documentId","typeLabel":"string"},"requirementType":{"type":"string","uniqueKey":"details.oneOf.0.requirementType","typeLabel":"string"},"maxSizeBytes":{"type":"integer","minimum":1,"maximum":1073741824,"description":"Maximum accepted file size in bytes, when supplied with HTTP 413.","uniqueKey":"details.oneOf.0.maxSizeBytes","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"details.oneOf.0","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["reason"],"properties":{"reason":{"type":"string","enum":["current_password_incorrect","unsupported_asset_network","recipient_unavailable","recipient_incompatible","payout_method_unavailable","payout_method_incompatible","network_unavailable","quote_expired","quote_already_used","quote_changed","invoice_required","invoice_invalid","amount_invalid","amount_precision_invalid","onboarding_revision_required","onboarding_revision_changed","onboarding_document_kind_mismatch"],"isRequired":true,"uniqueKey":"details.oneOf.1.reason","typeLabel":"enum\u003cstring>"},"precision":{"type":"integer","minimum":0,"maximum":18,"description":"Allowed number of decimal places when reason is amount_precision_invalid.","uniqueKey":"details.oneOf.1.precision","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"details.oneOf.1","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["period","sourceCurrency","requested","remaining","limit","resetsAt","timezone"],"properties":{"period":{"type":"string","enum":["daily","monthly"],"isRequired":true,"uniqueKey":"details.oneOf.2.period","typeLabel":"enum\u003cstring>"},"sourceCurrency":{"type":"string","pattern":"^[A-Z][A-Z0-9]{1,19}$","isRequired":true,"uniqueKey":"details.oneOf.2.sourceCurrency","typeLabel":"string"},"requested":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]+)?$","isRequired":true,"uniqueKey":"details.oneOf.2.requested","typeLabel":"string"},"remaining":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]+)?$","isRequired":true,"uniqueKey":"details.oneOf.2.remaining","typeLabel":"string"},"limit":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]+)?$","isRequired":true,"uniqueKey":"details.oneOf.2.limit","typeLabel":"string"},"resetsAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"details.oneOf.2.resetsAt","typeLabel":"string\u003cdate-time>"},"timezone":{"type":"string","const":"UTC","isRequired":true,"uniqueKey":"details.oneOf.2.timezone","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"details.oneOf.2","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["sourceCurrency","minimumAmount","maximumAmount"],"properties":{"sourceCurrency":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.3.sourceCurrency","typeLabel":"string"},"minimumAmount":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.3.minimumAmount","typeLabel":"string"},"maximumAmount":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.3.maximumAmount","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"details.oneOf.3","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["currency","requestedUsd","limitUsd"],"properties":{"currency":{"type":"string","const":"USD","isRequired":true,"uniqueKey":"details.oneOf.4.currency","typeLabel":"string"},"requestedUsd":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.4.requestedUsd","typeLabel":"string"},"limitUsd":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.4.limitUsd","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"details.oneOf.4","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["currency","requestedUsd","remainingUsd","resetsAt","timezone"],"properties":{"currency":{"type":"string","const":"USD","isRequired":true,"uniqueKey":"details.oneOf.5.currency","typeLabel":"string"},"requestedUsd":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.5.requestedUsd","typeLabel":"string"},"remainingUsd":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.5.remainingUsd","typeLabel":"string"},"resetsAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"details.oneOf.5.resetsAt","typeLabel":"string\u003cdate-time>"},"timezone":{"type":"string","const":"UTC","isRequired":true,"uniqueKey":"details.oneOf.5.timezone","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"details.oneOf.5","typeLabel":"object"}],"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"error","code":"CONFLICT","message":"The request conflicts with the current state of this resource."},"examples":{"Example":{"title":"Example","value":{"status":"error","code":"CONFLICT","message":"The request conflicts with the current state of this resource."}}},"exampleType":"examples"}},"exampleType":"examples"},"a67d6576-ea3b-4f10-a417-f822dd11e1ce":{"description":"A request or operation allowance has been reached. Wait before retrying. If the endpoint uses an idempotency key, keep the same key for the retry.","headers":{"Retry-After":{"description":"The number of seconds to wait before retrying.","schema":{"type":"integer","minimum":1}},"Cache-Control":{"description":"Responses use private, no-store or no-store. Do not cache this response.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["status","message","code"],"properties":{"status":{"type":"string","const":"error","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"oneOf":[{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["validationCode","reasonCode","retryable"],"properties":{"validationCode":{"type":"string","enum":["document_unreadable","document_type_mismatch","document_password_protected","document_limits_exceeded"],"isRequired":true,"uniqueKey":"details.oneOf.0.validationCode","typeLabel":"enum\u003cstring>"},"reasonCode":{"type":"string","enum":["document_unreadable","document_type_mismatch","document_password_protected","document_limits_exceeded"],"isRequired":true,"uniqueKey":"details.oneOf.0.reasonCode","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"details.oneOf.0.retryable","typeLabel":"boolean"},"documentId":{"type":"string","maxLength":128,"uniqueKey":"details.oneOf.0.documentId","typeLabel":"string"},"requirementType":{"type":"string","uniqueKey":"details.oneOf.0.requirementType","typeLabel":"string"},"maxSizeBytes":{"type":"integer","minimum":1,"maximum":1073741824,"description":"Maximum accepted file size in bytes, when supplied with HTTP 413.","uniqueKey":"details.oneOf.0.maxSizeBytes","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"details.oneOf.0","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["reason"],"properties":{"reason":{"type":"string","enum":["current_password_incorrect","unsupported_asset_network","recipient_unavailable","recipient_incompatible","payout_method_unavailable","payout_method_incompatible","network_unavailable","quote_expired","quote_already_used","quote_changed","invoice_required","invoice_invalid","amount_invalid","amount_precision_invalid","onboarding_revision_required","onboarding_revision_changed","onboarding_document_kind_mismatch"],"isRequired":true,"uniqueKey":"details.oneOf.1.reason","typeLabel":"enum\u003cstring>"},"precision":{"type":"integer","minimum":0,"maximum":18,"description":"Allowed number of decimal places when reason is amount_precision_invalid.","uniqueKey":"details.oneOf.1.precision","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"details.oneOf.1","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["period","sourceCurrency","requested","remaining","limit","resetsAt","timezone"],"properties":{"period":{"type":"string","enum":["daily","monthly"],"isRequired":true,"uniqueKey":"details.oneOf.2.period","typeLabel":"enum\u003cstring>"},"sourceCurrency":{"type":"string","pattern":"^[A-Z][A-Z0-9]{1,19}$","isRequired":true,"uniqueKey":"details.oneOf.2.sourceCurrency","typeLabel":"string"},"requested":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]+)?$","isRequired":true,"uniqueKey":"details.oneOf.2.requested","typeLabel":"string"},"remaining":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]+)?$","isRequired":true,"uniqueKey":"details.oneOf.2.remaining","typeLabel":"string"},"limit":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]+)?$","isRequired":true,"uniqueKey":"details.oneOf.2.limit","typeLabel":"string"},"resetsAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"details.oneOf.2.resetsAt","typeLabel":"string\u003cdate-time>"},"timezone":{"type":"string","const":"UTC","isRequired":true,"uniqueKey":"details.oneOf.2.timezone","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"details.oneOf.2","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["sourceCurrency","minimumAmount","maximumAmount"],"properties":{"sourceCurrency":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.3.sourceCurrency","typeLabel":"string"},"minimumAmount":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.3.minimumAmount","typeLabel":"string"},"maximumAmount":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.3.maximumAmount","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"details.oneOf.3","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["currency","requestedUsd","limitUsd"],"properties":{"currency":{"type":"string","const":"USD","isRequired":true,"uniqueKey":"details.oneOf.4.currency","typeLabel":"string"},"requestedUsd":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.4.requestedUsd","typeLabel":"string"},"limitUsd":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.4.limitUsd","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"details.oneOf.4","typeLabel":"object"},{"type":"object","description":"Additional information to help resolve an error, such as a file problem, allowed amount range or remaining payment allowance. The fields depend on the error code.","required":["currency","requestedUsd","remainingUsd","resetsAt","timezone"],"properties":{"currency":{"type":"string","const":"USD","isRequired":true,"uniqueKey":"details.oneOf.5.currency","typeLabel":"string"},"requestedUsd":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.5.requestedUsd","typeLabel":"string"},"remainingUsd":{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.5.remainingUsd","typeLabel":"string"},"resetsAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"details.oneOf.5.resetsAt","typeLabel":"string\u003cdate-time>"},"timezone":{"type":"string","const":"UTC","isRequired":true,"uniqueKey":"details.oneOf.5.timezone","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"details.oneOf.5","typeLabel":"object"}],"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"error","code":"RATE_LIMITED","message":"Too many requests. Wait before trying again."},"examples":{"Example":{"title":"Example","value":{"status":"error","code":"RATE_LIMITED","message":"Too many requests. Wait before trying again."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"85fe4cc8-2b23-45fe-81d5-c33f89ce09ba":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A user access token from sign-in. Send Authorization: Bearer followed by the token. Use this only on endpoints that list BearerAuth.","scopes":[],"schemeName":"BearerAuth"}},"49793a6a-8bbd-45b6-b6b1-e48e398069f6":{"LedigApiKey":{"type":"apiKey","in":"header","name":"x-ledig-key","description":"Your business API key ID. Keep its secret on your server and use that secret to sign each request.","scopes":[],"schemeName":"LedigApiKey"},"LedigTimestamp":{"type":"apiKey","in":"header","name":"x-ledig-timestamp","description":"The current Unix timestamp in seconds, used in the signed request.","scopes":[],"schemeName":"LedigTimestamp"},"LedigSignature":{"type":"apiKey","in":"header","name":"x-ledig-signature","description":"The request's HMAC-SHA256 signature. Use the v1= prefix for supported own-business requests, or v2= when acting for a managed business with signed business-selection headers. Follow the authentication guide to construct and sign the exact request.","scopes":[],"schemeName":"LedigSignature"}}},"servers":{"c1543be6-0781-4dcb-bc86-b1b22b949bd2":{"url":"https://api-sandbox.ledig.io","description":"Sandbox"},"e6ca68e6-66bd-44af-bc94-74b08e2d343a":{"url":"https://api.ledig.io","description":"Live"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A user access token from sign-in. Send Authorization: Bearer followed by the token. Use this only on endpoints that list BearerAuth.","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A user access token from sign-in. Send Authorization: Bearer followed by the token. Use this only on endpoints that list BearerAuth.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-ledig-key","description":"Your business API key ID. Keep its secret on your server and use that secret to sign each request.","scopes":[],"schemeName":"LedigApiKey"},"schema":{"title":"x-ledig-key","type":"string","description":"Your business API key ID. Keep its secret on your server and use that secret to sign each request.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"LedigApiKey","name":"x-ledig-key"},{"scheme":{"type":"apiKey","in":"header","name":"x-ledig-timestamp","description":"The current Unix timestamp in seconds, used in the signed request.","scopes":[],"schemeName":"LedigTimestamp"},"schema":{"title":"x-ledig-timestamp","type":"string","description":"The current Unix timestamp in seconds, used in the signed request.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"LedigTimestamp","name":"x-ledig-timestamp"},{"scheme":{"type":"apiKey","in":"header","name":"x-ledig-signature","description":"The request's HMAC-SHA256 signature. Use the v1= prefix for supported own-business requests, or v2= when acting for a managed business with signed business-selection headers. Follow the authentication guide to construct and sign the exact request.","scopes":[],"schemeName":"LedigSignature"},"schema":{"title":"x-ledig-signature","type":"string","description":"The request's HMAC-SHA256 signature. Use the v1= prefix for supported own-business requests, or v2= when acting for a managed business with signed business-selection headers. Follow the authentication guide to construct and sign the exact request.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"LedigSignature","name":"x-ledig-signature"}],"title":"LedigApiKey \u0026 LedigTimestamp \u0026 LedigSignature"}]},"originalFileLocation":"openapi/public.yaml"},"subdomain":"ledig","siteName":"Ledig Payments","title":"Add an owner or related person - Ledig Payments","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-15T18:48:55.924Z","originalFileLocation":"api-reference/managed-businesses/add-an-owner-or-related-person.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Add a person or organisation required by a business application.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ledig Payments\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ledig/ct3LOdcBUcKida3q/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/ledig/ct3LOdcBUcKida3q/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ledig/ct3LOdcBUcKida3q/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ledig/ct3LOdcBUcKida3q/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ledig/ct3LOdcBUcKida3q/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ledig/ct3LOdcBUcKida3q/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ledig/ct3LOdcBUcKida3q/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ledig/ct3LOdcBUcKida3q/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ledig/ct3LOdcBUcKida3q/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Add an owner or related person - Ledig Payments\">\u003cmeta data-mint-head property=\"og:description\" content=\"Add a person or organisation required by a business application.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ledig Payments\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://ledig.mintlify.app/api-reference/managed-businesses/add-an-owner-or-related-person\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ledig.mintlify.site/_mintlify/api/og/v2?division=Managed+businesses\u0026amp;title=Add+an+owner+or+related+person\u0026amp;description=Add+a+person+or+organisation+required+by+a+business+application.\u0026amp;theme=b3996c354e84ea128c07e7b6\u0026amp;signature=8a0fef491b58d563d8bc6b3ea445531db56a083cd8cd0f2c1a7cb1d9c957b477\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Add an owner or related person - Ledig Payments\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Add a person or organisation required by a business application.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ledig.mintlify.site/_mintlify/api/og/v2?division=Managed+businesses\u0026amp;title=Add+an+owner+or+related+person\u0026amp;description=Add+a+person+or+organisation+required+by+a+business+application.\u0026amp;theme=b3996c354e84ea128c07e7b6\u0026amp;signature=8a0fef491b58d563d8bc6b3ea445531db56a083cd8cd0f2c1a7cb1d9c957b477\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/ledig/ct3LOdcBUcKida3q/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ledig Payments\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4361EE\">\u003clink data-mint-head rel=\"canonical\" href=\"https://ledig.mintlify.app/api-reference/managed-businesses/add-an-owner-or-related-person\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/managed-businesses/add-an-owner-or-related-person.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://ledig.mintlify.app/#organization\",\"name\":\"Ledig Payments\",\"url\":\"https://ledig.mintlify.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ledig/kOFkh89JDbhYVCSA/logo/light.svg?fit=max\u0026auto=format\u0026n=kOFkh89JDbhYVCSA\u0026q=85\u0026s=36e926371f686474be67796eb9056852\"}},{\"@type\":\"WebSite\",\"@id\":\"https://ledig.mintlify.app#website\",\"name\":\"Ledig Payments\",\"url\":\"https://ledig.mintlify.app\",\"publisher\":{\"@id\":\"https://ledig.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://ledig.mintlify.app/api-reference/managed-businesses/add-an-owner-or-related-person#webpage\",\"url\":\"https://ledig.mintlify.app/api-reference/managed-businesses/add-an-owner-or-related-person\",\"name\":\"Add an owner or related person\",\"description\":\"Add a person or organisation required by a business application.\",\"dateModified\":\"2026-11-15T18:48:55.924Z\",\"isPartOf\":{\"@id\":\"https://ledig.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://ledig.mintlify.app/api-reference/managed-businesses/add-an-owner-or-related-person#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://ledig.mintlify.app/api-reference/managed-businesses/add-an-owner-or-related-person#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Managed businesses\",\"item\":\"https://ledig.mintlify.app/api-reference/managed-businesses/list-your-managed-businesses\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Add an owner or related person\",\"item\":\"https://ledig.mintlify.app/api-reference/managed-businesses/add-an-owner-or-related-person\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://ledig.mintlify.app/api-reference/managed-businesses/add-an-owner-or-related-person#apireference\",\"headline\":\"Add an owner or related person\",\"name\":\"Add an owner or related person\",\"description\":\"Add a person or organisation required by a business application.\",\"url\":\"https://ledig.mintlify.app/api-reference/managed-businesses/add-an-owner-or-related-person\",\"mainEntityOfPage\":{\"@id\":\"https://ledig.mintlify.app/api-reference/managed-businesses/add-an-owner-or-related-person#webpage\"},\"dateModified\":\"2026-11-15T18:48:55.924Z\",\"publisher\":{\"@id\":\"https://ledig.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://ledig.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ledig Payments\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Ledig Payments\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/managed-businesses/add-an-owner-or-related-person.md","siteName":"Ledig Payments","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API reference","href":"/api-reference/introduction"}]},{"group":"Currencies and rates","pages":[{"title":"List supported currencies","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/currencies","href":"/api-reference/currencies-and-rates/list-supported-currencies"},{"title":"View indicative exchange rates","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/rates","href":"/api-reference/currencies-and-rates/view-indicative-exchange-rates"},{"title":"List conversions and limits","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/liquidity/routes","href":"/api-reference/currencies-and-rates/list-conversions-and-limits"}]},{"group":"Balances","pages":[{"title":"View your balances","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/balances","href":"/api-reference/balances/view-your-balances"},{"title":"View your USD balance estimate and payout allowance","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/balances/summary","href":"/api-reference/balances/view-your-usd-balance-estimate-and-payout-allowance"},{"title":"View a currency balance","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/balances/{currency}","href":"/api-reference/balances/view-a-currency-balance"}]},{"group":"Funding accounts","pages":[{"title":"View a receiving account","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/virtual-accounts/{currency}","href":"/api-reference/funding-accounts/view-a-receiving-account"},{"title":"Request a receiving account","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/virtual-accounts","href":"/api-reference/funding-accounts/request-a-receiving-account"}]},{"group":"Deposit wallets","pages":[{"title":"List deposit networks and assets","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/wallets/options","href":"/api-reference/deposit-wallets/list-deposit-networks-and-assets"},{"title":"Create a network deposit address","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/wallets/network","href":"/api-reference/deposit-wallets/create-a-network-deposit-address"},{"title":"Check deposit address setup","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/wallets/network/{requestId}","href":"/api-reference/deposit-wallets/check-deposit-address-setup"},{"title":"List your deposit addresses","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/wallets","href":"/api-reference/deposit-wallets/list-your-deposit-addresses"},{"title":"Create a crypto deposit address","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/wallets","href":"/api-reference/deposit-wallets/create-a-crypto-deposit-address"},{"title":"View a deposit address","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/wallets/{id}","href":"/api-reference/deposit-wallets/view-a-deposit-address"}]},{"group":"Recipients","pages":[{"title":"List crypto recipient networks","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/recipient-requirements/crypto-networks","href":"/api-reference/recipients/list-crypto-recipient-networks"},{"title":"List your recipients","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/recipients","href":"/api-reference/recipients/list-your-recipients"},{"title":"Add a payment recipient","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/recipients","href":"/api-reference/recipients/add-a-payment-recipient"},{"title":"View a recipient","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/recipients/{id}","href":"/api-reference/recipients/view-a-recipient"},{"title":"Remove a recipient","deprecated":null,"version":null,"openapi":"/openapi/public.yaml delete /v1/recipients/{id}","href":"/api-reference/recipients/remove-a-recipient"}]},{"group":"Ledig businesses","pages":[{"title":"Find a Ledig business","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/ledig-businesses/{businessId}","href":"/api-reference/ledig-businesses/find-a-ledig-business"}]},{"group":"Payment options","pages":[{"title":"List payment methods","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/quotes/payment-options","href":"/api-reference/payment-options/list-payment-methods"},{"title":"List payout fees and limits","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/payouts/catalogue","href":"/api-reference/payment-options/list-payout-fees-and-limits"},{"title":"Estimate a payout fee","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/payouts/fee-estimate","href":"/api-reference/payment-options/estimate-a-payout-fee"},{"title":"View your payout fee schedule","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/quotes/payout-fees","href":"/api-reference/quotes/view-your-payout-fee-schedule"}]},{"group":"Quotes","pages":[{"title":"List your quotes","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/quotes","href":"/api-reference/quotes/list-your-quotes"},{"title":"Create a conversion or payment quote","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/quotes","href":"/api-reference/quotes/create-a-conversion-or-payment-quote"},{"title":"View a quote","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/quotes/{id}","href":"/api-reference/quotes/view-a-quote"}]},{"group":"Transfers","pages":[{"title":"Confirm a quote","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/transfers","href":"/api-reference/transfers/confirm-a-quote"},{"title":"Check a transfer","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/transfers/{id}","href":"/api-reference/transfers/check-a-transfer"}]},{"group":"Transactions","pages":[{"title":"View your transaction history","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/transactions","href":"/api-reference/transactions/view-your-transaction-history"},{"title":"View a transaction","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/transactions/{id}","href":"/api-reference/transactions/view-a-transaction"}]},{"group":"Managed businesses","pages":[{"title":"List your managed businesses","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/managed-businesses","href":"/api-reference/managed-businesses/list-your-managed-businesses"},{"title":"Start a business application","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/managed-businesses/applications","href":"/api-reference/managed-businesses/start-a-business-application"},{"title":"View a business application","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/managed-businesses/{businessId}/onboarding","href":"/api-reference/managed-businesses/view-a-business-application"},{"title":"List application sections","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/managed-businesses/{businessId}/onboarding/sections","href":"/api-reference/managed-businesses/list-application-sections"},{"title":"View an application section","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/managed-businesses/{businessId}/onboarding/{section}","href":"/api-reference/managed-businesses/view-an-application-section"},{"title":"Save an application section","deprecated":null,"version":null,"openapi":"/openapi/public.yaml put /v1/managed-businesses/{businessId}/onboarding/{section}","href":"/api-reference/managed-businesses/save-an-application-section"},{"title":"Complete an application section","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/managed-businesses/{businessId}/onboarding/{section}/complete","href":"/api-reference/managed-businesses/complete-an-application-section"},{"title":"List application answer options","description":"Get the available choices for an application section.","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/managed-businesses/{businessId}/onboarding/{section}/options","href":"/api-reference/managed-businesses/list-application-answer-options"},{"title":"Add an owner or related person","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/managed-businesses/{businessId}/onboarding/owners","href":"/api-reference/managed-businesses/add-an-owner-or-related-person"},{"title":"Remove an owner or related person","description":"Remove a person or organisation from a business application.","deprecated":null,"version":null,"openapi":"/openapi/public.yaml delete /v1/managed-businesses/{businessId}/onboarding/owners/{ownerId}","href":"/api-reference/managed-businesses/remove-an-owner-or-related-person"},{"title":"Start an owner's identity check","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/managed-businesses/{businessId}/onboarding/owners/{ownerId}/verification","href":"/api-reference/managed-businesses/start-an-owners-identity-check"},{"title":"Prepare a document upload","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/managed-businesses/{businessId}/onboarding/documents","href":"/api-reference/managed-businesses/prepare-a-document-upload"},{"title":"Complete a document upload","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/managed-businesses/{businessId}/onboarding/documents/{documentId}/complete","href":"/api-reference/managed-businesses/complete-a-document-upload"},{"title":"Submit a business application","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/managed-businesses/{businessId}/onboarding/submit","href":"/api-reference/managed-businesses/submit-a-business-application"},{"title":"Check an onboarding link","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/managed-businesses/{businessId}/onboarding/share","href":"/api-reference/managed-businesses/check-an-onboarding-link"},{"title":"Create an onboarding link","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/managed-businesses/{businessId}/onboarding/share","href":"/api-reference/managed-businesses/create-an-onboarding-link"},{"title":"Revoke an onboarding link","deprecated":null,"version":null,"openapi":"/openapi/public.yaml delete /v1/managed-businesses/{businessId}/onboarding/share/{sessionId}","href":"/api-reference/managed-businesses/revoke-an-onboarding-link"}]},{"group":"System","pages":[{"title":"Check API availability","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/health","href":"/api-reference/system/check-api-availability"}]}]}]},"basePath":"","title":"Add an owner or related person - Ledig Payments","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}