You have already added user with this address, see org: b45a5a15-3e4b-4e92-9167-635dd7e95252
Deprecated
Generate onboarding URL
deprecated
Generates a presigned URL for customer onboarding. If the customer does not exist, it
will be created. You generate a UUID for customerId and bankAccountId, and Etherfuse creates the
customer and bank account records associated with your organization.
Deprecated. Sunset August 16, 2026. Customer onboarding has consolidated onto a
single hosted flow: create the customer’s personal organization with
POST /ramp/organization, then launch them into /idv, which runs identity
verification and agreement signing in one step. See
Customer Onboarding (KYC). Migrate before the sunset date.
Upon visiting the URL, the customer has 15 minutes to complete onboarding (KYC
verification and bank account linking).
Personal organizations only
This endpoint always creates a personal organization; it forces individual KYC.
There is no accountType field; pass business orgs through
POST /ramp/organization instead.
userInfo
Pass userInfo with the end user’s email and display name. When provided, Etherfuse
pre-creates the user record so the customer’s eventual sign-in attaches to the right
user and we can email them on status changes (KYC approved/rejected, bank account
verified, etc.). userInfo is required, and neither email nor displayName may be blank. The
email is required for the customer’s verification record and status notifications. A
customer created without an email address cannot start KYC.
Authenticating as the customer
If the customer signs in with a JWT (see JWT User Authentication), use the same value for customerId as the JWT sub. The shared id links the customer record to the user who signs in.
You have already added user with this address, see org: b45a5a15-3e4b-4e92-9167-635dd7e95252
Authorizations
Authorization
string
header
required
API key sent in the Authorization header.
Body
application/json
bankAccountId
string<uuid>
required
blockchain
enum<string>
required
Canonical blockchain enum for API serialization.
Use this type for JSON APIs and WebSocket messages.
For database storage, convert to BlockchainType.
Available options:
stellar,
solana,
base,
polygon,
monad,
avalanche
customerId
string<uuid>
required
publicKey
string
required
userInfo
object
required
Info about the end user. Both fields are required and neither may be
blank. email is required for the verification record and status
notifications. A customer created without an email address cannot start
KYC. displayName is how the customer is addressed in notices.
Show child attributes
uiOverride
string | null
Response
A presigned onboarding URL
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Etherfuse API","colors":{"primary":"#141414","light":"#E4FF3F","dark":"#141414"},"logo":{"light":"https://mintcdn.com/etherfuse/XRSchVFGUgreQatD/img/logo-black.svg?fit=max\u0026auto=format\u0026n=XRSchVFGUgreQatD\u0026q=85\u0026s=92cf84eca27df4a19f7b032da398d110","dark":"https://mintcdn.com/etherfuse/XRSchVFGUgreQatD/img/logo-white.svg?fit=max\u0026auto=format\u0026n=XRSchVFGUgreQatD\u0026q=85\u0026s=7c87780c9a248347ffe6357ccf6762ed","href":"https://etherfuse.com"},"favicon":"https://mintcdn.com/etherfuse/pF4txuzXWQE790kS/img/favicon.png?fit=max\u0026auto=format\u0026n=pF4txuzXWQE790kS\u0026q=85\u0026s=ac74be5f7f4605e75bc961be0c6e5ff9","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python"],"autogenerate":true}},"navbar":{"links":[{"href":"https://cal.com/team/etherfuse/api-overview?overlayCalendar=true","label":"Book a demo"},{"href":"https://app.etherfuse.com","label":"App"}],"primary":{"type":"button","label":"Get sandbox keys","href":"https://sandbox.etherfuse.com/sign-in?returnTo=%2Faccount%2Fmanage"}},"footer":{"links":[{"items":[{"label":"Website","href":"https://etherfuse.com"},{"label":"App","href":"https://app.etherfuse.com"},{"label":"Book a demo","href":"https://cal.com/team/etherfuse/api-overview?overlayCalendar=true"}]}]},"fonts":{"family":"Figtree"},"integrations":{"posthog":{"apiKey":"phc_vJEpZk4aZr9PxdPqapjg8ZKWFybTTmDvAxZNg88LTuPu","apiHost":"https://us.i.posthog.com"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"etherfuse","hasAudioNarration":false,"actualSubdomain":"etherfuse","customDomains":["docs.etherfuse.com"],"gitSource":{"type":"github","owner":"etherfuse","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af90d2e546ce7e92eacd6dc","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API Reference","count":153},{"language":"default","tag":"Ramp API","count":72},{"language":"default","tag":"Guides","count":65},{"language":"default","tag":"KYC","count":20},{"language":"default","tag":"Lookup API","count":19},{"language":"default","tag":"Orders","count":17},{"language":"default","tag":"Organizations","count":17},{"language":"default","tag":"User Authentication","count":12},{"language":"default","tag":"Blockchains","count":12},{"language":"default","tag":"Integration Guides","count":12}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"global.css","content":"body{scrollbar-gutter:stable}.sandbox-playground-cta{display:block;margin:1rem 0 1.25rem;padding:1rem 1.25rem;border-radius:0.75rem;border:1px solid #141414;background-color:#e4ff3f;color:#141414!important;text-decoration:none;transition:background-color 0.15s ease, box-shadow 0.15s ease}.sandbox-playground-cta:hover{background-color:#d8f32f;box-shadow:0 2px 8px rgba(20, 20, 20, 0.12);color:#141414!important}.sandbox-playground-cta__title,.sandbox-playground-cta__body,.sandbox-playground-cta__detail{color:inherit!important}.dark .sandbox-playground-cta{border-color:#e4ff3f;background-color:#e4ff3f;color:#141414!important}.dark .sandbox-playground-cta:hover{background-color:#d8f32f;color:#141414!important}.sandbox-playground-cta__title{display:block;font-size:1rem;font-weight:600;margin-bottom:0.35rem}.sandbox-playground-cta__body{display:block;font-size:0.95rem;line-height:1.45;font-weight:500}.sandbox-playground-cta__detail{display:block;margin-top:0.35rem;font-size:0.85rem;line-height:1.45;opacity:0.85}"}],"page":{"pagePath":"api-reference/deprecated/generate-onboarding-url","slug":"/api-reference/deprecated/generate-onboarding-url","pageMetadata":{"title":"Generate onboarding URL","description":"Generates a presigned URL for customer onboarding. If the customer does not exist, it\nwill be created. You generate a UUID for `customerId` and `bankAccountId`, and Etherfuse creates the\ncustomer and bank account records associated with your organization.\n\n\u003cWarning>\n**Deprecated. Sunset August 16, 2026.** Customer onboarding has consolidated onto a\nsingle hosted flow: create the customer's `personal` organization with\n`POST /ramp/organization`, then launch them into `/idv`, which runs identity\nverification **and** agreement signing in one step. See\n[Customer Onboarding (KYC)](/guides/onboarding). Migrate before the sunset date.\n\u003c/Warning>\n\nUpon visiting the URL, the customer has 15 minutes to complete onboarding (KYC\nverification and bank account linking).\n\n## Personal organizations only\n\nThis endpoint always creates a **personal** organization; it forces individual KYC.\nThere is no `accountType` field; pass `business` orgs through\n`POST /ramp/organization` instead.\n\n## userInfo\n\nPass `userInfo` with the end user's email and display name. When provided, Etherfuse\npre-creates the user record so the customer's eventual sign-in attaches to the right\nuser and we can email them on status changes (KYC approved/rejected, bank account\nverified, etc.). `userInfo` is **required**, and neither `email` nor `displayName` may be blank. The\nemail is required for the customer's verification record and status notifications. A\ncustomer created without an email address cannot start KYC.\n\n## Authenticating as the customer\n\nIf the customer signs in with a JWT (see [JWT User Authentication](/guides/jwt-authentication)), use the **same** value for `customerId` as the JWT `sub`. The shared id links the customer record to the user who signs in.","deprecated":true,"version":null,"openapi":"/openapi.json post /ramp/onboarding-url","href":"/api-reference/deprecated/generate-onboarding-url","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n h2: \"h2\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n }, {Warning} = _components;\n if (!Warning) _missingMdxReference(\"Warning\", true);\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Generates a presigned URL for customer onboarding. If the customer does not exist, it\\nwill be created. You generate a UUID for \", _jsx(_components.code, {\n children: \"customerId\"\n }), \" and \", _jsx(_components.code, {\n children: \"bankAccountId\"\n }), \", and Etherfuse creates the\\ncustomer and bank account records associated with your organization.\"]\n }), \"\\n\", _jsx(Warning, {\n children: _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Deprecated. Sunset August 16, 2026.\"\n }), \" Customer onboarding has consolidated onto a\\nsingle hosted flow: create the customer’s \", _jsx(_components.code, {\n children: \"personal\"\n }), \" organization with\\n\", _jsx(_components.code, {\n children: \"POST /ramp/organization\"\n }), \", then launch them into \", _jsx(_components.code, {\n children: \"/idv\"\n }), \", which runs identity\\nverification \", _jsx(_components.strong, {\n children: \"and\"\n }), \" agreement signing in one step. See\\n\", _jsx(_components.a, {\n href: \"/guides/onboarding\",\n children: \"Customer Onboarding (KYC)\"\n }), \". Migrate before the sunset date.\"]\n })\n }), \"\\n\", _jsx(_components.p, {\n children: \"Upon visiting the URL, the customer has 15 minutes to complete onboarding (KYC\\nverification and bank account linking).\"\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Personal organizations only\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"This endpoint always creates a \", _jsx(_components.strong, {\n children: \"personal\"\n }), \" organization; it forces individual KYC.\\nThere is no \", _jsx(_components.code, {\n children: \"accountType\"\n }), \" field; pass \", _jsx(_components.code, {\n children: \"business\"\n }), \" orgs through\\n\", _jsx(_components.code, {\n children: \"POST /ramp/organization\"\n }), \" instead.\"]\n }), \"\\n\", _jsx(_components.h2, {\n children: \"userInfo\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Pass \", _jsx(_components.code, {\n children: \"userInfo\"\n }), \" with the end user’s email and display name. When provided, Etherfuse\\npre-creates the user record so the customer’s eventual sign-in attaches to the right\\nuser and we can email them on status changes (KYC approved/rejected, bank account\\nverified, etc.). \", _jsx(_components.code, {\n children: \"userInfo\"\n }), \" is \", _jsx(_components.strong, {\n children: \"required\"\n }), \", and neither \", _jsx(_components.code, {\n children: \"email\"\n }), \" nor \", _jsx(_components.code, {\n children: \"displayName\"\n }), \" may be blank. The\\nemail is required for the customer’s verification record and status notifications. A\\ncustomer created without an email address cannot start KYC.\"]\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Authenticating as the customer\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"If the customer signs in with a JWT (see \", _jsx(_components.a, {\n href: \"/guides/jwt-authentication\",\n children: \"JWT User Authentication\"\n }), \"), use the \", _jsx(_components.strong, {\n children: \"same\"\n }), \" value for \", _jsx(_components.code, {\n children: \"customerId\"\n }), \" as the JWT \", _jsx(_components.code, {\n children: \"sub\"\n }), \". The shared id links the customer record to the user who signs in.\"]\n })]\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};\nfunction _missingMdxReference(id, component) {\n throw new Error(\"Expected \" + (component ? \"component\" : \"object\") + \" `\" + id + \"` to be defined: you likely forgot to import, pass, or provide it.\");\n}\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}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":"Generate onboarding URL","description":"Generates a presigned URL for customer onboarding. If the customer does not exist, it\nwill be created. You generate a UUID for `customerId` and `bankAccountId`, and Etherfuse creates the\ncustomer and bank account records associated with your organization.\n\n\u003cWarning>\n**Deprecated. Sunset August 16, 2026.** Customer onboarding has consolidated onto a\nsingle hosted flow: create the customer's `personal` organization with\n`POST /ramp/organization`, then launch them into `/idv`, which runs identity\nverification **and** agreement signing in one step. See\n[Customer Onboarding (KYC)](/guides/onboarding). Migrate before the sunset date.\n\u003c/Warning>\n\nUpon visiting the URL, the customer has 15 minutes to complete onboarding (KYC\nverification and bank account linking).\n\n## Personal organizations only\n\nThis endpoint always creates a **personal** organization; it forces individual KYC.\nThere is no `accountType` field; pass `business` orgs through\n`POST /ramp/organization` instead.\n\n## userInfo\n\nPass `userInfo` with the end user's email and display name. When provided, Etherfuse\npre-creates the user record so the customer's eventual sign-in attaches to the right\nuser and we can email them on status changes (KYC approved/rejected, bank account\nverified, etc.). `userInfo` is **required**, and neither `email` nor `displayName` may be blank. The\nemail is required for the customer's verification record and status notifications. A\ncustomer created without an email address cannot start KYC.\n\n## Authenticating as the customer\n\nIf the customer signs in with a JWT (see [JWT User Authentication](/guides/jwt-authentication)), use the **same** value for `customerId` as the JWT `sub`. The shared id links the customer record to the user who signs in.","deprecated":true,"version":null,"openapi":"/openapi.json post /ramp/onboarding-url","href":"/api-reference/deprecated/generate-onboarding-url","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Deprecated"],"deprecated":true,"summary":"Generate onboarding URL","description":"Generates a presigned URL for customer onboarding. If the customer does not exist, it\nwill be created. You generate a UUID for `customerId` and `bankAccountId`, and Etherfuse creates the\ncustomer and bank account records associated with your organization.\n\n\u003cWarning>\n**Deprecated. Sunset August 16, 2026.** Customer onboarding has consolidated onto a\nsingle hosted flow: create the customer's `personal` organization with\n`POST /ramp/organization`, then launch them into `/idv`, which runs identity\nverification **and** agreement signing in one step. See\n[Customer Onboarding (KYC)](/guides/onboarding). Migrate before the sunset date.\n\u003c/Warning>\n\nUpon visiting the URL, the customer has 15 minutes to complete onboarding (KYC\nverification and bank account linking).\n\n## Personal organizations only\n\nThis endpoint always creates a **personal** organization; it forces individual KYC.\nThere is no `accountType` field; pass `business` orgs through\n`POST /ramp/organization` instead.\n\n## userInfo\n\nPass `userInfo` with the end user's email and display name. When provided, Etherfuse\npre-creates the user record so the customer's eventual sign-in attaches to the right\nuser and we can email them on status changes (KYC approved/rejected, bank account\nverified, etc.). `userInfo` is **required**, and neither `email` nor `displayName` may be blank. The\nemail is required for the customer's verification record and status notifications. A\ncustomer created without an email address cannot start KYC.\n\n## Authenticating as the customer\n\nIf the customer signs in with a JWT (see [JWT User Authentication](/guides/jwt-authentication)), use the **same** value for `customerId` as the JWT `sub`. The shared id links the customer record to the user who signs in.","operationId":"generate_onboarding_url","requestBody":"a09eb24f-d8b3-4ed4-b6ab-15b26c90f8bb","responses":{"200":"11cbdb52-a77b-4624-a04f-8a883d125b89","400":"dfd2dfae-3bd4-41f4-86a0-7d007dd8b844","409":"9318ca98-2f6b-4823-b9e9-c2d9b2e3fae0"},"method":"post","type":"path","servers":["8fd0d4e3-6659-4448-8df1-670600a58cbd"],"security":["9f611a57-a8ef-4fbd-98a3-aa7c39728333"],"path":"/ramp/onboarding-url","baseUrlOptions":["https://api.sand.etherfuse.com"],"title":"Generate onboarding URL","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["customerId","bankAccountId","publicKey","blockchain","userInfo"],"properties":{"bankAccountId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"bankAccountId","typeLabel":"string\u003cuuid>"},"blockchain":{"type":"string","description":"Canonical blockchain enum for API serialization.\nUse this type for JSON APIs and WebSocket messages.\nFor database storage, convert to `BlockchainType`.","enum":["stellar","solana","base","polygon","monad","avalanche"],"isRequired":true,"uniqueKey":"blockchain","typeLabel":"enum\u003cstring>"},"customerId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"customerId","typeLabel":"string\u003cuuid>"},"publicKey":{"type":"string","isRequired":true,"uniqueKey":"publicKey","typeLabel":"string"},"userInfo":{"type":"object","description":"Info about the end user. Both fields are required and neither may be\nblank. `email` is required for the verification record and status\nnotifications. A customer created without an email address cannot start\nKYC. `displayName` is how the customer is addressed in notices.","required":["email","displayName"],"properties":{"displayName":{"type":"string","isRequired":true,"uniqueKey":"userInfo.displayName","typeLabel":"string"},"email":{"type":"string","isRequired":true,"uniqueKey":"userInfo.email","typeLabel":"string"}},"isRequired":true,"uniqueKey":"userInfo","typeLabel":"object"},"uiOverride":{"oneOf":[{"type":"string","uniqueKey":"uiOverride.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"uiOverride.oneOf.1","typeLabel":"null"}],"uniqueKey":"uiOverride","typeLabel":"string | null"}},"example":{"bankAccountId":"b2c3d4e5-f6a7-8901-bcde-f12345678901","blockchain":"stellar","customerId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","publicKey":"GDUKMGUGD3V6VXTU2RLAUM7A2FABLMHCPWTMDHKP7HHJ6FCZKEY4PVWL","userInfo":{"displayName":"Ana García","email":"[email protected]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"bankAccountId":"b2c3d4e5-f6a7-8901-bcde-f12345678901","blockchain":"stellar","customerId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","publicKey":"GDUKMGUGD3V6VXTU2RLAUM7A2FABLMHCPWTMDHKP7HHJ6FCZKEY4PVWL","userInfo":{"displayName":"Ana García","email":"[email protected]"}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"11cbdb52-a77b-4624-a04f-8a883d125b89":{"description":"A presigned onboarding URL","content":{"application/json":{"schema":{},"example":{"presigned_url":"https://api.sand.etherfuse.com/onboarding?org_id=a1b2c3d4-...\u0026customer_id=a1b2c3d4-...\u0026expires=1748345400\u0026signature=..."},"examples":{"Example":{"title":"Example","value":{"presigned_url":"https://api.sand.etherfuse.com/onboarding?org_id=a1b2c3d4-...\u0026customer_id=a1b2c3d4-...\u0026expires=1748345400\u0026signature=..."}}},"exampleType":"examples"}},"exampleType":"examples"},"dfd2dfae-3bd4-41f4-86a0-7d007dd8b844":{"description":"Invalid request","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"9318ca98-2f6b-4823-b9e9-c2d9b2e3fae0":{"description":"The `publicKey` is already attached to another customer of your organization. The body names the existing customer id. On retries, reuse the same `customerId` (the call is idempotent for a customer you own) instead of generating a new one.","content":{"text/plain":{"schema":{"type":"string","uniqueKey":"","typeLabel":"string"},"example":"You have already added user with this address, see org: b45a5a15-3e4b-4e92-9167-635dd7e95252","examples":{"Example":{"title":"Example","value":"You have already added user with this address, see org: b45a5a15-3e4b-4e92-9167-635dd7e95252"}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"9f611a57-a8ef-4fbd-98a3-aa7c39728333":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key sent in the Authorization header.","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"8fd0d4e3-6659-4448-8df1-670600a58cbd":{"url":"https://api.sand.etherfuse.com","description":"Sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"API key sent in the Authorization header.","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"Authorization","type":"string","description":"API key sent in the Authorization header.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"etherfuse","siteName":"Etherfuse API","title":"Generate onboarding URL - Etherfuse API","navMaps":{"firstHrefInVersion":{"v2 (beta)":{"href":"/v2","matchLevel":4},"v1 (legacy)":{"href":"/api-reference/deprecated/generate-onboarding-url","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T18:38:13.164Z","originalFileLocation":"api-reference/deprecated/generate-onboarding-url.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=\"Generates a presigned URL for customer onboarding. If the customer does not exist, it will be created. You generate a UUID for customerId and bankAccountId, and Etherfuse creates the customer and bank account records associated with your organization. Deprecated. Sunset August 16, 2026. Customer onboarding has consolidated onto a single hosted flow: create the customer\u0026#x27;s personal organization with POST /ramp/organization, then launch them into /idv, which runs identity verification and agreement signing in one step. See Customer Onboarding (KYC). Migrate before the sunset date. Upon visiting the URL, the customer has 15 minutes to complete onboarding (KYC verification and bank account linking). ## Personal organizations only This endpoint always creates a personal organization; it forces individual KYC. There is no accountType field; pass business orgs through POST /ramp/organization instead. ## userInfo Pass userInfo with the end user\u0026#x27;s email and display name. When provided, Etherfuse pre-creates the user record so the customer\u0026#x27;s eventual sign-in attaches to the right user and we can email them on status changes (KYC approved/rejected, bank account verified, etc.). userInfo is required, and neither email nor displayName may be blank. The email is required for the customer\u0026#x27;s verification record and status notifications. A customer created without an email address cannot start KYC. ## Authenticating as the customer If the customer signs in with a JWT (see JWT User Authentication), use the same value for customerId as the JWT sub. The shared id links the customer record to the user who signs in.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Etherfuse API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/etherfuse/2PYR-_ECBzhTGa_z/_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/etherfuse/2PYR-_ECBzhTGa_z/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/etherfuse/2PYR-_ECBzhTGa_z/_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/etherfuse/2PYR-_ECBzhTGa_z/_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/etherfuse/2PYR-_ECBzhTGa_z/_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/etherfuse/2PYR-_ECBzhTGa_z/_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/etherfuse/2PYR-_ECBzhTGa_z/_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/etherfuse/2PYR-_ECBzhTGa_z/_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/etherfuse/2PYR-_ECBzhTGa_z/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Generate onboarding URL - Etherfuse API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Generates a presigned URL for customer onboarding. If the customer does not exist, it will be created. You generate a UUID for customerId and bankAccountId, and Etherfuse creates the customer and bank account records associated with your organization. Deprecated. Sunset August 16, 2026. Customer onboarding has consolidated onto a single hosted flow: create the customer\u0026#x27;s personal organization with POST /ramp/organization, then launch them into /idv, which runs identity verification and agreement signing in one step. See Customer Onboarding (KYC). Migrate before the sunset date. Upon visiting the URL, the customer has 15 minutes to complete onboarding (KYC verification and bank account linking). ## Personal organizations only This endpoint always creates a personal organization; it forces individual KYC. There is no accountType field; pass business orgs through POST /ramp/organization instead. ## userInfo Pass userInfo with the end user\u0026#x27;s email and display name. When provided, Etherfuse pre-creates the user record so the customer\u0026#x27;s eventual sign-in attaches to the right user and we can email them on status changes (KYC approved/rejected, bank account verified, etc.). userInfo is required, and neither email nor displayName may be blank. The email is required for the customer\u0026#x27;s verification record and status notifications. A customer created without an email address cannot start KYC. ## Authenticating as the customer If the customer signs in with a JWT (see JWT User Authentication), use the same value for customerId as the JWT sub. The shared id links the customer record to the user who signs in.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Etherfuse API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.etherfuse.com/api-reference/deprecated/generate-onboarding-url\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://etherfuse.mintlify.site/_mintlify/api/og/v2?division=Deprecated\u0026amp;title=Generate+onboarding+URL\u0026amp;description=Generates+a+presigned+URL+for+customer+onboarding.+If+the+customer+does+not+exist%2C+it%0Awill+be+created.+You+generate+a+UUID+for+%60customerId%60+and+%60bankAccountId%60%2C\u0026amp;theme=7e3bc6313a40e5ac9e5925e8\u0026amp;signature=4b38934a983e57c10669ffa08ef4219c27db69f4fef8b5b3e1c7d528d202ed7a\">\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=\"Generate onboarding URL - Etherfuse API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Generates a presigned URL for customer onboarding. If the customer does not exist, it will be created. You generate a UUID for customerId and bankAccountId, and Etherfuse creates the customer and bank account records associated with your organization. Deprecated. Sunset August 16, 2026. Customer onboarding has consolidated onto a single hosted flow: create the customer\u0026#x27;s personal organization with POST /ramp/organization, then launch them into /idv, which runs identity verification and agreement signing in one step. See Customer Onboarding (KYC). Migrate before the sunset date. Upon visiting the URL, the customer has 15 minutes to complete onboarding (KYC verification and bank account linking). ## Personal organizations only This endpoint always creates a personal organization; it forces individual KYC. There is no accountType field; pass business orgs through POST /ramp/organization instead. ## userInfo Pass userInfo with the end user\u0026#x27;s email and display name. When provided, Etherfuse pre-creates the user record so the customer\u0026#x27;s eventual sign-in attaches to the right user and we can email them on status changes (KYC approved/rejected, bank account verified, etc.). userInfo is required, and neither email nor displayName may be blank. The email is required for the customer\u0026#x27;s verification record and status notifications. A customer created without an email address cannot start KYC. ## Authenticating as the customer If the customer signs in with a JWT (see JWT User Authentication), use the same value for customerId as the JWT sub. The shared id links the customer record to the user who signs in.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://etherfuse.mintlify.site/_mintlify/api/og/v2?division=Deprecated\u0026amp;title=Generate+onboarding+URL\u0026amp;description=Generates+a+presigned+URL+for+customer+onboarding.+If+the+customer+does+not+exist%2C+it%0Awill+be+created.+You+generate+a+UUID+for+%60customerId%60+and+%60bankAccountId%60%2C\u0026amp;theme=7e3bc6313a40e5ac9e5925e8\u0026amp;signature=4b38934a983e57c10669ffa08ef4219c27db69f4fef8b5b3e1c7d528d202ed7a\">\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/etherfuse/2PYR-_ECBzhTGa_z/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Etherfuse API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#141414\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.etherfuse.com/api-reference/deprecated/generate-onboarding-url\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/deprecated/generate-onboarding-url.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.etherfuse.com/#organization\",\"name\":\"Etherfuse API\",\"url\":\"https://docs.etherfuse.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/etherfuse/XRSchVFGUgreQatD/img/logo-black.svg?fit=max\u0026auto=format\u0026n=XRSchVFGUgreQatD\u0026q=85\u0026s=92cf84eca27df4a19f7b032da398d110\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.etherfuse.com#website\",\"name\":\"Etherfuse API\",\"url\":\"https://docs.etherfuse.com\",\"publisher\":{\"@id\":\"https://docs.etherfuse.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.etherfuse.com/api-reference/deprecated/generate-onboarding-url#webpage\",\"url\":\"https://docs.etherfuse.com/api-reference/deprecated/generate-onboarding-url\",\"name\":\"Generate onboarding URL\",\"description\":\"Generates a presigned URL for customer onboarding. If the customer does not exist, it will be created. You generate a UUID for customerId and bankAccountId, and Etherfuse creates the customer and bank account records associated with your organization. Deprecated. Sunset August 16, 2026. Customer onboarding has consolidated onto a single hosted flow: create the customer's personal organization with POST /ramp/organization, then launch them into /idv, which runs identity verification and agreement signing in one step. See Customer Onboarding (KYC). Migrate before the sunset date. Upon visiting the URL, the customer has 15 minutes to complete onboarding (KYC verification and bank account linking). ## Personal organizations only This endpoint always creates a personal organization; it forces individual KYC. There is no accountType field; pass business orgs through POST /ramp/organization instead. ## userInfo Pass userInfo with the end user's email and display name. When provided, Etherfuse pre-creates the user record so the customer's eventual sign-in attaches to the right user and we can email them on status changes (KYC approved/rejected, bank account verified, etc.). userInfo is required, and neither email nor displayName may be blank. The email is required for the customer's verification record and status notifications. A customer created without an email address cannot start KYC. ## Authenticating as the customer If the customer signs in with a JWT (see JWT User Authentication), use the same value for customerId as the JWT sub. The shared id links the customer record to the user who signs in.\",\"dateModified\":\"2026-11-12T18:38:13.164Z\",\"isPartOf\":{\"@id\":\"https://docs.etherfuse.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.etherfuse.com/api-reference/deprecated/generate-onboarding-url#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.etherfuse.com/api-reference/deprecated/generate-onboarding-url#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Ramp API\",\"item\":\"https://docs.etherfuse.com/api-reference/assets/list-assets\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Generate onboarding URL\",\"item\":\"https://docs.etherfuse.com/api-reference/deprecated/generate-onboarding-url\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.etherfuse.com/api-reference/deprecated/generate-onboarding-url#apireference\",\"headline\":\"Generate onboarding URL\",\"name\":\"Generate onboarding URL\",\"description\":\"Generates a presigned URL for customer onboarding. If the customer does not exist, it will be created. You generate a UUID for customerId and bankAccountId, and Etherfuse creates the customer and bank account records associated with your organization. Deprecated. Sunset August 16, 2026. Customer onboarding has consolidated onto a single hosted flow: create the customer's personal organization with POST /ramp/organization, then launch them into /idv, which runs identity verification and agreement signing in one step. See Customer Onboarding (KYC). Migrate before the sunset date. Upon visiting the URL, the customer has 15 minutes to complete onboarding (KYC verification and bank account linking). ## Personal organizations only This endpoint always creates a personal organization; it forces individual KYC. There is no accountType field; pass business orgs through POST /ramp/organization instead. ## userInfo Pass userInfo with the end user's email and display name. When provided, Etherfuse pre-creates the user record so the customer's eventual sign-in attaches to the right user and we can email them on status changes (KYC approved/rejected, bank account verified, etc.). userInfo is required, and neither email nor displayName may be blank. The email is required for the customer's verification record and status notifications. A customer created without an email address cannot start KYC. ## Authenticating as the customer If the customer signs in with a JWT (see JWT User Authentication), use the same value for customerId as the JWT sub. The shared id links the customer record to the user who signs in.\",\"url\":\"https://docs.etherfuse.com/api-reference/deprecated/generate-onboarding-url\",\"mainEntityOfPage\":{\"@id\":\"https://docs.etherfuse.com/api-reference/deprecated/generate-onboarding-url#webpage\"},\"dateModified\":\"2026-11-12T18:38:13.164Z\",\"publisher\":{\"@id\":\"https://docs.etherfuse.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.etherfuse.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Etherfuse API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Etherfuse API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/deprecated/generate-onboarding-url.md","siteName":"Etherfuse API","nav":{"global":null,"versions":[{"version":"v2 (beta)","default":true,"pages":[{"title":"v2 (beta)","href":"/v2"}]},{"version":"v1 (legacy)","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"API Reference","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"API Authentication","href":"/authentication"},{"title":"Errors","href":"/errors"},{"title":"Pagination","href":"/pagination"},{"title":"Idempotency","href":"/idempotency"},{"group":"User Authentication","icon":"key","pages":[{"openapi":"openapi.json POST /auth/launch","title":"Launch a user into the app","href":"/api-reference/authentication/launch-a-user-into-the-app"},{"openapi":"openapi.json GET /auth/launch","title":"Launch a user via postMessage","href":"/api-reference/launch-via-postmessage"},{"title":"Exchange a partner JWT","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/token","href":"/api-reference/authentication/exchange-a-partner-jwt"}]},{"group":"Ramp API","icon":"money-bill-transfer","pages":[{"group":"Assets","icon":"coins","pages":[{"title":"List assets","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/assets","href":"/api-reference/assets/list-assets"},{"title":"Get one wallet's balances","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/balances","href":"/api-reference/assets/get-one-wallets-balances"}]},{"group":"Bank Accounts","icon":"building-columns","pages":[{"title":"Create bank account (presigned)","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/bank-account","href":"/api-reference/bank-accounts/create-bank-account-presigned"},{"title":"Get bank account","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/bank-account/{bank_account_id}","href":"/api-reference/bank-accounts/get-bank-account"},{"title":"List bank accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/bank-accounts","href":"/api-reference/bank-accounts/list-bank-accounts"},{"title":"Search bank accounts","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/bank-accounts","href":"/api-reference/bank-accounts/search-bank-accounts"},{"title":"Create bank account (API)","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/customer/{customer_id}/bank-account","href":"/api-reference/bank-accounts/create-bank-account-api"},{"title":"List customer accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/customer/{customer_id}/bank-accounts","href":"/api-reference/bank-accounts/list-customer-accounts"},{"title":"Search customer accounts","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/customer/{customer_id}/bank-accounts","href":"/api-reference/bank-accounts/search-customer-accounts"}]},{"group":"Quotes","icon":"tag","pages":[{"title":"Get quote","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/quote","href":"/api-reference/quotes/get-quote"}]},{"group":"Orders","icon":"receipt","pages":[{"title":"Create order","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/order","href":"/api-reference/orders/create-order"},{"title":"Get order","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/order/{order_id}","href":"/api-reference/orders/get-order"},{"title":"Cancel order","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/order/{order_id}/cancel","href":"/api-reference/orders/cancel-order"},{"title":"Regenerate tx","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/order/{order_id}/regenerate_tx","href":"/api-reference/orders/regenerate-tx"},{"title":"Get order approval","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/order/{order_id}/approvals","href":"/api-reference/orders/get-order-approval"},{"title":"Submit order approval","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/order/{order_id}/approvals","href":"/api-reference/orders/submit-order-approval"},{"title":"List orders","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/orders","href":"/api-reference/orders/list-orders"},{"title":"Search orders","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/orders","href":"/api-reference/orders/search-orders"},{"title":"List customer orders","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/customer/{customer_id}/orders","href":"/api-reference/orders/list-customer-orders"},{"title":"Search customer orders","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/customer/{customer_id}/orders","href":"/api-reference/orders/search-customer-orders"}]},{"group":"Statements","icon":"file-invoice-dollar","pages":[{"title":"List partner statements","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/partner-statements","href":"/api-reference/statements/list-partner-statements"},{"title":"Download statement CSV","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/partner-statements/{year}-{month}/csv","href":"/api-reference/statements/download-statement-csv"},{"title":"Download statement PDF","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/partner-statements/{year}-{month}/pdf","href":"/api-reference/statements/download-statement-pdf"}]},{"group":"WebSocket","icon":"plug","pages":[{"title":"Mint WebSocket token","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/ws-api-token","href":"/api-reference/websocket/mint-websocket-token"},{"title":"Connect to the live update stream","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/ws","href":"/api-reference/websocket/connect-to-the-live-update-stream"}]},{"group":"Swaps","icon":"right-left","pages":[{"title":"Swap assets","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/swap","href":"/api-reference/swaps/swap-assets"},{"title":"Regenerate swap tx","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/swap/{order_id}/regenerate_tx","href":"/api-reference/swaps/regenerate-swap-tx"}]},{"group":"Sponsored","icon":"hand-holding-dollar","pages":[{"title":"Approve EVM token","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/evm/approve","href":"/api-reference/sponsored/approve-evm-token"}]},{"group":"Customers","icon":"users","pages":[{"title":"Search customers","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/customers","href":"/api-reference/customers/search-customers"},{"title":"List customers","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/customers","href":"/api-reference/customers/list-customers"},{"title":"Get customer","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/customer/{customer_id}","href":"/api-reference/customers/get-customer"},{"title":"List a customer's organizations","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/customer/{customer_id}/organization","href":"/api-reference/customers/list-a-customers-organizations"}]},{"group":"Wallets","icon":"wallet","pages":[{"title":"Register wallet","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/wallet","href":"/api-reference/wallets/register-wallet"},{"title":"Get wallet","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/wallet/{wallet_id}","href":"/api-reference/wallets/get-wallet"},{"title":"Delete wallet","deprecated":null,"version":null,"openapi":"/openapi.json delete /ramp/wallet/{wallet_id}","href":"/api-reference/wallets/delete-wallet"},{"title":"List wallets","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/wallets","href":"/api-reference/wallets/list-wallets"},{"title":"Search wallets","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/wallets","href":"/api-reference/wallets/search-wallets"},{"title":"Register customer wallet","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/customer/{customer_id}/wallet","href":"/api-reference/wallets/register-customer-wallet"},{"title":"List customer wallets","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/customer/{customer_id}/wallets","href":"/api-reference/wallets/list-customer-wallets"},{"title":"Search customer wallets","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/customer/{customer_id}/wallets","href":"/api-reference/wallets/search-customer-wallets"}]},{"group":"KYC","icon":"id-card","pages":[{"title":"Get KYC status","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/customer/{customer_id}/kyc","href":"/api-reference/kyc/get-kyc-status"},{"title":"Submit verification data","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/customer/{customer_id}/verification","href":"/api-reference/kyc/submit-verification-data"},{"title":"Upload verification documents","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/customer/{customer_id}/verification/documents","href":"/api-reference/kyc/upload-verification-documents"},{"title":"Submit a verification questionnaire","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/customer/{customer_id}/verification/questionnaire","href":"/api-reference/kyc/submit-a-verification-questionnaire"},{"title":"Import a verified session","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/customer/{customer_id}/verification/import","href":"/api-reference/kyc/import-a-verified-session"},{"title":"List occupation categories","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/verification/occupations","href":"/api-reference/kyc/list-occupation-categories"}]},{"group":"Webhooks","icon":"bell","pages":[{"title":"Create webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/webhook","href":"/api-reference/webhooks/create-webhook"},{"title":"Get webhook","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/webhook/{webhook_id}","href":"/api-reference/webhooks/get-webhook"},{"title":"Delete webhook","deprecated":null,"version":null,"openapi":"/openapi.json delete /ramp/webhook/{webhook_id}","href":"/api-reference/webhooks/delete-webhook"},{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/webhooks","href":"/api-reference/webhooks/list-webhooks"}]},{"group":"Webhook Events","icon":"tower-broadcast","pages":[{"title":"Order updated","version":null,"deprecated":null,"openapi":"/openapi.json webhook orderUpdated","href":"/api-reference/webhooks/order_updated"},{"title":"Swap updated","version":null,"deprecated":null,"openapi":"/openapi.json webhook swapUpdated","href":"/api-reference/webhooks/swap_updated"},{"title":"Customer updated","version":null,"deprecated":null,"openapi":"/openapi.json webhook customerUpdated","href":"/api-reference/webhooks/customer_updated"},{"title":"Bank account updated","version":null,"deprecated":null,"openapi":"/openapi.json webhook bankAccountUpdated","href":"/api-reference/webhooks/bank_account_updated"},{"title":"Kyc updated","version":null,"deprecated":null,"openapi":"/openapi.json webhook kycUpdated","href":"/api-reference/webhooks/kyc_updated"},{"title":"Kyb updated","version":null,"deprecated":null,"openapi":"/openapi.json webhook kybUpdated","href":"/api-reference/webhooks/kyb_updated"}]},{"group":"Organizations","icon":"building","pages":[{"title":"Verify API key","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp","href":"/api-reference/organizations/verify-api-key"},{"title":"Get organization","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/me","href":"/api-reference/organizations/get-organization"},{"title":"Create child org","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/organization","href":"/api-reference/organizations/create-child-org"},{"title":"Add organization member","deprecated":null,"version":null,"openapi":"/openapi.json post /ramp/organization/{id}/member","href":"/api-reference/organizations/add-organization-member"},{"title":"List organization members","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/organization/{id}/member","href":"/api-reference/organizations/list-organization-members"},{"title":"Remove organization member","deprecated":null,"version":null,"openapi":"/openapi.json delete /ramp/organization/{id}/member/{customer_id}","href":"/api-reference/organizations/remove-organization-member"},{"title":"Revoke organization invite","deprecated":null,"version":null,"openapi":"/openapi.json delete /ramp/organization/{id}/member/invite/{email}","href":"/api-reference/organizations/revoke-organization-invite"},{"title":"Get KYB status","deprecated":null,"version":null,"openapi":"/openapi.json get /ramp/organization/{id}/kyb/status","href":"/api-reference/organizations/get-kyb-status"},{"title":"Rename organization","deprecated":null,"version":null,"openapi":"/openapi.json put /ramp/organization/{org_id}/name","href":"/api-reference/organizations/rename-organization"},{"title":"Set partner fee","deprecated":null,"version":null,"openapi":"/openapi.json put /ramp/partner-fee","href":"/api-reference/organizations/set-partner-fee"}]},{"group":"Sandbox API","icon":"flask","pages":[{"title":"Simulate Fiat Received","api":"POST https://api.sand.etherfuse.com/ramp/order/fiat_received","description":"Simulate the receipt of fiat funds for an onramp order (Sandbox only)","href":"/sandbox-api/fiat-received"}]},{"group":"Deprecated","icon":"ban","pages":[{"title":"Generate onboarding URL","deprecated":true,"version":null,"openapi":"/openapi.json post /ramp/onboarding-url","href":"/api-reference/deprecated/generate-onboarding-url"},{"title":"Get onboarding bank accounts","description":"Resolves the customer from a valid presigned onboarding URL and returns\ntheir bank accounts. Public — no API key required.","deprecated":true,"version":null,"openapi":"/openapi.json post /ramp/onboarding/bank-accounts","href":"/api-reference/deprecated/get-onboarding-bank-accounts"},{"title":"Submit KYC","deprecated":true,"version":null,"openapi":"/openapi.json post /ramp/customer/{customer_id}/kyc","href":"/api-reference/deprecated/submit-kyc"},{"title":"Upload KYC docs","deprecated":true,"version":null,"openapi":"/openapi.json post /ramp/customer/{customer_id}/kyc/documents","href":"/api-reference/deprecated/upload-kyc-docs"},{"title":"Get KYB progress","deprecated":true,"version":null,"openapi":"/openapi.json get /ramp/organization/{id}/kyb/progress","href":"/api-reference/deprecated/get-kyb-progress"}]}]},{"group":"Lookup API","icon":"magnifying-glass","pages":[{"title":"List exchange rates","deprecated":null,"version":null,"openapi":"/openapi.json get /lookup/exchange_rate","href":"/api-reference/lookup/list-exchange-rates"},{"title":"Get exchange rate","deprecated":null,"version":null,"openapi":"/openapi.json get /lookup/exchange_rate/usd_to_{currency}","href":"/api-reference/lookup/get-exchange-rate"},{"title":"List stablebonds","deprecated":null,"version":null,"openapi":"/openapi.json get /lookup/stablebonds","href":"/api-reference/lookup/list-stablebonds"},{"title":"Get stablebond","deprecated":null,"version":null,"openapi":"/openapi.json get /lookup/stablebond/{identifier}","href":"/api-reference/lookup/get-stablebond"},{"title":"List token costs","deprecated":null,"version":null,"openapi":"/openapi.json get /lookup/tokens/cost","href":"/api-reference/lookup/list-token-costs"},{"title":"Get token cost","deprecated":null,"version":null,"openapi":"/openapi.json get /lookup/tokens/cost/{identifier}","href":"/api-reference/lookup/get-token-cost"},{"title":"List stablebond costs","deprecated":true,"version":null,"openapi":"/openapi.json get /lookup/bonds/cost","href":"/api-reference/lookup/list-stablebond-costs"},{"title":"Get stablebond cost","deprecated":true,"version":null,"openapi":"/openapi.json get /lookup/bonds/cost/{identifier}","href":"/api-reference/lookup/get-stablebond-cost"},{"title":"List country codes","deprecated":null,"version":null,"openapi":"/openapi.json get /lookup/country-codes","href":"/api-reference/lookup/list-country-codes"},{"title":"List restricted countries","deprecated":null,"version":null,"openapi":"/openapi.json get /lookup/restricted-countries","href":"/api-reference/lookup/list-restricted-countries"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]}]},"basePath":"","title":"Generate onboarding URL - Etherfuse API","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}