{ "success": true, "message": "Address information updated successfully"}
Updates profile, contact, share, shareholder, and social details for a claimed company. The request is multipart/form-data so shareholder ID documents can be attached in the same call. Most fields are sent as flat form fields; shareHolderDetails, registrarInfo, and socials are JSON-encoded.
Path
string
required
The company must be owned by the caller.
Form fields
All fields are optional. Send each as a separate multipart/form-data part.
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string | number
string | number
string
string
string | boolean
string | boolean
string | boolean
boolean
boolean
When true, the response echoes the updated shareHolderDetails array instead of the trimmed company object.
object
JSON-encoded. Keys: website, facebook, instagram, linkedin, twitter, tiktok (each a URL). A reachable website flips website_verified to true.
JSON-encoded array. Each shareholder may include name, email, address, dateOfBirth, nationality, idType, roleInCompany, percentageOfOwner, noOfShares, identificationNumber, phoneNumber, identificationDocumentUrl. Supplying this array sets shareHolderVerified to true.
file[]
Up to 10 PDFs, ≤ 50 MB each. Files are matched to shareholders by position — the first file applies to the first entry in shareHolderDetails, the second to the second, and so on. Each uploaded document is verified against the shareholder’s name, identificationNumber, and idType before it is stored; a shareholder with no matching file keeps its existing document. Extra files beyond the shareholder count are ignored.
{ "success": true, "message": "Address information updated successfully"}
If no owned company matches companyId, the endpoint returns 404 with { "message": "Company not found" }. Invalid shareholder JSON returns 400 with { "message": "Invalid JSON data provided" }.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Vouchmark","description":"Verify Nigerian businesses, monitor counterparty risk, and prove trust on the web.","colors":{"primary":"#6466AE","light":"#8B8DC4","dark":"#45478B"},"logo":{"light":"https://mintcdn.com/vouchmark/vyDGY2ihe3oA_T8z/logo/logo.png?fit=max\u0026auto=format\u0026n=vyDGY2ihe3oA_T8z\u0026q=85\u0026s=4b7f5d3a985c0d54dda118e5f3eb7c3c","dark":"https://mintcdn.com/vouchmark/vyDGY2ihe3oA_T8z/logo/logo.png?fit=max\u0026auto=format\u0026n=vyDGY2ihe3oA_T8z\u0026q=85\u0026s=4b7f5d3a985c0d54dda118e5f3eb7c3c","href":"https://vouchmark.com"},"favicon":"https://mintcdn.com/vouchmark/vyDGY2ihe3oA_T8z/favicon.png?fit=max\u0026auto=format\u0026n=vyDGY2ihe3oA_T8z\u0026q=85\u0026s=8ce46c42758c5a8875f8efd3bb924904","appearance":{"default":"light","strict":true},"navbar":{"links":[{"href":"mailto:support@vouchmark.com","label":"Support"}],"primary":{"type":"button","label":"Open Dashboard","href":"https://vouchmark.com"}},"footer":{"socials":{"x":"https://x.com/vouchmark","linkedin":"https://www.linkedin.com/company/vouchmark"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Dashboard","icon":"browser","href":"https://vouchmark.com"},{"anchor":"Status","icon":"signal-bars","href":"https://status.vouchmark.com"},{"anchor":"Support","icon":"envelope","href":"mailto:support@vouchmark.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vouchmark","hasAudioNarration":false,"actualSubdomain":"vouchmark","customDomains":["docs.vouchmark.com"],"gitSource":{"type":"github","owner":"vouchmark-org","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae43def63718976c0ca212b","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"API Reference","count":83},{"language":"default","tag":"Documentation","count":21},{"language":"default","tag":"Verifications","count":15},{"language":"default","tag":"Onboarding (KYB)","count":13},{"language":"default","tag":"Monitoring","count":9},{"language":"default","tag":"Vouch AI","count":9},{"language":"default","tag":"Core concepts","count":9},{"language":"default","tag":"Compliance","count":7},{"language":"default","tag":"Wallet \u0026 Billing","count":7},{"language":"default","tag":"Developers","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"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":[],"page":{"pagePath":"api-reference/companies/edit","slug":"/api-reference/companies/edit","pageMetadata":{"title":"Edit a company","api":"POST /v1/edit-company/{companyId}","description":"Update editable fields on an owned company.","href":"/api-reference/companies/edit"},"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 editable fields on an owned company.\"\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={code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Heading,Note,ParamField}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Updates profile, contact, share, shareholder, and social details for a claimed company. The request is `,_jsx(_components.code,{children:`multipart/form-data`}),` so shareholder ID documents can be attached in the same call. Most fields are sent as flat form fields; `,_jsx(_components.code,{children:`shareHolderDetails`}),`, `,_jsx(_components.code,{children:`registrarInfo`}),`, and `,_jsx(_components.code,{children:`socials`}),` are JSON-encoded.`]}),`\n`,_jsx(Heading,{level:`2`,id:`path`,children:`Path`}),`\n`,_jsx(ParamField,{path:`companyId`,type:`string`,required:true,id:`param-company-id`,children:_jsx(_components.p,{children:`The company must be owned by the caller.`})}),`\n`,_jsx(Heading,{level:`2`,id:`form-fields`,children:`Form fields`}),`\n`,_jsxs(_components.p,{children:[`All fields are optional. Send each as a separate `,_jsx(_components.code,{children:`multipart/form-data`}),` part.`]}),`\n`,_jsx(ParamField,{body:`companyName`,type:`string`,id:`param-company-name`}),`\n`,_jsx(ParamField,{body:`rcNumber`,type:`string`,id:`param-rc-number`}),`\n`,_jsx(ParamField,{body:`email`,type:`string`,id:`param-email`}),`\n`,_jsx(ParamField,{body:`phone`,type:`string`,id:`param-phone`}),`\n`,_jsx(ParamField,{body:`address`,type:`string`,id:`param-address`}),`\n`,_jsx(ParamField,{body:`city`,type:`string`,id:`param-city`}),`\n`,_jsx(ParamField,{body:`state`,type:`string`,id:`param-state`}),`\n`,_jsx(ParamField,{body:`postcode`,type:`string`,id:`param-postcode`}),`\n`,_jsx(ParamField,{body:`natureOfBusiness`,type:`string`,id:`param-nature-of-business`}),`\n`,_jsx(ParamField,{body:`businessCategory`,type:`string`,id:`param-business-category`}),`\n`,_jsx(ParamField,{body:`businessDescription`,type:`string`,id:`param-business-description`}),`\n`,_jsx(ParamField,{body:`headOfficeAddress`,type:`string`,id:`param-head-office-address`}),`\n`,_jsx(ParamField,{body:`company_classification`,type:`string`,id:`param-company-classification`}),`\n`,_jsx(ParamField,{body:`firsTin`,type:`string`,id:`param-firs-tin`}),`\n`,_jsx(ParamField,{body:`shareCapital`,type:`string | number`,id:`param-share-capital`}),`\n`,_jsx(ParamField,{body:`vouchShareCapital`,type:`string | number`,id:`param-vouch-share-capital`}),`\n`,_jsx(ParamField,{body:`shareCapitalInWords`,type:`string`,id:`param-share-capital-in-words`}),`\n`,_jsx(ParamField,{body:`dividedInto`,type:`string`,id:`param-divided-into`}),`\n`,_jsx(ParamField,{body:`registrationApproved`,type:`string | boolean`,id:`param-registration-approved`}),`\n`,_jsx(ParamField,{body:`active`,type:`string | boolean`,id:`param-active`}),`\n`,_jsx(ParamField,{body:`website_verified`,type:`string | boolean`,id:`param-website-verified`}),`\n`,_jsx(ParamField,{body:`shareHolderVerified`,type:`boolean`,id:`param-share-holder-verified`}),`\n`,_jsx(ParamField,{body:`shareHolder`,type:`boolean`,id:`param-share-holder`,children:_jsxs(_components.p,{children:[`When `,_jsx(_components.code,{children:`true`}),`, the response echoes the updated `,_jsx(_components.code,{children:`shareHolderDetails`}),` array instead of the trimmed `,_jsx(_components.code,{children:`company`}),` object.`]})}),`\n`,_jsx(ParamField,{body:`socials`,type:`object`,id:`param-socials`,children:_jsxs(_components.p,{children:[`JSON-encoded. Keys: `,_jsx(_components.code,{children:`website`}),`, `,_jsx(_components.code,{children:`facebook`}),`, `,_jsx(_components.code,{children:`instagram`}),`, `,_jsx(_components.code,{children:`linkedin`}),`, `,_jsx(_components.code,{children:`twitter`}),`, `,_jsx(_components.code,{children:`tiktok`}),` (each a URL). A reachable `,_jsx(_components.code,{children:`website`}),` flips `,_jsx(_components.code,{children:`website_verified`}),` to `,_jsx(_components.code,{children:`true`}),`.`]})}),`\n`,_jsx(ParamField,{body:`registrarInfo`,type:`string | object`,id:`param-registrar-info`,children:_jsxs(_components.p,{children:[`JSON-encoded. Keys: `,_jsx(_components.code,{children:`surname`}),`, `,_jsx(_components.code,{children:`firstname`}),`, `,_jsx(_components.code,{children:`email`}),`, `,_jsx(_components.code,{children:`nationality`}),`, `,_jsx(_components.code,{children:`date_of_birth`}),`.`]})}),`\n`,_jsx(ParamField,{body:`shareHolderDetails`,type:`string | array`,id:`param-share-holder-details`,children:_jsxs(_components.p,{children:[`JSON-encoded array. Each shareholder may include `,_jsx(_components.code,{children:`name`}),`, `,_jsx(_components.code,{children:`email`}),`, `,_jsx(_components.code,{children:`address`}),`, `,_jsx(_components.code,{children:`dateOfBirth`}),`, `,_jsx(_components.code,{children:`nationality`}),`, `,_jsx(_components.code,{children:`idType`}),`, `,_jsx(_components.code,{children:`roleInCompany`}),`, `,_jsx(_components.code,{children:`percentageOfOwner`}),`, `,_jsx(_components.code,{children:`noOfShares`}),`, `,_jsx(_components.code,{children:`identificationNumber`}),`, `,_jsx(_components.code,{children:`phoneNumber`}),`, `,_jsx(_components.code,{children:`identificationDocumentUrl`}),`. Supplying this array sets `,_jsx(_components.code,{children:`shareHolderVerified`}),` to `,_jsx(_components.code,{children:`true`}),`.`]})}),`\n`,_jsx(ParamField,{body:`shareholderIdDocs`,type:`file[]`,id:`param-shareholder-id-docs`,children:_jsxs(_components.p,{children:[`Up to 10 PDFs, ≤ 50 MB each. Files are matched to shareholders `,_jsx(_components.strong,{children:`by position`}),` — the first file applies to the first entry in `,_jsx(_components.code,{children:`shareHolderDetails`}),`, the second to the second, and so on. Each uploaded document is verified against the shareholder’s `,_jsx(_components.code,{children:`name`}),`, `,_jsx(_components.code,{children:`identificationNumber`}),`, and `,_jsx(_components.code,{children:`idType`}),` before it is stored; a shareholder with no matching file keeps its existing document. Extra files beyond the shareholder count are ignored.`]})}),`\n`,`\n`,`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`If no owned company matches `,_jsx(_components.code,{children:`companyId`}),`, the endpoint returns `,_jsx(_components.code,{children:`404`}),` with `,_jsx(_components.code,{children:`{ \"message\": \"Company not found\" }`}),`. Invalid shareholder JSON returns `,_jsx(_components.code,{children:`400`}),` with `,_jsx(_components.code,{children:`{ \"message\": \"Invalid JSON data provided\" }`}),`.`]})})]})}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":{"config":{},"pageMetadata":{"title":"Edit a company","api":"POST /v1/edit-company/{companyId}","description":"Update editable fields on an owned company.","href":"/api-reference/companies/edit"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,ParamField,RequestExample,ResponseExample}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Updates profile, contact, share, shareholder, and social details for a claimed company. The request is `,_jsx(_components.code,{children:`multipart/form-data`}),` so shareholder ID documents can be attached in the same call. Most fields are sent as flat form fields; `,_jsx(_components.code,{children:`shareHolderDetails`}),`, `,_jsx(_components.code,{children:`registrarInfo`}),`, and `,_jsx(_components.code,{children:`socials`}),` are JSON-encoded.`]}),`\n`,_jsx(Heading,{level:`2`,id:`path`,children:`Path`}),`\n`,_jsx(ParamField,{path:`companyId`,type:`string`,required:true,id:`param-company-id`,children:_jsx(_components.p,{children:`The company must be owned by the caller.`})}),`\n`,_jsx(Heading,{level:`2`,id:`form-fields`,children:`Form fields`}),`\n`,_jsxs(_components.p,{children:[`All fields are optional. Send each as a separate `,_jsx(_components.code,{children:`multipart/form-data`}),` part.`]}),`\n`,_jsx(ParamField,{body:`companyName`,type:`string`,id:`param-company-name`}),`\n`,_jsx(ParamField,{body:`rcNumber`,type:`string`,id:`param-rc-number`}),`\n`,_jsx(ParamField,{body:`email`,type:`string`,id:`param-email`}),`\n`,_jsx(ParamField,{body:`phone`,type:`string`,id:`param-phone`}),`\n`,_jsx(ParamField,{body:`address`,type:`string`,id:`param-address`}),`\n`,_jsx(ParamField,{body:`city`,type:`string`,id:`param-city`}),`\n`,_jsx(ParamField,{body:`state`,type:`string`,id:`param-state`}),`\n`,_jsx(ParamField,{body:`postcode`,type:`string`,id:`param-postcode`}),`\n`,_jsx(ParamField,{body:`natureOfBusiness`,type:`string`,id:`param-nature-of-business`}),`\n`,_jsx(ParamField,{body:`businessCategory`,type:`string`,id:`param-business-category`}),`\n`,_jsx(ParamField,{body:`businessDescription`,type:`string`,id:`param-business-description`}),`\n`,_jsx(ParamField,{body:`headOfficeAddress`,type:`string`,id:`param-head-office-address`}),`\n`,_jsx(ParamField,{body:`company_classification`,type:`string`,id:`param-company-classification`}),`\n`,_jsx(ParamField,{body:`firsTin`,type:`string`,id:`param-firs-tin`}),`\n`,_jsx(ParamField,{body:`shareCapital`,type:`string | number`,id:`param-share-capital`}),`\n`,_jsx(ParamField,{body:`vouchShareCapital`,type:`string | number`,id:`param-vouch-share-capital`}),`\n`,_jsx(ParamField,{body:`shareCapitalInWords`,type:`string`,id:`param-share-capital-in-words`}),`\n`,_jsx(ParamField,{body:`dividedInto`,type:`string`,id:`param-divided-into`}),`\n`,_jsx(ParamField,{body:`registrationApproved`,type:`string | boolean`,id:`param-registration-approved`}),`\n`,_jsx(ParamField,{body:`active`,type:`string | boolean`,id:`param-active`}),`\n`,_jsx(ParamField,{body:`website_verified`,type:`string | boolean`,id:`param-website-verified`}),`\n`,_jsx(ParamField,{body:`shareHolderVerified`,type:`boolean`,id:`param-share-holder-verified`}),`\n`,_jsx(ParamField,{body:`shareHolder`,type:`boolean`,id:`param-share-holder`,children:_jsxs(_components.p,{children:[`When `,_jsx(_components.code,{children:`true`}),`, the response echoes the updated `,_jsx(_components.code,{children:`shareHolderDetails`}),` array instead of the trimmed `,_jsx(_components.code,{children:`company`}),` object.`]})}),`\n`,_jsx(ParamField,{body:`socials`,type:`object`,id:`param-socials`,children:_jsxs(_components.p,{children:[`JSON-encoded. Keys: `,_jsx(_components.code,{children:`website`}),`, `,_jsx(_components.code,{children:`facebook`}),`, `,_jsx(_components.code,{children:`instagram`}),`, `,_jsx(_components.code,{children:`linkedin`}),`, `,_jsx(_components.code,{children:`twitter`}),`, `,_jsx(_components.code,{children:`tiktok`}),` (each a URL). A reachable `,_jsx(_components.code,{children:`website`}),` flips `,_jsx(_components.code,{children:`website_verified`}),` to `,_jsx(_components.code,{children:`true`}),`.`]})}),`\n`,_jsx(ParamField,{body:`registrarInfo`,type:`string | object`,id:`param-registrar-info`,children:_jsxs(_components.p,{children:[`JSON-encoded. Keys: `,_jsx(_components.code,{children:`surname`}),`, `,_jsx(_components.code,{children:`firstname`}),`, `,_jsx(_components.code,{children:`email`}),`, `,_jsx(_components.code,{children:`nationality`}),`, `,_jsx(_components.code,{children:`date_of_birth`}),`.`]})}),`\n`,_jsx(ParamField,{body:`shareHolderDetails`,type:`string | array`,id:`param-share-holder-details`,children:_jsxs(_components.p,{children:[`JSON-encoded array. Each shareholder may include `,_jsx(_components.code,{children:`name`}),`, `,_jsx(_components.code,{children:`email`}),`, `,_jsx(_components.code,{children:`address`}),`, `,_jsx(_components.code,{children:`dateOfBirth`}),`, `,_jsx(_components.code,{children:`nationality`}),`, `,_jsx(_components.code,{children:`idType`}),`, `,_jsx(_components.code,{children:`roleInCompany`}),`, `,_jsx(_components.code,{children:`percentageOfOwner`}),`, `,_jsx(_components.code,{children:`noOfShares`}),`, `,_jsx(_components.code,{children:`identificationNumber`}),`, `,_jsx(_components.code,{children:`phoneNumber`}),`, `,_jsx(_components.code,{children:`identificationDocumentUrl`}),`. Supplying this array sets `,_jsx(_components.code,{children:`shareHolderVerified`}),` to `,_jsx(_components.code,{children:`true`}),`.`]})}),`\n`,_jsx(ParamField,{body:`shareholderIdDocs`,type:`file[]`,id:`param-shareholder-id-docs`,children:_jsxs(_components.p,{children:[`Up to 10 PDFs, ≤ 50 MB each. Files are matched to shareholders `,_jsx(_components.strong,{children:`by position`}),` — the first file applies to the first entry in `,_jsx(_components.code,{children:`shareHolderDetails`}),`, the second to the second, and so on. Each uploaded document is verified against the shareholder’s `,_jsx(_components.code,{children:`name`}),`, `,_jsx(_components.code,{children:`identificationNumber`}),`, and `,_jsx(_components.code,{children:`idType`}),` before it is stored; a shareholder with no matching file keeps its existing document. Extra files beyond the shareholder count are ignored.`]})}),`\n`,_jsx(RequestExample,{children:_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`7`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`7`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -X POST https://api.vouchmark.com/v1/edit-company/cmp_aBcD... \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Authorization: Bearer $TOKEN\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -F `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'city=Lagos'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -F `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'state=Lagos'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -F `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'socials={\"website\":\"https://tekcify.com\"}'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -F `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'shareHolderDetails=[{\"name\":\"Ada Obi\",\"email\":\"ada@tekcify.com\",\"idType\":\"NIN\",\"identificationNumber\":\"12345678901\",\"noOfShares\":5000}]'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -F `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'shareholderIdDocs=@./ada-nin.pdf'`})]}),`\n`]})})})}),`\n`,_jsxs(ResponseExample,{children:[_jsx(CodeBlock,{filename:`Company update`,numberOfLines:`17`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`17`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Company details updated successfully\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"company\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"cmp_aBcD...\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"shareHolderDetails\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Ada Obi\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"email\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ada@tekcify.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"idType\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"NIN\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"identificationNumber\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"12345678901\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"noOfShares\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`5000`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"identificationDocumentUrl\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://cdn.vouchmark.com/...\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Shareholder update (shareHolder=true)`,numberOfLines:`5`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Shareholder details updated successfully\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"shareHolderDetails\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: []`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Address-only update`,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Address information updated successfully\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`If no owned company matches `,_jsx(_components.code,{children:`companyId`}),`, the endpoint returns `,_jsx(_components.code,{children:`404`}),` with `,_jsx(_components.code,{children:`{ \"message\": \"Company not found\" }`}),`. Invalid shareholder JSON returns `,_jsx(_components.code,{children:`400`}),` with `,_jsx(_components.code,{children:`{ \"message\": \"Invalid JSON data provided\" }`}),`.`]})})]})}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":{"config":{},"pageMetadata":{"title":"Edit a company","api":"POST /v1/edit-company/{companyId}","description":"Update editable fields on an owned company.","href":"/api-reference/companies/edit"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Path","slug":"path","depth":2,"children":[]},{"title":"Form fields","slug":"form-fields","depth":2,"children":[]}],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"cURL","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"7\">\u003cspan class=\"line\">\u003cspan style=\"color:#8250DF;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> -X POST https://api.vouchmark.com/v1/edit-company/cmp_aBcD... \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> -H \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Authorization: Bearer $TOKEN\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> -F \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">'city=Lagos'\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> -F \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">'state=Lagos'\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> -F \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">'socials={\"website\":\"https://tekcify.com\"}'\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> -F \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">'shareHolderDetails=[{\"name\":\"Ada Obi\",\"email\":\"ada@tekcify.com\",\"idType\":\"NIN\",\"identificationNumber\":\"12345678901\",\"noOfShares\":5000}]'\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> -F \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">'shareholderIdDocs=@./ada-nin.pdf'\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]},"response":{"type":"ResponseExample","children":[{"filename":"Company update","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"17\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"success\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">true\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Company details updated successfully\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"company\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"cmp_aBcD...\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"shareHolderDetails\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Ada Obi\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"email\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"ada@tekcify.com\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"idType\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"NIN\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"identificationNumber\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"12345678901\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"noOfShares\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">5000\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"identificationDocumentUrl\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"https://cdn.vouchmark.com/...\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"Shareholder update (shareHolder=true)","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"5\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"success\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">true\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Shareholder details updated successfully\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"shareHolderDetails\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: []\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"Address-only update","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"4\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"success\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">true\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Address information updated successfully\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Edit a company","path":"/v1/edit-company/{companyId}","method":"post","request":{"security":[],"parameters":{"query":{},"header":{},"cookie":{},"path":{"companyId":{"schema":[{"type":"string","description":"The company must be owned by the caller.","required":true}]}}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"companyName":[{"type":"string"}],"rcNumber":[{"type":"string"}],"email":[{"type":"string"}],"phone":[{"type":"string"}],"address":[{"type":"string"}],"city":[{"type":"string"}],"state":[{"type":"string"}],"postcode":[{"type":"string"}],"natureOfBusiness":[{"type":"string"}],"businessCategory":[{"type":"string"}],"businessDescription":[{"type":"string"}],"headOfficeAddress":[{"type":"string"}],"company_classification":[{"type":"string"}],"firsTin":[{"type":"string"}],"shareCapital":[{"type":"object","properties":{}}],"vouchShareCapital":[{"type":"object","properties":{}}],"shareCapitalInWords":[{"type":"string"}],"dividedInto":[{"type":"string"}],"registrationApproved":[{"type":"object","properties":{}}],"active":[{"type":"object","properties":{}}],"website_verified":[{"type":"object","properties":{}}],"shareHolderVerified":[{"type":"boolean"}],"shareHolder":[{"type":"boolean","description":"When `true` , the response echoes the updated `shareHolderDetails` array instead of the trimmed `company` object."}],"socials":[{"type":"object","properties":{},"description":"JSON-encoded. Keys: `website` , `facebook` , `instagram` , `linkedin` , `twitter` , `tiktok` (each a URL). A reachable `website` flips `website_verified` to `true` ."}],"registrarInfo":[{"type":"object","properties":{},"description":"JSON-encoded. Keys: `surname` , `firstname` , `email` , `nationality` , `date_of_birth` ."}],"shareHolderDetails":[{"type":"object","properties":{},"description":"JSON-encoded array. Each shareholder may include `name` , `email` , `address` , `dateOfBirth` , `nationality` , `idType` , `roleInCompany` , `percentageOfOwner` , `noOfShares` , `identificationNumber` , `phoneNumber` , `identificationDocumentUrl` . Supplying this array sets `shareHolderVerified` to `true` ."}],"shareholderIdDocs":[{"type":"array","items":[{"type":"file"}],"description":"Up to 10 PDFs, ≤ 50 MB each. Files are matched to shareholders by position — the first file applies to the first entry in `shareHolderDetails` , the second to the second, and so on. Each uploaded document is verified against the shareholder’s `name` , `identificationNumber` , and `idType` before it is stored; a shareholder with no matching file keeps its existing document. Extra files beyond the shareholder count are ignored."}]}}],"examples":{"example":{"value":{"companyName":"\u003cstring>","rcNumber":"\u003cstring>","email":"\u003cstring>","phone":"\u003cstring>","address":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","postcode":"\u003cstring>","natureOfBusiness":"\u003cstring>","businessCategory":"\u003cstring>","businessDescription":"\u003cstring>","headOfficeAddress":"\u003cstring>","company_classification":"\u003cstring>","firsTin":"\u003cstring>","shareCapital":{},"vouchShareCapital":{},"shareCapitalInWords":"\u003cstring>","dividedInto":"\u003cstring>","registrationApproved":{},"active":{},"website_verified":{},"shareHolderVerified":true,"shareHolder":true,"socials":{},"registrarInfo":{},"shareHolderDetails":{},"shareholderIdDocs":[null]}}}}}},"response":{},"deprecated":false}},"jsLinks":[],"subdomain":"vouchmark","siteName":"Vouchmark","title":"Edit a company - Vouchmark","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-27T23:31:24.056Z","originalFileLocation":"api-reference/companies/edit.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"Update editable fields on an owned company.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Vouchmark\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vouchmark/oiIZI56Q3NT85JaQ/_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/vouchmark/oiIZI56Q3NT85JaQ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vouchmark/oiIZI56Q3NT85JaQ/_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/vouchmark/oiIZI56Q3NT85JaQ/_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/vouchmark/oiIZI56Q3NT85JaQ/_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/vouchmark/oiIZI56Q3NT85JaQ/_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/vouchmark/oiIZI56Q3NT85JaQ/_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/vouchmark/oiIZI56Q3NT85JaQ/_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/vouchmark/oiIZI56Q3NT85JaQ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Edit a company - Vouchmark\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update editable fields on an owned company.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Vouchmark\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.vouchmark.com/api-reference/companies/edit\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vouchmark.mintlify.site/_mintlify/api/og/v2?division=Companies\u0026amp;title=Edit+a+company\u0026amp;description=Update+editable+fields+on+an+owned+company.\u0026amp;theme=537dc3d63a6ec063e2d1a23f\u0026amp;signature=324970d23a9fad9859cb51888865677d1005d3cb990eaa99200b3a99f894aa9d\">\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=\"Edit a company - Vouchmark\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update editable fields on an owned company.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vouchmark.mintlify.site/_mintlify/api/og/v2?division=Companies\u0026amp;title=Edit+a+company\u0026amp;description=Update+editable+fields+on+an+owned+company.\u0026amp;theme=537dc3d63a6ec063e2d1a23f\u0026amp;signature=324970d23a9fad9859cb51888865677d1005d3cb990eaa99200b3a99f894aa9d\">\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/vouchmark/oiIZI56Q3NT85JaQ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Vouchmark\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6466AE\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.vouchmark.com/api-reference/companies/edit\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/companies/edit.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.vouchmark.com/#organization\",\"name\":\"Vouchmark\",\"url\":\"https://docs.vouchmark.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/vouchmark/vyDGY2ihe3oA_T8z/logo/logo.png?fit=max\u0026auto=format\u0026n=vyDGY2ihe3oA_T8z\u0026q=85\u0026s=4b7f5d3a985c0d54dda118e5f3eb7c3c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.vouchmark.com#website\",\"name\":\"Vouchmark\",\"url\":\"https://docs.vouchmark.com\",\"publisher\":{\"@id\":\"https://docs.vouchmark.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.vouchmark.com/api-reference/companies/edit#webpage\",\"url\":\"https://docs.vouchmark.com/api-reference/companies/edit\",\"name\":\"Edit a company\",\"description\":\"Update editable fields on an owned company.\",\"dateModified\":\"2026-06-27T23:31:24.056Z\",\"isPartOf\":{\"@id\":\"https://docs.vouchmark.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.vouchmark.com/api-reference/companies/edit#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.vouchmark.com/api-reference/companies/edit#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Companies\",\"item\":\"https://docs.vouchmark.com/api-reference/companies/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Edit a company\",\"item\":\"https://docs.vouchmark.com/api-reference/companies/edit\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.vouchmark.com/api-reference/companies/edit#apireference\",\"headline\":\"Edit a company\",\"name\":\"Edit a company\",\"description\":\"Update editable fields on an owned company.\",\"url\":\"https://docs.vouchmark.com/api-reference/companies/edit\",\"mainEntityOfPage\":{\"@id\":\"https://docs.vouchmark.com/api-reference/companies/edit#webpage\"},\"dateModified\":\"2026-06-27T23:31:24.056Z\",\"publisher\":{\"@id\":\"https://docs.vouchmark.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.vouchmark.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Vouchmark\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Vouchmark\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/companies/edit.md","siteName":"Vouchmark","nav":{"global":{"anchors":[{"anchor":"Dashboard","icon":"browser","href":"https://vouchmark.com"},{"anchor":"Status","icon":"signal-bars","href":"https://status.vouchmark.com"},{"anchor":"Support","icon":"envelope","href":"mailto:support@vouchmark.com"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/sdks/overview"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API overview","href":"/api-reference/introduction"}]},{"group":"Auth","pages":[{"title":"Sign up","api":"POST /v1/signup","href":"/api-reference/auth/signup"},{"title":"Log in","api":"POST /v1/login","href":"/api-reference/auth/login"},{"title":"Refresh token","api":"POST /v1/refresh-token","href":"/api-reference/auth/refresh-token"},{"title":"Log out","api":"POST /v1/logout","href":"/api-reference/auth/logout"}]},{"group":"Companies","pages":[{"title":"List my companies","api":"GET /v1/dashboard/my-companies","href":"/api-reference/companies/list"},{"title":"Get a company","api":"GET /v1/dashboard/company-details?companyId={companyId}","description":"Read a single owned company.","href":"/api-reference/companies/get"},{"title":"Edit a company","api":"POST /v1/edit-company/{companyId}","href":"/api-reference/companies/edit"},{"title":"Resolve FIRS TIN","api":"POST /v1/check-firstin","description":"Kick off FIRS TIN resolution for a claimed company.","href":"/api-reference/companies/check-firs-tin"}]},{"group":"Verifications","pages":[{"title":"Verify TIN (upload TCC)","api":"POST /v1/verifyTin","href":"/api-reference/verifications/verify-tin"},{"title":"Verify JTB TIN","api":"POST /v1/verifyJtbTin","href":"/api-reference/verifications/verify-jtb-tin"},{"title":"Verify utility bill","api":"POST /v1/verifyBill","href":"/api-reference/verifications/verify-bill"},{"title":"Verify utility bill (image)","api":"POST /v1/verify-utility-bill/image","href":"/api-reference/verifications/verify-bill-image"},{"title":"Verify utility bill (manual)","api":"POST /v1/verify-utility-bill/manual","href":"/api-reference/verifications/verify-bill-manual"},{"title":"Verify CAC documents","api":"POST /v1/verifyCacAndReport","href":"/api-reference/verifications/verify-cac"},{"title":"Verify one CAC document","api":"POST /v1/verifyCacDocument","href":"/api-reference/verifications/verify-cac-document"},{"title":"Get CAC verification status","api":"GET /v1/cacVerificationStatus/{companyId}","href":"/api-reference/verifications/cac-status"},{"title":"Check verification progress","api":"POST /v1/checkVerificationProgress","href":"/api-reference/verifications/check-progress"},{"title":"Physical address verification","api":"POST /v1/physicalAddress","href":"/api-reference/verifications/physical-address"}]},{"group":"Onboarding (KYB)","pages":[{"title":"Module catalog","api":"GET /v1/kyb/modules","href":"/api-reference/onboarding/module-catalog"},{"title":"List widgets","api":"GET /v1/kyb/widgets","href":"/api-reference/onboarding/list-widgets"},{"title":"Create widget","api":"POST /v1/kyb/widgets","href":"/api-reference/onboarding/create-widget"},{"title":"Get widget","api":"GET /v1/kyb/widgets/{id}","href":"/api-reference/onboarding/get-widget"},{"title":"Update widget","api":"PATCH /v1/kyb/widgets/{id}","href":"/api-reference/onboarding/update-widget"},{"title":"Set widget status","api":"PATCH /v1/kyb/widgets/{id}/status","href":"/api-reference/onboarding/set-widget-status"},{"title":"Delete widget","api":"DELETE /v1/kyb/widgets/{id}","href":"/api-reference/onboarding/delete-widget"},{"title":"Widget cost estimate","api":"GET /v1/kyb/widgets/{id}/estimate","href":"/api-reference/onboarding/cost-estimate"},{"title":"List applicants","api":"GET /v1/kyb/applicants","href":"/api-reference/onboarding/list-applicants"},{"title":"Get applicant","api":"GET /v1/kyb/applicants/{applicantId}","href":"/api-reference/onboarding/get-applicant"},{"title":"Create applicant","api":"POST /v1/kyb/widgets/{id}/applicants","href":"/api-reference/onboarding/create-applicant"},{"title":"Run module","api":"POST /v1/kyb/applicants/{applicantId}/modules/{moduleId}/run","href":"/api-reference/onboarding/run-module"},{"title":"Submit applicant","api":"POST /v1/kyb/applicants/{applicantId}/submit","href":"/api-reference/onboarding/submit-applicant"}]},{"group":"Widget Embed (Runtime)","pages":[{"title":"Get embed config","api":"GET /v1/widget/embed/config","href":"/api-reference/onboarding/embed-config"},{"title":"Create embed session","api":"POST /v1/widget/embed/sessions","href":"/api-reference/onboarding/create-session"},{"title":"Resume embed session","api":"GET /v1/widget/embed/sessions/{sessionId}","href":"/api-reference/onboarding/resume-session"},{"title":"Save session answers","api":"PATCH /v1/widget/embed/sessions/{sessionId}/answers","href":"/api-reference/onboarding/save-answers"},{"title":"Upload session attachment","api":"POST /v1/widget/embed/sessions/{sessionId}/uploads","href":"/api-reference/onboarding/upload-attachment"},{"title":"Submit embed session","api":"POST /v1/widget/embed/sessions/{sessionId}/submit","href":"/api-reference/onboarding/submit-session"}]},{"group":"Trust Badge","pages":[{"title":"Verify a badge token","api":"GET /v1/trust-badge/verify","href":"/api-reference/trust-badge/verify"},{"title":"Get my badge","api":"GET /v1/trust-badge/my-badge","href":"/api-reference/trust-badge/my-badge"}]},{"group":"Monitoring","pages":[{"title":"List monitored vendors","api":"GET /v1/monitoring/vendors","href":"/api-reference/monitoring/list-vendors"},{"title":"Get vendor profile","api":"GET /v1/monitoring/vendors/{vendorId}","href":"/api-reference/monitoring/vendor-profile"},{"title":"List vendor events","api":"GET /v1/monitoring/vendors/{vendorId}/events","href":"/api-reference/monitoring/vendor-events"},{"title":"Vendor score history","api":"GET /v1/monitoring/vendors/{vendorId}/score-history","href":"/api-reference/monitoring/score-history"},{"title":"Media mentions","api":"GET /v1/monitoring/media-mentions","href":"/api-reference/monitoring/media-mentions"},{"title":"List alerts","api":"GET /v1/monitoring/alerts","href":"/api-reference/monitoring/alerts"},{"title":"Add to watchlist","api":"POST /v1/monitoring/vendors/watchlist","href":"/api-reference/monitoring/add-to-watchlist"},{"title":"Remove from watchlist","api":"DELETE /v1/monitoring/vendors/watchlist/{vendorId}","href":"/api-reference/monitoring/remove-from-watchlist"},{"title":"Get watchlist capacity","api":"GET /v1/monitoring/watchlist/capacity","href":"/api-reference/monitoring/watchlist-limits"}]},{"group":"Investigations","pages":[{"title":"List investigation reports","api":"GET /v1/investigation/reports","href":"/api-reference/investigations/list-reports"},{"title":"Get investigation report","api":"GET /v1/investigation/reports/{reportId}","href":"/api-reference/investigations/get-report"}]},{"group":"Disputes","pages":[{"title":"List disputes","api":"GET /v1/disputes","href":"/api-reference/disputes/list-disputes"},{"title":"Submit dispute","api":"POST /v1/disputes","href":"/api-reference/disputes/submit-dispute"},{"title":"Get dispute","api":"GET /v1/disputes/{disputeId}","href":"/api-reference/disputes/get-dispute"}]},{"group":"Vouch AI","pages":[{"title":"Start new chat","api":"POST /v1/chat/new","href":"/api-reference/vouch-ai/new-chat"},{"title":"Send message","api":"POST /v1/chat/{chatId}/message","href":"/api-reference/vouch-ai/send-message"},{"title":"Stream message","api":"POST /v1/chat/{chatId}/stream","href":"/api-reference/vouch-ai/stream-message"},{"title":"Chat history","api":"GET /v1/chat/history","href":"/api-reference/vouch-ai/chat-history"},{"title":"Get chat","api":"GET /v1/chat/{chatId}","href":"/api-reference/vouch-ai/get-chat"},{"title":"Rename chat","api":"PATCH /v1/chat/{chatId}/title","href":"/api-reference/vouch-ai/rename-chat"},{"title":"Delete chat","api":"DELETE /v1/chat/{chatId}","href":"/api-reference/vouch-ai/delete-chat"},{"title":"Quick chat","api":"POST /v1/chat/quick","href":"/api-reference/vouch-ai/quick-chat"},{"title":"AI company overview","api":"POST /v1/company/ai-overview","href":"/api-reference/vouch-ai/ai-overview"}]},{"group":"Compliance","pages":[{"title":"List obligations","api":"GET /v1/compliance/obligations","href":"/api-reference/compliance/list-obligations"},{"title":"Upcoming obligations","api":"GET /v1/compliance/obligations/upcoming","href":"/api-reference/compliance/upcoming"},{"title":"Create obligation","api":"POST /v1/compliance/obligations","href":"/api-reference/compliance/create-obligation"},{"title":"Update obligation","api":"PATCH /v1/compliance/obligations/{obligationId}","href":"/api-reference/compliance/update-obligation"},{"title":"Complete obligation","api":"POST /v1/compliance/obligations/{obligationId}/complete","href":"/api-reference/compliance/complete-obligation"},{"title":"Delete obligation","api":"DELETE /v1/compliance/obligations/{obligationId}","href":"/api-reference/compliance/delete-obligation"},{"title":"Seed obligations","api":"POST /v1/compliance/seed","href":"/api-reference/compliance/seed"}]},{"group":"Wallet \u0026 Billing","pages":[{"title":"Get wallet","api":"GET /v1/wallet","href":"/api-reference/wallet/get-wallet"},{"title":"List transactions","api":"GET /v1/wallet/transactions","href":"/api-reference/wallet/transactions"},{"title":"Top up wallet","api":"POST /v1/wallet/topup","href":"/api-reference/wallet/topup"},{"title":"Verify top-up","api":"GET /v1/wallet/topup/verify","href":"/api-reference/wallet/verify-topup"},{"title":"Update auto top-up","api":"PATCH /v1/wallet/auto-top-up","href":"/api-reference/wallet/auto-topup"},{"title":"Update threshold","api":"PATCH /v1/wallet/threshold","href":"/api-reference/wallet/threshold"},{"title":"Pricing rates","api":"GET /v1/wallet/pricing-rates","href":"/api-reference/wallet/pricing-rates"}]},{"group":"Developers","pages":[{"title":"List API keys","api":"GET /v1/developers/api-keys","href":"/api-reference/developers/list-api-keys"},{"title":"Rotate API key","api":"POST /v1/developers/api-keys/rotate","href":"/api-reference/developers/rotate-api-key"},{"title":"List webhooks","api":"GET /v1/developers/webhooks","href":"/api-reference/developers/list-webhooks"},{"title":"Create webhook","api":"POST /v1/developers/webhooks","href":"/api-reference/developers/create-webhook"},{"title":"Rotate webhook secret","api":"POST /v1/developers/webhooks/{id}/rotate-secret","href":"/api-reference/developers/rotate-webhook-secret"},{"title":"Delete webhook","api":"DELETE /v1/developers/webhooks/{id}","href":"/api-reference/developers/delete-webhook"}]}]}]},"basePath":"","title":"Edit a company - Vouchmark","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-B6WFFOBL.js","utils-BN5um1KA.js","cloneDeep-C3md22mN.js","_Uint8Array-DLlL8L26.js","isObject-FP1Yky1u.js","utils-BSmbkXJR.js","addUniqueKeysToSchema-2tqcVnUE.js","snippetPresets-CtWfvr2J.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DkKHBy30.js","isEqual-O3q7y6pq.js","usePlaygroundInputsStore-Brc5H9UJ.js","shallow-C4L4xvbs.js","getApiPlaygroundDisplay-2bxyq_aI.js","CodeSnippet-BJu8ddd5.js","CodeSnippets-dazWmoqB.js","Page-CnLhKuUV.js","getPastedJson-Chy3Qa1S.js","icon-CyO7h3jh.js","MethodPill-Dle0_91v.js","DuplicateIcon-CVvWAf4a.js","createIcon-Di07A27B.js","DynamicMarkdown-C4w9kavL.js","SectionHeading-XiBebVYC.js","axios-vUo_bRtp.js"]}