Creation can outlast the request. When it does, the response is 202 with the id the customer will have, and the customer reads as 404 until creation finishes. Repeat the same request with the same Idempotency-Key to follow it: the repeat answers 202 while creation is still running and 201 with the customer once it is done.
Client-supplied request key. Required on all non-auth POST requests.
Maximum string length: 256
Body
application/json
Create a new customer. Individuals require firstName and lastName. Businesses require companyLegalName and email, and do not accept person-name fields. PII fields (birthDate, residentialAddress, ipAddress, identifyingInformation) are write-only and never returned in responses. Whether identity verification is required, and whether OMS relies on your attestation or a vendor verifies, is configured per project, not per request.
Customer response object. PII fields (birthDate, residentialAddress, ipAddress, identifyingInformation) are write-only — accepted in POST/PATCH but never returned in responses.
Where the customer is in onboarding. actionRequired carries a hold saying what to do, and rejected carries a failure. offboarded is a deleted or deactivated customer.
USD rollup of a customer's balances. Returned on GET /customers/{id} only — never on list, create, or update. Covers fiat wallets and custodial crypto wallets; noncustodial wallets are not yet valued, so a customer holding one reads an undercount here. Omitted entirely when the rollup cannot be read; a partial total is never returned, so treat an absent field as "unknown", not as zero.
Sum of the customer's USD fiat wallet balances as last reported by the holding bank. Can be negative — an ACH clawback can overdraw a deposit account — so render the sign verbatim and never clamp.
Sum of the customer's custodial crypto wallet balances at the custodian's own per-asset USD estimate. "0.00" for a customer with no custodial crypto account.
When the custodial wallet provider last updated the crypto balances in cryptoUsd: the newest per-asset timestamp the provider reports across those balances, read live with this request. Fiat balances do not affect it. Omitted when the provider reports no timestamp, for example when the customer holds no custodial crypto wallet.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Polygon Developer Docs","colors":{"primary":"#670DE5","light":"#9551F5","dark":"#500AB2"},"logo":{"light":"https://mintcdn.com/polygon-labs/ll1LL3IdpC3YxXZu/logo/light.svg?fit=max\u0026auto=format\u0026n=ll1LL3IdpC3YxXZu\u0026q=85\u0026s=d54ddb30492807a0eadf38093c075f2f","dark":"https://mintcdn.com/polygon-labs/ll1LL3IdpC3YxXZu/logo/dark.svg?fit=max\u0026auto=format\u0026n=ll1LL3IdpC3YxXZu\u0026q=85\u0026s=3b2b67f82ff1720328da11b176a86499"},"favicon":"https://mintcdn.com/polygon-labs/Xy_MJE0q00vmTroE/favicon.svg?fit=max\u0026auto=format\u0026n=Xy_MJE0q00vmTroE\u0026q=85\u0026s=3c26f9a9ab4a7a50ac3da5c9ad26c954","api":{"openapi":"api-reference/openapi.yaml","params":{"expanded":"all"},"playground":{"display":"interactive"},"mdx":{"server":["https://sandbox-api.polygon.technology/v0.13","https://api.polygon.technology/v0.13"]}},"appearance":{"default":"light"},"navbar":{"links":[{"href":"/resources/build-with-ai","label":"Build with AI"},{"href":"https://polygon.technology/get-access?utm_source=docs\u0026utm_medium=navbar\u0026utm_campaign=oms_access","label":"Request OMS Access"}]},"footer":{"socials":{"x":"https://x.com/0xPolygon","github":"https://github.com/0xPolygon","linkedin":"https://www.linkedin.com/company/polygonlabs","discord":"https://discord.com/invite/polygon-support-635865020172861441"},"links":[{"items":[{"label":"Support","href":"https://support.polygon.technology/support/home"}]}]},"fonts":{"family":"Fustat"},"integrations":{"ga4":{"measurementId":"G-RJ6JC0EEY5"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"polygon-labs","hasAudioNarration":false,"actualSubdomain":"polygon-labs","customDomains":["docs.polygon.technology"],"gitSource":{"type":"github","owner":"0xpolygon","repo":"new-polygon-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"contextualFeedback":{"allowEmail":true},"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af4bdb4c5d18096e680b150","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"Polygon Chain","count":385},{"language":"default","tag":"Wallets","count":174},{"language":"default","tag":"Developer Tools","count":94},{"language":"default","tag":"API Reference","count":86},{"language":"default","tag":"Agglayer","count":73},{"language":"default","tag":"Platform","count":71},{"language":"default","tag":"SDK","count":62},{"language":"default","tag":"Non-custodial","count":60},{"language":"default","tag":"Matic.js","count":59},{"language":"default","tag":"Guides","count":48}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@polygon.technology","showHelpButton":true}},"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":"llms-txt-v2","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}],"starterQuestions":[{"_id":"69cbd3d67f226f107dbd9b72","deploymentId":"69a9bcc427671ec5a2e05f92","questionText":"Can I move assets between different chains with OMS?","status":"active","generatedBy":"manual","createdAt":"2026-03-31T14:01:58.134Z","updatedAt":"2026-03-31T14:01:58.134Z","__v":0},{"_id":"69cbd3b07f226f107dbd9a9b","deploymentId":"69a9bcc427671ec5a2e05f92","questionText":"What are my options for integrating a wallet?","status":"active","generatedBy":"manual","createdAt":"2026-03-31T14:01:20.206Z","updatedAt":"2026-03-31T14:01:20.206Z","__v":0},{"_id":"69cbd3737f226f107dbd9910","deploymentId":"69a9bcc427671ec5a2e05f92","questionText":"How does KYC / KYB work in OMS?","status":"active","generatedBy":"manual","createdAt":"2026-03-31T14:00:19.974Z","updatedAt":"2026-03-31T14:00:19.974Z","__v":0}],"googleFontsInlined":true},"customCss":[{"filePath":"custom.css","content":".nav-tabs{gap:0!important;align-items:center!important}div:has(>.nav-tabs){height:58px!important}.nav-tabs a.nav-tabs-item{padding:7px 12px!important;font-size:14px;font-weight:500;color:#64708F!important;transition:color 120ms ease, background 120ms ease}.nav-tabs a.nav-tabs-item:hover{color:#141635!important}html.dark .nav-tabs a.nav-tabs-item{color:rgba(255, 255, 255, 0.55)!important}html.dark .nav-tabs a.nav-tabs-item:hover{color:#fff!important}.fam-grp{display:inline-flex;align-items:center;gap:4px}.fam-gap{width:1px;height:22px;background:#DFE3F0;margin:0 16px;flex-shrink:0}.fam-grp .nav-tabs-item>div{display:none!important}.fam-grp .nav-tabs-item{padding:7px 12px!important;border-radius:8px;font-size:14px;font-weight:500;color:#64708F!important;white-space:nowrap;text-decoration:none;transition:color 120ms ease, background 120ms ease!important}.fam-grp .nav-tabs-item:hover{color:#141635!important}.fam-grp .nav-tabs-item.fam-active-tab{background:#EAE4F5!important;color:#500AB2!important;font-weight:500!important}.fam-grp .nav-tabs-item.fam-active-tab svg{color:#500AB2!important}html.dark .fam-gap{background:rgba(255, 255, 255, 0.14)}html.dark .fam-grp .nav-tabs-item{color:rgba(255, 255, 255, 0.55)!important}html.dark .fam-grp .nav-tabs-item:hover{color:#fff!important}html.dark .fam-grp .nav-tabs-item.fam-active-tab{background:rgba(103, 13, 229, 0.22)!important;color:#A78BFA!important}html.dark .fam-grp .nav-tabs-item.fam-active-tab svg{color:#A78BFA!important}#navbar a[href*=\"build-with-ai\"]{background:#fff!important;color:#141635!important;border:1px solid #C8CFE1!important;font-weight:600!important;transition:border-color 140ms ease, background 140ms ease!important}#navbar a[href*=\"build-with-ai\"]:hover{border-color:#141635!important;background:#F6F6FC!important}html.dark #navbar a[href*=\"build-with-ai\"]{background:transparent!important;color:#fff!important;border-color:rgba(255, 255, 255, 0.25)!important}html.dark #navbar a[href*=\"build-with-ai\"]:hover{border-color:#fff!important;background:rgba(255, 255, 255, 0.06)!important}#navbar a[href*=\"get-access\"]{background:#0B0814!important;color:#fff!important;border:1px solid #0B0814!important;transition:background 140ms ease!important}#navbar a[href*=\"get-access\"]:hover{background:#2A2640!important}html.dark #navbar a[href*=\"get-access\"]{background:#FFFFFF!important;color:#0B0814!important;border-color:#FFFFFF!important}html.dark #navbar a[href*=\"get-access\"]:hover{background:#E5E7EB!important;border-color:#E5E7EB!important}#sidebar-content a.text-primary,#sidebar-content a[class*=\"text-primary-light\"]{background-color:transparent!important}#sidebar-content a:not(.text-primary):not([class*=\"text-primary-light\"]):hover{background-color:rgba(103, 13, 229, 0.06)!important}#content-area:has(.api-section) #page-title{font-size:1.75rem;line-height:2.25rem}#content-area:has(.api-section) #header .prose{font-size:0.9375rem;line-height:1.6}@container page-header (min-width: 520px){#content-area:has(.api-section) #header:has(.eyebrow) .eyebrow{display:flex;align-items:center;min-height:2.25rem;padding-right:11rem}#content-area:has(.api-section) #header:has(.eyebrow) .eyebrow~div:has(#page-context-menu){position:static}#content-area:has(.api-section) #header:has(.eyebrow) .eyebrow~div #page-context-menu{position:absolute;top:0;right:0;margin:0}}.api-section[data-api-section=\"authorizations\"]:has(+.api-section[data-api-section=\"headers\"]) .api-section-heading-title{font-size:0}.api-section[data-api-section=\"authorizations\"]:has(+.api-section[data-api-section=\"headers\"]) .api-section-heading-title::after{content:\"Authorization and headers\";font-size:1.125rem}.api-section[data-api-section=\"authorizations\"]+.api-section[data-api-section=\"headers\"] .api-section-heading{display:none}.api-section[data-api-section=\"authorizations\"]:has(+.api-section[data-api-section=\"headers\"]) .primitive-param-field:last-child{border-bottom-width:1px}.api-section .api-section-heading .border-b,.api-section .primitive-param-field{border-color:#D1D5DB}html.dark .api-section .api-section-heading .border-b,html.dark .api-section .primitive-param-field{border-color:#374151}.api-section .primitive-param-field>.py-6{padding-top:0.875rem;padding-bottom:0.875rem}.api-section .primitive-param-field .mt-4{margin-top:0.5rem}@media (min-width: 1600px){#body-content:has(.api-section){max-width:1760px}#body-content:has(.api-section) #content-container{max-width:1440px}}"},{"filePath":"oms-visuals.css","content":"@font-face{font-family:\"Fustat\";src:url(\"/fonts/Fustat-VariableFont_wght.woff2\") format(\"woff2\");font-weight:200 900;font-style:normal;font-display:swap}@font-face{font-family:\"Geist Mono\";src:url(\"/fonts/GeistMono-VariableFont_wght.woff2\") format(\"woff2\");font-weight:100 900;font-style:normal;font-display:swap}.oms-v{--oms-purple-50: #f6f3fb;--oms-purple-100: #eae4f5;--oms-purple-200: #d5c4f2;--oms-purple-300: #b78eef;--oms-purple-400: #9551f5;--oms-purple-500: #670de5;--oms-purple-600: #500ab2;--oms-purple-700: #400a8e;--oms-slate-50: #f6f6fc;--oms-slate-100: #eef0f9;--oms-slate-200: #dfe3f0;--oms-slate-300: #c8cfe1;--oms-slate-400: #929eba;--oms-slate-500: #64708f;--oms-slate-600: #48526f;--oms-slate-700: #363e5c;--oms-slate-800: #222744;--oms-slate-900: #141635;--oms-slate-950: #090624;--oms-btn-primary: #090624;--oms-btn-primary-hover: #222744;--oms-btn-primary-text: #ffffff;--ss-font: \"Fustat\", \"Inter\", system-ui, sans-serif;--ss-mono: \"Geist Mono\", \"JetBrains Mono\", ui-monospace, monospace;--ss-accent: #670de5;--ss-accent-2: #9551f5;--ss-accent-soft: #eae4f5;--ss-accent-text: #500ab2;--ss-canvas: #f6f6fc;--ss-well: #f6f6fc;--ss-surface: #ffffff;--ss-raised: #ffffff;--ss-chrome: #ffffff;--ss-fill: #eef0f9;--ss-line: #c8cfe1;--ss-line-faint: #dfe3f0;--ss-text-strong: #141635;--ss-text: #48526f;--ss-text-faint: #64708f;--ss-icon: #48526f;--ss-icon-faint: #929eba;--ss-ink-1: rgba(20, 22, 53, 0.04);--ss-ink-2: rgba(20, 22, 53, 0.06);--ss-ink-3: rgba(20, 22, 53, 0.08);--ss-ink-4: rgba(20, 22, 53, 0.10);--ss-ink-5: rgba(20, 22, 53, 0.15);--ss-success: #10b981;--ss-success-soft: #ecfdf5;--ss-success-text: #047857;--ss-warning: #b45309;--ss-warning-soft: #fff7ed;--ss-warning-text: #b45309;--ss-danger: #dc2626;--ss-danger-soft: #fef2f2;--ss-danger-text: #b91c1c;--ss-radius-sm: 6px;--ss-radius-md: 8px;--ss-radius-lg: 12px;--ss-radius-window: 12px;--ss-radius-pill: 999px;--ss-shadow-window: 0 0 0 1px rgba(0, 0, 0, 0.06), 0 4px 16px rgba(0, 0, 0, 0.08);--ss-shadow-float: 0px 4px 6px -4px rgba(0, 0, 0, 0.1), 0px 10px 15px -3px rgba(0, 0, 0, 0.1);--ss-shadow-card: 0 1px 2px rgba(0, 0, 0, 0.04);--ss-shadow-hero: 0 0 0 1px rgba(0, 0, 0, 0.06), 0 30px 60px -12px rgba(50, 50, 93, 0.25), 0 18px 36px -18px rgba(0, 0, 0, 0.3);--ss-shadow-lift: 0 0 0 1px rgba(0, 0, 0, 0.04), 0 12px 28px -6px rgba(50, 50, 93, 0.28), 0 6px 12px -6px rgba(0, 0, 0, 0.16);--ss-shadow-satellite: 0 0 0 1px rgba(0, 0, 0, 0.04), 0 14px 32px -8px rgba(50, 50, 93, 0.24), 0 4px 10px -4px rgba(0, 0, 0, 0.1);--ss-shadow-ground: 0 0 0 1px rgba(50, 50, 93, 0.06), 0 24px 48px -24px rgba(50, 50, 93, 0.18);--ss-ease: cubic-bezier(0.16, 1, 0.3, 1);font-family:var(--ss-font);color:var(--ss-text);-webkit-font-smoothing:antialiased}html.dark .oms-v{--oms-btn-primary: #ffffff;--oms-btn-primary-hover: #e5e7eb;--oms-btn-primary-text: #090624;--ss-accent: #9551f5;--ss-accent-2: #b78eef;--ss-accent-soft: rgba(149, 81, 245, 0.16);--ss-accent-text: #b78eef;--ss-canvas: #0b0a10;--ss-well: #131218;--ss-surface: #1a1922;--ss-raised: #23212d;--ss-chrome: #16151d;--ss-fill: #2a2834;--ss-line: rgba(255, 255, 255, 0.10);--ss-line-faint: rgba(255, 255, 255, 0.06);--ss-text-strong: #eef0f9;--ss-text: #c8cfe1;--ss-text-faint: #929eba;--ss-icon: #c8cfe1;--ss-icon-faint: #64708f;--ss-ink-1: rgba(255, 255, 255, 0.05);--ss-ink-2: rgba(255, 255, 255, 0.07);--ss-ink-3: rgba(255, 255, 255, 0.10);--ss-ink-4: rgba(255, 255, 255, 0.13);--ss-ink-5: rgba(255, 255, 255, 0.20);--ss-success: #34d399;--ss-success-soft: rgba(16, 185, 129, 0.16);--ss-success-text: #34d399;--ss-shadow-window: 0 0 0 1px rgba(255, 255, 255, 0.08), 0 4px 16px rgba(0, 0, 0, 0.4);--ss-shadow-float: 0 0 0 1px rgba(255, 255, 255, 0.1), 0 4px 16px rgba(0, 0, 0, 0.4), 0 12px 32px rgba(0, 0, 0, 0.3);--ss-shadow-card: 0 0 0 1px rgba(255, 255, 255, 0.05);--ss-shadow-hero: 0 0 0 1px rgba(255, 255, 255, 0.08), 0 30px 60px -12px rgba(0, 0, 0, 0.6);--ss-shadow-lift: 0 0 0 1px rgba(255, 255, 255, 0.1), 0 12px 28px -6px rgba(0, 0, 0, 0.6);--ss-shadow-satellite: 0 0 0 1px rgba(255, 255, 255, 0.1), 0 14px 32px -8px rgba(0, 0, 0, 0.7), 0 4px 10px -4px rgba(0, 0, 0, 0.5);--ss-shadow-ground: 0 0 0 1px rgba(255, 255, 255, 0.1), 0 24px 48px -24px rgba(0, 0, 0, 0.6)}.oms-v-fit{position:relative;width:100%}.oms-v-stage{position:absolute;top:0;left:0;transform-origin:0 0;overflow:hidden}.oms-v *,.oms-v *::before,.oms-v *::after{box-sizing:border-box}.oms-v :where(h1,h2,h3,h4,p,ul,ol){margin:0}.oms-v .oms-badge{display:inline-flex;align-items:center;justify-content:center;gap:4px;padding:4px 8px;border-radius:16px;border:0.5px solid transparent;font-family:var(--ss-font);font-weight:500;font-size:12px;line-height:1;white-space:nowrap;text-box:trim-both cap alphabetic}.oms-v .oms-badge--info{background:#f6f3fb;border-color:#d5c4f2;color:#500ab2}.oms-v .oms-badge--neutral{background:#f6f6fc;border-color:#c8cfe1;color:#141635}.oms-v .oms-badge--success{background:#ecfdf5;border-color:#a7f3d0;color:#047857}.oms-v .oms-badge--warning{background:#fff7ed;border-color:#fed7aa;color:#b45309}.oms-v .oms-badge--danger{background:#fef2f2;border-color:#fecaca;color:#b91c1c}html.dark .oms-v .oms-badge--info{background:rgba(149, 81, 245, 0.14);border-color:rgba(183, 142, 239, 0.35);color:#c9b0f5}html.dark .oms-v .oms-badge--neutral{background:rgba(255, 255, 255, 0.05);border-color:rgba(255, 255, 255, 0.14);color:#c8cfe1}html.dark .oms-v .oms-badge--success{background:rgba(16, 185, 129, 0.14);border-color:rgba(52, 211, 153, 0.35);color:#6ee7b7}html.dark .oms-v .oms-badge--warning{background:rgba(251, 191, 36, 0.12);border-color:rgba(251, 191, 36, 0.3);color:#fcd34d}html.dark .oms-v .oms-badge--danger{background:rgba(248, 113, 113, 0.12);border-color:rgba(248, 113, 113, 0.3);color:#fca5a5}.oms-v .oms-phone{position:relative;flex-shrink:0;--oms-phone-glass: #0b0b0c;--oms-phone-rim: #2c2c2d;--oms-phone-band-1: #e3e3e6;--oms-phone-band-2: #9a9ba0;--oms-phone-band-3: #cfd0d4;--oms-phone-band-4: #85868b;--oms-phone-band-5: #c9cacd;box-shadow:0 calc(var(--ps) * 40) calc(var(--ps) * 80) calc(var(--ps) * -16) rgba(50, 50, 93, 0.25),\n 0 calc(var(--ps) * 24) calc(var(--ps) * 48) calc(var(--ps) * -24) rgba(0, 0, 0, 0.3)}html.dark .oms-v .oms-phone{--oms-phone-band-1: #5b5c61;--oms-phone-band-2: #2b2c2f;--oms-phone-band-3: #48494d;--oms-phone-band-4: #232427;--oms-phone-band-5: #404145}.oms-v .oms-phone__bands{position:absolute;inset:0;overflow:visible;pointer-events:none}.oms-v .oms-phone__glass{position:relative;height:100%}.oms-v .oms-phone__window{position:relative;overflow:hidden;isolation:isolate}.oms-v .oms-phone__screen{position:absolute;top:0;left:0;width:402px;height:874px;display:flex;flex-direction:column;overflow:hidden;background:#fff;color:#000;font-family:-apple-system, system-ui, sans-serif;font-size:15px;letter-spacing:-0.015em;transform-origin:0 0;-webkit-font-smoothing:antialiased}.oms-v .oms-phone[data-dark] .oms-phone__screen{background:#000;color:#fff}.oms-v .oms-phone__status{position:absolute;top:0;right:0;left:0;z-index:2;height:62px;transition:color 0.3s ease;will-change:transform}.oms-v .oms-phone__time{position:absolute;top:21.5px;left:0;width:138.5px;line-height:22px;text-align:center;font-family:\"SF Pro Text\", -apple-system, system-ui, sans-serif;font-variation-settings:\"opsz\" 17;font-size:17.67px;font-weight:590;letter-spacing:0}.oms-v .oms-phone__glyphs{position:absolute;top:25.33px;left:285.25px;display:flex;align-items:flex-start;gap:8px}.oms-v .oms-phone__glyphs svg{display:block}.oms-v .oms-phone__signal{margin-top:1px}.oms-v .oms-phone__battery{margin-top:0.33px}.oms-v .oms-phone__island{position:absolute;top:14px;left:50%;z-index:3;width:95px;height:37px;border-radius:18.5px;background:#000;transform:translateX(-50%)}.oms-v .oms-phone__content{position:relative;flex:1;min-height:0;padding-top:62px}.oms-v .oms-phone__home{position:absolute;bottom:8px;left:50%;z-index:2;width:144px;height:5px;border-radius:2.5px;background:currentColor;transform:translateX(-50%);transition:color 0.3s ease;will-change:transform}.obz{overflow:hidden;border-radius:14px;background:linear-gradient(110deg, rgba(255, 255, 255, 0.18) 0%, transparent 22%, transparent 32%, rgba(255, 255, 255, 0.1) 44%, transparent 60%),\n linear-gradient(135deg, var(--obz-from) 0%, var(--obz-to) 100%);--obz-ink: var(--ss-text-strong);--obz-faint: var(--oms-slate-500);--obz-app: var(--oms-slate-50);--obz-card: #fff;--obz-rule: var(--oms-slate-200)}.obz--payouts{--obz-from: #7c3aed;--obz-to: #3b0764}.obz--rewards{--obz-from: #10b981;--obz-to: #064e3b}html.dark .obz{--obz-faint: var(--oms-slate-400);--obz-app: #0b0a10;--obz-card: #1a1922;--obz-rule: rgba(255, 255, 255, 0.08)}.obz .obz-phone{position:absolute;top:30px;left:30px}.obz .obz-app{position:absolute;inset:0;padding-top:62px;background:var(--obz-app);color:var(--obz-ink);text-align:left;font-family:var(--ss-font)}.obz .obz-btn .obz-states,.obz .obz-status,.obz .obz-big--count{transition:opacity 0.38s ease}.obz .obz-app[data-fade] :is(.obz-btn .obz-states,.obz-status,.obz-big--count){opacity:0}.obz .obz-title{transition:opacity 0.2s ease}.obz .obz-app[data-notif] .obz-title{opacity:0}.obz .obz-head{display:flex;align-items:baseline;justify-content:space-between;padding:8px 36px 14px}.obz--payouts .obz-head{padding-bottom:10px}.obz--rewards .obz-head{padding-bottom:34px}.obz .obz-title{font-size:32px;font-weight:700;line-height:38px;letter-spacing:-0.02em;color:var(--obz-ink)}.obz .obz-head__meta{font-size:19px;line-height:25px;color:var(--obz-faint)}.obz .obz-card{display:block;margin:0 16px 12px;border-radius:22px;background:var(--obz-card);box-shadow:0 0 0 0.5px var(--obz-rule)}.obz .obz-batch,.obz .obz-balance{display:grid;justify-items:start;padding:18px 20px 20px}.obz--payouts .obz-batch{padding-bottom:16px}.obz .obz-label{font-size:19px;line-height:25px;color:var(--obz-faint)}.obz .obz-big{margin-top:2px;font-size:50px;font-weight:700;line-height:58px;letter-spacing:-0.03em;color:var(--obz-ink)}.obz .obz-big--count{margin:4px 0 2px;font-size:60px;line-height:68px}.obz .obz-count{display:inline-flex;align-items:baseline;white-space:nowrap;font-variant-numeric:tabular-nums}.obz .obz-count__char{display:inline-block;font-variant-numeric:normal}.obz .obz-count__digit{display:inline-block;height:1em;overflow:hidden;line-height:1;vertical-align:baseline;mask-image:linear-gradient(to bottom, transparent, #000 8%, #000 92%, transparent)}.obz .obz-count__strip{display:flex;flex-direction:column;will-change:transform;transition:transform 900ms cubic-bezier(0.3, 0.75, 0.1, 1)}.obz .obz-count__strip>span{display:block;height:1em;line-height:1}.obz .obz-count__unit{display:inline-block;margin-left:8px;font-size:22px;font-weight:600;letter-spacing:0;color:var(--obz-faint)}.obz .obz-btn{position:relative;isolation:isolate;display:grid;place-items:center;justify-self:stretch;height:58px;margin-top:14px;border-radius:16px;color:var(--oms-btn-primary-text);font-size:20px;font-weight:600}.obz .obz-btn::before{content:\"\";position:absolute;inset:0;z-index:-1;border-radius:inherit;background:var(--oms-btn-primary);transition:transform 0.15s ease, background-color 0.2s ease}.obz .obz-btn[data-pressed]::before{transform:scale(0.97);background:var(--oms-btn-primary-hover)}.obz .obz-btn__group{display:inline-flex;align-items:center;justify-content:center;gap:8px;width:180px;height:26px}.obz .obz-btn__group--icon{justify-content:flex-start;padding-left:44px}.obz .obz-btn__group svg{flex:none}.obz .obz-spin{animation:obz-spin 0.8s linear infinite}@keyframes obz-spin{to{transform:rotate(360deg)}}.obz .obz-touch{position:absolute;left:50%;top:50%;width:44px;height:44px;margin:-22px 0 0 -22px;border-radius:50%;background:rgba(255, 255, 255, 0.35);box-shadow:0 0 0 1.5px rgba(255, 255, 255, 0.55);opacity:0;transform:scale(0.6);transition:opacity 0.3s ease, transform 0.3s ease;pointer-events:none}.obz .obz-touch[data-on]{opacity:1;transform:scale(1);transition:opacity 0.08s ease, transform 0.12s ease}.obz .obz-states{display:inline-grid;align-items:center;justify-items:center}.obz .obz-states__item{display:inline-flex;grid-area:1 / 1;align-items:center;opacity:0;filter:blur(2px);will-change:transform;transform:translate3d(0, 4px, 0);transition:opacity 0.15s ease, filter 0.15s ease, transform 0s 0.15s}.obz .obz-states__item[data-on]{opacity:1;filter:none;transform:translate3d(0, 0, 0);transition:opacity 0.25s ease-out 0.07s, filter 0.25s ease-out 0.07s, transform 0.3s cubic-bezier(0.22, 1, 0.36, 1) 0.07s}.obz .obz-status{display:inline-grid;justify-items:end;margin-right:10px;flex:none}.obz--payouts .obz-status{margin-right:6px}.obz--rewards .obz-status{width:96px}.obz .obz-list{padding:4px 0}.obz .obz-row{display:flex;align-items:center;gap:14px;padding:14px;will-change:transform}.obz .obz-list>.obz-row+.obz-row,.obz .obz-list>.obz-collapse+.obz-row{box-shadow:0 -0.5px 0 var(--obz-rule)}.obz .obz-row__body{display:flex;flex-direction:column;gap:2px;flex:1;min-width:0}.obz .obz-row__title{overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-size:21px;font-weight:600;line-height:28px;color:var(--obz-ink)}.obz .obz-row__sub{overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-size:19px;line-height:28px;color:var(--ss-text)}.obz--payouts .obz-row__sub{font-size:18px}.obz .obz-bar{display:block;border-radius:5px;background:var(--ss-ink-3)}.obz .obz-bar--title{height:11px;margin:8.5px 0;background:var(--ss-ink-4)}.obz .obz-bar--sub{height:9px;margin:9.5px 0}.obz .obz-avatar{display:inline-grid;flex:none;place-items:center;width:48px;height:48px;border-radius:50%;color:#fff;font-size:20px;font-weight:600;line-height:1;will-change:transform}.obz .obz-avatar>span{display:block;text-box:trim-both cap alphabetic}.obz .obz-avatar--plain{background:var(--ss-fill)}.obz .obz-tile{display:grid;flex:none;place-items:center;width:48px;height:48px;border-radius:14px;background:var(--ss-success-soft);color:var(--ss-success-text)}.obz .obz-tile--plain{background:var(--ss-ink-1)}html.dark .obz .obz-tile{background:rgba(16, 185, 129, 0.14);color:#34d399}html.dark .obz .obz-tile--plain{background:rgba(255, 255, 255, 0.06)}.obz .oms-badge.obz-badge{padding:5px 12px;border-radius:16px;font-size:19px;line-height:22px}.obz .obz-collapse{display:grid;grid-template-rows:0fr;opacity:0;transition:grid-template-rows 0.42s cubic-bezier(0.4, 0, 0.2, 1) 0.05s, opacity 0.42s cubic-bezier(0, 0.8, 0.5, 1)}.obz .obz-collapse[data-open]{grid-template-rows:1fr;opacity:1;transition:grid-template-rows 0.5s cubic-bezier(0.45, 0, 0.2, 1), opacity 0.3s ease 0.24s}.obz .obz-collapse__inner{min-height:0;overflow:visible}.obz .obz-collapse__inner>*{transform:translateY(-10px);transition:transform 0.3s ease}.obz .obz-collapse[data-open]>.obz-collapse__inner>*{transform:none;transition:transform 0.6s cubic-bezier(0.22, 1, 0.36, 1) 0.2s}.obz .obz-banner{position:absolute;inset:0;z-index:2;pointer-events:none;will-change:transform;transform:translateY(-52px) scale(0.96);opacity:0;transition:transform 0.45s cubic-bezier(0.4, 0, 0.6, 1), opacity 0.3s ease 0.1s}.obz .obz-banner[data-show]{transform:none;opacity:1;transition:transform 0.55s cubic-bezier(0.2, 0.9, 0.25, 1), opacity 0.2s ease}.obz .obz-notif{position:absolute;top:56px;left:18px;right:18px;display:flex;align-items:center;gap:13px;padding:14px 17px 14px 14px;border-radius:23px;background:rgba(255, 255, 255, 0.92);box-shadow:0 0 0 0.5px rgba(0, 0, 0, 0.08), 0 8px 24px rgba(0, 0, 0, 0.12);color:#000;text-align:left;will-change:transform}.obz .obz-banner[data-dark] .obz-notif{background:rgba(252, 252, 253, 0.76);backdrop-filter:blur(30px) saturate(1.25);box-shadow:0 4px 24px rgba(0, 0, 0, 0.06)}.obz .obz-notif__icon{display:grid;flex:none;place-items:center;width:38px;height:38px;border-radius:9px;overflow:hidden;background:linear-gradient(160deg, #10b981, #047857);color:#fff}.obz .obz-notif__text{display:flex;flex:1;flex-direction:column;min-width:0;font-size:15px;line-height:18px;letter-spacing:-0.016em}.obz .obz-notif__head{display:flex;align-items:baseline;gap:8px}.obz .obz-notif__title{flex:1;min-width:0;overflow:hidden;font-weight:600;white-space:nowrap;text-overflow:ellipsis}.obz .obz-notif__time{flex:none;font-size:12px;letter-spacing:-0.005em;color:rgba(60, 60, 67, 0.6)}.obz .obz-notif__body{display:-webkit-box;overflow:hidden;-webkit-line-clamp:3;-webkit-box-orient:vertical}@media (prefers-reduced-motion: reduce){.obz .obz-spin{animation:none}}"}],"page":{"pagePath":"api-reference/customers/create-a-customer","slug":"/api-reference/customers/create-a-customer","pageMetadata":{"title":"Create a customer","description":"Creation can outlast the request. When it does, the response is 202 with the id the customer will have, and the customer reads as 404 until creation finishes. Repeat the same request with the same Idempotency-Key to follow it: the repeat answers 202 while creation is still running and 201 with the customer once it is done.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /customers","href":"/api-reference/customers/create-a-customer","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Creation can outlast the request. When it does, the response is 202 with the id the customer will have, and the customer reads as 404 until creation finishes. Repeat the same request with the same Idempotency-Key to follow it: the repeat answers 202 while creation is still running and 201 with the customer once it is done.\"\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 a customer","description":"Creation can outlast the request. When it does, the response is 202 with the id the customer will have, and the customer reads as 404 until creation finishes. Repeat the same request with the same Idempotency-Key to follow it: the repeat answers 202 while creation is still running and 201 with the customer once it is done.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /customers","href":"/api-reference/customers/create-a-customer","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/polygon-labs/3aef159c73509324/analytics.js","/_mintlify/custom/polygon-labs/3af50e0aa9bbe82e/custom.js"],"openApiReferenceData":{"operation":{"tags":["Customers"],"operationId":"createCustomer","summary":"Create a customer","description":"Creation can outlast the request. When it does, the response is 202 with the id the customer will have, and the customer reads as 404 until creation finishes. Repeat the same request with the same Idempotency-Key to follow it: the repeat answers 202 while creation is still running and 201 with the customer once it is done.","parameters":["565f5f06-e25f-404f-b8a3-0f9900aba09e"],"requestBody":"65247394-f5c4-42e3-b88e-764248017a80","responses":{"201":"a212fa00-3ced-47dd-99de-642bc3b99276","202":"76d87733-77c4-42b2-ad8d-4a175df3e1de","400":"f00c5886-abcc-4058-9043-42c6fa76d138","401":"57125361-736e-4e6e-9b82-2fbfef8ce53f"},"method":"post","type":"path","servers":["5171b292-2587-4003-b902-7c9c8b5e8c45","648ebbb9-4224-4903-ae0e-6397711f6143"],"security":["7cb3f03a-dd48-413f-836d-b3b987f3ca59"],"path":"/customers","baseUrlOptions":["https://sandbox-api.polygon.technology/v0.13","https://api.polygon.technology/v0.13"],"title":"Create a customer","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"565f5f06-e25f-404f-b8a3-0f9900aba09e":{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","maxLength":256,"isRequired":true,"description":"Client-supplied request key. Required on all non-auth POST requests.","uniqueKey":"","typeLabel":"string"},"description":"Client-supplied request key. Required on all non-auth POST requests.","example":"ord_123_attempt_1"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["type"],"description":"Create a new customer. Individuals require firstName and lastName. Businesses require companyLegalName and email, and do not accept person-name fields. PII fields (birthDate, residentialAddress, ipAddress, identifyingInformation) are write-only and never returned in responses. Whether identity verification is required, and whether OMS relies on your attestation or a vendor verifies, is configured per project, not per request.","properties":{"type":{"type":"string","enum":["individual","business"],"description":"Customer type. Individuals follow the project's KYC policy, businesses its KYB policy.","example":"individual","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"companyLegalName":{"type":"string","maxLength":255,"description":"Legal business name. Required for business creation; supports Unicode and punctuation. Only valid for business customers.","uniqueKey":"companyLegalName","typeLabel":"string"},"firstName":{"type":"string","description":"Individual customer's legal first name. Not accepted for business customers.","example":"Jane","uniqueKey":"firstName","typeLabel":"string"},"middleName":{"type":"string","description":"Individual customer's middle name. Not accepted for business customers.","uniqueKey":"middleName","typeLabel":"string"},"lastName":{"type":"string","description":"Individual customer's legal last name. Not accepted for business customers.","example":"Smith","uniqueKey":"lastName","typeLabel":"string"},"email":{"type":"string","format":"email","example":"jane@example.com","uniqueKey":"email","typeLabel":"string\u003cemail>"},"phone":{"type":"string","description":"Primary phone in E.164 format.","example":"+12125551234","uniqueKey":"phone","typeLabel":"string"},"birthDate":{"type":"string","description":"Date of birth in YYYY-MM-DD format. Write-only.","example":"1990-05-15","writeOnly":true,"uniqueKey":"birthDate","typeLabel":"string"},"nationality":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","example":"US","uniqueKey":"nationality","typeLabel":"string"},"ipAddress":{"type":"string","description":"Customer's IP address. Used for geo-based compliance checks on the basic endorsement. Write-only.","writeOnly":true,"uniqueKey":"ipAddress","typeLabel":"string"},"externalId":{"type":"string","description":"Developer's own customer ID for cross-referencing.","example":"crm-12345","uniqueKey":"externalId","typeLabel":"string"},"signedAgreement":{"type":"boolean","description":"Whether the customer has accepted OMS terms of service. Default false.","default":false,"uniqueKey":"signedAgreement","typeLabel":"boolean"},"residentialAddress":{"type":"object","description":"Customer's residential address. Write-only.","properties":{"line1":{"type":"string","example":"123 Main St","uniqueKey":"residentialAddress.line1","typeLabel":"string"},"line2":{"type":"string","uniqueKey":"residentialAddress.line2","typeLabel":"string"},"city":{"type":"string","example":"Seattle","uniqueKey":"residentialAddress.city","typeLabel":"string"},"state":{"type":"string","example":"WA","uniqueKey":"residentialAddress.state","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","example":"US","uniqueKey":"residentialAddress.country","typeLabel":"string"},"zipCode":{"type":"string","example":"98101","uniqueKey":"residentialAddress.zipCode","typeLabel":"string"}},"uniqueKey":"residentialAddress","typeLabel":"object"},"identifyingInformation":{"type":"array","description":"Array of ID documents. Write-only. Supported types: ssn, itin, driversLicense, passport.","writeOnly":true,"items":{"type":"object","required":["type","issuingCountry","number"],"properties":{"type":{"type":"string","enum":["ssn","itin","driversLicense","passport"],"example":"ssn","isRequired":true,"uniqueKey":"identifyingInformation.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"issuingCountry":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","example":"US","isRequired":true,"uniqueKey":"identifyingInformation.items.[INDEX].issuingCountry","typeLabel":"string"},"number":{"type":"string","description":"The identification number.","example":"123456789","isRequired":true,"uniqueKey":"identifyingInformation.items.[INDEX].number","typeLabel":"string"}},"uniqueKey":"identifyingInformation.items.[INDEX]","typeLabel":"object"},"uniqueKey":"identifyingInformation","typeLabel":"object[]"},"endorsements":{"type":"array","description":"Endorsements to request: basic, cryptoCustody, usd. If omitted, OMS defaults to cryptoCustody and usd (which auto-includes basic).","items":{"type":"string","enum":["basic","cryptoCustody","usd"],"uniqueKey":"endorsements.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"endorsements","typeLabel":"enum\u003cstring>[]"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"string"},"maxProperties":20,"uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.1.additionalProperties","typeLabel":"string"},"maxProperties":20,"uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"dbaName":{"type":"string","uniqueKey":"dbaName","typeLabel":"string"},"formationDate":{"type":"string","uniqueKey":"formationDate","typeLabel":"string"},"registrationCountry":{"type":"string","uniqueKey":"registrationCountry","typeLabel":"string"},"registrationNumber":{"type":"string","uniqueKey":"registrationNumber","typeLabel":"string"},"legalEntityType":{"type":"string","enum":["corporation","llc","nonProfit","partnership","soleProprietorship","trust"],"uniqueKey":"legalEntityType","typeLabel":"enum\u003cstring>"},"ownershipType":{"type":"string","enum":["exempt","excluded","nonProfit","legalEntity"],"uniqueKey":"ownershipType","typeLabel":"enum\u003cstring>"},"taxIdType":{"type":"string","enum":["ein","vat","foreign","ssn","itin","foreignTin"],"uniqueKey":"taxIdType","typeLabel":"enum\u003cstring>"},"incorporationAddress":{"type":"object","properties":{"line1":{"type":"string","uniqueKey":"incorporationAddress.line1","typeLabel":"string"},"line2":{"type":"string","uniqueKey":"incorporationAddress.line2","typeLabel":"string"},"city":{"type":"string","uniqueKey":"incorporationAddress.city","typeLabel":"string"},"state":{"type":"string","uniqueKey":"incorporationAddress.state","typeLabel":"string"},"postalCode":{"type":"string","uniqueKey":"incorporationAddress.postalCode","typeLabel":"string"},"country":{"type":"string","uniqueKey":"incorporationAddress.country","typeLabel":"string"}},"uniqueKey":"incorporationAddress","typeLabel":"object"},"physicalAddress":{"type":"object","properties":{"line1":{"type":"string","uniqueKey":"physicalAddress.line1","typeLabel":"string"},"line2":{"type":"string","uniqueKey":"physicalAddress.line2","typeLabel":"string"},"city":{"type":"string","uniqueKey":"physicalAddress.city","typeLabel":"string"},"state":{"type":"string","uniqueKey":"physicalAddress.state","typeLabel":"string"},"postalCode":{"type":"string","uniqueKey":"physicalAddress.postalCode","typeLabel":"string"},"country":{"type":"string","uniqueKey":"physicalAddress.country","typeLabel":"string"}},"uniqueKey":"physicalAddress","typeLabel":"object"},"websiteUrl":{"type":"string","uniqueKey":"websiteUrl","typeLabel":"string"},"businessDescription":{"type":"string","uniqueKey":"businessDescription","typeLabel":"string"},"industry":{"type":"string","uniqueKey":"industry","typeLabel":"string"},"industryFinancialServicesSubtype":{"type":"string","uniqueKey":"industryFinancialServicesSubtype","typeLabel":"string"},"industryCryptoSubtype":{"type":"string","uniqueKey":"industryCryptoSubtype","typeLabel":"string"},"industryOtherDescription":{"type":"string","uniqueKey":"industryOtherDescription","typeLabel":"string"},"sourceOfFundsOtherDescription":{"type":"string","uniqueKey":"sourceOfFundsOtherDescription","typeLabel":"string"},"accountPurposesOtherDescription":{"type":"string","uniqueKey":"accountPurposesOtherDescription","typeLabel":"string"},"primaryTargetMarketOtherDescription":{"type":"string","uniqueKey":"primaryTargetMarketOtherDescription","typeLabel":"string"},"sourceOfFunds":{"type":"array","items":{"type":"string","uniqueKey":"sourceOfFunds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"sourceOfFunds","typeLabel":"string[]"},"accountPurposes":{"type":"array","items":{"type":"string","uniqueKey":"accountPurposes.items.[INDEX]","typeLabel":"string"},"uniqueKey":"accountPurposes","typeLabel":"string[]"},"primaryTargetMarket":{"type":"string","uniqueKey":"primaryTargetMarket","typeLabel":"string"},"expectedFiatMonthlyVolume":{"type":"string","uniqueKey":"expectedFiatMonthlyVolume","typeLabel":"string"},"expectedCryptoMonthlyVolume":{"type":"string","uniqueKey":"expectedCryptoMonthlyVolume","typeLabel":"string"},"isMsb":{"type":"boolean","uniqueKey":"isMsb","typeLabel":"boolean"},"disclosureAccepted":{"type":"boolean","uniqueKey":"disclosureAccepted","typeLabel":"boolean"},"disclosureAcceptedAt":{"type":"string","format":"date-time","uniqueKey":"disclosureAcceptedAt","typeLabel":"string\u003cdate-time>"},"disclosureVersion":{"type":"string","uniqueKey":"disclosureVersion","typeLabel":"string"},"disclosureIpAddress":{"type":"string","uniqueKey":"disclosureIpAddress","typeLabel":"string"},"businessTaxId":{"type":"string","writeOnly":true,"uniqueKey":"businessTaxId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"individual","companyLegalName":"\u003cstring>","firstName":"Jane","middleName":"\u003cstring>","lastName":"Smith","email":"jane@example.com","phone":"+12125551234","birthDate":"1990-05-15","nationality":"US","ipAddress":"\u003cstring>","externalId":"crm-12345","signedAgreement":false,"residentialAddress":{"line1":"123 Main St","line2":"\u003cstring>","city":"Seattle","state":"WA","country":"US","zipCode":"98101"},"identifyingInformation":[{"type":"ssn","issuingCountry":"US","number":"123456789"}],"endorsements":[],"metadata":{},"dbaName":"\u003cstring>","formationDate":"\u003cstring>","registrationCountry":"\u003cstring>","registrationNumber":"\u003cstring>","incorporationAddress":{"line1":"\u003cstring>","line2":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","postalCode":"\u003cstring>","country":"\u003cstring>"},"physicalAddress":{"line1":"\u003cstring>","line2":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","postalCode":"\u003cstring>","country":"\u003cstring>"},"websiteUrl":"\u003cstring>","businessDescription":"\u003cstring>","industry":"\u003cstring>","industryFinancialServicesSubtype":"\u003cstring>","industryCryptoSubtype":"\u003cstring>","industryOtherDescription":"\u003cstring>","sourceOfFundsOtherDescription":"\u003cstring>","accountPurposesOtherDescription":"\u003cstring>","primaryTargetMarketOtherDescription":"\u003cstring>","sourceOfFunds":["\u003cstring>"],"accountPurposes":["\u003cstring>"],"primaryTargetMarket":"\u003cstring>","expectedFiatMonthlyVolume":"\u003cstring>","expectedCryptoMonthlyVolume":"\u003cstring>","isMsb":true,"disclosureAccepted":true,"disclosureAcceptedAt":"2023-11-07T05:31:56Z","disclosureVersion":"\u003cstring>","disclosureIpAddress":"\u003cstring>","businessTaxId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"a212fa00-3ced-47dd-99de-642bc3b99276":{"description":"Customer created","content":{"application/json":{"schema":{"type":"object","description":"Customer response object. PII fields (birthDate, residentialAddress, ipAddress, identifyingInformation) are write-only — accepted in POST/PATCH but never returned in responses.","properties":{"id":{"type":"string","x-go-type-skip-optional-pointer":true,"example":"cst_01H9Xa8F5dN6mP3q","uniqueKey":"id","typeLabel":"string"},"type":{"type":"string","x-go-type-skip-optional-pointer":true,"enum":["individual","business"],"description":"Customer type. Individuals are subject to the project's KYC policy, businesses to its KYB policy.","example":"individual","uniqueKey":"type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"An individual's first, middle and last names joined by spaces, or a business's legal name. Left out when the customer has no name.","example":"Jane Smith","uniqueKey":"name","typeLabel":"string"},"firstName":{"oneOf":[{"type":"string","x-go-type-skip-optional-pointer":true,"example":"Jane","uniqueKey":"firstName.oneOf.0","typeLabel":"string"},{"type":"null","x-go-type-skip-optional-pointer":true,"example":"Jane","uniqueKey":"firstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"firstName","typeLabel":"string | null"},"middleName":{"oneOf":[{"type":"string","x-go-type-skip-optional-pointer":true,"example":null,"uniqueKey":"middleName.oneOf.0","typeLabel":"string"},{"type":"null","x-go-type-skip-optional-pointer":true,"example":null,"uniqueKey":"middleName.oneOf.1","typeLabel":"null"}],"uniqueKey":"middleName","typeLabel":"string | null"},"lastName":{"oneOf":[{"type":"string","x-go-type-skip-optional-pointer":true,"example":"Smith","uniqueKey":"lastName.oneOf.0","typeLabel":"string"},{"type":"null","x-go-type-skip-optional-pointer":true,"example":"Smith","uniqueKey":"lastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"lastName","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","x-go-type-skip-optional-pointer":true,"example":"jane@example.com","uniqueKey":"email.oneOf.0","typeLabel":"string"},{"type":"null","x-go-type-skip-optional-pointer":true,"example":"jane@example.com","uniqueKey":"email.oneOf.1","typeLabel":"null"}],"uniqueKey":"email","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","x-go-type-skip-optional-pointer":true,"description":"Primary phone in E.164 format.","example":"+12125551234","uniqueKey":"phone.oneOf.0","typeLabel":"string"},{"type":"null","x-go-type-skip-optional-pointer":true,"description":"Primary phone in E.164 format.","example":"+12125551234","uniqueKey":"phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"phone","typeLabel":"string | null"},"nationality":{"oneOf":[{"type":"string","x-go-type-skip-optional-pointer":true,"description":"ISO 3166-1 alpha-2 country code.","example":"US","uniqueKey":"nationality.oneOf.0","typeLabel":"string"},{"type":"null","x-go-type-skip-optional-pointer":true,"description":"ISO 3166-1 alpha-2 country code.","example":"US","uniqueKey":"nationality.oneOf.1","typeLabel":"null"}],"uniqueKey":"nationality","typeLabel":"string | null"},"externalId":{"oneOf":[{"type":"string","x-go-type-skip-optional-pointer":true,"description":"Developer's own customer ID for cross-referencing.","example":"crm-12345","uniqueKey":"externalId.oneOf.0","typeLabel":"string"},{"type":"null","x-go-type-skip-optional-pointer":true,"description":"Developer's own customer ID for cross-referencing.","example":"crm-12345","uniqueKey":"externalId.oneOf.1","typeLabel":"null"}],"uniqueKey":"externalId","typeLabel":"string | null"},"status":{"type":"string","x-go-type-skip-optional-pointer":true,"enum":["pending","actionRequired","active","rejected","offboarded"],"description":"Where the customer is in onboarding. `actionRequired` carries a `hold` saying what to do, and `rejected` carries a `failure`. `offboarded` is a deleted or deactivated customer.","example":"active","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"hold":{"type":"object","description":"What you must do for a customer in `actionRequired`.","required":["code","message"],"properties":{"code":{"type":"string","example":"verificationRequired","isRequired":true,"uniqueKey":"hold.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"hold.message","typeLabel":"string"}},"uniqueKey":"hold","typeLabel":"object"},"failure":{"type":"object","description":"Why a customer or an endorsement was rejected.","required":["code","message","retryable"],"properties":{"code":{"type":"string","example":"onboardingRejected","isRequired":true,"uniqueKey":"failure.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"failure.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"failure.retryable","typeLabel":"boolean"}},"uniqueKey":"failure","typeLabel":"object"},"signedAgreement":{"type":"boolean","x-go-type-skip-optional-pointer":true,"description":"Whether the customer has accepted OMS terms of service.","example":true,"uniqueKey":"signedAgreement","typeLabel":"boolean"},"signedAgreementAt":{"oneOf":[{"type":"string","format":"date-time","description":"Timestamp when signedAgreement was set to true. Null if not yet signed.","example":"2026-03-20T14:15:22Z","uniqueKey":"signedAgreementAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Timestamp when signedAgreement was set to true. Null if not yet signed.","example":"2026-03-20T14:15:22Z","uniqueKey":"signedAgreementAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"signedAgreementAt","typeLabel":"string\u003cdate-time> | null"},"totalBalance":{"type":"object","description":"USD rollup of a customer's balances. Returned on GET /customers/{id} only — never on list, create, or update. Covers fiat wallets and custodial crypto wallets; `noncustodial` wallets are not yet valued, so a customer holding one reads an undercount here. Omitted entirely when the rollup cannot be read; a partial total is never returned, so treat an absent field as \"unknown\", not as zero.","properties":{"totalUsd":{"type":"string","description":"`fiatUsd + cryptoUsd`, 2 decimal places, sign preserved.","example":"1250.00","uniqueKey":"totalBalance.totalUsd","typeLabel":"string"},"fiatUsd":{"type":"string","description":"Sum of the customer's USD fiat wallet balances as last reported by the holding bank. Can be negative — an ACH clawback can overdraw a deposit account — so render the sign verbatim and never clamp.","example":"1000.00","uniqueKey":"totalBalance.fiatUsd","typeLabel":"string"},"cryptoUsd":{"type":"string","description":"Sum of the customer's custodial crypto wallet balances at the custodian's own per-asset USD estimate. `\"0.00\"` for a customer with no custodial crypto account.","example":"250.00","uniqueKey":"totalBalance.cryptoUsd","typeLabel":"string"},"updatedAt":{"type":"string","format":"date-time","description":"When the custodial wallet provider last updated the crypto balances in `cryptoUsd`: the newest per-asset timestamp the provider reports across those balances, read live with this request. Fiat balances do not affect it. Omitted when the provider reports no timestamp, for example when the customer holds no custodial crypto wallet.","example":"2026-03-20T14:15:22Z","uniqueKey":"totalBalance.updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"totalBalance","typeLabel":"object"},"endorsements":{"type":"array","description":"What the customer is endorsed for. An endorsement never reads further along than its customer, and one that was not requested is left out.","items":{"type":"object","required":["type","status"],"properties":{"type":{"type":"string","enum":["basic","cryptoCustody","usd"],"isRequired":true,"uniqueKey":"endorsements.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["pending","actionRequired","active","rejected","offboarded"],"isRequired":true,"uniqueKey":"endorsements.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"requirements":{"type":"object","description":"Tracks what is complete, pending, missing, or has issues for this endorsement.","properties":{"complete":{"type":"array","items":{"type":"string","uniqueKey":"endorsements.items.[INDEX].requirements.complete.items.[INDEX]","typeLabel":"string"},"uniqueKey":"endorsements.items.[INDEX].requirements.complete","typeLabel":"string[]"},"pending":{"type":"array","items":{"type":"string","uniqueKey":"endorsements.items.[INDEX].requirements.pending.items.[INDEX]","typeLabel":"string"},"uniqueKey":"endorsements.items.[INDEX].requirements.pending","typeLabel":"string[]"},"missing":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"endorsements.items.[INDEX].requirements.missing.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"endorsements.items.[INDEX].requirements.missing.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"endorsements.items.[INDEX].requirements.missing.oneOf.1","typeLabel":"null"}],"uniqueKey":"endorsements.items.[INDEX].requirements.missing","typeLabel":"string[] | null"},"issues":{"type":"array","items":{"type":"string","uniqueKey":"endorsements.items.[INDEX].requirements.issues.items.[INDEX]","typeLabel":"string"},"uniqueKey":"endorsements.items.[INDEX].requirements.issues","typeLabel":"string[]"}},"uniqueKey":"endorsements.items.[INDEX].requirements","typeLabel":"object"},"failure":{"type":"object","description":"Why a customer or an endorsement was rejected.","required":["code","message","retryable"],"properties":{"code":{"type":"string","example":"onboardingRejected","isRequired":true,"uniqueKey":"endorsements.items.[INDEX].failure.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"endorsements.items.[INDEX].failure.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"endorsements.items.[INDEX].failure.retryable","typeLabel":"boolean"}},"uniqueKey":"endorsements.items.[INDEX].failure","typeLabel":"object"}},"uniqueKey":"endorsements.items.[INDEX]","typeLabel":"object"},"uniqueKey":"endorsements","typeLabel":"object[]"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.1.additionalProperties","typeLabel":"string"},"uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"companyLegalName":{"type":"string","maxLength":255,"uniqueKey":"companyLegalName","typeLabel":"string"},"dbaName":{"type":"string","uniqueKey":"dbaName","typeLabel":"string"},"formationDate":{"type":"string","uniqueKey":"formationDate","typeLabel":"string"},"registrationCountry":{"type":"string","uniqueKey":"registrationCountry","typeLabel":"string"},"registrationNumber":{"type":"string","uniqueKey":"registrationNumber","typeLabel":"string"},"legalEntityType":{"type":"string","enum":["corporation","llc","nonProfit","partnership","soleProprietorship","trust"],"uniqueKey":"legalEntityType","typeLabel":"enum\u003cstring>"},"ownershipType":{"type":"string","enum":["exempt","excluded","nonProfit","legalEntity"],"uniqueKey":"ownershipType","typeLabel":"enum\u003cstring>"},"taxIdType":{"type":"string","enum":["ein","vat","foreign","ssn","itin","foreignTin"],"uniqueKey":"taxIdType","typeLabel":"enum\u003cstring>"},"incorporationAddress":{"type":"object","properties":{"line1":{"type":"string","uniqueKey":"incorporationAddress.line1","typeLabel":"string"},"line2":{"type":"string","uniqueKey":"incorporationAddress.line2","typeLabel":"string"},"city":{"type":"string","uniqueKey":"incorporationAddress.city","typeLabel":"string"},"state":{"type":"string","uniqueKey":"incorporationAddress.state","typeLabel":"string"},"postalCode":{"type":"string","uniqueKey":"incorporationAddress.postalCode","typeLabel":"string"},"country":{"type":"string","uniqueKey":"incorporationAddress.country","typeLabel":"string"}},"uniqueKey":"incorporationAddress","typeLabel":"object"},"physicalAddress":{"type":"object","properties":{"line1":{"type":"string","uniqueKey":"physicalAddress.line1","typeLabel":"string"},"line2":{"type":"string","uniqueKey":"physicalAddress.line2","typeLabel":"string"},"city":{"type":"string","uniqueKey":"physicalAddress.city","typeLabel":"string"},"state":{"type":"string","uniqueKey":"physicalAddress.state","typeLabel":"string"},"postalCode":{"type":"string","uniqueKey":"physicalAddress.postalCode","typeLabel":"string"},"country":{"type":"string","uniqueKey":"physicalAddress.country","typeLabel":"string"}},"uniqueKey":"physicalAddress","typeLabel":"object"},"websiteUrl":{"type":"string","uniqueKey":"websiteUrl","typeLabel":"string"},"businessDescription":{"type":"string","uniqueKey":"businessDescription","typeLabel":"string"},"industry":{"type":"string","uniqueKey":"industry","typeLabel":"string"},"industryFinancialServicesSubtype":{"type":"string","uniqueKey":"industryFinancialServicesSubtype","typeLabel":"string"},"industryCryptoSubtype":{"type":"string","uniqueKey":"industryCryptoSubtype","typeLabel":"string"},"industryOtherDescription":{"type":"string","uniqueKey":"industryOtherDescription","typeLabel":"string"},"sourceOfFundsOtherDescription":{"type":"string","uniqueKey":"sourceOfFundsOtherDescription","typeLabel":"string"},"accountPurposesOtherDescription":{"type":"string","uniqueKey":"accountPurposesOtherDescription","typeLabel":"string"},"primaryTargetMarketOtherDescription":{"type":"string","uniqueKey":"primaryTargetMarketOtherDescription","typeLabel":"string"},"sourceOfFunds":{"type":"array","items":{"type":"string","uniqueKey":"sourceOfFunds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"sourceOfFunds","typeLabel":"string[]"},"accountPurposes":{"type":"array","items":{"type":"string","uniqueKey":"accountPurposes.items.[INDEX]","typeLabel":"string"},"uniqueKey":"accountPurposes","typeLabel":"string[]"},"primaryTargetMarket":{"type":"string","uniqueKey":"primaryTargetMarket","typeLabel":"string"},"expectedFiatMonthlyVolume":{"type":"string","uniqueKey":"expectedFiatMonthlyVolume","typeLabel":"string"},"expectedCryptoMonthlyVolume":{"type":"string","uniqueKey":"expectedCryptoMonthlyVolume","typeLabel":"string"},"isMsb":{"type":"boolean","uniqueKey":"isMsb","typeLabel":"boolean"},"disclosureAccepted":{"type":"boolean","uniqueKey":"disclosureAccepted","typeLabel":"boolean"},"disclosureAcceptedAt":{"type":"string","format":"date-time","uniqueKey":"disclosureAcceptedAt","typeLabel":"string\u003cdate-time>"},"disclosureVersion":{"type":"string","uniqueKey":"disclosureVersion","typeLabel":"string"},"disclosureIpAddress":{"type":"string","uniqueKey":"disclosureIpAddress","typeLabel":"string"},"hasBusinessTaxId":{"type":"boolean","uniqueKey":"hasBusinessTaxId","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"cst_01H9Xa8F5dN6mP3q","type":"individual","name":"Jane Smith","firstName":"Jane","middleName":null,"lastName":"Smith","email":"jane@example.com","phone":"+12125551234","nationality":"US","externalId":"crm-12345","status":"active","hold":{"code":"verificationRequired","message":"\u003cstring>"},"failure":{"code":"onboardingRejected","message":"\u003cstring>","retryable":true},"signedAgreement":true,"signedAgreementAt":"2026-03-20T14:15:22Z","totalBalance":{"totalUsd":"1250.00","fiatUsd":"1000.00","cryptoUsd":"250.00","updatedAt":"2026-03-20T14:15:22Z"},"endorsements":[{"type":"basic","status":"pending","requirements":{"complete":["\u003cstring>"],"pending":["\u003cstring>"],"missing":["\u003cstring>"],"issues":["\u003cstring>"]},"failure":{"code":"onboardingRejected","message":"\u003cstring>","retryable":true}}],"metadata":{},"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","companyLegalName":"\u003cstring>","dbaName":"\u003cstring>","formationDate":"\u003cstring>","registrationCountry":"\u003cstring>","registrationNumber":"\u003cstring>","legalEntityType":"corporation","ownershipType":"exempt","taxIdType":"ein","incorporationAddress":{"line1":"\u003cstring>","line2":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","postalCode":"\u003cstring>","country":"\u003cstring>"},"physicalAddress":{"line1":"\u003cstring>","line2":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","postalCode":"\u003cstring>","country":"\u003cstring>"},"websiteUrl":"\u003cstring>","businessDescription":"\u003cstring>","industry":"\u003cstring>","industryFinancialServicesSubtype":"\u003cstring>","industryCryptoSubtype":"\u003cstring>","industryOtherDescription":"\u003cstring>","sourceOfFundsOtherDescription":"\u003cstring>","accountPurposesOtherDescription":"\u003cstring>","primaryTargetMarketOtherDescription":"\u003cstring>","sourceOfFunds":["\u003cstring>"],"accountPurposes":["\u003cstring>"],"primaryTargetMarket":"\u003cstring>","expectedFiatMonthlyVolume":"\u003cstring>","expectedCryptoMonthlyVolume":"\u003cstring>","isMsb":true,"disclosureAccepted":true,"disclosureAcceptedAt":"2023-11-07T05:31:56Z","disclosureVersion":"\u003cstring>","disclosureIpAddress":"\u003cstring>","hasBusinessTaxId":true}}},"exampleType":"generated"}},"exampleType":"generated"},"76d87733-77c4-42b2-ad8d-4a175df3e1de":{"description":"Customer creation accepted and still running","headers":{"Retry-After":{"description":"Seconds to wait before repeating the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","description":"A customer creation that is still running. The customer reads as 404 until it finishes.","required":["id","object","status"],"properties":{"id":{"type":"string","description":"The id the customer will have once created.","example":"cst_01H9Xa8F5dN6mP3q","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","enum":["customer"],"isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["processing"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"cst_01H9Xa8F5dN6mP3q","object":"customer","status":"processing"}}},"exampleType":"generated"}},"exampleType":"generated"},"f00c5886-abcc-4058-9043-42c6fa76d138":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["error","code","msg","status"],"description":"Standard OMS error response. Error names and numeric codes are stable identifiers.","properties":{"error":{"type":"string","description":"Stable OMS error name.","example":"Unauthorized","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"integer","description":"Stable OMS error code.","example":1000,"isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"msg":{"type":"string","description":"Human-readable message (kept stable across releases)","example":"unauthorized access","isRequired":true,"uniqueKey":"msg","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status mirrored in the body for client convenience","example":401,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"cause":{"type":"string","description":"Optional internal cause for operator triage; filtered before reaching end customers","example":"signature","uniqueKey":"cause","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Unauthorized","code":1000,"msg":"unauthorized access","status":401,"cause":"signature"}}},"exampleType":"generated"}},"exampleType":"generated"},"57125361-736e-4e6e-9b82-2fbfef8ce53f":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","msg","status"],"description":"Standard OMS error response. Error names and numeric codes are stable identifiers.","properties":{"error":{"type":"string","description":"Stable OMS error name.","example":"Unauthorized","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"integer","description":"Stable OMS error code.","example":1000,"isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"msg":{"type":"string","description":"Human-readable message (kept stable across releases)","example":"unauthorized access","isRequired":true,"uniqueKey":"msg","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status mirrored in the body for client convenience","example":401,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"cause":{"type":"string","description":"Optional internal cause for operator triage; filtered before reaching end customers","example":"signature","uniqueKey":"cause","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Unauthorized","code":1000,"msg":"unauthorized access","status":401,"cause":"signature"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"7cb3f03a-dd48-413f-836d-b3b987f3ca59":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token from POST /auth/token","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"5171b292-2587-4003-b902-7c9c8b5e8c45":{"url":"https://sandbox-api.polygon.technology/v0.13","description":"Sandbox"},"648ebbb9-4224-4903-ae0e-6397711f6143":{"url":"https://api.polygon.technology/v0.13","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token from POST /auth/token","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Token from POST /auth/token","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"polygon-labs","siteName":"Polygon Developer Docs","title":"Create a customer - Polygon Developer Docs","contextualStarterQuestions":[{"_id":"6a06fb3b0233f8d04dd1db37","deploymentId":"69a9bcc427671ec5a2e05f92","questionText":"How do I create a customer?","status":"active","generatedBy":"contextual","path":"api-reference/customers/create-a-customer","createdAt":"2026-05-15T10:53:47.434Z","updatedAt":"2026-05-15T10:53:47.434Z","__v":0},{"_id":"6a06fb3b0233f8d04dd1db36","deploymentId":"69a9bcc427671ec5a2e05f92","questionText":"What data is required?","status":"active","generatedBy":"contextual","path":"api-reference/customers/create-a-customer","createdAt":"2026-05-15T10:53:47.434Z","updatedAt":"2026-05-15T10:53:47.434Z","__v":0},{"_id":"6a06fb3b0233f8d04dd1db38","deploymentId":"69a9bcc427671ec5a2e05f92","questionText":"What fields can I include?","status":"active","generatedBy":"contextual","path":"api-reference/customers/create-a-customer","createdAt":"2026-05-15T10:53:47.434Z","updatedAt":"2026-05-15T10:53:47.434Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T10:20:50.305Z","originalFileLocation":"api-reference/customers/create-a-customer.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=\"light\"}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=\"Creation can outlast the request. When it does, the response is 202 with the id the customer will have, and the customer reads as 404 until creation finishes. Repeat the same request with the same Idempotency-Key to follow it: the repeat answers 202 while creation is still running and 201 with the customer once it is done.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Polygon Developer Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/polygon-labs/mGaxVdHZf09e3t79/_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/polygon-labs/mGaxVdHZf09e3t79/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/polygon-labs/mGaxVdHZf09e3t79/_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/polygon-labs/mGaxVdHZf09e3t79/_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/polygon-labs/mGaxVdHZf09e3t79/_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/polygon-labs/mGaxVdHZf09e3t79/_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/polygon-labs/mGaxVdHZf09e3t79/_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/polygon-labs/mGaxVdHZf09e3t79/_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/polygon-labs/mGaxVdHZf09e3t79/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a customer - Polygon Developer Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creation can outlast the request. When it does, the response is 202 with the id the customer will have, and the customer reads as 404 until creation finishes. Repeat the same request with the same Idempotency-Key to follow it: the repeat answers 202 while creation is still running and 201 with the customer once it is done.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Polygon Developer Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.polygon.technology/api-reference/customers/create-a-customer\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://polygon-labs.mintlify.site/_mintlify/api/og/v2?division=Customers\u0026amp;title=Create+a+customer\u0026amp;description=Creation+can+outlast+the+request.+When+it+does%2C+the+response+is+202+with+the+id+the+customer+will+have%2C+and+the+customer+reads+as+404+until+creation+finishes.+R\u0026amp;theme=b36bd2d42ef34b1589e85268\u0026amp;signature=db947f84587b2ae110df58d28747c19a4bc61dadf9f9dbf055f94d4622eb7007\">\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 a customer - Polygon Developer Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creation can outlast the request. When it does, the response is 202 with the id the customer will have, and the customer reads as 404 until creation finishes. Repeat the same request with the same Idempotency-Key to follow it: the repeat answers 202 while creation is still running and 201 with the customer once it is done.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://polygon-labs.mintlify.site/_mintlify/api/og/v2?division=Customers\u0026amp;title=Create+a+customer\u0026amp;description=Creation+can+outlast+the+request.+When+it+does%2C+the+response+is+202+with+the+id+the+customer+will+have%2C+and+the+customer+reads+as+404+until+creation+finishes.+R\u0026amp;theme=b36bd2d42ef34b1589e85268\u0026amp;signature=db947f84587b2ae110df58d28747c19a4bc61dadf9f9dbf055f94d4622eb7007\">\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/polygon-labs/mGaxVdHZf09e3t79/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Polygon Developer Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#670DE5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.polygon.technology/api-reference/customers/create-a-customer\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/customers/create-a-customer.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.polygon.technology/#organization\",\"name\":\"Polygon Developer Docs\",\"url\":\"https://docs.polygon.technology\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/polygon-labs/ll1LL3IdpC3YxXZu/logo/light.svg?fit=max\u0026auto=format\u0026n=ll1LL3IdpC3YxXZu\u0026q=85\u0026s=d54ddb30492807a0eadf38093c075f2f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.polygon.technology#website\",\"name\":\"Polygon Developer Docs\",\"url\":\"https://docs.polygon.technology\",\"publisher\":{\"@id\":\"https://docs.polygon.technology/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.polygon.technology/api-reference/customers/create-a-customer#webpage\",\"url\":\"https://docs.polygon.technology/api-reference/customers/create-a-customer\",\"name\":\"Create a customer\",\"description\":\"Creation can outlast the request. When it does, the response is 202 with the id the customer will have, and the customer reads as 404 until creation finishes. Repeat the same request with the same Idempotency-Key to follow it: the repeat answers 202 while creation is still running and 201 with the customer once it is done.\",\"dateModified\":\"2026-11-09T10:20:50.305Z\",\"isPartOf\":{\"@id\":\"https://docs.polygon.technology#website\"},\"breadcrumb\":{\"@id\":\"https://docs.polygon.technology/api-reference/customers/create-a-customer#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.polygon.technology/api-reference/customers/create-a-customer#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Platform\",\"item\":\"https://docs.polygon.technology/api-reference/auth/get-bearer-token\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a customer\",\"item\":\"https://docs.polygon.technology/api-reference/customers/create-a-customer\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.polygon.technology/api-reference/customers/create-a-customer#apireference\",\"headline\":\"Create a customer\",\"name\":\"Create a customer\",\"description\":\"Creation can outlast the request. When it does, the response is 202 with the id the customer will have, and the customer reads as 404 until creation finishes. Repeat the same request with the same Idempotency-Key to follow it: the repeat answers 202 while creation is still running and 201 with the customer once it is done.\",\"url\":\"https://docs.polygon.technology/api-reference/customers/create-a-customer\",\"mainEntityOfPage\":{\"@id\":\"https://docs.polygon.technology/api-reference/customers/create-a-customer#webpage\"},\"dateModified\":\"2026-11-09T10:20:50.305Z\",\"publisher\":{\"@id\":\"https://docs.polygon.technology/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.polygon.technology#website\"}}]}\u003c/script>","agentPointerHref":"/api-reference/customers/create-a-customer.md","siteName":"Polygon Developer Docs","nav":{"global":null,"tabs":[{"tab":"Platform","icon":"layer-group","pages":[{"title":"Platform","href":""}]},{"tab":"Payments","pages":[{"title":"Payments","href":"/payments/overview"}]},{"tab":"Wallets","pages":[{"title":"Wallets","href":"/wallets/overview"}]},{"tab":"Cross-chain","pages":[{"title":"Cross-chain","href":"/cross-chain"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Open Money Stack API","href":"/api-reference/overview"}]},{"group":"Move money","pages":[{"group":"Quotes","pages":[{"title":"Create a payment quote","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /quotes","href":"/api-reference/quote/create-a-payment-quote"},{"title":"Get quote by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /quotes/{quoteId}","href":"/api-reference/quote/get-quote-by-id"}]},{"group":"Transactions","pages":[{"title":"Execute a transaction (send)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /transactions","href":"/api-reference/transaction/execute-a-transaction-send"},{"title":"List transactions with filters","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /transactions","href":"/api-reference/transaction/list-transactions-with-filters"},{"title":"Get transaction by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /transactions/{transactionId}","href":"/api-reference/transaction/get-transaction-by-id"}]},{"group":"Transfers","pages":[{"title":"Get transfer by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /transfers/{transferId}","href":"/api-reference/transfer/get-transfer-by-id"}]},{"group":"Cash-In","pages":[{"title":"Create a cash-in deposit code","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /cash-ins","href":"/api-reference/cashins/create-a-cash-in-deposit-code"},{"title":"List cash-ins","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /cash-ins","href":"/api-reference/cashins/list-cash-ins"},{"title":"Get a cash-in by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /cash-ins/{cashInId}","href":"/api-reference/cashins/get-a-cash-in-by-id"},{"title":"Refresh a cash-in deposit code","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /cash-ins/{cashInId}/refresh","href":"/api-reference/cashins/refresh-a-cash-in-deposit-code"},{"title":"Cancel a cash-in","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /cash-ins/{cashInId}/cancel","href":"/api-reference/cashins/cancel-a-cash-in"}]}]},{"group":"Routes","pages":[{"group":"Deposit Addresses","pages":[{"title":"Create a Deposit Address","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /deposit-addresses","href":"/api-reference/depositaddress/create-a-deposit-address"},{"title":"List all Deposit Addresses","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /deposit-addresses","href":"/api-reference/depositaddress/list-all-deposit-addresses"},{"title":"Get a Deposit Address","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /deposit-addresses/{depositAddressId}","href":"/api-reference/depositaddress/get-a-deposit-address"},{"title":"Update a Deposit Address","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /deposit-addresses/{depositAddressId}","href":"/api-reference/depositaddress/update-a-deposit-address"}]},{"group":"Virtual Accounts","pages":[{"title":"Create a Virtual Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /virtual-accounts","href":"/api-reference/virtualaccount/create-a-virtual-account"},{"title":"List all Virtual Accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /virtual-accounts","href":"/api-reference/virtualaccount/list-all-virtual-accounts"},{"title":"Get a Virtual Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /virtual-accounts/{virtualAccountId}","href":"/api-reference/virtualaccount/get-a-virtual-account"},{"title":"Update a Virtual Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /virtual-accounts/{virtualAccountId}","href":"/api-reference/virtualaccount/update-a-virtual-account"},{"title":"Delete a Virtual Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /virtual-accounts/{virtualAccountId}","href":"/api-reference/virtualaccount/delete-a-virtual-account"}]}]},{"group":"External Payment Methods","pages":[{"group":"Counterparties","pages":[{"title":"Create a Counterparty","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /counterparties","href":"/api-reference/counterparty/create-a-counterparty"},{"title":"List Counterparties","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /counterparties","href":"/api-reference/counterparty/list-counterparties"},{"title":"Get a Counterparty","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /counterparties/{counterpartyId}","href":"/api-reference/counterparty/get-a-counterparty"},{"title":"Update a Counterparty","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /counterparties/{counterpartyId}","href":"/api-reference/counterparty/update-a-counterparty"},{"title":"Delete a Counterparty","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /counterparties/{counterpartyId}","href":"/api-reference/counterparty/delete-a-counterparty"}]},{"group":"External Accounts","pages":[{"title":"Create an External Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /external-accounts","href":"/api-reference/externalaccount/create-an-external-account"},{"title":"Register a card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /external-accounts/cards","href":"/api-reference/externalaccount/register-a-card"},{"title":"List External Accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /external-accounts","href":"/api-reference/externalaccount/list-external-accounts"},{"title":"Get an External Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /external-accounts/{externalAccountId}","href":"/api-reference/externalaccount/get-an-external-account"},{"title":"Update an External Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /external-accounts/{externalAccountId}","href":"/api-reference/externalaccount/update-an-external-account"},{"title":"Delete an External Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /external-accounts/{externalAccountId}","href":"/api-reference/externalaccount/delete-an-external-account"}]}]},{"group":"Platform","pages":[{"group":"Auth","pages":[{"title":"Get bearer token","description":"Exchanges an OMS API key + secret for a bearer token valid for 60 minutes. The token is signed by the OMS issuer and must be presented as `Authorization Bearer \u003ctoken>` on every other endpoint.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /auth/token","href":"/api-reference/auth/get-bearer-token"}]},{"group":"Customers","pages":[{"title":"Create a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /customers","href":"/api-reference/customers/create-a-customer"},{"title":"List customers","description":"Returns a paginated list of customers under the current Project.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /customers","href":"/api-reference/customers/list-customers"},{"title":"Get customer by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /customers/{customerId}","href":"/api-reference/customers/get-customer-by-id"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /customers/{customerId}","href":"/api-reference/customers/update-a-customer"},{"title":"Delete a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /customers/{customerId}","href":"/api-reference/customers/delete-a-customer"},{"title":"Get customer balance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /customers/{id}/balance","href":"/api-reference/customer/get-customer-balance"},{"title":"Create a browser token for a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /customers/{customerId}/token","href":"/api-reference/customertokens/create-a-browser-token-for-a-customer"},{"title":"Get browser risk configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /risk/config","href":"/api-reference/get-browser-risk-configuration"}]},{"group":"Business onboarding","pages":[{"title":"Post customers beneficiaries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /customers/{customerId}/beneficiaries","href":"/api-reference/business-onboarding/post-customers-beneficiaries"},{"title":"Get customers beneficiaries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /customers/{customerId}/beneficiaries/{beneficiaryId}","href":"/api-reference/business-onboarding/get-customers-beneficiaries"},{"title":"Get customers beneficiaries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /customers/{customerId}/beneficiaries/{beneficiaryId}","href":"/api-reference/business-onboarding/get-customers-beneficiaries"},{"title":"Put customers beneficiaries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /customers/{customerId}/beneficiaries/{beneficiaryId}","href":"/api-reference/business-onboarding/put-customers-beneficiaries"},{"title":"Delete customers beneficiaries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /customers/{customerId}/beneficiaries/{beneficiaryId}","href":"/api-reference/business-onboarding/delete-customers-beneficiaries"},{"title":"Post customers onboardings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /customers/{customerId}/onboardings","href":"/api-reference/business-onboarding/post-customers-onboardings"},{"title":"Get customers onboardings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /customers/{customerId}/onboardings/{onboardingId}","href":"/api-reference/business-onboarding/get-customers-onboardings"},{"title":"Get customers onboardings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /customers/{customerId}/onboardings/{onboardingId}","href":"/api-reference/business-onboarding/get-customers-onboardings"}]},{"group":"Wallets","pages":[{"title":"List wallets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /wallets","href":"/api-reference/wallet/list-wallets"},{"title":"Create a wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /wallets","href":"/api-reference/wallet/create-a-wallet"},{"title":"Get a wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /wallets/{id}","href":"/api-reference/wallet/get-a-wallet"},{"title":"Update a wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /wallets/{id}","href":"/api-reference/wallet/update-a-wallet"},{"title":"Get a wallet-provisioning operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /wallets/operations/{operationId}","href":"/api-reference/wallet/get-a-wallet-provisioning-operation"},{"title":"Associate an embedded wallet with a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /customers/{customerId}/wallets/associate","href":"/api-reference/wallets/associate-an-embedded-wallet-with-a-customer"}]},{"group":"Cash Locations","pages":[{"title":"List cash locations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /cash-locations","href":"/api-reference/cashlocation/list-cash-locations"}]},{"group":"Webhooks","pages":[{"title":"Webhook events","href":"/api-reference/webhook-events"},{"title":"Create a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /webhooks","href":"/api-reference/webhooks/create-a-webhook"},{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Get webhook by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /webhooks/{webhookId}","href":"/api-reference/webhooks/get-webhook-by-id"},{"title":"Update a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /webhooks/{webhookId}","href":"/api-reference/webhooks/update-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /webhooks/{webhookId}","href":"/api-reference/webhooks/delete-a-webhook"},{"title":"Enable a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /webhooks/{webhookId}/enable","href":"/api-reference/webhooks/enable-a-webhook"},{"title":"Disable a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /webhooks/{webhookId}/disable","href":"/api-reference/webhooks/disable-a-webhook"},{"title":"Rotate the signing key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /webhooks/{webhookId}/rotate-key","href":"/api-reference/webhooks/rotate-the-signing-key"},{"title":"Send a test delivery","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /webhooks/{webhookId}/test","href":"/api-reference/webhooks/send-a-test-delivery"},{"title":"List deliveries for a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /webhooks/{webhookId}/deliveries","href":"/api-reference/webhooks/list-deliveries-for-a-webhook"},{"title":"Get a delivery with its attempts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /webhooks/{webhookId}/deliveries/{deliveryId}","href":"/api-reference/webhooks/get-a-delivery-with-its-attempts"},{"title":"Retry deliveries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /webhooks/{webhookId}/deliveries/retry","href":"/api-reference/webhooks/retry-deliveries"}]},{"group":"Route transactions","pages":[{"title":"List Deposit Address transactions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /deposit-addresses/{depositAddressId}/transactions","href":"/api-reference/depositaddress/list-deposit-address-transactions"},{"title":"List Virtual Account transactions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /virtual-accounts/{virtualAccountId}/transactions","href":"/api-reference/virtualaccount/list-virtual-account-transactions"}]},{"group":"Reference","pages":[{"title":"List supported networks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /networks","href":"/api-reference/reference/list-supported-networks"},{"title":"Get account-type requirements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /reference/account-type-requirements","href":"/api-reference/reference/get-account-type-requirements"}]},{"group":"Sandbox Simulations","pages":[{"title":"Simulate inbound transfer on a Virtual Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /virtual-accounts/{virtualAccountId}/simulate/inbound-transfer","href":"/api-reference/sandbox/simulate-inbound-transfer-on-a-virtual-account"},{"title":"Simulate cash-in present code","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /cash-ins/{cashInId}/simulate/present-code","href":"/api-reference/sandbox/simulate-cash-in-present-code"},{"title":"Simulate cash-in deposit cash","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /cash-ins/{cashInId}/simulate/deposit-cash","href":"/api-reference/sandbox/simulate-cash-in-deposit-cash"},{"title":"Simulate cash-in cancel","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /cash-ins/{cashInId}/simulate/cancel","href":"/api-reference/sandbox/simulate-cash-in-cancel"}]}]},{"group":"Read onchain data","pages":[{"group":"Token Balances","pages":[{"title":"Get token balance summary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetTokenBalancesSummary","href":"/api-reference/indexer/get-token-balance-summary"},{"title":"Get token balance details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetTokenBalancesDetails","href":"/api-reference/indexer/get-token-balance-details"},{"title":"Get token balances by contract","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetTokenBalancesByContract","href":"/api-reference/indexer/get-token-balances-by-contract"},{"title":"Get native token balance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetNativeTokenBalance","href":"/api-reference/indexer/get-native-token-balance"},{"title":"Get balance updates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetBalanceUpdates","href":"/api-reference/indexer/get-balance-updates"},{"title":"Get Solana token balances","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/SolanaIndexerGateway/GetTokenBalancesDetails","href":"/api-reference/indexer/get-solana-token-balances"},{"title":"Get Tron token balances","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/TronIndexerGateway/GetTokenBalancesDetails","href":"/api-reference/indexer/get-tron-token-balances"}]},{"group":"Token Prices","pages":[{"title":"Get token price","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetTokenPrice","href":"/api-reference/indexer/get-token-price"},{"title":"Get token prices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetTokenPrices","href":"/api-reference/indexer/get-token-prices"}]},{"group":"Transaction History","pages":[{"title":"Get transaction history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetTransactionHistory","href":"/api-reference/indexer/get-transaction-history"}]},{"group":"Chains","pages":[{"title":"List chains","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetChains","href":"/api-reference/indexer/list-chains"}]}]}]},{"tab":"Infrastructure","icon":"server","pages":[{"title":"Infrastructure","href":"/infrastructure"}]},{"tab":"Polygon Chain","pages":[{"title":"Polygon Chain","href":"/pos/overview"}]},{"tab":"Polygon CDK","pages":[{"title":"Polygon CDK","href":"/chain-development/cdk"}]},{"tab":"Agglayer","pages":[{"title":"Agglayer","href":"/interoperability/overview"}]},{"tab":"Agentic","pages":[{"title":"Agentic","href":"/payment-services/agentic-payments/agent-integration/intro"}]}]},"basePath":"","title":"Create a customer - Polygon Developer Docs","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}