Full replacement of non-sensitive beneficiary facts. Omitted non-sensitive values are cleared. Sensitive identifiers are write-only; omission preserves their values and an empty string clears them. Enum values use camelCase.
{"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/neKXk5towK-oBDip/favicon.png?fit=max\u0026auto=format\u0026n=neKXk5towK-oBDip\u0026q=85\u0026s=64034729f6d0b52274b3093da8c47b2c","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":""},"chroma":{"liveDeploymentHistoryId":"6ae86f88b4392014d5239f62","collectionId":"3f7cb874-4540-4fe2-8531-4e763a494c9c","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae86f88b4392014d5239f62"},"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":"6ae8701bd2f0a6b0237db816","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Polygon Chain","count":385},{"language":"default","tag":"Wallets","count":172},{"language":"default","tag":"Developer Tools","count":94},{"language":"default","tag":"API Reference","count":84},{"language":"default","tag":"Agglayer","count":73},{"language":"default","tag":"Platform","count":70},{"language":"default","tag":"SDK","count":61},{"language":"default","tag":"Matic.js","count":59},{"language":"default","tag":"Non-custodial","count":59},{"language":"default","tag":"Guides","count":47}]},"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":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"sso-setup-deadline-banner","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}.fam-grp .nav-tabs-item,.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}.fam-grp .nav-tabs-item:hover,.nav-tabs a.nav-tabs-item:hover{color:#141635!important}html.dark .fam-grp .nav-tabs-item,html.dark .nav-tabs a.nav-tabs-item{color:rgba(255,255,255,.55)!important}html.dark .fam-grp .nav-tabs-item:hover,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{border-radius:8px;white-space:nowrap;text-decoration:none;transition:color 120ms ease,background 120ms ease!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,.14)}html.dark .fam-grp .nav-tabs-item.fam-active-tab{background:rgba(103,13,229,.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:0 0!important;color:#fff!important;border-color:rgba(255,255,255,.25)!important}html.dark #navbar a[href*=build-with-ai]:hover{border-color:#fff!important;background:rgba(255,255,255,.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:#fff!important;color:#0b0814!important;border-color:#fff!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,.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:.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:.875rem;padding-bottom:.875rem}.api-section .primitive-param-field .mt-4{margin-top:.5rem}@media (min-width:1600px){#body-content:has(.api-section){max-width:1760px}#body-content:has(.api-section) #content-container{max-width:1440px}}"}],"page":{"pagePath":"api-reference/business-onboarding/put-customers-beneficiaries","slug":"/api-reference/business-onboarding/put-customers-beneficiaries","pageMetadata":{"title":"Put customers beneficiaries","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /customers/{customerId}/beneficiaries/{beneficiaryId}","href":"/api-reference/business-onboarding/put-customers-beneficiaries","autogeneratedByOpenApi":true},"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":"Put customers beneficiaries","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /customers/{customerId}/beneficiaries/{beneficiaryId}","href":"/api-reference/business-onboarding/put-customers-beneficiaries","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":["Business onboarding"],"operationId":"updateBusinessBeneficiary","requestBody":"82d356cc-42f6-46a2-a735-ff6981c1c2f2","responses":{"200":"4d0579ac-6955-4b0c-bdd5-1ffcae84b4b4","400":"3b483a86-8fbf-4376-8701-17afb43d8f9c","401":"63fd18a3-a9bf-46f2-a736-81ddbd7b40b6","403":"3a0b5ed6-80d0-4a98-ab0e-0af934078503","404":"1548004a-1d4e-4b34-ba1c-81835ca1d24c","409":"d109c2e2-4453-4adf-817a-7d2ff65ed383","422":"543e10f1-4297-4080-a63c-a2f63c19137c"},"method":"put","type":"path","servers":["794a6118-d7ac-45b7-8528-60c6d8f8eb67","9c5f544c-965f-43fa-8e33-d87844cc5dff"],"security":["bcde8fa6-42e0-463c-a363-dff03dbabdee"],"path":"/customers/{customerId}/beneficiaries/{beneficiaryId}","baseUrlOptions":["https://sandbox-api.polygon.technology/v0.13","https://api.polygon.technology/v0.13"],"title":"","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"927140d2-6b10-459d-9858-cd0f2890ecb5":{"name":"customerId","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"e22f5ad7-231c-419e-9a8a-433b636f28b3":{"name":"beneficiaryId","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["version","input"],"properties":{"version":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"version","typeLabel":"integer"},"input":{"type":"object","description":"Full replacement of non-sensitive beneficiary facts. Omitted non-sensitive values are cleared. Sensitive identifiers are write-only; omission preserves their values and an empty string clears them. Enum values use camelCase.","required":["roles"],"properties":{"roles":{"type":"array","items":{"type":"string","enum":["beneficialOwner","controller","director","signatory","representative"],"uniqueKey":"input.roles.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"input.roles","typeLabel":"enum\u003cstring>[]"},"firstName":{"type":"string","uniqueKey":"input.firstName","typeLabel":"string"},"middleName":{"type":"string","uniqueKey":"input.middleName","typeLabel":"string"},"lastName":{"type":"string","uniqueKey":"input.lastName","typeLabel":"string"},"fullNameAsOnDocument":{"type":"string","uniqueKey":"input.fullNameAsOnDocument","typeLabel":"string"},"nationality":{"type":"string","uniqueKey":"input.nationality","typeLabel":"string"},"address":{"type":"object","properties":{"line1":{"type":"string","uniqueKey":"input.address.line1","typeLabel":"string"},"line2":{"type":"string","uniqueKey":"input.address.line2","typeLabel":"string"},"city":{"type":"string","uniqueKey":"input.address.city","typeLabel":"string"},"state":{"type":"string","uniqueKey":"input.address.state","typeLabel":"string"},"postalCode":{"type":"string","uniqueKey":"input.address.postalCode","typeLabel":"string"},"country":{"type":"string","uniqueKey":"input.address.country","typeLabel":"string"}},"uniqueKey":"input.address","typeLabel":"object"},"email":{"type":"string","uniqueKey":"input.email","typeLabel":"string"},"emailType":{"type":"string","enum":["personal","work","other"],"uniqueKey":"input.emailType","typeLabel":"enum\u003cstring>"},"phone":{"type":"string","uniqueKey":"input.phone","typeLabel":"string"},"phoneType":{"type":"string","enum":["home","mobile","work","fax"],"uniqueKey":"input.phoneType","typeLabel":"enum\u003cstring>"},"title":{"type":"string","uniqueKey":"input.title","typeLabel":"string"},"ownershipPercentage":{"type":"string","uniqueKey":"input.ownershipPercentage","typeLabel":"string"},"hasControl":{"type":"boolean","uniqueKey":"input.hasControl","typeLabel":"boolean"},"politicallyExposedPerson":{"type":"boolean","uniqueKey":"input.politicallyExposedPerson","typeLabel":"boolean"},"regO":{"type":"boolean","uniqueKey":"input.regO","typeLabel":"boolean"},"riskRating":{"type":"string","enum":["low","medium","high"],"uniqueKey":"input.riskRating","typeLabel":"enum\u003cstring>"},"taxIdType":{"type":"string","enum":["ein","vat","foreign","ssn","itin","foreignTin"],"uniqueKey":"input.taxIdType","typeLabel":"enum\u003cstring>"},"identificationType":{"type":"string","enum":["driversLicense","passport","idCard","socialSecurityCard","other"],"uniqueKey":"input.identificationType","typeLabel":"enum\u003cstring>"},"issuingAuthority":{"type":"string","uniqueKey":"input.issuingAuthority","typeLabel":"string"},"issuingCountry":{"type":"string","uniqueKey":"input.issuingCountry","typeLabel":"string"},"issuingState":{"type":"string","uniqueKey":"input.issuingState","typeLabel":"string"},"issuedDate":{"type":"string","uniqueKey":"input.issuedDate","typeLabel":"string"},"expirationDate":{"type":"string","uniqueKey":"input.expirationDate","typeLabel":"string"},"verifiedDate":{"type":"string","uniqueKey":"input.verifiedDate","typeLabel":"string"},"birthDate":{"type":"string","writeOnly":true,"uniqueKey":"input.birthDate","typeLabel":"string"},"taxId":{"type":"string","writeOnly":true,"uniqueKey":"input.taxId","typeLabel":"string"},"identificationNumber":{"type":"string","writeOnly":true,"uniqueKey":"input.identificationNumber","typeLabel":"string"}},"isRequired":true,"uniqueKey":"input","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"version":2,"input":{"roles":[],"firstName":"\u003cstring>","middleName":"\u003cstring>","lastName":"\u003cstring>","fullNameAsOnDocument":"\u003cstring>","nationality":"\u003cstring>","address":{"line1":"\u003cstring>","line2":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","postalCode":"\u003cstring>","country":"\u003cstring>"},"email":"\u003cstring>","phone":"\u003cstring>","title":"\u003cstring>","ownershipPercentage":"\u003cstring>","hasControl":true,"politicallyExposedPerson":true,"regO":true,"issuingAuthority":"\u003cstring>","issuingCountry":"\u003cstring>","issuingState":"\u003cstring>","issuedDate":"\u003cstring>","expirationDate":"\u003cstring>","verifiedDate":"\u003cstring>","birthDate":"\u003cstring>","taxId":"\u003cstring>","identificationNumber":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"4d0579ac-6955-4b0c-bdd5-1ffcae84b4b4":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["id","object","customerId","roles","version"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","enum":["businessBeneficiary"],"isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"customerId":{"type":"string","isRequired":true,"uniqueKey":"customerId","typeLabel":"string"},"roles":{"type":"array","items":{"type":"string","enum":["beneficialOwner","controller","director","signatory","representative"],"uniqueKey":"roles.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"roles","typeLabel":"enum\u003cstring>[]"},"version":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"version","typeLabel":"integer"},"firstName":{"type":"string","uniqueKey":"firstName","typeLabel":"string"},"middleName":{"type":"string","uniqueKey":"middleName","typeLabel":"string"},"lastName":{"type":"string","uniqueKey":"lastName","typeLabel":"string"},"fullNameAsOnDocument":{"type":"string","uniqueKey":"fullNameAsOnDocument","typeLabel":"string"},"nationality":{"type":"string","uniqueKey":"nationality","typeLabel":"string"},"address":{"type":"object","properties":{"line1":{"type":"string","uniqueKey":"address.line1","typeLabel":"string"},"line2":{"type":"string","uniqueKey":"address.line2","typeLabel":"string"},"city":{"type":"string","uniqueKey":"address.city","typeLabel":"string"},"state":{"type":"string","uniqueKey":"address.state","typeLabel":"string"},"postalCode":{"type":"string","uniqueKey":"address.postalCode","typeLabel":"string"},"country":{"type":"string","uniqueKey":"address.country","typeLabel":"string"}},"uniqueKey":"address","typeLabel":"object"},"email":{"type":"string","uniqueKey":"email","typeLabel":"string"},"emailType":{"type":"string","enum":["personal","work","other"],"uniqueKey":"emailType","typeLabel":"enum\u003cstring>"},"phone":{"type":"string","uniqueKey":"phone","typeLabel":"string"},"phoneType":{"type":"string","enum":["home","mobile","work","fax"],"uniqueKey":"phoneType","typeLabel":"enum\u003cstring>"},"title":{"type":"string","uniqueKey":"title","typeLabel":"string"},"ownershipPercentage":{"type":"string","uniqueKey":"ownershipPercentage","typeLabel":"string"},"hasControl":{"type":"boolean","uniqueKey":"hasControl","typeLabel":"boolean"},"politicallyExposedPerson":{"type":"boolean","uniqueKey":"politicallyExposedPerson","typeLabel":"boolean"},"regO":{"type":"boolean","uniqueKey":"regO","typeLabel":"boolean"},"riskRating":{"type":"string","enum":["low","medium","high"],"uniqueKey":"riskRating","typeLabel":"enum\u003cstring>"},"taxIdType":{"type":"string","enum":["ein","vat","foreign","ssn","itin","foreignTin"],"uniqueKey":"taxIdType","typeLabel":"enum\u003cstring>"},"identificationType":{"type":"string","enum":["driversLicense","passport","idCard","socialSecurityCard","other"],"uniqueKey":"identificationType","typeLabel":"enum\u003cstring>"},"issuingAuthority":{"type":"string","uniqueKey":"issuingAuthority","typeLabel":"string"},"issuingCountry":{"type":"string","uniqueKey":"issuingCountry","typeLabel":"string"},"issuingState":{"type":"string","uniqueKey":"issuingState","typeLabel":"string"},"issuedDate":{"type":"string","uniqueKey":"issuedDate","typeLabel":"string"},"expirationDate":{"type":"string","uniqueKey":"expirationDate","typeLabel":"string"},"verifiedDate":{"type":"string","uniqueKey":"verifiedDate","typeLabel":"string"},"hasBirthDate":{"type":"boolean","uniqueKey":"hasBirthDate","typeLabel":"boolean"},"hasTaxId":{"type":"boolean","uniqueKey":"hasTaxId","typeLabel":"boolean"},"hasIdentificationNumber":{"type":"boolean","uniqueKey":"hasIdentificationNumber","typeLabel":"boolean"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","object":"businessBeneficiary","customerId":"\u003cstring>","roles":["beneficialOwner"],"version":2,"firstName":"\u003cstring>","middleName":"\u003cstring>","lastName":"\u003cstring>","fullNameAsOnDocument":"\u003cstring>","nationality":"\u003cstring>","address":{"line1":"\u003cstring>","line2":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","postalCode":"\u003cstring>","country":"\u003cstring>"},"email":"\u003cstring>","emailType":"personal","phone":"\u003cstring>","phoneType":"home","title":"\u003cstring>","ownershipPercentage":"\u003cstring>","hasControl":true,"politicallyExposedPerson":true,"regO":true,"riskRating":"low","taxIdType":"ein","identificationType":"driversLicense","issuingAuthority":"\u003cstring>","issuingCountry":"\u003cstring>","issuingState":"\u003cstring>","issuedDate":"\u003cstring>","expirationDate":"\u003cstring>","verifiedDate":"\u003cstring>","hasBirthDate":true,"hasTaxId":true,"hasIdentificationNumber":true,"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"3b483a86-8fbf-4376-8701-17afb43d8f9c":{"description":"Request failed","content":{"application/json":{"schema":{"type":"object","required":["error","code","msg","status"],"description":"Canonical OMSX error envelope, matching the webrpc shape every OMSX service emits. Names and numeric codes are stable identifiers defined in `schema/omsx/errors.ridl`.","properties":{"error":{"type":"string","description":"Stable error name from schema/omsx/errors.ridl","example":"Unauthorized","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"integer","description":"Stable numeric code from schema/omsx/errors.ridl","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"},"63fd18a3-a9bf-46f2-a736-81ddbd7b40b6":{"description":"Request failed","content":{"application/json":{"schema":{"type":"object","required":["error","code","msg","status"],"description":"Canonical OMSX error envelope, matching the webrpc shape every OMSX service emits. Names and numeric codes are stable identifiers defined in `schema/omsx/errors.ridl`.","properties":{"error":{"type":"string","description":"Stable error name from schema/omsx/errors.ridl","example":"Unauthorized","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"integer","description":"Stable numeric code from schema/omsx/errors.ridl","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"},"3a0b5ed6-80d0-4a98-ab0e-0af934078503":{"description":"Request failed","content":{"application/json":{"schema":{"type":"object","required":["error","code","msg","status"],"description":"Canonical OMSX error envelope, matching the webrpc shape every OMSX service emits. Names and numeric codes are stable identifiers defined in `schema/omsx/errors.ridl`.","properties":{"error":{"type":"string","description":"Stable error name from schema/omsx/errors.ridl","example":"Unauthorized","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"integer","description":"Stable numeric code from schema/omsx/errors.ridl","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"},"1548004a-1d4e-4b34-ba1c-81835ca1d24c":{"description":"Request failed","content":{"application/json":{"schema":{"type":"object","required":["error","code","msg","status"],"description":"Canonical OMSX error envelope, matching the webrpc shape every OMSX service emits. Names and numeric codes are stable identifiers defined in `schema/omsx/errors.ridl`.","properties":{"error":{"type":"string","description":"Stable error name from schema/omsx/errors.ridl","example":"Unauthorized","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"integer","description":"Stable numeric code from schema/omsx/errors.ridl","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"},"d109c2e2-4453-4adf-817a-7d2ff65ed383":{"description":"Request failed","content":{"application/json":{"schema":{"type":"object","required":["error","code","msg","status"],"description":"Canonical OMSX error envelope, matching the webrpc shape every OMSX service emits. Names and numeric codes are stable identifiers defined in `schema/omsx/errors.ridl`.","properties":{"error":{"type":"string","description":"Stable error name from schema/omsx/errors.ridl","example":"Unauthorized","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"integer","description":"Stable numeric code from schema/omsx/errors.ridl","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"},"543e10f1-4297-4080-a63c-a2f63c19137c":{"description":"Request failed","content":{"application/json":{"schema":{"type":"object","required":["error","code","msg","status"],"description":"Canonical OMSX error envelope, matching the webrpc shape every OMSX service emits. Names and numeric codes are stable identifiers defined in `schema/omsx/errors.ridl`.","properties":{"error":{"type":"string","description":"Stable error name from schema/omsx/errors.ridl","example":"Unauthorized","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"integer","description":"Stable numeric code from schema/omsx/errors.ridl","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":{"bcde8fa6-42e0-463c-a363-dff03dbabdee":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token from POST /auth/token","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"794a6118-d7ac-45b7-8528-60c6d8f8eb67":{"url":"https://sandbox-api.polygon.technology/v0.13","description":"Sandbox"},"9c5f544c-965f-43fa-8e33-d87844cc5dff":{"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":"Put customers beneficiaries - Polygon Developer Docs","contextualStarterQuestions":[],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-02T11:12:51.594Z","originalFileLocation":"api-reference/business-onboarding/put-customers-beneficiaries.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=\"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/62XjF4p_S3sLlTMv/_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/62XjF4p_S3sLlTMv/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/polygon-labs/62XjF4p_S3sLlTMv/_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/62XjF4p_S3sLlTMv/_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/62XjF4p_S3sLlTMv/_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/62XjF4p_S3sLlTMv/_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/62XjF4p_S3sLlTMv/_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/62XjF4p_S3sLlTMv/_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/62XjF4p_S3sLlTMv/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Put customers beneficiaries - Polygon Developer Docs\">\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/business-onboarding/put-customers-beneficiaries\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://polygon-labs.mintlify.app/_mintlify/api/og/v2?division=Business+onboarding\u0026amp;title=Put+customers+beneficiaries\u0026amp;theme=430e64796fff481709b26ceb\u0026amp;signature=3364c33665f8814136a03f4a328d314ada9e108b42d0df45de61f7a0e1ab7c35\">\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=\"Put customers beneficiaries - Polygon Developer Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://polygon-labs.mintlify.app/_mintlify/api/og/v2?division=Business+onboarding\u0026amp;title=Put+customers+beneficiaries\u0026amp;theme=430e64796fff481709b26ceb\u0026amp;signature=3364c33665f8814136a03f4a328d314ada9e108b42d0df45de61f7a0e1ab7c35\">\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/62XjF4p_S3sLlTMv/_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/business-onboarding/put-customers-beneficiaries\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/business-onboarding/put-customers-beneficiaries.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/business-onboarding/put-customers-beneficiaries#webpage\",\"url\":\"https://docs.polygon.technology/api-reference/business-onboarding/put-customers-beneficiaries\",\"name\":\"Put customers beneficiaries\",\"dateModified\":\"2026-11-02T11:12:51.594Z\",\"isPartOf\":{\"@id\":\"https://docs.polygon.technology#website\"},\"breadcrumb\":{\"@id\":\"https://docs.polygon.technology/api-reference/business-onboarding/put-customers-beneficiaries#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.polygon.technology/api-reference/business-onboarding/put-customers-beneficiaries#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Platform\",\"item\":\"https://docs.polygon.technology/api-reference/auth/get-bearer-token\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Business onboarding\",\"item\":\"https://docs.polygon.technology/api-reference/business-onboarding/post-customers-beneficiaries\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Put customers beneficiaries\",\"item\":\"https://docs.polygon.technology/api-reference/business-onboarding/put-customers-beneficiaries\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.polygon.technology/api-reference/business-onboarding/put-customers-beneficiaries#apireference\",\"headline\":\"Put customers beneficiaries\",\"name\":\"Put customers beneficiaries\",\"url\":\"https://docs.polygon.technology/api-reference/business-onboarding/put-customers-beneficiaries\",\"mainEntityOfPage\":{\"@id\":\"https://docs.polygon.technology/api-reference/business-onboarding/put-customers-beneficiaries#webpage\"},\"dateModified\":\"2026-11-02T11:12:51.594Z\",\"publisher\":{\"@id\":\"https://docs.polygon.technology/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.polygon.technology#website\"}}]}\u003c/script>","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"}]}]},{"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":"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","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","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","description":null,"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","description":null,"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":"Put customers beneficiaries - Polygon Developer Docs","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}