For Banking, updates to user properties including external_metadata.open_banking.end_user will be reflected in future banking reports.Setting a field to null or an empty string will update the Argyle user object but may cause future banking reports to continue to display the previous value.
Authorizations
Authorization
string
header
required
Username = api_key_id, Password = api_key_secret
Path Parameters
id
string<uuid>
required
ID of the user object to be updated.
Body
application/json
first_name
string
Pre-fill Link's login screen with this first name.
last_name
string
Pre-fill Link's login screen with this last name.
email
string
Pre-fill Link's login screen with this email.
Invalid email addresses will cause the request to fail.
phone_number
string
Pre-fill Link's login screen with this phone number.
E.164 international format recommended.
Invalid phone numbers will cause the request to fail.
ssn
string
Social Security number.
address
object
Show child attributes
birth_date
object
Show child attributes
external_metadata
object
Any valid JSON.
The provided values are merged with the user's existing external metadata.
Can be used as a query parameter when listing users. (Only exact matches are supported)
Can be used to search for specific users within the Connections section of Console.
Will appear on billing CSVs if associated with a user.
Example:
"July_Connection"
first_name
string
First name of the user.
Example:
"Sarah"
last_name
string
Last name of the user.
Example:
"Longfield"
email
string
Email of the user.
Example:
"sarah@email.com"
phone_number
string
Phone number of the user. E.164 international format.
Example:
"+12125555555"
ssn
string
Social Security number of the user.
Example:
"522-09-1191"
address
object
Address of the user.
Show child attributes
birth_date
object
Date of birth of the user.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Argyle Docs","colors":{"primary":"#214E48","light":"#7FB2A8","dark":"#1D1D1D"},"logo":{"light":"https://mintcdn.com/argyle/HtlySCcYVcDJWXiY/logo/light.svg?fit=max\u0026auto=format\u0026n=HtlySCcYVcDJWXiY\u0026q=85\u0026s=3d77b5555b7fdd5185b855e858558376","dark":"https://mintcdn.com/argyle/HtlySCcYVcDJWXiY/logo/dark.svg?fit=max\u0026auto=format\u0026n=HtlySCcYVcDJWXiY\u0026q=85\u0026s=9fd2f436065a41825b9839fb81c76467","href":"/"},"favicon":"https://mintcdn.com/argyle/xZQDezYDpb8d7zmN/favicon.png?fit=max\u0026auto=format\u0026n=xZQDezYDpb8d7zmN\u0026q=85\u0026s=046e800dc429a2f398d20a345dd7350a","api":{"openapi":["openAPI/account-webhook-updated.yaml","openAPI/account-webhooks-added.yaml","openAPI/accounts-webhooks-connected.yaml","openAPI/accounts-webhooks-failed.yaml","openAPI/accounts-webhooks-removed.yaml","openAPI/accounts.yaml","openAPI/deposit-destinations.yaml","openAPI/employer-search.yaml","openAPI/employments.yaml","openAPI/gigs-webhooks-added.yaml","openAPI/gigs-webhooks-fully-synced.yaml","openAPI/gigs-webhooks-partially-synced.yaml","openAPI/gigs-webhooks-removed.yaml","openAPI/gigs-webhooks-updated.yaml","openAPI/gigs.yaml","openAPI/identities-webhooks-added.yaml","openAPI/identities-webhooks-updated.yaml","openAPI/identities.yaml","openAPI/invites.yaml","openAPI/item-filters.yaml","openAPI/items-webhooks-removed.yaml","openAPI/items-webhooks-updated.yaml","openAPI/items.yaml","openAPI/open-banking.yaml","openAPI/payroll-documents-webhooks-added.yaml","openAPI/payroll-documents-webhooks-ocr-completed.yaml","openAPI/payroll-documents-webhooks-ocr-failed.yaml","openAPI/payroll-documents-webhooks-removed.yaml","openAPI/payroll-documents-webhooks-updated.yaml","openAPI/payroll-documents.yaml","openAPI/paystubs-webhooks-added.yaml","openAPI/paystubs-webhooks-fully-synced.yaml","openAPI/paystubs-webhooks-partially-synced.yaml","openAPI/paystubs-webhooks-updated.yaml","openAPI/paystubs.yaml","openAPI/ratings-webhooks-added.yaml","openAPI/ratings-webhooks-updated.yaml","openAPI/ratings.yaml","openAPI/receipts.yaml","openAPI/reports-webhooks-generated.yaml","openAPI/reports-webhooks-ready.yaml","openAPI/reports.yaml","openAPI/shifts-webhooks-added.yaml","openAPI/shifts-webhooks-fully-synced.yaml","openAPI/shifts-webhooks-partially-synced.yaml","openAPI/shifts-webhooks-removed.yaml","openAPI/shifts-webhooks-updated.yaml","openAPI/shifts.yaml","openAPI/user-forms-webhooks-removed.yaml","openAPI/user-forms-webhooks.yaml","openAPI/user-forms.yaml","openAPI/user-tokens.yaml","openAPI/user-uploads-webhooks-added.yaml","openAPI/user-uploads-webhooks-ocr-authenticity.yaml","openAPI/user-uploads-webhooks-ocr-completed.yaml","openAPI/user-uploads-webhooks-ocr-failed.yaml","openAPI/user-uploads-webhooks-removed.yaml","openAPI/user-uploads.yaml","openAPI/users-webhooks.yaml","openAPI/users.yaml","openAPI/verifications-partners-webhooks-creation-failed.yaml","openAPI/verifications-partners-webhooks-connection-added.yaml","openAPI/verifications-partners-webhooks-connection-removed.yaml","openAPI/verifications-partners-webhooks-updated.yaml","openAPI/verifications-partners.yaml","openAPI/verifications-webhooks-creation-failed.yaml","openAPI/verifications-webhooks-connection-added.yaml","openAPI/verifications-webhooks-connection-removed.yaml","openAPI/verifications-webhooks-updated.yaml","openAPI/vehicles-webhooks-added.yaml","openAPI/vehicles-webhooks-removed.yaml","openAPI/vehicles-webhooks-updated.yaml","openAPI/vehicles.yaml","openAPI/verifications.yaml","openAPI/webhooks.yaml"],"mdx":{"server":["https://api-sandbox.argyle.com","https://api.argyle.com"]}},"appearance":{"default":"light"},"navbar":{"links":[{"href":"/changelog","label":"Changelog"},{"href":"https://console.argyle.com/sign-in","label":"Sign in"}],"primary":{"type":"button","label":"Contact sales","href":"https://argyle.com/contact-sales/"}},"footer":{"socials":{}},"seo":{"metatags":{"og:image":"https://docs.argyle.com/images/social/argyle-docs.png","og:image:alt":"Argyle","twitter:image":"https://docs.argyle.com/images/social/argyle-docs.png","twitter:image:alt":"Argyle"}},"fonts":{"heading":{"family":"Plain","source":"fonts/Plain-Regular.woff2","format":"woff2"},"body":{"family":"Plain","source":"fonts/Plain-Regular.woff2","format":"woff2"}},"styling":{"codeblocks":{},"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"argyle","hasAudioNarration":false,"actualSubdomain":"argyle","customDomains":["docs.argyle.com"],"gitSource":{"type":"github","owner":"argyle-systems","repo":"argyle-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"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":"6afb6a91c833ee61a251abd0","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"Clients","count":216},{"language":"default","tag":"API Reference","count":171},{"language":"default","tag":"Guides","count":76},{"language":"default","tag":"Webhooks","count":51},{"language":"default","tag":"Partners","count":41},{"language":"default","tag":"Verifications","count":39},{"language":"default","tag":"Payroll Data Sets","count":24},{"language":"default","tag":"Core Resources","count":21},{"language":"default","tag":"Workflows","count":16},{"language":"default","tag":"Verticals","count":16}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","href":"/_mintlify/custom/argyle/225e00a80fa65353/style.css"},{"filePath":"changelog.css","href":"/_mintlify/custom/argyle/43713bf2b359289f/changelog.css"}]}
{"page":{"pagePath":"api-reference/users/update-a-user","slug":"/api-reference/users/update-a-user","pageMetadata":{"title":"Update A User","openapi":"patch /v2/users/{id}","badge":"PATCH","description":"Updates a user object.","href":"/api-reference/users/update-a-user"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Updates a user object.\"\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsxs(Note,{children:[_jsxs(_components.p,{children:[`For Banking, updates to user properties including `,_jsx(_components.a,{href:`/api-reference/users/update-a-user#body-external-metadata-open-banking-end-user`,children:_jsx(_components.code,{children:`external_metadata.open_banking.end_user`})}),` will be reflected in future banking reports.`]}),_jsxs(_components.p,{children:[`Setting a field to `,_jsx(_components.code,{children:`null`}),` or an empty string will update the Argyle user object but may cause future banking reports to continue to display the previous value.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{},"config":{},"pageMetadata":{"title":"Update A User","openapi":"patch /v2/users/{id}","badge":"PATCH","description":"Updates a user object.","href":"/api-reference/users/update-a-user"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/argyle/af2164acf85a6b07/remove-image.js","/_mintlify/custom/argyle/0819c75d96f0177a/syntax-highlight.js","/_mintlify/custom/argyle/72285dbf6c5af137/legacy-hash-redirect.js","/_mintlify/custom/argyle/6e9f1651420bfe27/syntax-highlight-20260225.js","/_mintlify/custom/argyle/6c5de915fd850018/session-example-sync.js","/_mintlify/custom/argyle/74858b35daa8e825/audience-navigation.js","/_mintlify/custom/argyle/6e74c8b91218c4d2/audience-toggle.js","/_mintlify/custom/argyle/4b7ec966460f12b0/changelog-minisearch.js","/_mintlify/custom/argyle/cc05ec1a3c7e032f/changelog-navigation.js","/_mintlify/custom/argyle/77d8a125002fffa8/changelog-search.js","/_mintlify/custom/argyle/53f62f407a9be5ea/changelog-subscribe.js","/_mintlify/custom/argyle/ccdcfecc455cb06e/changelog-tags.js"],"openApiReferenceData":{"operation":{"summary":"Update a user","description":"Updates a user object.","parameters":["01d7e4fc-3be4-47be-94fa-a780499e05be"],"requestBody":"35d49783-f844-45bb-9103-8cf46e9d2e67","responses":{"200":"13ae9872-1fc8-4797-8a28-af2afb94c17e"},"method":"patch","type":"path","servers":["c4787795-e588-423a-91a5-debfb9bfc949","13b6ab7c-08b4-4506-b0da-e63728ac171e"],"security":["f54a3fab-2355-45a7-afd4-8f1ced779433"],"path":"/v2/users/{id}","baseUrlOptions":["https://api-sandbox.argyle.com","https://api.argyle.com"],"title":"Update a user","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"01d7e4fc-3be4-47be-94fa-a780499e05be":{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"ID of the user object to be updated.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"ID of the user object to be updated."}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string","description":"Pre-fill Link's login screen with this first name.","uniqueKey":"first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Pre-fill Link's login screen with this last name.","uniqueKey":"last_name","typeLabel":"string"},"email":{"type":"string","description":"Pre-fill Link's login screen with this email.\n\nInvalid email addresses will cause the request to fail.\n","uniqueKey":"email","typeLabel":"string"},"phone_number":{"type":"string","description":"Pre-fill Link's login screen with this phone number.\n\n[E.164](https://en.wikipedia.org/wiki/E.164) international format recommended.\nInvalid phone numbers will cause the request to fail.\n","uniqueKey":"phone_number","typeLabel":"string"},"ssn":{"type":"string","description":"Social Security number.","uniqueKey":"ssn","typeLabel":"string"},"address":{"type":"object","properties":{"city":{"type":"string","description":"Name of the city, town, district, or similar regional entity.","uniqueKey":"address.city","typeLabel":"string"},"line1":{"type":"string","description":"Address-Line 1, usually street address or P.O. Box information.","uniqueKey":"address.line1","typeLabel":"string"},"line2":{"type":"string","description":"Address-Line 2, usually the apartment or unit number.","uniqueKey":"address.line2","typeLabel":"string"},"state":{"type":"string","description":"State, county, province, region, or equivalent.","uniqueKey":"address.state","typeLabel":"string"},"country":{"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format).","uniqueKey":"address.country","typeLabel":"string"},"postal_code":{"type":"string","description":"Zip code, or equivalent.","uniqueKey":"address.postal_code","typeLabel":"string"}},"uniqueKey":"address","typeLabel":"object"},"birth_date":{"type":"object","properties":{"year":{"type":"integer","description":"Birth year (1900 or later).","uniqueKey":"birth_date.year","typeLabel":"integer"},"month":{"type":"integer","description":"Birth month (between 1 and 12).","uniqueKey":"birth_date.month","typeLabel":"integer"},"day":{"type":"integer","description":"Birth day (between 1 and 31).","uniqueKey":"birth_date.day","typeLabel":"integer"}},"uniqueKey":"birth_date","typeLabel":"object"},"external_metadata":{"type":"object","description":"Any valid JSON.\n\nThe provided values are merged with the user's existing external metadata.\n\nMust be an object `{}` when used for [banking reports](/api-reference/banking-overview#create-an-argyle-user).\n","properties":{"broker":{"type":"object","description":"**Note:** Only for wholesale mortgage integrations.\n\nContains information about the user's mortgage broker for [broker-branded invites](/verifications/wholesale-mortgage).\n","properties":{"name":{"type":"string","description":"Name of the mortgage broker.","uniqueKey":"external_metadata.broker.name","typeLabel":"string"},"company_name":{"oneOf":[{"type":"string","description":"Name of the mortgage broker's company. Used by the `[Broker_company]` variable in [wholesale email/SMS templates](/console/flows/email-sms-templates#wholesale-mortgage-templates).","uniqueKey":"external_metadata.broker.company_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the mortgage broker's company. Used by the `[Broker_company]` variable in [wholesale email/SMS templates](/console/flows/email-sms-templates#wholesale-mortgage-templates).","uniqueKey":"external_metadata.broker.company_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"external_metadata.broker.company_name","typeLabel":"string | null"},"phone_number":{"type":"string","description":"Phone number of the mortgage broker. [E.164](https://en.wikipedia.org/wiki/E.164) international format.","uniqueKey":"external_metadata.broker.phone_number","typeLabel":"string"},"email":{"type":"string","description":"Email address of the mortgage broker.","uniqueKey":"external_metadata.broker.email","typeLabel":"string"},"nmls":{"type":"string","description":"NMLS ID of the mortgage broker.","uniqueKey":"external_metadata.broker.nmls","typeLabel":"string"}},"uniqueKey":"external_metadata.broker","typeLabel":"object"},"open_banking":{"type":"object","description":"Only relevant to [banking reports](/api-reference/banking-overview#create-an-argyle-user).","properties":{"end_user":{"type":"object","description":"Contains details about the person or entity making the lending decision.","properties":{"name":{"type":"string","description":"Name of the lender or entity.","uniqueKey":"external_metadata.open_banking.end_user.name","typeLabel":"string"},"address":{"type":"string","description":"Street address or P.O. Box information (include apartment or unit numbers).","uniqueKey":"external_metadata.open_banking.end_user.address","typeLabel":"string"},"city":{"type":"string","description":"Name of the city, town, district, or similar regional entity.","uniqueKey":"external_metadata.open_banking.end_user.city","typeLabel":"string"},"state":{"type":"string","description":"State, county, province, region, or equivalent.","uniqueKey":"external_metadata.open_banking.end_user.state","typeLabel":"string"},"zip":{"type":"string","description":"Zip code, or equivalent.","uniqueKey":"external_metadata.open_banking.end_user.zip","typeLabel":"string"},"phone":{"type":"string","description":"Phone number of the lender or entity.\n\nMust be 10 or 11 digits (with or without hyphens).\n","uniqueKey":"external_metadata.open_banking.end_user.phone","typeLabel":"string"}},"uniqueKey":"external_metadata.open_banking.end_user","typeLabel":"object"}},"uniqueKey":"external_metadata.open_banking","typeLabel":"object"}},"uniqueKey":"external_metadata","typeLabel":"object"},"external_id":{"type":"string","description":"Any string. Maximum 100 characters.","uniqueKey":"external_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"general_update":{"title":"general_update","summary":"General update","value":{"first_name":"Sarah","last_name":"Longfield","email":"sarah@email.com","phone_number":"+12125555555","external_metadata":{"notes":"Moved to stage 2 of loan approval.","category":"Summer Initiative"},"external_id":"July_Connection"}},"banking_end_user_update":{"title":"banking_end_user_update","summary":"Banking end-user update","value":{"external_metadata":{"open_banking":{"end_user":{"name":"Example Tenant","address":"1234 Example Way","city":"Example City","state":"FL","zip":"12345","phone":"11234567890"}}}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"13ae9872-1fc8-4797-8a28-af2afb94c17e":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"id":"018051aa-f7a9-a0db-2f38-6cfa325e9d69","created_at":"2023-01-30T22:25:38.971Z","items_connected":["item_123456789","item_987654321"],"employers_connected":["Whole Goods","Bullseye"],"external_metadata":{"notes":"Moved to stage 2 of loan approval.","category":"Summer Initiative"},"external_id":"July_Connection","first_name":"Sarah","last_name":"Longfield","email":"sarah@email.com","phone_number":"+12125555555","ssn":"522-09-1191","address":{"city":"New York","line1":"852 North W St","line2":"Apt 221","state":"NY","country":"US","postal_code":"10014"},"birth_date":{"year":1980,"month":10,"day":30}},"properties":{"id":{"type":"string","format":"uuid","description":"Unique ID of the user.","example":"018051aa-f7a9-a0db-2f38-6cfa325e9d69","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"created_at":{"type":"string","format":"date-time","description":"Timestamp (ISO 8601) when the user object was created.","example":"2023-01-30T22:25:38.971Z","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"items_connected":{"type":"array","items":{"type":"string","uniqueKey":"items_connected.items.[INDEX]","typeLabel":"string"},"description":"Items the user has connected through Link. Typically employers or payroll platforms.","example":["item_123456789","item_987654321"],"uniqueKey":"items_connected","typeLabel":"string[]"},"employers_connected":{"type":"array","items":{"type":"string","uniqueKey":"employers_connected.items.[INDEX]","typeLabel":"string"},"description":"Individual employers associated with the connected Items.","example":["Whole Goods","Bullseye"],"uniqueKey":"employers_connected","typeLabel":"string[]"},"external_metadata":{"type":"object","description":"Free-text field where additional context for the user can be added.\n- Can be any valid JSON, such as a string or object.\n\n**Note:** Using `external_id` (see below) is recommended when the ability to filter users by an external value is needed.\n","properties":{"broker":{"type":"object","description":"**Note:** Only for wholesale mortgage integrations.\n\nContains information about the user's mortgage broker for [broker-branded invites](/verifications/wholesale-mortgage).\n","properties":{"name":{"type":"string","description":"Name of the mortgage broker.","uniqueKey":"external_metadata.broker.name","typeLabel":"string"},"company_name":{"oneOf":[{"type":"string","description":"Name of the mortgage broker's company. Used by the `[Broker_company]` variable in [wholesale email/SMS templates](/console/flows/email-sms-templates#wholesale-mortgage-templates).","uniqueKey":"external_metadata.broker.company_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the mortgage broker's company. Used by the `[Broker_company]` variable in [wholesale email/SMS templates](/console/flows/email-sms-templates#wholesale-mortgage-templates).","uniqueKey":"external_metadata.broker.company_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"external_metadata.broker.company_name","typeLabel":"string | null"},"phone_number":{"type":"string","description":"Phone number of the mortgage broker. [E.164](https://en.wikipedia.org/wiki/E.164) international format.","uniqueKey":"external_metadata.broker.phone_number","typeLabel":"string"},"email":{"type":"string","description":"Email address of the mortgage broker.","uniqueKey":"external_metadata.broker.email","typeLabel":"string"},"nmls":{"type":"string","description":"NMLS ID of the mortgage broker.","uniqueKey":"external_metadata.broker.nmls","typeLabel":"string"}},"uniqueKey":"external_metadata.broker","typeLabel":"object"}},"example":{"notes":"Moved to stage 2 of loan approval.","category":"Summer Initiative"},"uniqueKey":"external_metadata","typeLabel":"object"},"external_id":{"type":"string","description":"Free-text field where [additional context](/overview/data-structure/users#external-identifiers) for the user can be added.\n- Can be any string of 100 characters or less.\n- Multiple users can have the same `external_id`.\n\nOften used to group users, or associate your internal ID's to users.\n- Can be attached to [invites](/console/flows/email-sms-templates#inviting-new-users) or [shareable URLs](/console/flows/shareable-urls#customizations).\n- Can be used as a query parameter when [listing users](/api-reference/users#list). (Only exact matches are supported)\n- Can be used to search for specific users within the [Connections](https://console.argyle.com/connections) section of Console.\n- Will appear on billing CSVs if associated with a user.\n","example":"July_Connection","uniqueKey":"external_id","typeLabel":"string"},"first_name":{"type":"string","description":"First name of the user.","example":"Sarah","uniqueKey":"first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Last name of the user.","example":"Longfield","uniqueKey":"last_name","typeLabel":"string"},"email":{"type":"string","description":"Email of the user.","example":"sarah@email.com","uniqueKey":"email","typeLabel":"string"},"phone_number":{"type":"string","description":"Phone number of the user. E.164 international format.","example":"+12125555555","uniqueKey":"phone_number","typeLabel":"string"},"ssn":{"type":"string","description":"Social Security number of the user.","example":"522-09-1191","uniqueKey":"ssn","typeLabel":"string"},"address":{"type":"object","description":"Address of the user.","properties":{"city":{"type":"string","description":"Name of the city, town, district, or similar regional entity.","example":"New York","uniqueKey":"address.city","typeLabel":"string"},"line1":{"type":"string","description":"Address-Line 1, usually street address or P.O. Box information.","example":"852 North W St","uniqueKey":"address.line1","typeLabel":"string"},"line2":{"type":"string","description":"Address-Line 2, usually the apartment or unit number.","example":"Apt 221","uniqueKey":"address.line2","typeLabel":"string"},"state":{"type":"string","description":"State, county, province, region, or equivalent.","example":"NY","uniqueKey":"address.state","typeLabel":"string"},"country":{"type":"string","description":"Two-letter country code (ISO 3166-1 alpha-2 format).","example":"US","uniqueKey":"address.country","typeLabel":"string"},"postal_code":{"type":"string","description":"Zip code, or equivalent.","example":"10014","uniqueKey":"address.postal_code","typeLabel":"string"}},"uniqueKey":"address","typeLabel":"object"},"birth_date":{"type":"object","description":"Date of birth of the user.","properties":{"year":{"type":"integer","description":"Birth year (1900 or later).","example":1980,"uniqueKey":"birth_date.year","typeLabel":"integer"},"month":{"type":"integer","description":"Birth month (between 1 and 12).","example":10,"uniqueKey":"birth_date.month","typeLabel":"integer"},"day":{"type":"integer","description":"Birth day (between 1 and 31).","example":30,"uniqueKey":"birth_date.day","typeLabel":"integer"}},"uniqueKey":"birth_date","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"018051aa-f7a9-a0db-2f38-6cfa325e9d69","created_at":"2023-01-30T22:25:38.971Z","items_connected":["item_123456789","item_987654321"],"employers_connected":["Whole Goods","Bullseye"],"external_metadata":{"notes":"Moved to stage 2 of loan approval.","category":"Summer Initiative"},"external_id":"July_Connection","first_name":"Sarah","last_name":"Longfield","email":"sarah@email.com","phone_number":"+12125555555","ssn":"522-09-1191","address":{"city":"New York","line1":"852 North W St","line2":"Apt 221","state":"NY","country":"US","postal_code":"10014"},"birth_date":{"year":1980,"month":10,"day":30}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f54a3fab-2355-45a7-afd4-8f1ced779433":{"basicAuth":{"type":"http","scheme":"basic","description":"Username = api_key_id, Password = api_key_secret","scopes":[],"schemeName":"basicAuth"}}},"servers":{"c4787795-e588-423a-91a5-debfb9bfc949":{"url":"https://api-sandbox.argyle.com","description":"Sandbox"},"13b6ab7c-08b4-4506-b0da-e63728ac171e":{"url":"https://api.argyle.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","description":"Username = api_key_id, Password = api_key_secret","scopes":[],"schemeName":"basicAuth"},"schema":{"title":"Basic Auth","type":"object","description":"Username = api_key_id, Password = api_key_secret","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"basicAuth","name":"Authorization"}],"title":"basicAuth"}]},"originalFileLocation":"openAPI/users.yaml"},"subdomain":"argyle","siteName":"Argyle Docs","title":"Update A User - Argyle Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-11T16:34:01.443Z","originalFileLocation":"api-reference/users/update-a-user.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Updates a user object.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Argyle 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/argyle/cbIyejDMMl6E05gL/_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/argyle/cbIyejDMMl6E05gL/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/argyle/cbIyejDMMl6E05gL/_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/argyle/cbIyejDMMl6E05gL/_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/argyle/cbIyejDMMl6E05gL/_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/argyle/cbIyejDMMl6E05gL/_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/argyle/cbIyejDMMl6E05gL/_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/argyle/cbIyejDMMl6E05gL/_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/argyle/cbIyejDMMl6E05gL/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update A User - Argyle Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates a user object.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Argyle Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.argyle.com/api-reference/users/update-a-user\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docs.argyle.com/images/social/argyle-docs.png\">\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 User - Argyle Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates a user object.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docs.argyle.com/images/social/argyle-docs.png\">\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/argyle/cbIyejDMMl6E05gL/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Argyle Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#214E48\">\u003cmeta data-mint-head name=\"og:image:alt\" content=\"Argyle\">\u003cmeta data-mint-head name=\"twitter:image:alt\" content=\"Argyle\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.argyle.com/api-reference/users/update-a-user\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/users/update-a-user.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.argyle.com/#organization\",\"name\":\"Argyle Docs\",\"url\":\"https://docs.argyle.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/argyle/HtlySCcYVcDJWXiY/logo/light.svg?fit=max\u0026auto=format\u0026n=HtlySCcYVcDJWXiY\u0026q=85\u0026s=3d77b5555b7fdd5185b855e858558376\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.argyle.com#website\",\"name\":\"Argyle Docs\",\"url\":\"https://docs.argyle.com\",\"publisher\":{\"@id\":\"https://docs.argyle.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.argyle.com/api-reference/users/update-a-user#webpage\",\"url\":\"https://docs.argyle.com/api-reference/users/update-a-user\",\"name\":\"Update A User\",\"description\":\"Updates a user object.\",\"dateModified\":\"2026-08-11T16:34:01.443Z\",\"isPartOf\":{\"@id\":\"https://docs.argyle.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.argyle.com/api-reference/users/update-a-user#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.argyle.com/api-reference/users/update-a-user#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Core Resources\",\"item\":\"https://docs.argyle.com/api-reference/users\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Users\",\"item\":\"https://docs.argyle.com/api-reference/users\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update A User\",\"item\":\"https://docs.argyle.com/api-reference/users/update-a-user\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.argyle.com/api-reference/users/update-a-user#apireference\",\"headline\":\"Update A User\",\"name\":\"Update A User\",\"description\":\"Updates a user object.\",\"url\":\"https://docs.argyle.com/api-reference/users/update-a-user\",\"mainEntityOfPage\":{\"@id\":\"https://docs.argyle.com/api-reference/users/update-a-user#webpage\"},\"image\":\"https://docs.argyle.com/images/social/argyle-docs.png\",\"dateModified\":\"2026-08-11T16:34:01.443Z\",\"publisher\":{\"@id\":\"https://docs.argyle.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.argyle.com#website\"}}]}\u003c/script>","agentPointerHref":"/api-reference/users/update-a-user.md","siteName":"Argyle Docs","nav":{"global":null,"products":[{"product":"Clients","icon":"building","description":"Build for your organization.","tabs":[{"tab":"Home","pages":[{"title":"Home","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides"}]},{"tab":"Verticals","pages":[{"title":"Verticals","href":"/verticals"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference","href":"/api-reference/overview"}]},{"group":"Verifications","pages":[{"group":"Verifications","pages":[{"openapi":"openAPI/verifications.yaml post /v2/verifications","title":"Order a verification","sidebarTitle":"Order a verification","href":"/api-reference/verifications/order-a-verification"},{"openapi":"openAPI/verifications.yaml post /v2/sessions","title":"Create a session","sidebarTitle":"Create a session","href":"/api-reference/verifications/create-a-session"},{"openapi":"openAPI/verifications.yaml post /v2/verifications/refresh","title":"Refresh a verification","sidebarTitle":"Refresh a verification","href":"/api-reference/verifications/refresh-a-verification"},{"openapi":"openAPI/verifications.yaml get /v2/verifications/{id}","title":"Retrieve a verification","sidebarTitle":"Retrieve a verification","href":"/api-reference/verifications/retrieve-a-verification"},{"openapi":"openAPI/verifications.yaml patch /v2/verifications/{id}","title":"Update a verification","sidebarTitle":"Update a verification","href":"/api-reference/verifications/update-a-verification"},{"openapi":"openAPI/verifications.yaml post /v2/verifications/{id}/cancel","title":"Cancel a verification","sidebarTitle":"Cancel a verification","href":"/api-reference/verifications/cancel-a-verification"},{"openapi":"openAPI/verifications.yaml get /v2/verifications","title":"List all verifications","sidebarTitle":"List all verifications","href":"/api-reference/verifications/list-all-verifications"}]}]},{"group":"Core Resources","pages":[{"group":"Users","pages":[{"title":"Users","sidebarTitle":"Users","href":"/api-reference/users"},{"title":"Create A User","openapi":"post /v2/users","href":"/api-reference/users/create-a-user"},{"title":"Retrieve A User","description":"Retrieves a user object.\n","openapi":"get /v2/users/{id}","href":"/api-reference/users/retrieve-a-user"},{"title":"Update A User","openapi":"patch /v2/users/{id}","href":"/api-reference/users/update-a-user"},{"title":"Delete A User","description":"Deletes a user object.\n\n\u003cWarning>Deleting a user object will also delete all accounts and resources associated with the user.\u003c/Warning>\n","openapi":"delete /v2/users/{id}","href":"/api-reference/users/delete-a-user"},{"title":"List All Users","openapi":"get /v2/users","href":"/api-reference/users/list-all-users"}]},{"group":"User Tokens","pages":[{"title":"User Tokens","href":"/api-reference/user-tokens"},{"title":"Create A User Token","openapi":"post /v2/user-tokens","href":"/api-reference/user-tokens/create-a-user-token"}]},{"group":"Invites","pages":[{"title":"Invites","sidebarTitle":"Invites","href":"/api-reference/invites"},{"title":"Send An Invite","openapi":"post /v2/invites","href":"/api-reference/invites/send-an-invite"},{"title":"Retrieve An Invite","openapi":"get /v2/invites/{id}","href":"/api-reference/invites/retrieve-an-invite"},{"title":"Re-send an invite","openapi":"post /v2/invites/{id}","href":"/api-reference/invites/re-send-an-invite"},{"title":"Revoke An Invite","openapi":"post /v2/invites/{id}/revoke","href":"/api-reference/invites/revoke-an-invite"},{"title":"List All Invites","openapi":"get /v2/invites","href":"/api-reference/invites/list-all-invites"}]},{"group":"Accounts","pages":[{"title":"Accounts","sidebarTitle":"Accounts","href":"/api-reference/accounts"},{"title":"Retrieve An Account","openapi":"openAPI/accounts.yaml get /v2/accounts/{id}","href":"/api-reference/accounts/retrieve-an-account"},{"title":"Delete An Account","openapi":"openAPI/accounts.yaml delete /v2/accounts/{id}","href":"/api-reference/accounts/delete-an-account"},{"title":"List All Accounts","openapi":"openAPI/accounts.yaml get /v2/accounts","href":"/api-reference/accounts/list-all-accounts"},{"title":"Disable Account Updates","openapi":"openAPI/accounts.yaml post /v2/accounts/{id}/disable-ongoing-refresh","href":"/api-reference/accounts/disable-account-updates"}]},{"group":"Employments","pages":[{"title":"Employments","sidebarTitle":"Employments","href":"/api-reference/employments"},{"title":"List All Employments","openapi":"get /v2/employments","href":"/api-reference/employments/list-all-employments"}]}]},{"group":"Coverage","pages":[{"group":"Items","pages":[{"title":"Items","sidebarTitle":"Items","href":"/api-reference/items"},{"title":"Retrieve An Item","openapi":"get /v2/items/{id}","href":"/api-reference/items/retrieve-an-item"},{"title":"List All Items","openapi":"get /v2/items","href":"/api-reference/items/list-all-items"},{"title":"Migrate a Link Item ID","openapi":"post /v2/item-migrations","href":"/api-reference/items/migrate-a-link-item-id"}]},{"group":"Item Filters","pages":[{"title":"Item Filters","sidebarTitle":"Item Filters","href":"/api-reference/item-filters"},{"title":"Create An Item Filter","openapi":"post /v2/item-filters","href":"/api-reference/item-filters/create-an-item-filter"},{"title":"Retrieve An Item Filter","openapi":"get /v2/item-filters/{id}","href":"/api-reference/item-filters/retrieve-an-item-filter"},{"title":"Replace An Item Filter","openapi":"put /v2/item-filters/{id}","href":"/api-reference/item-filters/replace-an-item-filter"},{"title":"Delete An Item Filter","openapi":"delete /v2/item-filters/{id}","href":"/api-reference/item-filters/delete-an-item-filter"},{"title":"List All Item Filters","openapi":"get /v2/item-filters","href":"/api-reference/item-filters/list-all-item-filters"}]},{"group":"Employer Search","pages":[{"title":"Employer Search","sidebarTitle":"Employer Search","href":"/api-reference/employer-search"},{"title":"List All Employers","openapi":"get /v2/employer-search","href":"/api-reference/employer-search/list-all-employers"}]}]},{"group":"Payroll Data Sets","pages":[{"group":"Identities","pages":[{"title":"Identities","sidebarTitle":"Identities","href":"/api-reference/identities"},{"title":"Retrieve An Identity","openapi":"get /v2/identities/{id}","href":"/api-reference/identities/retrieve-an-identity"},{"title":"List All Identities","openapi":"get /v2/identities","href":"/api-reference/identities/list-all-identities"}]},{"group":"Paystubs","pages":[{"title":"Paystubs","sidebarTitle":"Paystubs","href":"/api-reference/paystubs"},{"title":"Retrieve A Paystub","openapi":"get /v2/paystubs/{id}","href":"/api-reference/paystubs/retrieve-a-paystub"},{"title":"List All Paystubs","openapi":"get /v2/paystubs","href":"/api-reference/paystubs/list-all-paystubs"}]},{"group":"Payroll Documents","pages":[{"title":"Payroll Documents","sidebarTitle":"Payroll Documents","href":"/api-reference/payroll-documents"},{"title":"Retrieve A Payroll Document","openapi":"get /v2/payroll-documents/{id}","href":"/api-reference/payroll-documents/retrieve-a-payroll-document"},{"title":"List All Payroll Documents","openapi":"get /v2/payroll-documents","href":"/api-reference/payroll-documents/list-all-payroll-documents"}]},{"group":"Deposit Destinations","pages":[{"title":"Deposit Destinations","sidebarTitle":"Deposit Destinations","href":"/api-reference/deposit-destinations"},{"title":"Retrieve A Deposit Destination","openapi":"get /v2/deposit-destinations/{id}","href":"/api-reference/deposit-destinations/retrieve-a-deposit-destination"},{"title":"List All Deposit Destinations","openapi":"get /v2/deposit-destinations","href":"/api-reference/deposit-destinations/list-all-deposit-destinations"}]},{"group":"Shifts","pages":[{"title":"Shifts","sidebarTitle":"Shifts","href":"/api-reference/shifts"},{"title":"Retrieve A Shift","openapi":"get /v2/shifts/{id}","href":"/api-reference/shifts/retrieve-a-shift"},{"title":"List All Shifts","openapi":"get /v2/shifts","href":"/api-reference/shifts/list-all-shifts"}]},{"group":"Gigs","pages":[{"title":"Gigs","sidebarTitle":"Gigs","href":"/api-reference/gigs"},{"title":"Retrieve A Gig","openapi":"get /v2/gigs/{id}","href":"/api-reference/gigs/retrieve-a-gig"},{"title":"List All Gigs","openapi":"get /v2/gigs","href":"/api-reference/gigs/list-all-gigs"}]},{"group":"Vehicles","pages":[{"title":"Vehicles","sidebarTitle":"Vehicles","href":"/api-reference/vehicles"},{"title":"Retrieve A Vehicle","openapi":"get /v2/vehicles/{id}","href":"/api-reference/vehicles/retrieve-a-vehicle"},{"title":"List All Vehicles","openapi":"get /v2/vehicles","href":"/api-reference/vehicles/list-all-vehicles"}]},{"group":"Ratings","pages":[{"title":"Ratings","sidebarTitle":"Ratings","href":"/api-reference/ratings"},{"title":"Retrieve A Rating","openapi":"get /v2/ratings/{id}","href":"/api-reference/ratings/retrieve-a-rating"},{"title":"List All Ratings","openapi":"get /v2/ratings","href":"/api-reference/ratings/list-all-ratings"}]}]},{"group":"Banking","pages":[{"group":"Financial Institutions","pages":[{"title":"Financial Institutions","sidebarTitle":"Financial Institutions","href":"/api-reference/financial-institutions"},{"openapi":"get /v2/open-banking/institutions/{institution_id}","title":"Retrieve an institution","href":"/api-reference/financial-institutions/retrieve-an-institution"},{"openapi":"get /v2/open-banking/institutions","title":"List all institutions","href":"/api-reference/financial-institutions/list-all-institutions"}]},{"group":"Bank Accounts","pages":[{"title":"Bank Accounts","sidebarTitle":"Bank Accounts","href":"/api-reference/bank-accounts"},{"openapi":"get /v2/open-banking/bank-accounts/{bank_account_id}","title":"Retrieve a bank account","href":"/api-reference/bank-accounts/retrieve-a-bank-account"},{"openapi":"get /v2/open-banking/bank-accounts","title":"List all bank accounts","href":"/api-reference/bank-accounts/list-all-bank-accounts"}]}]},{"group":"Reports","pages":[{"group":"Reports","pages":[{"title":"Reports","sidebarTitle":"Reports","href":"/api-reference/reports"},{"title":"List All Reports","openapi":"get /v2/reports","href":"/api-reference/reports/list-all-reports"},{"title":"Generate A Report","openapi":"post /v2/reports/{type}","href":"/api-reference/reports/generate-a-report"},{"title":"Retrieve A Report","openapi":"get /v2/reports/{id}","href":"/api-reference/reports/retrieve-a-report"},{"title":"Delete A Report","openapi":"delete /v2/reports/{id}","href":"/api-reference/reports/delete-a-report"}]}]},{"group":"Workflows","pages":[{"group":"User Uploads","pages":[{"title":"User Uploads","sidebarTitle":"User Uploads","href":"/api-reference/user-uploads"},{"title":"Upload A Document","openapi":"post /v2/user-uploads","href":"/api-reference/user-uploads/upload-a-document"},{"title":"Retrieve A User Upload","openapi":"get /v2/user-uploads/{id}","href":"/api-reference/user-uploads/retrieve-a-user-upload"},{"title":"List All User Uploads","openapi":"get /v2/user-uploads","href":"/api-reference/user-uploads/list-all-user-uploads"}]},{"group":"User Forms","pages":[{"title":"User Forms","sidebarTitle":"User Forms","href":"/api-reference/user-forms"},{"title":"Retrieve A User Form","openapi":"get /v2/user-forms/{id}","href":"/api-reference/user-forms/retrieve-a-user-form"},{"title":"List All User Forms","openapi":"get /v2/user-forms","href":"/api-reference/user-forms/list-all-user-forms"}]},{"group":"Legacy Workflows","pages":[{"title":"Document Verifications","sidebarTitle":"Legacy Documents","href":"/api-reference/documents-overview"},{"group":"Legacy Banking","pages":[{"title":"Banking Overview Guide","sidebarTitle":"Overview Guide","href":"/api-reference/banking-overview"},{"group":"Connect URL","pages":[{"title":"Connect URL","openapi":"openAPI/open-banking.yaml post /v2/open-banking/connect","href":"/api-reference/connect-url"},{"openapi":"post /v2/open-banking/connect","title":"Create a Connect URL","href":"/api-reference/connect-url/create-a-connect-url"}]},{"group":"Banking Reports","pages":[{"title":"Banking Reports","href":"/api-reference/banking-reports"},{"openapi":"post /v2/open-banking/reports/{type}","title":"Generate a banking report","href":"/api-reference/banking-reports/generate-a-banking-report"}]}]}]}]},{"group":"Webhooks","pages":[{"group":"Users","pages":[{"title":"Users.fully_synced webhook","openapi":"openAPI/users-webhooks.yaml post /v2/webhooks","sidebarTitle":"Fully synced","href":"/api-reference/users-webhooks/fully-synced"}]},{"group":"Accounts","pages":[{"title":"Accounts.added webhook","openapi":"openAPI/account-webhooks-added.yaml post /v2/webhooks","sidebarTitle":"Added","href":"/api-reference/accounts-webhooks/added"},{"title":"Accounts.updated webhook","openapi":"openAPI/account-webhook-updated.yaml post /v2/webhooks","sidebarTitle":"Updated","href":"/api-reference/accounts-webhooks/updated"},{"title":"Accounts.removed webhook","openapi":"openAPI/accounts-webhooks-removed.yaml post /v2/webhooks","sidebarTitle":"Removed","href":"/api-reference/accounts-webhooks/removed"},{"title":"Accounts.connected webhook","openapi":"openAPI/accounts-webhooks-connected.yaml post /v2/webhooks","sidebarTitle":"Connected","href":"/api-reference/accounts-webhooks/connected"},{"title":"Accounts.failed webhook","openapi":"openAPI/accounts-webhooks-failed.yaml post /v2/webhooks","sidebarTitle":"Failed","href":"/api-reference/accounts-webhooks/failed"}]},{"group":"Items","pages":[{"title":"Items.updated webhook","openapi":"openAPI/items-webhooks-updated.yaml post /v2/webhooks","sidebarTitle":"Updated","href":"/api-reference/items-webhooks/updated"},{"title":"Items.removed webhook","openapi":"openAPI/items-webhooks-removed.yaml post /v2/webhooks","sidebarTitle":"Removed","href":"/api-reference/items-webhooks/removed"}]},{"group":"Identities","pages":[{"title":"Identities.added webhook","openapi":"openAPI/identities-webhooks-added.yaml post /v2/webhooks","sidebarTitle":"Added","href":"/api-reference/identities-webhooks/added"},{"title":"Identities.updated webhook","openapi":"openAPI/identities-webhooks-updated.yaml post /v2/webhooks","sidebarTitle":"Updated","href":"/api-reference/identities-webhooks/updated"}]},{"group":"Paystubs","pages":[{"title":"Paystubs.added webhook","openapi":"openAPI/paystubs-webhooks-added.yaml post /v2/webhooks","sidebarTitle":"Added","href":"/api-reference/paystubs-webhooks/added"},{"title":"Paystubs.updated webhook","openapi":"openAPI/paystubs-webhooks-updated.yaml post /v2/webhooks","sidebarTitle":"Updated","href":"/api-reference/paystubs-webhooks/updated"},{"title":"Paystubs.partially_synced webhook","openapi":"openAPI/paystubs-webhooks-partially-synced.yaml post /v2/webhooks","sidebarTitle":"Partially synced","href":"/api-reference/paystubs-webhooks/partially-synced"},{"title":"Paystubs.fully_synced webhook","openapi":"openAPI/paystubs-webhooks-fully-synced.yaml post /v2/webhooks","sidebarTitle":"Fully synced","href":"/api-reference/paystubs-webhooks/fully-synced"}]},{"group":"Payroll Documents","pages":[{"title":"Payroll Documents.added webhook","openapi":"openAPI/payroll-documents-webhooks-added.yaml post /v2/webhooks","sidebarTitle":"Added","href":"/api-reference/payroll-documents-webhooks/added"},{"title":"Payroll Documents.updated webhook","openapi":"openAPI/payroll-documents-webhooks-updated.yaml post /v2/webhooks","sidebarTitle":"Updated","href":"/api-reference/payroll-documents-webhooks/updated"},{"title":"Payroll Documents.removed webhook","openapi":"openAPI/payroll-documents-webhooks-removed.yaml post /v2/webhooks","sidebarTitle":"Removed","href":"/api-reference/payroll-documents-webhooks/removed"},{"title":"Payroll Documents.ocr_completed webhook","openapi":"openAPI/payroll-documents-webhooks-ocr-completed.yaml post /v2/webhooks","sidebarTitle":"OCR completed","href":"/api-reference/payroll-documents-webhooks/ocr-completed"},{"title":"Payroll Documents.ocr_failed webhook","openapi":"openAPI/payroll-documents-webhooks-ocr-failed.yaml post /v2/webhooks","sidebarTitle":"OCR failed","href":"/api-reference/payroll-documents-webhooks/ocr-failed"}]},{"group":"Shifts","pages":[{"title":"Shifts.added webhook","openapi":"openAPI/shifts-webhooks-added.yaml post /v2/webhooks","sidebarTitle":"Added","href":"/api-reference/shifts-webhooks/added"},{"title":"Shifts.updated webhook","openapi":"openAPI/shifts-webhooks-updated.yaml post /v2/webhooks","sidebarTitle":"Updated","href":"/api-reference/shifts-webhooks/updated"},{"title":"Shifts.removed webhook","openapi":"openAPI/shifts-webhooks-removed.yaml post /v2/webhooks","sidebarTitle":"Removed","href":"/api-reference/shifts-webhooks/removed"},{"title":"Shifts.partially_synced webhook","openapi":"openAPI/shifts-webhooks-partially-synced.yaml post /v2/webhooks","sidebarTitle":"Partially synced","href":"/api-reference/shifts-webhooks/partially-synced"},{"title":"Shifts.fully_synced webhook","openapi":"openAPI/shifts-webhooks-fully-synced.yaml post /v2/webhooks","sidebarTitle":"Fully synced","href":"/api-reference/shifts-webhooks/fully-synced"}]},{"group":"Gigs","pages":[{"openapi":"openAPI/gigs-webhooks-added.yaml post /v2/webhooks","title":"Gigs.added webhook","sidebarTitle":"Added","href":"/api-reference/gigs-webhooks/added"},{"openapi":"openAPI/gigs-webhooks-updated.yaml post /v2/webhooks","title":"Gigs.updated webhook","sidebarTitle":"Updated","href":"/api-reference/gigs-webhooks/updated"},{"openapi":"openAPI/gigs-webhooks-removed.yaml post /v2/webhooks","title":"Gigs.removed webhook","sidebarTitle":"Removed","href":"/api-reference/gigs-webhooks/removed"},{"openapi":"openAPI/gigs-webhooks-partially-synced.yaml post /v2/webhooks","title":"Gigs.partially_synced webhook","sidebarTitle":"Partially synced","href":"/api-reference/gigs-webhooks/partially-synced"},{"openapi":"openAPI/gigs-webhooks-fully-synced.yaml post /v2/webhooks","title":"Gigs.fully_synced webhook","sidebarTitle":"Fully synced","href":"/api-reference/gigs-webhooks/fully-synced"}]},{"group":"Vehicles","pages":[{"openapi":"openAPI/vehicles-webhooks-added.yaml post /v2/webhooks","title":"Vehicles.added webhook","sidebarTitle":"Added","href":"/api-reference/vehicles-webhooks/added"},{"openapi":"openAPI/vehicles-webhooks-updated.yaml post /v2/webhooks","title":"Vehicles.updated webhook","sidebarTitle":"Updated","href":"/api-reference/vehicles-webhooks/updated"},{"openapi":"openAPI/vehicles-webhooks-removed.yaml post /v2/webhooks","title":"Vehicles.removed webhook","sidebarTitle":"Removed","href":"/api-reference/vehicles-webhooks/removed"}]},{"group":"Ratings","pages":[{"openapi":"openAPI/ratings-webhooks-added.yaml post /v2/webhooks","title":"Ratings.added webhook","sidebarTitle":"Added","href":"/api-reference/ratings-webhooks/added"},{"openapi":"openAPI/ratings-webhooks-updated.yaml post /v2/webhooks","title":"Ratings.updated webhook","sidebarTitle":"Updated","href":"/api-reference/ratings-webhooks/updated"}]},{"group":"Reports","pages":[{"openapi":"openAPI/reports-webhooks-ready.yaml post /v2/webhooks","title":"Reports.ready webhook","sidebarTitle":"Ready","href":"/api-reference/reports-webhooks/ready"},{"openapi":"openAPI/reports-webhooks-generated.yaml post /v2/webhooks","title":"Reports.generated webhook","sidebarTitle":"Generated","href":"/api-reference/reports-webhooks/generated"}]},{"group":"User Uploads","pages":[{"openapi":"openAPI/user-uploads-webhooks-added.yaml post /v2/webhooks","title":"User Uploads.added webhook","sidebarTitle":"Added","href":"/api-reference/user-uploads-webhooks/added"},{"openapi":"openAPI/user-uploads-webhooks-removed.yaml post /v2/webhooks","title":"User Uploads.removed webhook","sidebarTitle":"Removed","href":"/api-reference/user-uploads-webhooks/removed"},{"openapi":"openAPI/user-uploads-webhooks-ocr-completed.yaml post /v2/webhooks","title":"User Uploads.ocr_completed webhook","sidebarTitle":"OCR Completed","href":"/api-reference/user-uploads-webhooks/ocr-completed"},{"openapi":"openAPI/user-uploads-webhooks-ocr-failed.yaml post /v2/webhooks","title":"User Uploads.ocr_failed webhook","sidebarTitle":"OCR Failed","href":"/api-reference/user-uploads-webhooks/ocr-failed"},{"openapi":"openAPI/user-uploads-webhooks-ocr-authenticity.yaml post /v2/webhooks","title":"User Uploads.ocr_authenticity webhook","sidebarTitle":"OCR Authenticity","href":"/api-reference/user-uploads-webhooks/ocr-authenticity"}]},{"group":"User Forms","pages":[{"title":"User Forms.submitted webhook","openapi":"openAPI/user-forms-webhooks.yaml post /v2/webhooks","sidebarTitle":"Submitted","href":"/api-reference/user-forms-webhooks/user-forms-submitted"},{"title":"User Forms.removed webhook","openapi":"openAPI/user-forms-webhooks-removed.yaml post /v2/webhooks","sidebarTitle":"Removed","href":"/api-reference/user-forms-webhooks/user-forms-removed"}]},{"group":"Verifications","pages":[{"title":"Verifications.updated webhook","openapi":"openAPI/verifications-webhooks-updated.yaml post /v2/webhooks","sidebarTitle":"Updated","href":"/api-reference/verifications-webhooks/updated"},{"title":"Verifications.creation_failed webhook","openapi":"openAPI/verifications-webhooks-creation-failed.yaml post /v2/webhooks","sidebarTitle":"Creation failed","href":"/api-reference/verifications-webhooks/creation-failed"},{"title":"Verifications.connection_added webhook","openapi":"openAPI/verifications-webhooks-connection-added.yaml post /v2/webhooks","sidebarTitle":"Connection added","href":"/api-reference/verifications-webhooks/connection-added"},{"title":"Verifications.connection_removed webhook","openapi":"openAPI/verifications-webhooks-connection-removed.yaml post /v2/webhooks","sidebarTitle":"Connection removed","href":"/api-reference/verifications-webhooks/connection-removed"}]},{"group":"Webhook management","pages":[{"title":"Create a webhook","openapi":"openAPI/webhooks.yaml post /v2/webhooks","href":"/api-reference/webhooks/create-a-webhook"},{"title":"Retrieve a webhook","openapi":"openAPI/webhooks.yaml get /v2/webhooks/{id}","href":"/api-reference/webhooks/retrieve-a-webhook"},{"title":"Delete a webhook","openapi":"openAPI/webhooks.yaml delete /v2/webhooks/{id}","href":"/api-reference/webhooks/delete-a-webhook"},{"title":"List all webhooks","openapi":"openAPI/webhooks.yaml get /v2/webhooks","href":"/api-reference/webhooks/list-all-webhooks"}]}]},{"group":"Receipts","pages":[{"group":"Receipts","pages":[{"openapi":"post /v2/receipts","title":"Receipts","href":"/api-reference/receipts"}]}]},{"group":"Error Codes","pages":[{"title":"Account Connection Errors","sidebarTitle":"Account Connection Errors","href":"/api-reference/account-connection-errors"},{"title":"Bank Connection Errors","sidebarTitle":"Bank Connection Errors","href":"/api-reference/bank-connection-errors"}]}]}]},{"product":"Partners","icon":"puzzle-piece","description":"Build for your customers.","pages":[{"title":"Partners","href":"/partners"}]},{"product":"Changelog","description":"Product updates and announcements","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Update A User - Argyle Docs","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js","Markdown-CwtoSfEf.js","AssistantPageLink-CTqa3eoi.js","dist-DIfYWxfm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}