{
"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."
}
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. The application must still be editable. Anyone with the link can edit and submit this application, including its documents, without creating an account. The link does not give access to balances, payments or the dashboard and expires after seven days. To replace an active link, first read its status and send replaceSessionId. A missing or outdated replacement ID returns 409. Replacing the link also ends access through the old link. The URL is returned once and is not emailed automatically. Share it only with the intended applicant; do not store it in logs.
A user access token from sign-in. Send Authorization: Bearer followed by the token. Use this only on endpoints that list BearerAuth.
Headers
X-Ledig-Business-Id
string
The business you are acting for. For a managed business, your institution must be authorised to act for it and API-key requests must use HMAC v2. Set this header explicitly; a business ID in the body does not select the business.
Minimum string length: 1
X-Ledig-Acting-Business-Id
string
Your institution's business ID when acting for a managed business. It must match your API key's owner or an institution you belong to. HMAC v2 signs the trimmed value, or an empty string when omitted.
Minimum string length: 1
Path Parameters
businessId
string
required
Body
application/json
replaceSessionId
string<uuid>
Response
One-time disclosure of the sharing URL.
status
string
required
Allowed value: "success"
data
object
required
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/create-an-onboarding-link","slug":"/api-reference/managed-businesses/create-an-onboarding-link","pageMetadata":{"title":"Create an onboarding link","description":"Let someone complete a managed business application through a secure 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","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: \"Let someone complete a managed business application through a secure link.\"\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. The application must still be editable. Anyone with the link can edit and submit this application, including its documents, without creating an account. The link does not give access to balances, payments or the dashboard and expires after seven days. To replace an active link, first read its status and send replaceSessionId. A missing or outdated replacement ID returns 409. Replacing the link also ends access through the old link. The URL is returned once and is not emailed automatically. Share it only with the intended applicant; do not store it in logs.`})]})}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":"Create an onboarding link","description":"Let someone complete a managed business application through a secure 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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Managed businesses"],"operationId":"createManagedOnboardingShare","summary":"Create an onboarding link","description":"Let someone complete a managed business application through a secure link.","security":["89a3b0f6-8b7b-4e41-8189-0c8c4c14421a","8537f0cf-71b0-468b-bdeb-f87e7154161a"],"requestBody":"2ee8d0ad-250f-49f1-83b2-94ebe2f10021","responses":{"201":"5e8fa7cd-0c7d-4d57-a97c-0069030ab015","401":"b5563dd8-8a2d-42c6-bffe-e4f471f4ff9b","403":"d5a03611-c5ac-4d77-bb91-2af100cd0ed0","404":"f6c84f62-2c8c-49e5-9716-8c36644b3020","409":"f7ce1c59-a109-4561-9357-a7b8349a02a5"},"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. The application must still be editable. Anyone with the link can edit and submit this application, including its documents, without creating an account. The link does not give access to balances, payments or the dashboard and expires after seven days. To replace an active link, first read its status and send replaceSessionId. A missing or outdated replacement ID returns 409. Replacing the link also ends access through the old link. The URL is returned once and is not emailed automatically. Share it only with the intended applicant; do not store it in logs."},"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/share`;\nconst pathWithQuery = path;\nconst body = {};\nconst rawBody = JSON.stringify(body);\nconst headers = { \"Accept\": \"application/json\" };\nheaders[\"Content-Type\"] = \"application/json\";\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/share","baseUrlOptions":["https://api-sandbox.ledig.io","https://api.ledig.io"],"title":"Create an onboarding link","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/share`;\nconst pathWithQuery = path;\nconst body = {};\nconst rawBody = JSON.stringify(body);\nconst headers = { \"Accept\": \"application/json\" };\nheaders[\"Content-Type\"] = \"application/json\";\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":{"6cc6227b-1220-4a89-95fc-d5e01962c9c2":{"in":"path","name":"businessId","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"example":"business_example_001"},"43d3b65a-6e61-46a5-b683-78b1074f3a7b":{"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"},"2f0d6a50-8048-4dc4-84c0-d4934f100f1d":{"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":false,"properties":{"replaceSessionId":{"type":"string","format":"uuid","uniqueKey":"replaceSessionId","typeLabel":"string\u003cuuid>"}},"uniqueKey":"","typeLabel":"object"},"example":{},"examples":{"Example":{"title":"Example","value":{}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"5e8fa7cd-0c7d-4d57-a97c-0069030ab015":{"description":"One-time disclosure of the sharing URL.","headers":{"Cache-Control":{"schema":{"type":"string"},"description":"private, no-store"},"Referrer-Policy":{"schema":{"type":"string"},"description":"no-referrer"}},"content":{"application/json":{"schema":{"type":"object","required":["data","status"],"properties":{"status":{"type":"string","const":"success","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"data":{"type":"object","required":["sessionId","expiresAt","url"],"properties":{"sessionId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.sessionId","typeLabel":"string\u003cuuid>"},"expiresAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.expiresAt","typeLabel":"string\u003cdate-time>"},"url":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"data.url","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"success","data":{"sessionId":"22222222-2222-4222-8222-222222222222","expiresAt":"2026-01-15T10:05:00.000Z","url":"https://example.com/onboarding/example-link-not-valid"}},"examples":{"Example":{"title":"Example","value":{"status":"success","data":{"sessionId":"22222222-2222-4222-8222-222222222222","expiresAt":"2026-01-15T10:05:00.000Z","url":"https://example.com/onboarding/example-link-not-valid"}}}},"exampleType":"examples"}},"exampleType":"examples"},"b5563dd8-8a2d-42c6-bffe-e4f471f4ff9b":{"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"},"d5a03611-c5ac-4d77-bb91-2af100cd0ed0":{"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"},"f6c84f62-2c8c-49e5-9716-8c36644b3020":{"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"},"f7ce1c59-a109-4561-9357-a7b8349a02a5":{"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"}},"security":{"89a3b0f6-8b7b-4e41-8189-0c8c4c14421a":{"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"}},"8537f0cf-71b0-468b-bdeb-f87e7154161a":{"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":"Create an onboarding link - Ledig Payments","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-15T18:48:56.028Z","originalFileLocation":"api-reference/managed-businesses/create-an-onboarding-link.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=\"Let someone complete a managed business application through a secure link.\">\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=\"Create an onboarding link - Ledig Payments\">\u003cmeta data-mint-head property=\"og:description\" content=\"Let someone complete a managed business application through a secure link.\">\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/create-an-onboarding-link\">\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=Create+an+onboarding+link\u0026amp;description=Let+someone+complete+a+managed+business+application+through+a+secure+link.\u0026amp;theme=b3996c354e84ea128c07e7b6\u0026amp;signature=e7d73b102aa52dcd444acb7ee3bb5a5b044374d7d74f85b961f8198e6db16f0d\">\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=\"Create an onboarding link - Ledig Payments\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Let someone complete a managed business application through a secure link.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ledig.mintlify.site/_mintlify/api/og/v2?division=Managed+businesses\u0026amp;title=Create+an+onboarding+link\u0026amp;description=Let+someone+complete+a+managed+business+application+through+a+secure+link.\u0026amp;theme=b3996c354e84ea128c07e7b6\u0026amp;signature=e7d73b102aa52dcd444acb7ee3bb5a5b044374d7d74f85b961f8198e6db16f0d\">\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/create-an-onboarding-link\">\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/create-an-onboarding-link.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/create-an-onboarding-link#webpage\",\"url\":\"https://ledig.mintlify.app/api-reference/managed-businesses/create-an-onboarding-link\",\"name\":\"Create an onboarding link\",\"description\":\"Let someone complete a managed business application through a secure link.\",\"dateModified\":\"2026-11-15T18:48:56.028Z\",\"isPartOf\":{\"@id\":\"https://ledig.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://ledig.mintlify.app/api-reference/managed-businesses/create-an-onboarding-link#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://ledig.mintlify.app/api-reference/managed-businesses/create-an-onboarding-link#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\":\"Create an onboarding link\",\"item\":\"https://ledig.mintlify.app/api-reference/managed-businesses/create-an-onboarding-link\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://ledig.mintlify.app/api-reference/managed-businesses/create-an-onboarding-link#apireference\",\"headline\":\"Create an onboarding link\",\"name\":\"Create an onboarding link\",\"description\":\"Let someone complete a managed business application through a secure link.\",\"url\":\"https://ledig.mintlify.app/api-reference/managed-businesses/create-an-onboarding-link\",\"mainEntityOfPage\":{\"@id\":\"https://ledig.mintlify.app/api-reference/managed-businesses/create-an-onboarding-link#webpage\"},\"dateModified\":\"2026-11-15T18:48:56.028Z\",\"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/create-an-onboarding-link.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","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","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","description":"Check whether a managed business has an active 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","description":"Stop access through an onboarding link and any sessions opened from it.","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":"Create an onboarding link - 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"]}