{
"success": false,
"errors": [
{
"code": "unauthenticated",
"message": "Please authenticate to perform this action."
}
]
}
{
"success": false,
"errors": [
{
"code": "forbidden",
"message": "You do not have permission to access this resource."
}
]
}
{
"success": false,
"errors": [
{
"code": "account-not-found",
"message": "The requested resource was not found."
}
]
}
{
"success": false,
"errors": [
{
"code": "concurrent-modification",
"message": "This request has been modified by another user. Please refresh and try again."
}
]
}
{
"success": false,
"errors": [
{
"code": "unauthenticated",
"message": "Please authenticate to perform this action."
}
]
}
{
"success": false,
"errors": [
{
"code": "forbidden",
"message": "You do not have permission to access this resource."
}
]
}
{
"success": false,
"errors": [
{
"code": "account-not-found",
"message": "The requested resource was not found."
}
]
}
{
"success": false,
"errors": [
{
"code": "concurrent-modification",
"message": "This request has been modified by another user. Please refresh and try again."
}
]
}
Requires scope:manage:parties — see Required scopes.Patches only the fields you send. Include the current version (from a prior read); a stale version returns 409 so you can refetch and retry (see Versioning). partyType cannot be changed after creation.
Which tenant the request is scoped to, among those your token grants. Omit it when the token
grants exactly one tenant; it is required when the token grants more than one. A supplied
value must exactly match a tenant the token grants.
Absent when required, blank, malformed, or naming a tenant the token does not grant — each gets
the same generic 403 forbidden, which reveals neither whether a tenant exists nor which ones
you may use. Send the header once: a repeated header is rejected the same way.
Update party details. Only fields applicable to the party type can be updated.
For Individuals: firstName, lastName, address.
For Organisations: name, vatNumber, address.
Contact email for the party, kept as your own record. Optional — omitting it never blocks an
onboarding. When an account holder is onboarded to a partner, the email travels only as far as
Venly's verification case: the partner is given a Venly-controlled address instead, so its
operational and pricing mail never reaches the party directly.
A party represents an Individual or Organisation that can hold accounts.
The partyType field determines which additional fields are present.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Venly Finance","colors":{"primary":"#e07826","light":"#f0a060","dark":"#c56820"},"logo":{"light":"https://mintcdn.com/venly/NZGy1d4c4LA-0jM9/logo/light_venly_logo.png?fit=max\u0026auto=format\u0026n=NZGy1d4c4LA-0jM9\u0026q=85\u0026s=d808fd8f702829ca93bf607f200800bb","dark":"https://mintcdn.com/venly/NZGy1d4c4LA-0jM9/logo/dark_venly_logo.png?fit=max\u0026auto=format\u0026n=NZGy1d4c4LA-0jM9\u0026q=85\u0026s=3bafc93202007edf53e789ed58bc7002","href":"https://venlyfinance.com"},"favicon":"https://mintcdn.com/venly/MUxny2c1OXcZxLbW/logo/favicon_logo.png?fit=max\u0026auto=format\u0026n=MUxny2c1OXcZxLbW\u0026q=85\u0026s=892dd58ed49fe804011fcf42f60f82d4","api":{"playground":{"display":"interactive"}},"navbar":{"primary":{"type":"button","label":"Venly","href":"https://venlyfinance.com"}},"footer":{"socials":{"x":"https://x.com/Venly_io","linkedin":"https://be.linkedin.com/company/venly-io"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://venlyfinance.com/blog"},{"anchor":"Support","icon":"envelope","href":"https://venlyfinance.com/contact"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"venly","hasAudioNarration":false,"actualSubdomain":"venly","customDomains":["docs.venlyfinance.com"],"gitSource":{"type":"github","owner":"venly","repo":"mintlify-api-docs-main","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ad0bd1e4dcba6f2ddf906eb","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"Finance API","count":98},{"language":"default","tag":"Fundflow API","count":45},{"language":"default","tag":"Parties","count":13},{"language":"default","tag":"Core Concepts","count":13},{"language":"default","tag":"Ramp Requests","count":12},{"language":"default","tag":"Overview","count":10},{"language":"default","tag":"Webhooks","count":9},{"language":"default","tag":"Onboarding \u0026 Verification","count":9},{"language":"default","tag":"Accounts","count":6},{"language":"default","tag":"Getting Started","count":6}]},"assistantConfig":{},"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":"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},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/Finance-API/parties/update-party-details","slug":"/api-reference/Finance-API/parties/update-party-details","pageMetadata":{"title":"Update a party","description":"Update an existing party's name, VAT number, or address.","openapi":"api-reference/Finance-API-Specs.yaml PATCH /parties/{partyId}","href":"/api-reference/Finance-API/parties/update-party-details"},"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: \"Update an existing party’s name, VAT number, or address.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Requires scope:`}),` `,_jsx(_components.code,{children:`manage:parties`}),` — see `,_jsx(_components.a,{href:`/getting-started/authentication#required-scopes-finance-api`,children:`Required scopes`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Patches only the fields you send. Include the current `,_jsx(_components.code,{children:`version`}),` (from a prior read); a stale `,_jsx(_components.code,{children:`version`}),` returns `,_jsx(_components.code,{children:`409`}),` so you can refetch and retry (see `,_jsx(_components.a,{href:`/getting-started/conventions#versioning`,children:`Versioning`}),`). `,_jsx(_components.code,{children:`partyType`}),` cannot be changed after creation.`]})]})}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":"Update a party","description":"Update an existing party's name, VAT number, or address.","openapi":"api-reference/Finance-API-Specs.yaml PATCH /parties/{partyId}","href":"/api-reference/Finance-API/parties/update-party-details"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Parties"],"summary":"Update party details","description":"Update an existing party's name, VAT number, or address.","operationId":"updateParty","parameters":["35ce86df-3ce6-44cf-bd8e-3cb286ab27f8"],"requestBody":"91b58878-234e-4be9-a2d3-ba8b223d7269","responses":{"200":"a0dc1d9a-47a1-4a7d-8064-3ec650113d59","400":"a6b7fcdd-e3a5-4e6d-acff-c49aebe1e654","401":"d40f3750-8f4f-4af0-96fb-43c30fbddaa8","403":"09c196cb-d731-41fd-b77b-85f68bd538e7","404":"2f3f09db-f0d6-443c-8db8-033d8e2ee55c","409":"6fd3a96b-183a-4873-a5b7-b8241a730011","500":"d289935a-a0ae-4fb6-b4c2-c85e316b994c"},"method":"patch","type":"path","servers":["21e412a3-a369-4e3e-8c53-f1ccb83c3a83","bed023ee-c018-412c-ba06-d7ddf85d8199"],"security":["cea216b5-9159-488e-a42d-f5626675ace3"],"path":"/parties/{partyId}","baseUrlOptions":["https://api.venlyfinance.com/v1","https://api-staging.venlyfinance.com/v1"],"title":"Update party details","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"35ce86df-3ce6-44cf-bd8e-3cb286ab27f8":{"name":"partyId","in":"path","required":true,"description":"Unique party identifier","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Unique party identifier","uniqueKey":"","typeLabel":"string\u003cuuid>"},"example":"7e3b9c2a-1f4d-4a8b-9c11-2d6e8f0a1b22"},"0cd939ce-c989-45dd-8b07-3b56c528a035":{"name":"x-tenant-id","in":"header","required":false,"description":"Which tenant the request is scoped to, among those your token grants. Omit it when the token\ngrants exactly one tenant; it is **required** when the token grants more than one. A supplied\nvalue must exactly match a tenant the token grants.\n\nAbsent when required, blank, malformed, or naming a tenant the token does not grant — each gets\nthe same generic `403 forbidden`, which reveals neither whether a tenant exists nor which ones\nyou may use. Send the header once: a repeated header is rejected the same way.\n","schema":{"type":"string","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","isRequired":false,"description":"Which tenant the request is scoped to, among those your token grants. Omit it when the token\ngrants exactly one tenant; it is **required** when the token grants more than one. A supplied\nvalue must exactly match a tenant the token grants.\n\nAbsent when required, blank, malformed, or naming a tenant the token does not grant — each gets\nthe same generic `403 forbidden`, which reveals neither whether a tenant exists nor which ones\nyou may use. Send the header once: a repeated header is rejected the same way.\n","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["version"],"description":"Update party details. Only fields applicable to the party type can be updated.\nFor Individuals: firstName, lastName, address.\nFor Organisations: name, vatNumber, address.\n","properties":{"version":{"type":"integer","format":"int64","description":"Current version of the party for optimistic locking","isRequired":true,"uniqueKey":"version","typeLabel":"integer\u003cint64>"},"firstName":{"type":"string","maxLength":100,"description":"First name (Individual only)","uniqueKey":"firstName","typeLabel":"string"},"lastName":{"type":"string","maxLength":100,"description":"Last name (Individual only)","uniqueKey":"lastName","typeLabel":"string"},"name":{"type":"string","maxLength":255,"description":"Organisation name (Organisation only)","uniqueKey":"name","typeLabel":"string"},"vatNumber":{"type":"string","maxLength":50,"description":"VAT number (Organisation only)","uniqueKey":"vatNumber","typeLabel":"string"},"email":{"oneOf":[{"type":"string","format":"email","maxLength":255,"description":"Contact email for the party, kept as your own record. Optional — omitting it never blocks an\nonboarding. When an account holder is onboarded to a partner, the email travels only as far as\nVenly's verification case: the partner is given a Venly-controlled address instead, so its\noperational and pricing mail never reaches the party directly.\n","uniqueKey":"email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","maxLength":255,"description":"Contact email for the party, kept as your own record. Optional — omitting it never blocks an\nonboarding. When an account holder is onboarded to a partner, the email travels only as far as\nVenly's verification case: the partner is given a Venly-controlled address instead, so its\noperational and pricing mail never reaches the party directly.\n","uniqueKey":"email.oneOf.1","typeLabel":"null"}],"uniqueKey":"email","typeLabel":"string\u003cemail> | null"},"address":{"type":"object","description":"Standardized address format used across all endpoints","properties":{"addressLine1":{"type":"string","maxLength":255,"uniqueKey":"address.addressLine1","typeLabel":"string"},"addressLine2":{"type":"string","maxLength":255,"uniqueKey":"address.addressLine2","typeLabel":"string"},"city":{"type":"string","maxLength":100,"uniqueKey":"address.city","typeLabel":"string"},"state":{"type":"string","maxLength":100,"uniqueKey":"address.state","typeLabel":"string"},"postalCode":{"type":"string","maxLength":20,"uniqueKey":"address.postalCode","typeLabel":"string"},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country code","uniqueKey":"address.country","typeLabel":"string"}},"uniqueKey":"address","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"version":0,"firstName":"Janet","lastName":"Doe"},"examples":{"Example":{"title":"Example","value":{"version":0,"firstName":"Janet","lastName":"Doe"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"a0dc1d9a-47a1-4a7d-8064-3ec650113d59":{"description":"Party updated","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful","uniqueKey":"success","typeLabel":"boolean"},"result":{"type":"object","description":"A party represents an Individual or Organisation that can hold accounts.\nThe partyType field determines which additional fields are present.\n","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"result.id","typeLabel":"string\u003cuuid>"},"externalId":{"type":"string","description":"External reference ID","uniqueKey":"result.externalId","typeLabel":"string"},"partyType":{"type":"string","description":"Type of party","enum":["INDIVIDUAL","ORGANISATION"],"uniqueKey":"result.partyType","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"Status of a party","enum":["ACTIVE","SUSPENDED","BLOCKED"],"uniqueKey":"result.status","typeLabel":"enum\u003cstring>"},"firstName":{"type":"string","description":"First name (Individual only)","uniqueKey":"result.firstName","typeLabel":"string"},"lastName":{"type":"string","description":"Last name (Individual only)","uniqueKey":"result.lastName","typeLabel":"string"},"kycStatus":{"type":"string","description":"KYC verification status (Individuals \u0026 accounts).\n- `VERIFICATION_PENDING` — awaiting a verdict; money movement is blocked\n- `VERIFIED` — approved; all operations available\n- `REJECTED` — verification was declined\n- `NOT_REQUIRED` — **accounts only.** The tenant manages KYC itself, so Venly does not gate on its\n own verification. Settable only at account creation, and only once a **Venly admin has enabled the\n tenant-managed KYC flag** on the company tenant; otherwise the call fails with\n `kyc-not-required-not-allowed`. The flag is granted for testing rather than production use —\n production integrations verify via a hosted verification link or Sumsub token sharing.\n","enum":["VERIFICATION_PENDING","VERIFIED","NOT_REQUIRED","REJECTED"],"uniqueKey":"result.kycStatus","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Organisation name (Organisation only)","uniqueKey":"result.name","typeLabel":"string"},"vatNumber":{"type":"string","description":"VAT number (Organisation only)","uniqueKey":"result.vatNumber","typeLabel":"string"},"kybStatus":{"type":"string","description":"KYB verification status (Organisations)","enum":["PENDING","VERIFIED","DENIED"],"uniqueKey":"result.kybStatus","typeLabel":"enum\u003cstring>"},"partnerTermsStatus":{"type":"string","description":"Whether a party's end customer still has to accept our partners' terms. Party-level and\npartner-agnostic — one value regardless of how many partners are involved.\n\n- `NOT_REQUIRED` — nothing outstanding. Also the answer for a party that has not passed KYC yet, since\n there is nothing to accept before then.\n- `REQUIRED` — the end customer must accept before onboarding can proceed. A `consentUrl` is always\n present alongside this value.\n- `ACCEPTED` — every enabled partner's **currently-active** terms have been accepted, so onboarding\n is not blocked on consent.\n\n\u003cNote>\n`ACCEPTED` is **not** terminal, because it is evaluated against the terms that are active *now*.\nEnabling a new partner, or a partner publishing a new terms version, supersedes what was accepted and\nmoves the party back to `REQUIRED`. Re-read it rather than caching it as a completed milestone.\n\u003c/Note>\n","enum":["NOT_REQUIRED","REQUIRED","ACCEPTED"],"uniqueKey":"result.partnerTermsStatus","typeLabel":"enum\u003cstring>"},"partnerOnboardingStatus":{"type":"string","description":"Where the party stands with our banking partner's recipient checks — the state behind the\n`partner-onboarding-pending` / `partner-onboarding-rejected` provisioning errors, readable\nwithout attempting provisioning. A party-level attribute: the meaningful value for an account\nis its account-holder party's. Also available as\n[`GET /parties/{partyId}/partner-onboarding`](/api-reference/Finance-API/parties/get-a-partys-partner-onboarding-status).\n","enum":["NOT_STARTED","PENDING","APPROVED","REJECTED"],"uniqueKey":"result.partnerOnboardingStatus","typeLabel":"enum\u003cstring>"},"email":{"oneOf":[{"type":"string","format":"email","maxLength":255,"description":"Contact email for the party, kept as your own record. Optional — omitting it never blocks an\nonboarding. When an account holder is onboarded to a partner, the email travels only as far as\nVenly's verification case: the partner is given a Venly-controlled address instead, so its\noperational and pricing mail never reaches the party directly.\n","uniqueKey":"result.email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","maxLength":255,"description":"Contact email for the party, kept as your own record. Optional — omitting it never blocks an\nonboarding. When an account holder is onboarded to a partner, the email travels only as far as\nVenly's verification case: the partner is given a Venly-controlled address instead, so its\noperational and pricing mail never reaches the party directly.\n","uniqueKey":"result.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.email","typeLabel":"string\u003cemail> | null"},"address":{"type":"object","description":"Standardized address format used across all endpoints","properties":{"addressLine1":{"type":"string","maxLength":255,"uniqueKey":"result.address.addressLine1","typeLabel":"string"},"addressLine2":{"type":"string","maxLength":255,"uniqueKey":"result.address.addressLine2","typeLabel":"string"},"city":{"type":"string","maxLength":100,"uniqueKey":"result.address.city","typeLabel":"string"},"state":{"type":"string","maxLength":100,"uniqueKey":"result.address.state","typeLabel":"string"},"postalCode":{"type":"string","maxLength":20,"uniqueKey":"result.address.postalCode","typeLabel":"string"},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country code","uniqueKey":"result.address.country","typeLabel":"string"}},"uniqueKey":"result.address","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"result.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","uniqueKey":"result.updatedAt","typeLabel":"string\u003cdate-time>"},"version":{"type":"integer","format":"int64","description":"Optimistic-locking version, required when updating","uniqueKey":"result.version","typeLabel":"integer\u003cint64>"}},"uniqueKey":"result","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":true,"result":{"id":"7e3b9c2a-1f4d-4a8b-9c11-2d6e8f0a1b22","externalId":"user-12345","partyType":"INDIVIDUAL","status":"ACTIVE","firstName":"Janet","lastName":"Doe","address":{"addressLine1":"1 Example Street","city":"Amsterdam","postalCode":"1011AB","country":"NL"},"createdAt":"2026-01-15T09:30:00Z","updatedAt":"2026-01-15T09:30:00Z","version":0}},"examples":{"Example":{"title":"Example","value":{"success":true,"result":{"id":"7e3b9c2a-1f4d-4a8b-9c11-2d6e8f0a1b22","externalId":"user-12345","partyType":"INDIVIDUAL","status":"ACTIVE","firstName":"Janet","lastName":"Doe","address":{"addressLine1":"1 Example Street","city":"Amsterdam","postalCode":"1011AB","country":"NL"},"createdAt":"2026-01-15T09:30:00Z","updatedAt":"2026-01-15T09:30:00Z","version":0}}}},"exampleType":"examples"}},"exampleType":"examples"},"a6b7fcdd-e3a5-4e6d-acff-c49aebe1e654":{"description":"Request validation failed (400)","content":{"application/json":{"schema":{"type":"object","description":"Error response wrapper","properties":{"success":{"type":"boolean","description":"Always false for error responses","example":false,"uniqueKey":"success","typeLabel":"boolean"},"errors":{"type":"array","description":"List of errors that occurred","items":{"type":"object","description":"Individual error details","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"invalid-request","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"The request contains invalid parameters.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"result":{"oneOf":[{"type":"object","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.1","typeLabel":"null"}],"uniqueKey":"result","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"errors":[{"code":"invalid-request","message":"The request contains invalid parameters."}]},"examples":{"Example":{"title":"Example","value":{"success":false,"errors":[{"code":"invalid-request","message":"The request contains invalid parameters."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"d40f3750-8f4f-4af0-96fb-43c30fbddaa8":{"description":"Authentication required or failed (401)","content":{"application/json":{"schema":{"type":"object","description":"Error response wrapper","properties":{"success":{"type":"boolean","description":"Always false for error responses","example":false,"uniqueKey":"success","typeLabel":"boolean"},"errors":{"type":"array","description":"List of errors that occurred","items":{"type":"object","description":"Individual error details","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"invalid-request","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"The request contains invalid parameters.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"result":{"oneOf":[{"type":"object","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.1","typeLabel":"null"}],"uniqueKey":"result","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"errors":[{"code":"unauthenticated","message":"Please authenticate to perform this action."}]},"examples":{"Example":{"title":"Example","value":{"success":false,"errors":[{"code":"unauthenticated","message":"Please authenticate to perform this action."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"09c196cb-d731-41fd-b77b-85f68bd538e7":{"description":"Caller lacks the required authority/role (403)","content":{"application/json":{"schema":{"type":"object","description":"Error response wrapper","properties":{"success":{"type":"boolean","description":"Always false for error responses","example":false,"uniqueKey":"success","typeLabel":"boolean"},"errors":{"type":"array","description":"List of errors that occurred","items":{"type":"object","description":"Individual error details","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"invalid-request","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"The request contains invalid parameters.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"result":{"oneOf":[{"type":"object","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.1","typeLabel":"null"}],"uniqueKey":"result","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"errors":[{"code":"forbidden","message":"You do not have permission to access this resource."}]},"examples":{"Example":{"title":"Example","value":{"success":false,"errors":[{"code":"forbidden","message":"You do not have permission to access this resource."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"2f3f09db-f0d6-443c-8db8-033d8e2ee55c":{"description":"Resource not found (404)","content":{"application/json":{"schema":{"type":"object","description":"Error response wrapper","properties":{"success":{"type":"boolean","description":"Always false for error responses","example":false,"uniqueKey":"success","typeLabel":"boolean"},"errors":{"type":"array","description":"List of errors that occurred","items":{"type":"object","description":"Individual error details","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"invalid-request","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"The request contains invalid parameters.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"result":{"oneOf":[{"type":"object","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.1","typeLabel":"null"}],"uniqueKey":"result","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"errors":[{"code":"account-not-found","message":"The requested resource was not found."}]},"examples":{"Example":{"title":"Example","value":{"success":false,"errors":[{"code":"account-not-found","message":"The requested resource was not found."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"6fd3a96b-183a-4873-a5b7-b8241a730011":{"description":"Resource conflict / optimistic-lock failure (409)","content":{"application/json":{"schema":{"type":"object","description":"Error response wrapper","properties":{"success":{"type":"boolean","description":"Always false for error responses","example":false,"uniqueKey":"success","typeLabel":"boolean"},"errors":{"type":"array","description":"List of errors that occurred","items":{"type":"object","description":"Individual error details","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"invalid-request","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"The request contains invalid parameters.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"result":{"oneOf":[{"type":"object","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.1","typeLabel":"null"}],"uniqueKey":"result","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"errors":[{"code":"concurrent-modification","message":"This request has been modified by another user. Please refresh and try again."}]},"examples":{"Example":{"title":"Example","value":{"success":false,"errors":[{"code":"concurrent-modification","message":"This request has been modified by another user. Please refresh and try again."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"d289935a-a0ae-4fb6-b4c2-c85e316b994c":{"description":"Unexpected server error (500)","content":{"application/json":{"schema":{"type":"object","description":"Error response wrapper","properties":{"success":{"type":"boolean","description":"Always false for error responses","example":false,"uniqueKey":"success","typeLabel":"boolean"},"errors":{"type":"array","description":"List of errors that occurred","items":{"type":"object","description":"Individual error details","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"invalid-request","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"The request contains invalid parameters.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"result":{"oneOf":[{"type":"object","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.1","typeLabel":"null"}],"uniqueKey":"result","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"errors":[{"code":"internal-error","message":"An unexpected error occurred. Please try again later."}]},"examples":{"Example":{"title":"Example","value":{"success":false,"errors":[{"code":"internal-error","message":"An unexpected error occurred. Please try again later."}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"cea216b5-9159-488e-a42d-f5626675ace3":{"OAuth2":{"type":"oauth2","description":"OAuth2 client credentials flow. Token endpoints:\n- Staging: https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token\n- Production: https://login.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token\n","flows":{"clientCredentials":{"tokenUrl":"https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token","scopes":{}}},"scopes":[],"schemeName":"OAuth2"}}},"servers":{"21e412a3-a369-4e3e-8c53-f1ccb83c3a83":{"url":"https://api.venlyfinance.com/v1","description":"Production"},"bed023ee-c018-412c-ba06-d7ddf85d8199":{"url":"https://api-staging.venlyfinance.com/v1","description":"Staging"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"oauth2","description":"OAuth2 client credentials flow. Token endpoints:\n- Staging: https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token\n- Production: https://login.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token\n","flows":{"clientCredentials":{"tokenUrl":"https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token","scopes":{}}},"scopes":[],"schemeName":"OAuth2"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"OAuth2 client credentials flow. Token endpoints:\n- Staging: https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token\n- Production: https://login.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"OAuth2","name":"Authorization"}],"title":"OAuth2"}]},"originalFileLocation":"api-reference/Finance-API-Specs.yaml"},"subdomain":"venly","siteName":"Venly Finance","title":"Update a party - Venly Finance","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-25T10:03:05.319Z","originalFileLocation":"api-reference/Finance-API/parties/update-party-details.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Update an existing party\u0026#x27;s name, VAT number, or address.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Venly Finance\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a party - Venly Finance\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update an existing party\u0026#x27;s name, VAT number, or address.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Venly Finance\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.venlyfinance.com/api-reference/Finance-API/parties/update-party-details\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://venly.mintlify.site/_mintlify/api/og/v2?division=Parties\u0026amp;title=Update+a+party\u0026amp;description=Update+an+existing+party%27s+name%2C+VAT+number%2C+or+address.\u0026amp;theme=66844d886c63c9d7741f1e37\u0026amp;signature=7d250f4b8adb8b2bd84864aadcfa6252fc0f1d85a680744408596033615fa9e2\">\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=\"Update a party - Venly Finance\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update an existing party\u0026#x27;s name, VAT number, or address.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://venly.mintlify.site/_mintlify/api/og/v2?division=Parties\u0026amp;title=Update+a+party\u0026amp;description=Update+an+existing+party%27s+name%2C+VAT+number%2C+or+address.\u0026amp;theme=66844d886c63c9d7741f1e37\u0026amp;signature=7d250f4b8adb8b2bd84864aadcfa6252fc0f1d85a680744408596033615fa9e2\">\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/venly/NJHVXnPMqQUaB4Tk/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Venly Finance\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#e07826\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.venlyfinance.com/api-reference/Finance-API/parties/update-party-details\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/Finance-API/parties/update-party-details.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.venlyfinance.com/#organization\",\"name\":\"Venly Finance\",\"url\":\"https://docs.venlyfinance.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/venly/NZGy1d4c4LA-0jM9/logo/light_venly_logo.png?fit=max\u0026auto=format\u0026n=NZGy1d4c4LA-0jM9\u0026q=85\u0026s=d808fd8f702829ca93bf607f200800bb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.venlyfinance.com#website\",\"name\":\"Venly Finance\",\"url\":\"https://docs.venlyfinance.com\",\"publisher\":{\"@id\":\"https://docs.venlyfinance.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.venlyfinance.com/api-reference/Finance-API/parties/update-party-details#webpage\",\"url\":\"https://docs.venlyfinance.com/api-reference/Finance-API/parties/update-party-details\",\"name\":\"Update a party\",\"description\":\"Update an existing party's name, VAT number, or address.\",\"dateModified\":\"2026-08-25T10:03:05.319Z\",\"isPartOf\":{\"@id\":\"https://docs.venlyfinance.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.venlyfinance.com/api-reference/Finance-API/parties/update-party-details#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.venlyfinance.com/api-reference/Finance-API/parties/update-party-details#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Parties\",\"item\":\"https://docs.venlyfinance.com/api-reference/Finance-API/parties/list-all-parties\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update a party\",\"item\":\"https://docs.venlyfinance.com/api-reference/Finance-API/parties/update-party-details\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.venlyfinance.com/api-reference/Finance-API/parties/update-party-details#apireference\",\"headline\":\"Update a party\",\"name\":\"Update a party\",\"description\":\"Update an existing party's name, VAT number, or address.\",\"url\":\"https://docs.venlyfinance.com/api-reference/Finance-API/parties/update-party-details\",\"mainEntityOfPage\":{\"@id\":\"https://docs.venlyfinance.com/api-reference/Finance-API/parties/update-party-details#webpage\"},\"dateModified\":\"2026-08-25T10:03:05.319Z\",\"publisher\":{\"@id\":\"https://docs.venlyfinance.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.venlyfinance.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Venly Finance\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Venly Finance","nav":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://venlyfinance.com/blog"},{"anchor":"Support","icon":"envelope","href":"https://venlyfinance.com/contact"}]},"tabs":[{"tab":"Getting Started","pages":[{"title":"Getting Started","href":""}]},{"tab":"Fundflow API","pages":[{"title":"Fundflow API","href":"/guides/payments/getting-started"}]},{"tab":"Finance API","groups":[{"group":"Overview","pages":[{"title":"Finance API","sidebarTitle":"Overview","icon":"building-columns","href":"/api-reference/introduction"},{"title":"Data model","icon":"sitemap","href":"/guides/finance/data-model"},{"title":"Getting started","icon":"rocket","href":"/guides/finance/getting-started"},{"title":"Integration Walkthrough","sidebarTitle":"Integration Walkthrough","icon":"route","href":"/guides/finance/integration-walkthrough"},{"title":"Glossary","sidebarTitle":"Glossary","icon":"book-open","href":"/guides/finance/glossary"},{"title":"Countries","icon":"globe-europe","href":"/guides/finance/countries"}]},{"group":"Recipes","pages":[{"title":"Recipe: issue wallets, receive fiat, pay out fiat","sidebarTitle":"Wallet API end-to-end","icon":"book-open","href":"/guides/finance/recipes/wallet-api-end-to-end"}]},{"group":"Onboarding \u0026 Verification","pages":[{"title":"Onboarding lifecycle","sidebarTitle":"Onboarding lifecycle","icon":"route","href":"/guides/finance/onboarding/lifecycle"},{"title":"Roles \u0026 entities","sidebarTitle":"Roles \u0026 entities","icon":"sitemap","href":"/guides/finance/onboarding/roles-and-entities"},{"title":"Individual KYC","sidebarTitle":"Individual KYC","icon":"user","href":"/guides/finance/onboarding/individual-kyc"},{"title":"Business KYB","sidebarTitle":"Business KYB","icon":"building","href":"/guides/finance/onboarding/business-kyb"},{"title":"Hosted verification links","sidebarTitle":"Hosted verification","icon":"link","href":"/guides/finance/onboarding/hosted-verification"},{"title":"Sumsub token sharing","sidebarTitle":"Sumsub token sharing","icon":"forward","href":"/guides/finance/onboarding/sumsub-token-sharing"},{"title":"Partner-terms consent","sidebarTitle":"Partner-terms consent","icon":"file-signature","href":"/guides/finance/onboarding/partner-terms-consent"},{"title":"Partner onboarding","sidebarTitle":"Partner onboarding","icon":"handshake","href":"/guides/finance/onboarding/partner-onboarding"},{"title":"Troubleshooting verification","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/guides/finance/onboarding/troubleshooting"}]},{"group":"Core Concepts","pages":[{"title":"Venly-managed vs self-custody","icon":"key","href":"/guides/finance/managed-vs-self-custody"},{"title":"Account verification","icon":"id-card","href":"/guides/finance/kyc-verification"},{"title":"Wallets \u0026 balances","icon":"wallet","href":"/guides/finance/wallets"},{"title":"Approving transfers without gas","icon":"file-signature","href":"/guides/finance/permits-and-allowances"},{"title":"Transfers","icon":"money-bill-transfer","href":"/guides/finance/transfers"},{"title":"Virtual bank accounts","sidebarTitle":"Virtual bank accounts","icon":"building-columns","href":"/guides/finance/virtual-bank-accounts"},{"title":"Pay-ins","sidebarTitle":"Pay-ins","icon":"arrow-down-to-bracket","href":"/guides/finance/pay-ins"},{"title":"Pay-outs","icon":"money-bill-transfer","href":"/guides/finance/payouts"},{"title":"Webhooks","icon":"bell","href":"/guides/finance/webhooks"},{"title":"API credentials","sidebarTitle":"API credentials","icon":"key","href":"/guides/finance/api-credentials"},{"title":"Billing","sidebarTitle":"Billing","icon":"receipt","href":"/guides/finance/billing"},{"title":"Safe retries with idempotency keys","icon":"arrows-rotate","href":"/guides/finance/idempotency"},{"title":"Versioning \u0026 safe updates","icon":"code-branch","href":"/guides/finance/versioning"}]},{"group":"Parties","pages":[{"title":"List parties","openapi":"api-reference/Finance-API-Specs.yaml GET /parties","href":"/api-reference/Finance-API/parties/list-all-parties"},{"title":"Create a party","openapi":"api-reference/Finance-API-Specs.yaml POST /parties","href":"/api-reference/Finance-API/parties/create-a-new-party"},{"title":"Get a party","description":"Retrieve a single party by ID, including verification status and address.","openapi":"api-reference/Finance-API-Specs.yaml GET /parties/{partyId}","href":"/api-reference/Finance-API/parties/get-party-details"},{"title":"Update a party","openapi":"api-reference/Finance-API-Specs.yaml PATCH /parties/{partyId}","href":"/api-reference/Finance-API/parties/update-party-details"},{"title":"Delete a party","description":"Permanently delete a party that has no linked accounts.","openapi":"api-reference/Finance-API-Specs.yaml DELETE /parties/{partyId}","href":"/api-reference/Finance-API/parties/delete-party"},{"title":"Create a verification link","openapi":"api-reference/Finance-API-Specs.yaml POST /parties/{partyId}/verification","href":"/api-reference/Finance-API/parties/create-a-verification-link"},{"title":"Get verification linkage","openapi":"api-reference/Finance-API-Specs.yaml GET /parties/{partyId}/iv-verification","href":"/api-reference/Finance-API/parties/get-verification-linkage"},{"title":"Get a party's KYC status","openapi":"api-reference/Finance-API-Specs.yaml GET /parties/{partyId}/kyc-status","href":"/api-reference/Finance-API/parties/get-a-partys-kyc-status"},{"title":"Issue a KYC completion link","openapi":"api-reference/Finance-API-Specs.yaml POST /parties/{partyId}/kyc-status/completion-link","href":"/api-reference/Finance-API/parties/issue-a-kyc-completion-link"},{"title":"Get partner-terms consent state","openapi":"api-reference/Finance-API-Specs.yaml GET /parties/{partyId}/partner-terms","href":"/api-reference/Finance-API/parties/get-a-partys-partner-terms-consent-state"},{"title":"Issue a partner-terms consent link","openapi":"api-reference/Finance-API-Specs.yaml POST /parties/{partyId}/partner-terms/link","href":"/api-reference/Finance-API/parties/issue-a-partner-terms-consent-link"},{"title":"Get a party's partner-onboarding status","openapi":"api-reference/Finance-API-Specs.yaml GET /parties/{partyId}/partner-onboarding","href":"/api-reference/Finance-API/parties/get-a-partys-partner-onboarding-status"},{"title":"Request partner onboarding","openapi":"api-reference/Finance-API-Specs.yaml POST /parties/{partyId}/partner-onboarding","href":"/api-reference/Finance-API/parties/request-partner-onboarding-for-a-party"}]},{"group":"Accounts","pages":[{"title":"List accounts","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts","href":"/api-reference/Finance-API/accounts/list-all-accounts"},{"title":"Create an account","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts","href":"/api-reference/Finance-API/accounts/create-a-new-account"},{"title":"Get an account","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}","href":"/api-reference/Finance-API/accounts/get-account-details"},{"title":"List party roles","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/party-roles","href":"/api-reference/Finance-API/accounts/list-party-roles-for-an-account"},{"title":"Add a party role","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/party-roles","href":"/api-reference/Finance-API/accounts/add-a-party-to-an-account"},{"title":"Remove a party role","openapi":"api-reference/Finance-API-Specs.yaml DELETE /accounts/{accountId}/party-roles/{partyId}","href":"/api-reference/Finance-API/accounts/remove-a-party-from-an-account"}]},{"group":"Virtual Bank Accounts","pages":[{"title":"List virtual bank accounts","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/virtual-bank-accounts","href":"/api-reference/Finance-API/virtual-bank-accounts/list-virtual-bank-accounts"},{"title":"Create a virtual bank account","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/virtual-bank-accounts","href":"/api-reference/Finance-API/virtual-bank-accounts/create-a-virtual-bank-account"},{"title":"Get a virtual bank account","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/virtual-bank-accounts/{virtualBankAccountId}","href":"/api-reference/Finance-API/virtual-bank-accounts/get-virtual-bank-account-details"},{"title":"Prepare a wallet-ownership proof","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/virtual-bank-accounts/prepare","href":"/api-reference/Finance-API/virtual-bank-accounts/prepare-a-wallet-ownership-proof"},{"title":"Close a virtual bank account","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/virtual-bank-accounts/{virtualBankAccountId}/close","href":"/api-reference/Finance-API/virtual-bank-accounts/close-a-virtual-bank-account"}]},{"group":"Supported Assets","pages":[{"title":"List supported assets","openapi":"api-reference/Finance-API-Specs.yaml GET /supported-assets","href":"/api-reference/Finance-API/supported-assets/list-supported-assets"},{"title":"List account supported assets","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/supported-assets","href":"/api-reference/Finance-API/supported-assets/list-account-supported-assets"}]},{"group":"Wallets","pages":[{"title":"List wallets","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/wallets","href":"/api-reference/Finance-API/wallets/list-wallets-for-an-account"}]},{"group":"Transfers","pages":[{"title":"Create a fiat transfer","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{senderAccountId}/transfers/fiat","href":"/api-reference/Finance-API/transfers/create-fiat-transfer"},{"title":"Create a crypto transfer","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{senderAccountId}/transfers/crypto","href":"/api-reference/Finance-API/transfers/create-crypto-transfer"},{"title":"List transfers","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/transfers","href":"/api-reference/Finance-API/transfers/list-transfers-for-account"},{"title":"Get a transfer","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/transfers/{transferId}","href":"/api-reference/Finance-API/transfers/get-transfer-details"}]},{"group":"Fiat to Crypto Payment Sessions","pages":[{"title":"Create a pay-in session","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/fiat-to-crypto/payment-sessions","tag":"Coming soon","href":"/api-reference/Finance-API/fiat-to-crypto-payment-sessions/create-a-fiat-to-crypto-payment-session"},{"title":"List pay-in sessions","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/fiat-to-crypto/payment-sessions","tag":"Coming soon","href":"/api-reference/Finance-API/fiat-to-crypto-payment-sessions/list-pay-in-sessions"},{"title":"Get a pay-in session","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/fiat-to-crypto/payment-sessions/{sessionId}","tag":"Coming soon","href":"/api-reference/Finance-API/fiat-to-crypto-payment-sessions/get-a-pay-in-session"}]},{"group":"Pay-Ins","pages":[{"title":"List pay-ins","openapi":"api-reference/Finance-API-Specs.yaml GET /pay-ins","href":"/api-reference/Finance-API/pay-ins/list-pay-ins"},{"title":"Get a pay-in","openapi":"api-reference/Finance-API-Specs.yaml GET /pay-ins/{payInId}","href":"/api-reference/Finance-API/pay-ins/get-a-pay-in"}]},{"group":"Payout Bank Accounts","pages":[{"title":"Register a payout bank account","openapi":"api-reference/Finance-API-Specs.yaml POST /parties/{partyId}/payout-bank-accounts","href":"/api-reference/Finance-API/payout-bank-accounts/register-a-payout-bank-account"},{"title":"List payout bank accounts","openapi":"api-reference/Finance-API-Specs.yaml GET /parties/{partyId}/payout-bank-accounts","href":"/api-reference/Finance-API/payout-bank-accounts/list-payout-bank-accounts"},{"title":"Get a payout bank account","openapi":"api-reference/Finance-API-Specs.yaml GET /parties/{partyId}/payout-bank-accounts/{payoutBankAccountId}","href":"/api-reference/Finance-API/payout-bank-accounts/get-a-payout-bank-account"}]},{"group":"Payout Routes","pages":[{"title":"Create a payout route","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/payout-routes","href":"/api-reference/Finance-API/payout-routes/create-a-payout-route"},{"title":"List payout routes","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/payout-routes","href":"/api-reference/Finance-API/payout-routes/list-payout-routes"},{"title":"Prepare a route ownership proof","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/payout-routes/{routeId}/ownership-proof/prepare","href":"/api-reference/Finance-API/payout-routes/prepare-a-route-ownership-proof"},{"title":"Submit a route ownership proof","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/payout-routes/{routeId}/ownership-proof/complete","href":"/api-reference/Finance-API/payout-routes/submit-a-route-ownership-proof"}]},{"group":"Payouts","pages":[{"title":"Request a payout","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/payouts","href":"/api-reference/Finance-API/payouts/request-a-payout"},{"title":"List payouts","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/payouts","href":"/api-reference/Finance-API/payouts/list-payouts"},{"title":"Get a payout","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/payouts/{payoutId}","href":"/api-reference/Finance-API/payouts/get-a-payout"}]},{"group":"Permits","pages":[{"title":"Get permit messages","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/wallets/{walletId}/permits","href":"/api-reference/Finance-API/permits/get-permit-messages"},{"title":"Submit a signed permit","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/wallets/{walletId}/permits","href":"/api-reference/Finance-API/permits/submit-signed-permit"}]},{"group":"Allowances","pages":[{"title":"Get wallet allowances","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/wallets/{walletId}/allowances","href":"/api-reference/Finance-API/allowances/get-wallet-token-allowances"},{"title":"Verify wallet allowances","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/wallets/{walletId}/allowance-verification","tag":"Coming soon","href":"/api-reference/Finance-API/allowances/verify-wallet-allowances"}]},{"group":"Webhooks","pages":[{"title":"Register a webhook","openapi":"api-reference/Finance-API-Specs.yaml POST /webhooks","href":"/api-reference/Finance-API/webhooks/register-a-webhook"},{"title":"List webhooks","openapi":"api-reference/Finance-API-Specs.yaml GET /webhooks","href":"/api-reference/Finance-API/webhooks/list-webhooks"},{"title":"Get webhook details","openapi":"api-reference/Finance-API-Specs.yaml GET /webhooks/{webhookId}","href":"/api-reference/Finance-API/webhooks/get-webhook-details"},{"title":"Update a webhook","openapi":"api-reference/Finance-API-Specs.yaml PUT /webhooks/{webhookId}","href":"/api-reference/Finance-API/webhooks/update-a-webhook"},{"title":"Delete a webhook","openapi":"api-reference/Finance-API-Specs.yaml DELETE /webhooks/{webhookId}","href":"/api-reference/Finance-API/webhooks/delete-a-webhook"},{"title":"Ping a webhook","openapi":"api-reference/Finance-API-Specs.yaml POST /webhooks/{webhookId}/ping","href":"/api-reference/Finance-API/webhooks/ping-a-webhook"},{"title":"List webhook deliveries","openapi":"api-reference/Finance-API-Specs.yaml GET /webhooks/{webhookId}/deliveries","href":"/api-reference/Finance-API/webhooks/list-webhook-deliveries"},{"title":"Get a webhook delivery","openapi":"api-reference/Finance-API-Specs.yaml GET /webhooks/{webhookId}/deliveries/{deliveryId}","href":"/api-reference/Finance-API/webhooks/get-a-webhook-delivery"},{"title":"Resend a webhook delivery","openapi":"api-reference/Finance-API-Specs.yaml POST /webhooks/{webhookId}/deliveries/{deliveryId}/resend","href":"/api-reference/Finance-API/webhooks/resend-a-webhook-delivery"}]},{"group":"API Credentials","pages":[{"title":"List API credentials","openapi":"api-reference/Finance-API-Specs.yaml GET /api-credentials","href":"/api-reference/Finance-API/api-credentials/list-api-credentials"},{"title":"Create API credentials","openapi":"api-reference/Finance-API-Specs.yaml POST /api-credentials","href":"/api-reference/Finance-API/api-credentials/create-api-credentials"},{"title":"Rotate a credential's secret","openapi":"api-reference/Finance-API-Specs.yaml POST /api-credentials/{clientId}/secret","href":"/api-reference/Finance-API/api-credentials/rotate-a-credentials-secret"},{"title":"Enable or disable a credential","openapi":"api-reference/Finance-API-Specs.yaml PUT /api-credentials/{clientId}/status","href":"/api-reference/Finance-API/api-credentials/enable-or-disable-a-credential"}]},{"group":"Billing","pages":[{"title":"List invoices","openapi":"api-reference/Finance-API-Specs.yaml GET /billing/invoices","href":"/api-reference/Finance-API/billing/list-invoices"},{"title":"Get an invoice","openapi":"api-reference/Finance-API-Specs.yaml GET /billing/invoices/{invoiceId}","href":"/api-reference/Finance-API/billing/get-an-invoice"},{"title":"Download an invoice PDF","openapi":"api-reference/Finance-API-Specs.yaml GET /billing/invoices/{invoiceId}/download","href":"/api-reference/Finance-API/billing/download-an-invoice-pdf"}]},{"group":"Company","pages":[{"title":"Get your company profile","openapi":"api-reference/Finance-API-Specs.yaml GET /company","href":"/api-reference/Finance-API/company/get-your-company-profile"}]},{"group":"Reference","pages":[{"title":"Errors \u0026 error codes","sidebarTitle":"Errors","icon":"triangle-exclamation","href":"/guides/finance/errors"},{"title":"Supported chains \u0026 assets","sidebarTitle":"Chains \u0026 assets","icon":"coins","href":"/guides/finance/supported-chains-and-assets"}]}]},{"tab":"Upcoming","pages":[{"title":"Upcoming","href":"/guides/card-issuance/introduction"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/guides/finance/changelog"}]}]},"basePath":"","title":"Update a party - Venly Finance","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}