Program API key identifying your integration. Pass as the api_key HTTP header (preferred) or as an api_key field in the JSON request body. Required on every request in addition to the HMAC Authorization header.
{
"status": "error",
"message": "Something went wrong",
"data": "<unknown>",
"status_code": {
"status_code": 1000,
"error_type": "NOT_FOUND",
"message": "Resource not found",
"description": "The requested resource does not exist"
}
}
{
"status": "error",
"message": "Something went wrong",
"data": "<unknown>",
"status_code": {
"status_code": 1000,
"error_type": "NOT_FOUND",
"message": "Resource not found",
"description": "The requested resource does not exist"
}
}
{
"status": "error",
"message": "Something went wrong",
"data": "<unknown>",
"status_code": {
"status_code": 1000,
"error_type": "NOT_FOUND",
"message": "Resource not found",
"description": "The requested resource does not exist"
}
}
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Ingo Payments Developer Hub","description":"Ingo Payments Developer Hub — APIs, SDKs, and integration guides.","colors":{"primary":"#23ad4b","light":"#5dcaa5","dark":"#058237"},"logo":{"light":"https://mintcdn.com/ingopayments/iShoHhbLzbG-YOtN/logo/light.svg?fit=max\u0026auto=format\u0026n=iShoHhbLzbG-YOtN\u0026q=85\u0026s=556c65165f3a5daf3e33eaf145664046","dark":"https://mintcdn.com/ingopayments/iShoHhbLzbG-YOtN/logo/dark.svg?fit=max\u0026auto=format\u0026n=iShoHhbLzbG-YOtN\u0026q=85\u0026s=52323e8aa1687a6fbdd29a6351b84fcf"},"favicon":"https://mintcdn.com/ingopayments/V3R8LABa_ahl2WE8/favicon.svg?fit=max\u0026auto=format\u0026n=V3R8LABa_ahl2WE8\u0026q=85\u0026s=b46af7ead1c5e85e3fe5d6813b1be106","api":{"openapi":["specs/iframe-session-create.yaml","specs/ingo-banking-merchant-ledgering.yaml","specs/ingopay-check-cancel.yaml","specs/ingopay-check-stop.yaml","specs/ingopay-debit-process-ach.yaml","specs/ingopay-debit-process-card.yaml","specs/ingopay-notify-v3.yaml","specs/ingopay-notify-v4.yaml","specs/ingopay-process-ach.yaml","specs/ingopay-process-billpay.yaml","specs/ingopay-process-card.yaml","specs/ingopay-process-check.yaml","specs/ingopay-process-paypal-venmo.yaml","specs/ingopay-process-retail-card-present.yaml","specs/ingopay-risk.yaml","specs/ingopay-search-v11.yaml","specs/ingopay-verify-ach.yaml","specs/ingopay-verify-billpay.yaml","specs/ingopay-verify-card.yaml","specs/ingopay-verify-check.yaml","specs/ingopay-verify-paypal-venmo.yaml","specs/ingopay-verify-retail-card-present.yaml","specs/ingopay-open-banking-account.yaml","specs/crms-check-maker-alert.yaml","specs/crms-check-protect.yaml","specs/crms-duplicate-exchange.yaml","specs/crms-fraud-alert.yaml","specs/crms-sdk-card-add-or-update-tokenized.yaml","specs/crms-sdk-card-add-or-update.yaml","specs/crms-sdk-card-delete.yaml","specs/crms-sdk-card-get-registered-cards.yaml","specs/crms-sdk-card-update-account.yaml","specs/crms-sdk-partners-add-customer-attributes.yaml","specs/crms-sdk-partners-add-session-attributes.yaml","specs/crms-sdk-partners-authenticate-obo.yaml","specs/crms-sdk-partners-authenticate.yaml","specs/crms-sdk-partners-enroll-customer.yaml","specs/crms-sdk-partners-find-customer.yaml","specs/crms-sdk-partners-get-transaction-history.yaml","specs/crms-sdk-paypal-register-customer.yaml"],"asyncapi":["specs/asyncapi-ingopay.yaml","specs/asyncapi-notify-v3.yaml","specs/asyncapi-notify-v4.yaml","specs/asyncapi-iframe.yaml","specs/asyncapi-banking.yaml","specs/asyncapi-crms-sdk.yaml","specs/asyncapi-crms-check-protect.yaml"],"playground":{"display":"simple"}},"appearance":{"default":"dark"},"contextual":{"options":["copy","view","claude","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ingopayments","hasAudioNarration":false,"actualSubdomain":"ingopayments","customDomains":["developers.ingopayments.com"],"gitSource":{"type":"github","owner":"ingopayments","repo":"ingo-developer-center","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ada84e0793a44c014900f96","collectionId":"78d95d12-1fbc-4af9-94cd-d9532bf64744","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ada84e0793a44c014900f96"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae1f353201cdb70a522441a","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"Webhooks","count":242},{"language":"default","tag":"Banking Platform","count":81},{"language":"default","tag":"API Reference","count":74},{"language":"default","tag":"Notify — Managed Parties","count":56},{"language":"default","tag":"Notify — Classic","count":42},{"language":"default","tag":"IngoPay API","count":37},{"language":"default","tag":"Embedded Account Capture","count":22},{"language":"default","tag":"Overview","count":20},{"language":"default","tag":"Hub","count":17},{"language":"default","tag":"Business Owners \u0026 Documents","count":9}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"#navbar>div>div:first-child{border-bottom:3px solid #23ad4b!important;border-color:#23ad4b!important}nav a.link.rounded-full{height:40px!important;font-size:13.5px!important;padding-left:16px!important;padding-right:16px!important;transition:background .15s ease,color .15s ease,border-color .15s ease!important}nav a.link.rounded-full:not(.text-gray-600){background-color:#23ad4b!important;color:#fff!important;font-weight:700!important}nav a.link.rounded-full.text-gray-600{border:1px solid transparent!important;background-color:transparent!important}nav a.link.rounded-full.text-gray-600:hover{border-color:#23ad4b!important;color:#23ad4b!important;background-color:transparent!important}.spec-btn,.spec-btn:hover{text-decoration:none!important}.spec-btn{display:inline-block;background:0 0;border:1px solid #23ad4b;color:#23ad4b!important;font-size:12px;font-weight:600;padding:5px 14px;border-radius:20px;transition:background .15s ease,color .15s ease,border-color .15s ease}.spec-btn:hover{background:#23ad4b;color:#fff!important}.dark table th{color:#e2e8f0!important}img[src*=\"/crms/sdk/screens/\"]{border-radius:24px;max-width:280px;background:#fff;border:1px solid rgba(0,0,0,.18);box-shadow:0 6px 16px rgba(0,0,0,.12)}.dark img[src*=\"/crms/sdk/screens/\"]{border:1px solid rgba(255,255,255,.15);box-shadow:0 6px 16px rgba(0,0,0,.4)}.screen-row{display:grid;grid-template-columns:repeat(auto-fit,minmax(420px,1fr));gap:36px;margin:28px 0}.screen-card{display:grid;grid-template-columns:160px 1fr;gap:20px;align-items:start}.screen-card img{max-width:160px!important;width:100%}.screen-card .screen-text h4,.screen-card .screen-text strong:first-child{display:block;font-size:15px;font-weight:700;margin-top:0;margin-bottom:8px;line-height:1.3}.screen-card .screen-text p{margin:0 0 8px;font-size:14px;line-height:1.55}@media (max-width:540px){.screen-card{grid-template-columns:1fr;gap:12px}.screen-card img{max-width:200px!important;margin:0 auto}}.mermaid svg,div[class*=mermaid] svg,pre.mermaid svg{height:auto!important;margin:0 auto;display:block}.diagram-links{margin:8px 0 4px;font-size:.85rem;text-align:right}.diagram-links a{font-weight:500;text-decoration:none;border-bottom:1px solid currentColor}.diagram-accordion{position:relative;padding-left:14px;margin:28px 0;transition:transform .18s ease}.diagram-accordion::before{content:\"\";position:absolute;left:0;top:6px;bottom:6px;width:4px;background:#1a73e8;border-radius:2px;pointer-events:none;transition:background .18s ease,width .18s ease}.diagram-accordion:hover,.sdk-download-cta:hover{transform:translateY(-1px)}.diagram-accordion:hover::before{background:#4a90f0;width:5px}.sdk-download-cta{position:relative;margin:24px 0;padding:6px;border:2px solid #23ad4b;border-radius:14px;background:rgba(35,173,75,.06);box-shadow:0 4px 14px rgba(35,173,75,.18);transition:transform .18s ease,box-shadow .18s ease}.sdk-download-cta:hover{box-shadow:0 6px 20px rgba(35,173,75,.28)}.dark .sdk-download-cta{background:rgba(35,173,75,.12);box-shadow:0 4px 14px rgba(0,0,0,.4)}.report-downloads{display:flex;flex-wrap:wrap;gap:14px;margin:20px 0 4px}.report-downloads a.report-dl-btn{display:inline-flex;align-items:center;gap:9px;background:#23ad4b;color:#fff!important;font-size:14px;font-weight:600;padding:11px 20px;border-radius:10px;text-decoration:none!important;border:1px solid #23ad4b;box-shadow:0 2px 8px rgba(35,173,75,.2);transition:transform .15s ease,box-shadow .15s ease,background .15s ease}.report-downloads a.report-dl-btn::before{content:\"\\2193\";font-size:15px;font-weight:700;line-height:1}.report-downloads a.report-dl-btn:hover{background:#1c8f3d;transform:translateY(-1px);box-shadow:0 5px 16px rgba(35,173,75,.32);text-decoration:none!important}.dark .report-downloads a.report-dl-btn{box-shadow:0 2px 8px rgba(0,0,0,.4)}"}],"page":{"pagePath":"docs/banking/onboarding/create-user","slug":"/docs/banking/onboarding/create-user","pageMetadata":{"title":"Create User","description":"Create an individual user entity within your program.","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /user/create","href":"/docs/banking/onboarding/create-user"},"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: \"Create an individual user entity within your program.\"\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}=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":"Create User","description":"Create an individual user entity within your program.","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /user/create","href":"/docs/banking/onboarding/create-user"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ingopayments/6302b08f7c932246/scripts/convert.js","/_mintlify/custom/ingopayments/803ba8a0d7080d96/scripts/generate-from-code.js","/_mintlify/custom/ingopayments/20b0b95f387de69d/scripts/validate.js","/_mintlify/custom/ingopayments/e31e657fa2223781/scripts/export-diagrams.js"],"openApiReferenceData":{"operation":{"operationId":"createUser","summary":"Create a user entity","tags":["Onboarding"],"description":"Create an individual user entity within your program.","requestBody":"dba9896a-95d3-4112-aee6-f64397027ea5","responses":{"200":"92dcfca0-ba61-473c-a27d-4c00be0f32d9","400":"7df6ba91-b244-4594-8355-356987554c89","401":"3261fad9-3818-41a9-8195-399ee1bda01f","500":"0d52b6b4-2d3a-4b2a-9fbe-5e28306151e8"},"method":"post","type":"path","servers":["ef4acdce-d36b-4320-b822-4e6075ab255b","db05db77-a1d4-47ca-b121-452af9f44c8a"],"security":["0deb5c50-703e-45d1-a4a3-033d4f7a8aa5"],"path":"/user/create","baseUrlOptions":["https://api.sdev.banking.ingopayments.tech/api/v4","https://api.banking.ingopayments.tech/api/v4"],"title":"Create a user entity","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"required":["first_name","last_name","phone_number","address_one","city","postal_code","country","state","email"],"properties":{"first_name":{"type":"string","description":"First name.","isRequired":true,"uniqueKey":"first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Last name.","isRequired":true,"uniqueKey":"last_name","typeLabel":"string"},"address_one":{"type":"string","description":"Street address line 1.","isRequired":true,"uniqueKey":"address_one","typeLabel":"string"},"city":{"type":"string","description":"City.","isRequired":true,"uniqueKey":"city","typeLabel":"string"},"postal_code":{"type":"string","description":"5-digit US ZIP code.","isRequired":true,"uniqueKey":"postal_code","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","isRequired":true,"uniqueKey":"country","typeLabel":"string"},"state":{"type":"string","description":"ISO 3166-2 two-letter state/region code.","isRequired":true,"uniqueKey":"state","typeLabel":"string"},"email":{"type":"string","format":"email","example":"jane.doe@example.com","description":"Email address.","isRequired":true,"uniqueKey":"email","typeLabel":"string\u003cemail>"},"phone_number":{"type":"string","example":"+12125551234","description":"Phone number in E.164 format.","isRequired":true,"uniqueKey":"phone_number","typeLabel":"string"},"api_key":{"type":"string","description":"Program API key. Accepted either in the `api_key` HTTP header or as this body field.","uniqueKey":"api_key","typeLabel":"string"},"ssn":{"type":"string","description":"Social security number. Encrypted at rest.","uniqueKey":"ssn","typeLabel":"string"},"date_of_birth":{"type":"string","format":"date","example":"1990-04-15","description":"Date of birth in YYYY-MM-DD format.","uniqueKey":"date_of_birth","typeLabel":"string\u003cdate>"},"middle_name":{"type":"string","description":"Middle name.","uniqueKey":"middle_name","typeLabel":"string"},"address_two":{"type":"string","description":"Street address line 2.","uniqueKey":"address_two","typeLabel":"string"},"username":{"type":"string","description":"Chosen username for the user.","uniqueKey":"username","typeLabel":"string"},"terms_accepted":{"type":"boolean","description":"True to confirm the end user accepted the program terms.","uniqueKey":"terms_accepted","typeLabel":"boolean"},"meta_data":{"type":"array","description":"List of {name, value} pairs to persist alongside the entity.","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","example":"external_ref","isRequired":true,"uniqueKey":"meta_data.items.[INDEX].name","typeLabel":"string"},"value":{"type":"string","example":"order-123","isRequired":true,"uniqueKey":"meta_data.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"meta_data.items.[INDEX]","typeLabel":"object"},"uniqueKey":"meta_data","typeLabel":"object[]"},"business_id":{"type":"string","description":"Optional. When supplied, the created user is also linked as a contact of this business.","example":"buss-2ef94c60-5a11-4d72-a3c1-5be7fab0123e","uniqueKey":"business_id","typeLabel":"string"},"is_vendor":{"type":"boolean","description":"Optional. When `business_id` is supplied, marks the created business contact as a vendor.","uniqueKey":"is_vendor","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"postman_example":{"title":"postman_example","value":{"api_key":"YOUR_API_KEY","email":"jane.doe@example.com","first_name":"Alex","middle_name":"","last_name":"Rivera","phone_number":"+15555551234","postal_code":"30044","country":"US","state":"TX","city":"Anytown","address_one":"100 Innovation Way","address_two":"Suite 100","username":"janedoe","date_of_birth":"1980-04-20","ssn":"XXXXXXXXX","terms_accepted":true,"meta_data":[{"name":"external_ref","value":"customer-001"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"92dcfca0-ba61-473c-a27d-4c00be0f32d9":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","required":["status","message"],"properties":{"status":{"type":"string","enum":["success"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"operation completed","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","description":"Endpoint-specific payload; shape varies per operation.","properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"string","description":"User entity id; prefix `user-`.","example":"user-8f3a2b1c-0e44-4f2d-9a11-7b23cc90d1ef","uniqueKey":"data.\\items.items.[INDEX].id","typeLabel":"string"},"uuid":{"type":"string","uniqueKey":"data.\\items.items.[INDEX].uuid","typeLabel":"string"},"first_name":{"type":"string","example":"Jane","uniqueKey":"data.\\items.items.[INDEX].first_name","typeLabel":"string"},"middle_name":{"type":"string","uniqueKey":"data.\\items.items.[INDEX].middle_name","typeLabel":"string"},"last_name":{"type":"string","example":"Doe","uniqueKey":"data.\\items.items.[INDEX].last_name","typeLabel":"string"},"email":{"type":"string","format":"email","example":"jane.doe@example.com","uniqueKey":"data.\\items.items.[INDEX].email","typeLabel":"string\u003cemail>"},"phone_number":{"type":"string","example":"+12125551234","uniqueKey":"data.\\items.items.[INDEX].phone_number","typeLabel":"string"},"date_of_birth":{"type":"string","format":"date","example":"1990-04-15","uniqueKey":"data.\\items.items.[INDEX].date_of_birth","typeLabel":"string\u003cdate>"},"address_one":{"type":"string","uniqueKey":"data.\\items.items.[INDEX].address_one","typeLabel":"string"},"address_two":{"type":"string","uniqueKey":"data.\\items.items.[INDEX].address_two","typeLabel":"string"},"city":{"type":"string","uniqueKey":"data.\\items.items.[INDEX].city","typeLabel":"string"},"state":{"type":"string","uniqueKey":"data.\\items.items.[INDEX].state","typeLabel":"string"},"country":{"type":"string","uniqueKey":"data.\\items.items.[INDEX].country","typeLabel":"string"},"postal_code":{"type":"string","uniqueKey":"data.\\items.items.[INDEX].postal_code","typeLabel":"string"},"ssn_last_4":{"type":"string","example":"6789","uniqueKey":"data.\\items.items.[INDEX].ssn_last_4","typeLabel":"string"},"status":{"type":"string","example":"active","uniqueKey":"data.\\items.items.[INDEX].status","typeLabel":"string"},"kyc_status":{"type":"string","example":"verified","uniqueKey":"data.\\items.items.[INDEX].kyc_status","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","example":"2026-04-16T12:34:56.000Z","uniqueKey":"data.\\items.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","example":"2026-04-16T12:34:56.000Z","uniqueKey":"data.\\items.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data.\\items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.\\items","typeLabel":"object[]"},"pagination":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"example":1,"uniqueKey":"data.pagination.page","typeLabel":"integer"},"per_page":{"type":"integer","minimum":1,"maximum":500,"example":25,"uniqueKey":"data.pagination.per_page","typeLabel":"integer"},"total":{"type":"integer","example":100,"uniqueKey":"data.pagination.total","typeLabel":"integer"},"sort":{"type":"string","example":"created_at:desc","uniqueKey":"data.pagination.sort","typeLabel":"string"},"search":{"type":"string","example":"jane","uniqueKey":"data.pagination.search","typeLabel":"string"}},"uniqueKey":"data.pagination","typeLabel":"object"}},"additionalProperties":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"success","message":"operation completed","data":{"items":[{"id":"user-8f3a2b1c-0e44-4f2d-9a11-7b23cc90d1ef","uuid":"\u003cstring>","first_name":"Jane","middle_name":"\u003cstring>","last_name":"Doe","email":"jane.doe@example.com","phone_number":"+12125551234","date_of_birth":"1990-04-15","address_one":"\u003cstring>","address_two":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","country":"\u003cstring>","postal_code":"\u003cstring>","ssn_last_4":"6789","status":"active","kyc_status":"verified","created_at":"2026-04-16T12:34:56.000Z","updated_at":"2026-04-16T12:34:56.000Z"}],"pagination":{"page":1,"per_page":25,"total":100,"sort":"created_at:desc","search":"jane"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"7df6ba91-b244-4594-8355-356987554c89":{"description":"Validation or business-rule error.","content":{"application/json":{"schema":{"type":"object","required":["status","message"],"properties":{"status":{"type":"string","enum":["error"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"Something went wrong","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"data":{"description":"Optional error context (for example validation field errors or missing ids).","uniqueKey":"data","typeLabel":"any"},"status_code":{"type":"object","description":"Structured error code family (1000 to 1060).","properties":{"status_code":{"type":"integer","example":1000,"uniqueKey":"status_code.status_code","typeLabel":"integer"},"error_type":{"type":"string","enum":["NOT_FOUND","INVALID_STATE","VALIDATION","SYSTEM_ERROR","SECURITY","PROCESSING"],"uniqueKey":"status_code.error_type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"Resource not found","uniqueKey":"status_code.message","typeLabel":"string"},"description":{"type":"string","example":"The requested resource does not exist","uniqueKey":"status_code.description","typeLabel":"string"}},"uniqueKey":"status_code","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","message":"Something went wrong","data":"\u003cunknown>","status_code":{"status_code":1000,"error_type":"NOT_FOUND","message":"Resource not found","description":"The requested resource does not exist"}}}},"exampleType":"generated"}},"exampleType":"generated"},"3261fad9-3818-41a9-8195-399ee1bda01f":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","required":["status","message"],"properties":{"status":{"type":"string","enum":["error"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"Something went wrong","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"data":{"description":"Optional error context (for example validation field errors or missing ids).","uniqueKey":"data","typeLabel":"any"},"status_code":{"type":"object","description":"Structured error code family (1000 to 1060).","properties":{"status_code":{"type":"integer","example":1000,"uniqueKey":"status_code.status_code","typeLabel":"integer"},"error_type":{"type":"string","enum":["NOT_FOUND","INVALID_STATE","VALIDATION","SYSTEM_ERROR","SECURITY","PROCESSING"],"uniqueKey":"status_code.error_type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"Resource not found","uniqueKey":"status_code.message","typeLabel":"string"},"description":{"type":"string","example":"The requested resource does not exist","uniqueKey":"status_code.description","typeLabel":"string"}},"uniqueKey":"status_code","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","message":"Something went wrong","data":"\u003cunknown>","status_code":{"status_code":1000,"error_type":"NOT_FOUND","message":"Resource not found","description":"The requested resource does not exist"}}}},"exampleType":"generated"}},"exampleType":"generated"},"0d52b6b4-2d3a-4b2a-9fbe-5e28306151e8":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"type":"object","required":["status","message"],"properties":{"status":{"type":"string","enum":["error"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"Something went wrong","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"data":{"description":"Optional error context (for example validation field errors or missing ids).","uniqueKey":"data","typeLabel":"any"},"status_code":{"type":"object","description":"Structured error code family (1000 to 1060).","properties":{"status_code":{"type":"integer","example":1000,"uniqueKey":"status_code.status_code","typeLabel":"integer"},"error_type":{"type":"string","enum":["NOT_FOUND","INVALID_STATE","VALIDATION","SYSTEM_ERROR","SECURITY","PROCESSING"],"uniqueKey":"status_code.error_type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"Resource not found","uniqueKey":"status_code.message","typeLabel":"string"},"description":{"type":"string","example":"The requested resource does not exist","uniqueKey":"status_code.description","typeLabel":"string"}},"uniqueKey":"status_code","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","message":"Something went wrong","data":"\u003cunknown>","status_code":{"status_code":1000,"error_type":"NOT_FOUND","message":"Resource not found","description":"The requested resource does not exist"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"0deb5c50-703e-45d1-a4a3-033d4f7a8aa5":{"HmacAuth":{"type":"http","scheme":"hmac-sha512","description":"All requests must be authenticated using an HMAC-signed Authorization header. Ingo Money requires HMAC-SHA512 for all new integrations. SHA-512 provides a significantly larger internal state and output length than SHA-256, making it substantially more resistant to length-extension attacks and brute-force preimage attempts — properties that matter for financial API traffic. Legacy integrations using HMAC-SHA256 remain supported but are encouraged to upgrade. MD5 and SHA-1 are not accepted and will be rejected.\n\nAuthorization header format:\n\nAuthorization: hmac username=\"YOUR_HMAC_USERNAME\",\n algorithm=\"hmac-sha512\",\n headers=\"request-line x-date content-type content-length\n content-sha512\",\n signature=\"BASE64_SIGNATURE\"\n\n\nSee the Ingo API Authentication Guide for signature construction details.\n","scopes":[]},"ApiKeyAuth":{"type":"apiKey","in":"header","name":"api_key","description":"Program API key identifying your integration. Pass as the `api_key` HTTP header (preferred) or as an `api_key` field in the JSON request body. Required on every request in addition to the HMAC Authorization header.\n","scopes":[]}}},"servers":{"ef4acdce-d36b-4320-b822-4e6075ab255b":{"url":"https://api.sdev.banking.ingopayments.tech/api/v4","description":"Sandbox"},"db05db77-a1d4-47ca-b121-452af9f44c8a":{"url":"https://api.banking.ingopayments.tech/api/v4","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"hmac-sha512","description":"All requests must be authenticated using an HMAC-signed Authorization header. Ingo Money requires HMAC-SHA512 for all new integrations. SHA-512 provides a significantly larger internal state and output length than SHA-256, making it substantially more resistant to length-extension attacks and brute-force preimage attempts — properties that matter for financial API traffic. Legacy integrations using HMAC-SHA256 remain supported but are encouraged to upgrade. MD5 and SHA-1 are not accepted and will be rejected.\n\nAuthorization header format:\n\nAuthorization: hmac username=\"YOUR_HMAC_USERNAME\",\n algorithm=\"hmac-sha512\",\n headers=\"request-line x-date content-type content-length\n content-sha512\",\n signature=\"BASE64_SIGNATURE\"\n\n\nSee the Ingo API Authentication Guide for signature construction details.\n","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"All requests must be authenticated using an HMAC-signed Authorization header. Ingo Money requires HMAC-SHA512 for all new integrations. SHA-512 provides a significantly larger internal state and output length than SHA-256, making it substantially more resistant to length-extension attacks and brute-force preimage attempts — properties that matter for financial API traffic. Legacy integrations using HMAC-SHA256 remain supported but are encouraged to upgrade. MD5 and SHA-1 are not accepted and will be rejected.\n\nAuthorization header format:\n\nAuthorization: hmac username=\"YOUR_HMAC_USERNAME\",\n algorithm=\"hmac-sha512\",\n headers=\"request-line x-date content-type content-length\n content-sha512\",\n signature=\"BASE64_SIGNATURE\"\n\n\nSee the Ingo API Authentication Guide for signature construction details.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"HmacAuth","name":"Authorization"},{"scheme":{"type":"apiKey","in":"header","name":"api_key","description":"Program API key identifying your integration. Pass as the `api_key` HTTP header (preferred) or as an `api_key` field in the JSON request body. Required on every request in addition to the HMAC Authorization header.\n","scopes":[]},"schema":{"title":"api_key","type":"string","description":"Program API key identifying your integration. Pass as the `api_key` HTTP header (preferred) or as an `api_key` field in the JSON request body. Required on every request in addition to the HMAC Authorization header.\n","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"api_key"}],"title":"HmacAuth \u0026 ApiKeyAuth"}]},"originalFileLocation":"specs/ingo-banking-merchant-ledgering.yaml"},"subdomain":"ingopayments","siteName":"Ingo Payments Developer Hub","title":"Create User - Ingo Payments Developer Hub","contextualStarterQuestions":[{"_id":"69f1320d20d5d5d066b6f5ac","deploymentId":"69de7f66155c3ba96bc71012","questionText":"How do I create a new user?","status":"active","generatedBy":"contextual","path":"docs/banking/onboarding/create-user","createdAt":"2026-04-28T22:17:49.098Z","updatedAt":"2026-04-28T22:17:49.098Z","__v":0},{"_id":"69f1320d20d5d5d066b6f5ae","deploymentId":"69de7f66155c3ba96bc71012","questionText":"Can I bulk create users?","status":"active","generatedBy":"contextual","path":"docs/banking/onboarding/create-user","createdAt":"2026-04-28T22:17:49.098Z","updatedAt":"2026-04-28T22:17:49.098Z","__v":0},{"_id":"69f1320d20d5d5d066b6f5ad","deploymentId":"69de7f66155c3ba96bc71012","questionText":"What user data is required?","status":"active","generatedBy":"contextual","path":"docs/banking/onboarding/create-user","createdAt":"2026-04-28T22:17:49.098Z","updatedAt":"2026-04-28T22:17:49.098Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-28T22:17:29.674Z","originalFileLocation":"docs/banking/onboarding/create-user.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=\"dark\"}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=\"Create an individual user entity within your program.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ingo Payments Developer Hub\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ingopayments/iHiCiEx6lpf9Tbeq/_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/ingopayments/iHiCiEx6lpf9Tbeq/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ingopayments/iHiCiEx6lpf9Tbeq/_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/ingopayments/iHiCiEx6lpf9Tbeq/_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/ingopayments/iHiCiEx6lpf9Tbeq/_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/ingopayments/iHiCiEx6lpf9Tbeq/_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/ingopayments/iHiCiEx6lpf9Tbeq/_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/ingopayments/iHiCiEx6lpf9Tbeq/_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/ingopayments/iHiCiEx6lpf9Tbeq/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create User - Ingo Payments Developer Hub\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create an individual user entity within your program.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ingo Payments Developer Hub\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.ingopayments.com/docs/banking/onboarding/create-user\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ingopayments.mintlify.app/_mintlify/api/og/v2?division=Onboarding\u0026amp;title=Create+User\u0026amp;description=Create+an+individual+user+entity+within+your+program.\u0026amp;theme=ffb6732ea583e2d7404edaa7\u0026amp;signature=23287b745d04fdde85c629f08dc4f8f688962438b934340a10107e97a3be2965\">\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 User - Ingo Payments Developer Hub\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create an individual user entity within your program.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ingopayments.mintlify.app/_mintlify/api/og/v2?division=Onboarding\u0026amp;title=Create+User\u0026amp;description=Create+an+individual+user+entity+within+your+program.\u0026amp;theme=ffb6732ea583e2d7404edaa7\u0026amp;signature=23287b745d04fdde85c629f08dc4f8f688962438b934340a10107e97a3be2965\">\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/ingopayments/iHiCiEx6lpf9Tbeq/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ingo Payments Developer Hub\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#23ad4b\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.ingopayments.com/docs/banking/onboarding/create-user\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/banking/onboarding/create-user.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.ingopayments.com/#organization\",\"name\":\"Ingo Payments Developer Hub\",\"url\":\"https://developers.ingopayments.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ingopayments/iShoHhbLzbG-YOtN/logo/light.svg?fit=max\u0026auto=format\u0026n=iShoHhbLzbG-YOtN\u0026q=85\u0026s=556c65165f3a5daf3e33eaf145664046\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.ingopayments.com#website\",\"name\":\"Ingo Payments Developer Hub\",\"url\":\"https://developers.ingopayments.com\",\"publisher\":{\"@id\":\"https://developers.ingopayments.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.ingopayments.com/docs/banking/onboarding/create-user#webpage\",\"url\":\"https://developers.ingopayments.com/docs/banking/onboarding/create-user\",\"name\":\"Create User\",\"description\":\"Create an individual user entity within your program.\",\"dateModified\":\"2026-04-28T22:17:29.674Z\",\"isPartOf\":{\"@id\":\"https://developers.ingopayments.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.ingopayments.com/docs/banking/onboarding/create-user#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.ingopayments.com/docs/banking/onboarding/create-user#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Ingo Payments Developer Hub\",\"item\":\"https://developers.ingopayments.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create User\",\"item\":\"https://developers.ingopayments.com/docs/banking/onboarding/create-user\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.ingopayments.com/docs/banking/onboarding/create-user#apireference\",\"headline\":\"Create User\",\"name\":\"Create User\",\"description\":\"Create an individual user entity within your program.\",\"url\":\"https://developers.ingopayments.com/docs/banking/onboarding/create-user\",\"mainEntityOfPage\":{\"@id\":\"https://developers.ingopayments.com/docs/banking/onboarding/create-user#webpage\"},\"dateModified\":\"2026-04-28T22:17:29.674Z\",\"publisher\":{\"@id\":\"https://developers.ingopayments.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.ingopayments.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ingo Payments Developer Hub\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Ingo Payments Developer Hub","nav":{"global":{},"tabs":[{"tab":"Hub","pages":[{"title":"Hub","href":"/docs/hub/overview"}]},{"tab":"IngoPay API","pages":[{"title":"IngoPay API","href":"/docs/ingopay/overview"}]},{"tab":"Embedded Account Capture","pages":[{"title":"Embedded Account Capture","href":"/docs/iframe/overview"}]},{"tab":"Notify — Classic","pages":[{"title":"Notify — Classic","href":"/docs/notify-classic/overview"}]},{"tab":"Notify — Managed Parties","pages":[{"title":"Notify — Managed Parties","href":"/docs/notify-managed/overview"}]},{"tab":"Banking Platform","groups":[{"group":"Overview","pages":[{"title":"Banking Platform","mode":"wide","href":"/docs/banking/overview"},{"title":"Quick Start","description":"Create a user, complete KYC verification, and issue a routable bank account.","href":"/docs/banking/quick-start"}]},{"group":"API Reference","pages":[{"group":"Onboarding","expanded":false,"pages":[{"title":"Create User","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /user/create","href":"/docs/banking/onboarding/create-user"},{"title":"Create Business","description":"Create a business entity and link it to a representative user.","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/create","href":"/docs/banking/onboarding/create-business"},{"title":"Verify User (KYC)","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /user/send-verification-request","href":"/docs/banking/onboarding/verify-user"},{"title":"Verify Business (KYB)","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/send-verification-request","href":"/docs/banking/onboarding/verify-business"}]},{"group":"User Management","expanded":false,"pages":[{"title":"Get User","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /user/get","href":"/docs/banking/users/get"},{"title":"List Users","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /user/get-all","href":"/docs/banking/users/list"},{"title":"Update User","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /user/update","href":"/docs/banking/users/update"},{"title":"Check Verification Status","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /user/check-verification-request","href":"/docs/banking/users/check-verification"},{"title":"Block User","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /user/block","href":"/docs/banking/users/block"},{"title":"Unblock User","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /user/unblock","href":"/docs/banking/users/unblock"}]},{"group":"Business Management","expanded":false,"pages":[{"title":"Get Business","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/get","href":"/docs/banking/businesses/get"},{"title":"List Businesses","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/program/get-all","href":"/docs/banking/businesses/list"},{"title":"Update Business","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/update","href":"/docs/banking/businesses/update"},{"title":"Update Business Representative","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/update-business-rep","href":"/docs/banking/businesses/update-rep"},{"title":"Block Business","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/block","href":"/docs/banking/businesses/block"},{"title":"Unblock Business","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/unblock","href":"/docs/banking/businesses/unblock"},{"title":"List Business Contacts","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/customers/get-all","href":"/docs/banking/businesses/list-contacts"},{"title":"Get Business Contact","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/customers/get-single","href":"/docs/banking/businesses/get-contact"}]},{"group":"Business Owners \u0026 Documents","expanded":false,"pages":[{"title":"List Business Owners","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/get-business-owners","href":"/docs/banking/owners-documents/list-owners"},{"title":"Add Business Owner","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/add-business-owner","href":"/docs/banking/owners-documents/add-owner"},{"title":"Remove Business Owner","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/delete-business-owner","href":"/docs/banking/owners-documents/remove-owner"},{"title":"List Owner Documents","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/get-business-owner-documents","href":"/docs/banking/owners-documents/list-owner-documents"},{"title":"Upload Owner Document","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/add-business-owner-document","href":"/docs/banking/owners-documents/upload-owner-document"},{"title":"Remove Owner Document","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/delete-business-owner-document","href":"/docs/banking/owners-documents/remove-owner-document"},{"title":"List Business Documents","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/get-business-documents","href":"/docs/banking/owners-documents/list-business-documents"},{"title":"Upload Business Document","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/add-business-document","href":"/docs/banking/owners-documents/upload-business-document"},{"title":"Remove Business Document","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/delete-business-document","href":"/docs/banking/owners-documents/remove-business-document"}]},{"group":"Accounts","expanded":false,"pages":[{"title":"Issue Routable Bank Account","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/routable-bank-accounts/issue","href":"/docs/banking/accounts/issue-rba"},{"title":"Link External Bank Account","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /users/bank-accounts/save","href":"/docs/banking/accounts/link-bank-account"}]},{"group":"Routable Bank Accounts","expanded":false,"pages":[{"title":"Get Routable Account","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/routable-bank-accounts/get-single","href":"/docs/banking/routable-accounts/get"},{"title":"List Routable Accounts","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/routable-bank-accounts/get-all","href":"/docs/banking/routable-accounts/list"},{"title":"Get Program Routable Account","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /program/routable-bank-accounts/get","href":"/docs/banking/routable-accounts/get-program"}]},{"group":"Balance","expanded":false,"pages":[{"title":"Balance-Program","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /balance/program-master-rba","href":"/docs/banking/money/balance-program"},{"title":"Balance-Business","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /balance/business","href":"/docs/banking/money/balance-business"},{"title":"Balance-User","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /balance/user","href":"/docs/banking/money/balance-user"}]},{"group":"Transactions \u0026 Reporting","expanded":false,"pages":[{"title":"List Business Transactions","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /transactions/business","href":"/docs/banking/transactions/list-business"},{"title":"Get Transaction","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /transactions/single","href":"/docs/banking/transactions/get-single"},{"title":"List Program Transactions","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /transactions/program","href":"/docs/banking/transactions/list-program"},{"title":"List Program RBA Transactions","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /transactions/program-rba","href":"/docs/banking/transactions/list-program-rba"},{"title":"List Contact Transactions","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /transactions/business-contacts","href":"/docs/banking/transactions/list-contacts"},{"title":"Download Transaction Report","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /transactions/report","href":"/docs/banking/transactions/download-report"},{"title":"List Payment Intents","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /payment-intent/program/all","href":"/docs/banking/transactions/list-payment-intents"},{"title":"Program Transaction Summary","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /balance/program-transaction-summary","href":"/docs/banking/transactions/program-summary"}]},{"group":"Metadata","expanded":false,"pages":[{"title":"Add Metadata","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/meta-data/add","href":"/docs/banking/metadata/add"},{"title":"List Metadata","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /metadata/business/get-all","href":"/docs/banking/metadata/list"},{"title":"Update Metadata","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /metadata/update","href":"/docs/banking/metadata/update"}]},{"group":"Program Management","expanded":false,"pages":[{"title":"List Program Bank Accounts","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /program/bank-accounts/get-all","href":"/docs/banking/program/list-bank-accounts"},{"title":"Save Program Bank Account","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /program/bank-accounts/save","href":"/docs/banking/program/save-bank-account"},{"title":"Remove Program Bank Account","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /program/bank-accounts/remove","href":"/docs/banking/program/remove-bank-account"},{"title":"Fund Program Routable Account","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /program/charge-program-bank-account-fund-program-routable-bank-account","href":"/docs/banking/program/fund-rba"},{"title":"List Funds Advanced","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /program/funds-lent/get","href":"/docs/banking/program/list-funds-advanced"},{"title":"Mark Advance as Paid","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /program/funds-lent/mark-as-paid","href":"/docs/banking/program/mark-advance-paid"},{"title":"Book Transfer","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /book-transfer/routable-bank-account-to-routable-bank-account-transfer","href":"/docs/banking/program/book-transfer"}]},{"group":"Card Issuance","hidden":true,"expanded":false,"pages":[{"title":"Issue User Card","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /user/routable-cards/create","href":"/docs/banking/cards/user-issue"},{"title":"Get User Card","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /user/routable-cards/get-single","href":"/docs/banking/cards/user-get"},{"title":"List User Cards","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /user/routable-cards/get-all","href":"/docs/banking/cards/user-list"},{"title":"Activate User Card","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /user/routable-cards/activate","href":"/docs/banking/cards/user-activate"},{"title":"Freeze User Card","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /user/routable-cards/freeze","href":"/docs/banking/cards/user-freeze"},{"title":"Unfreeze User Card","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /user/routable-cards/unfreeze","href":"/docs/banking/cards/user-unfreeze"},{"title":"Reissue User Card","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /user/routable-cards/reissue","href":"/docs/banking/cards/user-reissue"},{"title":"Get User Card Balance","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /user/routable-cards/balance","href":"/docs/banking/cards/user-balance"},{"title":"Issue Business Card","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/routable-cards/create","href":"/docs/banking/cards/business-issue"},{"title":"Get Business Card","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/routable-cards/get-single","href":"/docs/banking/cards/business-get"},{"title":"List Business Cards","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/routable-cards/get-all","href":"/docs/banking/cards/business-list"},{"title":"Activate Business Card","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/routable-cards/activate","href":"/docs/banking/cards/business-activate"},{"title":"Freeze Business Card","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/routable-cards/freeze","href":"/docs/banking/cards/business-freeze"},{"title":"Unfreeze Business Card","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/routable-cards/unfreeze","href":"/docs/banking/cards/business-unfreeze"},{"title":"Reissue Business Card","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/routable-cards/reissue","href":"/docs/banking/cards/business-reissue"},{"title":"Get Business Card Balance","openapi":"specs/ingo-banking-merchant-ledgering.yaml POST /business/routable-cards/balance","href":"/docs/banking/cards/business-balance"}]}]},{"group":"Webhooks","pages":[{"title":"Webhooks","sidebarTitle":"Overview","href":"/docs/banking/webhooks/overview"},{"group":"User Events","pages":[{"asyncapi":"specs/asyncapi-banking.yaml UserCreated","href":"/banking-webhooks/user-events/user-created","title":"User Created","version":null},{"asyncapi":"specs/asyncapi-banking.yaml UserKycSuccess","href":"/banking-webhooks/user-events/user-kyc-success","title":"User KYC Success","version":null},{"asyncapi":"specs/asyncapi-banking.yaml UserKycFailed","href":"/banking-webhooks/user-events/user-kyc-failed","title":"User KYC Failed","version":null}]},{"group":"Business Events","pages":[{"asyncapi":"specs/asyncapi-banking.yaml BusinessCreated","href":"/banking-webhooks/business-events/business-created","title":"Business Created","version":null},{"asyncapi":"specs/asyncapi-banking.yaml BusinessKybSuccess","href":"/banking-webhooks/business-events/business-kyb-success","title":"Business KYB Success","version":null},{"asyncapi":"specs/asyncapi-banking.yaml BusinessKybFailed","href":"/banking-webhooks/business-events/business-kyb-failed","title":"Business KYB Failed","version":null}]},{"group":"Wallet Events","pages":[{"asyncapi":"specs/asyncapi-banking.yaml WalletCreated","href":"/banking-webhooks/wallet-events/wallet-created","title":"Wallet Created","version":null},{"asyncapi":"specs/asyncapi-banking.yaml WalletTopupSuccess","href":"/banking-webhooks/wallet-events/wallet-top-up-success","title":"Wallet Top-Up Success","version":null},{"asyncapi":"specs/asyncapi-banking.yaml WalletTopupFailed","href":"/banking-webhooks/wallet-events/wallet-top-up-failed","title":"Wallet Top-Up Failed","version":null}]},{"group":"Account Lifecycle","pages":[{"asyncapi":"specs/asyncapi-banking.yaml AccountCreated","href":"/banking-webhooks/account-lifecycle/account-created","title":"Account Created","version":null},{"asyncapi":"specs/asyncapi-banking.yaml AccountSaved","href":"/banking-webhooks/account-lifecycle/account-saved","title":"Account Saved","version":null},{"asyncapi":"specs/asyncapi-banking.yaml AccountLinkCreated","href":"/banking-webhooks/account-lifecycle/account-link-created","title":"Account Link Created","version":null},{"asyncapi":"specs/asyncapi-banking.yaml AccountLinkDeleted","href":"/banking-webhooks/account-lifecycle/account-link-deleted","title":"Account Link Deleted","version":null},{"asyncapi":"specs/asyncapi-banking.yaml AccountIssueCreated","href":"/banking-webhooks/account-lifecycle/account-issue-created","title":"Account Issue Created","version":null},{"asyncapi":"specs/asyncapi-banking.yaml AccountIssueFailed","href":"/banking-webhooks/account-lifecycle/account-issue-failed","title":"Account Issue Failed","version":null}]},{"group":"Account Assignment","pages":[{"asyncapi":"specs/asyncapi-banking.yaml AccountAssignmentSuccess","href":"/banking-webhooks/account-assignment/account-assignment-success","title":"Account Assignment Success","version":null},{"asyncapi":"specs/asyncapi-banking.yaml AccountAssignmentFailed","href":"/banking-webhooks/account-assignment/account-assignment-failed","title":"Account Assignment Failed","version":null}]},{"group":"Transfer Events","pages":[{"asyncapi":"specs/asyncapi-banking.yaml AccountTransferCreated","href":"/banking-webhooks/transfer-events/account-transfer-created","title":"Account Transfer Created","version":null},{"asyncapi":"specs/asyncapi-banking.yaml AccountTransferCompleted","href":"/banking-webhooks/transfer-events/account-transfer-completed","title":"Account Transfer Completed","version":null},{"asyncapi":"specs/asyncapi-banking.yaml AccountTransferReversed","href":"/banking-webhooks/transfer-events/account-transfer-reversed","title":"Account Transfer Reversed","version":null},{"asyncapi":"specs/asyncapi-banking.yaml AccountTransferBlocked","href":"/banking-webhooks/transfer-events/account-transfer-blocked","title":"Account Transfer Blocked","version":null},{"asyncapi":"specs/asyncapi-banking.yaml AccountTransferFailed","href":"/banking-webhooks/transfer-events/account-transfer-failed","title":"Account Transfer Failed","version":null},{"asyncapi":"specs/asyncapi-banking.yaml AccountTransferReturned","href":"/banking-webhooks/transfer-events/account-transfer-returned","title":"Account Transfer Returned","version":null},{"asyncapi":"specs/asyncapi-banking.yaml AccountOverdraftCreated","href":"/banking-webhooks/transfer-events/account-overdraft-created","title":"Account Overdraft Created","version":null},{"asyncapi":"specs/asyncapi-banking.yaml AccountTransferException","href":"/banking-webhooks/transfer-events/account-transfer-exception","title":"Account Transfer Exception","version":null}]}]}]},{"tab":"Check Risk Management Services","hidden":true,"pages":[{"title":"Check Risk Management Services","href":"/docs/crms/overview"}]}]},"title":"Create User - Ingo Payments Developer Hub","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-CBCH2P7b.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}