--- title: "Update Entity" method: PATCH path: "/entities/{entityId}" tags: ["Entities"] --- # Update Entity `PATCH /entities/{entityId}` Updates a Entity. ## Path parameters - `entityId` string, required ## Request body - UpdateEntityRequestModel — Request body for a partial update (PATCH) of an entity. All fields are optional — include only the top-level fields you want to change, and each is applied independently of the others. When a top-level object (for example `attributes` or `contact`) is provided, its own required sub-fields still apply. - `ibID` string — The unique identifier of the firm. - `type` 'CORPORATION' | 'LLC' | 'TRUST' | 'PARTNERSHIP' — The type of the entity. - `subType` 'S_CORPORATION' | 'C_CORPORATION' | 'LLC_SINGLE_MEMBER' | 'LLC_C_CORPORATION' | 'LLC_S_CORPORATION' | 'LLC_PARTNERSHIP' | 'PARTNERSHIP_GENERAL' | 'PARTNERSHIP_LIMITED' | 'SMSF' — The subtype of the entity. Required for 'CORPORATION', 'LLC', and 'PARTNERSHIP'; optional for 'TRUST'. Valid values by type — CORPORATION: S_CORPORATION, C_CORPORATION; LLC: LLC_SINGLE_MEMBER, LLC_C_CORPORATION, LLC_S_CORPORATION, LLC_PARTNERSHIP; PARTNERSHIP: PARTNERSHIP_GENERAL, PARTNERSHIP_LIMITED; TRUST: SMSF. - `attributes` EntitiesAttributesRequestModel - `name` string, required — The name of the entity. - `dba` string — The doing business as (DBA) name of the entity. - `incorporationCountry` string, required — The country of incorporation. - `incorporationProvince` string — The province or state of incorporation. - `incorporationDate` string, date — The date of incorporation. - `identifications` Identifications - `ein` string — The Employer Identification Number of the entity. - `ftin` string — The Foreign Tax Identification Number of the entity. - `giin` string — The Global Intermediary Identification Number of the entity. - `ftnlo` boolean — indicates if FTIN is not legally required for the entity. - `ssn` string — Social Security Number of the grantor for trust entity (must be exactly 9 digits with no hyphens). - `contact` AddressRequestModel - `addresses` object, required — A map of address type to address details. - `phone` string, required — The phone number associated with the entity in E.164 format. - `email` string, required — The email address associated with the entity. - `website` string — The website associated with the entity. - `metadata` object — Additional metadata for the entity. - `kyb` EntityKybInputModel - `status` 'KYB_APPROVED' | 'KYB_DENIED' — The KYB status of the entity. - `statusWhen` string — The date and time when the KYB was done. - `verificationKey` string — The verification key provided by the KYB vendor. - `disclosures` EntityDisclosuresModel - `termsOfUse` DisclosureRequestModel - `agreed` boolean — Indicates if the disclosure has been agreed to. - `signedBy` string — The name of the person who signed the disclosure. - `signedWhen` string — The date and time when the disclosure was signed. - `customerAgreement` DisclosureRequestModel - `agreed` boolean — Indicates if the disclosure has been agreed to. - `signedBy` string — The name of the person who signed the disclosure. - `signedWhen` string — The date and time when the disclosure was signed. - `rule14b` DisclosureRequestModel - `agreed` boolean — Indicates if the disclosure has been agreed to. - `signedBy` string — The name of the person who signed the disclosure. - `signedWhen` string — The date and time when the disclosure was signed. - `extendedHoursAgreement` DisclosureRequestModel - `agreed` boolean — Indicates if the disclosure has been agreed to. - `signedBy` string — The name of the person who signed the disclosure. - `signedWhen` string — The date and time when the disclosure was signed. - `marginAgreement` DisclosureRequestModel - `agreed` boolean — Indicates if the disclosure has been agreed to. - `signedBy` string — The name of the person who signed the disclosure. - `signedWhen` string — The date and time when the disclosure was signed. - `fpslAgreement` DisclosureRequestModel - `agreed` boolean — Indicates if the disclosure has been agreed to. - `signedBy` string — The name of the person who signed the disclosure. - `signedWhen` string — The date and time when the disclosure was signed. - `privacyPolicy` DisclosureRequestModel - `agreed` boolean — Indicates if the disclosure has been agreed to. - `signedBy` string — The name of the person who signed the disclosure. - `signedWhen` string — The date and time when the disclosure was signed. - `investorProfile` EntityInvestorProfile - `annualRevenue` number — The annual revenue of the entity in USD. - `netWorthTotal` number — The total net worth of the entity in USD. - `investmentObjective` 'CAPITAL_PRESERVATION' | 'INCOME' | 'GROWTH' | 'SPECULATION' — The investment objective of the entity. - `riskTolerance` 'LOW' | 'MODERATE' | 'HIGH' | 'SPECULATION' — The risk tolerance of the entity. - `liquidityNeeds` 'IMMEDIATE' | 'SHORT_TERM' | 'MODERATE_TERM' | 'LONG_TERM' — The degree to which the entity requires the ability to quickly and easily convert investments into cash without significant loss of value, penalties, or costs. - `investmentExperience` 'NONE' | 'YRS_1_2' | 'YRS_3_5' | 'YRS_5_10' | 'YRS_10_' — The investment experience in years. - `timeHorizon` 'SHORT_TERM' | 'MEDIUM_TERM' | 'LONG_TERM' — Expected investment duration - `equities` object — Equity investment profile - `monthlyTransactionAmount` 'UNDER_$1K' | '$1K_TO_$10K' | '$10K_TO_$50K' | '$50K_TO_$250K' | '$250K_TO_$1M' | 'OVER_$1M' — Anticipated monthly transaction volumes in dollar amount per instrument. - `investmentExperience` 'NONE' | 'YRS_1_2' | 'YRS_3_5' | 'YRS_5_10' | 'YRS_10_' — The investment experience in years. - `fixedIncome` object - `monthlyTransactionAmount` 'UNDER_$1K' | '$1K_TO_$10K' | '$10K_TO_$50K' | '$50K_TO_$250K' | '$250K_TO_$1M' | 'OVER_$1M' — Anticipated monthly transaction volumes in dollar amount per instrument. - `investmentExperience` 'NONE' | 'YRS_1_2' | 'YRS_3_5' | 'YRS_5_10' | 'YRS_10_' — The investment experience in years. - `financialAffiliations` string[] — List of financial affiliations. - `industryClassification` object — Industry classification details. - `NAICS` object - `code` integer — The NAICS code representing the industry classification. - `Other` object - `code` string — The industry classification code that is not part of NAICS. ## Response `200` Updating a Entity was Successful. - EntityResponseModel — Entity representation returned by the API. Note the key casing differs from the request body: `identifications` keys are returned uppercase (EIN, FTIN, GIIN, FTNLO, SSN) and address types are returned uppercase (PRIMARY), whereas requests use lowercase (ein, ftin, ..., primary). - `id` string — The unique identifier of the entity. - `ibID` string — The unique identifier of the firm. - `wlpID` string — The WLP identifier of the entity. - `type` 'CORPORATION' | 'LLC' | 'TRUST' | 'PARTNERSHIP' — The type of the entity. - `subType` 'S_CORPORATION' | 'C_CORPORATION' | 'LLC_SINGLE_MEMBER' | 'LLC_C_CORPORATION' | 'LLC_S_CORPORATION' | 'LLC_PARTNERSHIP' | 'PARTNERSHIP_GENERAL' | 'PARTNERSHIP_LIMITED' | 'SMSF' — The subtype of the entity. - `attributes` EntitiesAttributesRequestModel - `name` string, required — The name of the entity. - `dba` string — The doing business as (DBA) name of the entity. - `incorporationCountry` string, required — The country of incorporation. - `incorporationProvince` string — The province or state of incorporation. - `incorporationDate` string, date — The date of incorporation. - `identifications` IdentificationsResponse — Entity identification numbers as returned in responses. Keys are uppercase, unlike the lowercase keys used in requests. - `EIN` string — The Employer Identification Number of the entity. - `FTIN` string — The Foreign Tax Identification Number of the entity. - `GIIN` string — The Global Intermediary Identification Number of the entity. - `FTNLO` boolean — indicates if FTIN is not legally required for the entity. - `SSN` string — Social Security Number of the grantor for trust entity (must be exactly 9 digits with no hyphens). - `contact` AddressResponseModel — Contact details as returned in responses. Address types are keyed uppercase (e.g. PRIMARY), unlike the lowercase keys used in requests. - `addresses` object, required — A map of address type to address details. Keys are returned uppercase (e.g. PRIMARY). - `phone` string, required — The phone number associated with the entity in E.164 format. - `email` string, required — The email address associated with the entity. - `website` string — The website associated with the entity. - `metadata` object — Additional metadata for the entity. - `disclosures` EntityDisclosuresModel - `termsOfUse` DisclosureRequestModel - `agreed` boolean — Indicates if the disclosure has been agreed to. - `signedBy` string — The name of the person who signed the disclosure. - `signedWhen` string — The date and time when the disclosure was signed. - `customerAgreement` DisclosureRequestModel - `agreed` boolean — Indicates if the disclosure has been agreed to. - `signedBy` string — The name of the person who signed the disclosure. - `signedWhen` string — The date and time when the disclosure was signed. - `rule14b` DisclosureRequestModel - `agreed` boolean — Indicates if the disclosure has been agreed to. - `signedBy` string — The name of the person who signed the disclosure. - `signedWhen` string — The date and time when the disclosure was signed. - `extendedHoursAgreement` DisclosureRequestModel - `agreed` boolean — Indicates if the disclosure has been agreed to. - `signedBy` string — The name of the person who signed the disclosure. - `signedWhen` string — The date and time when the disclosure was signed. - `marginAgreement` DisclosureRequestModel - `agreed` boolean — Indicates if the disclosure has been agreed to. - `signedBy` string — The name of the person who signed the disclosure. - `signedWhen` string — The date and time when the disclosure was signed. - `fpslAgreement` DisclosureRequestModel - `agreed` boolean — Indicates if the disclosure has been agreed to. - `signedBy` string — The name of the person who signed the disclosure. - `signedWhen` string — The date and time when the disclosure was signed. - `privacyPolicy` DisclosureRequestModel - `agreed` boolean — Indicates if the disclosure has been agreed to. - `signedBy` string — The name of the person who signed the disclosure. - `signedWhen` string — The date and time when the disclosure was signed. - `financialAffiliations` string[] — List of financial affiliations. - `industryClassification` object — Industry classification details. - `NAICS` object - `code` integer — The NAICS code representing the industry classification. - `Other` object - `code` string — The industry classification code that is not part of NAICS. - `directors` EntityDirectorsResponseModel[] — A list of directors of the entity. - `id` string — The ID of the director - `roles` DirectorRoleType[] — List of director roles - `title` string — Title of the director - `firstName` string — First name of the director - `lastName` string — Last name of the director - `percentage` number — The percentage of ownership the director has in the institution. Value must be greater than 0 and up to 1 (representing 0-100%), with a maximum of 2 decimal places. - `controlContact` boolean — Indicates if the director is a control contact. - `kycStatus` 'KYC_NOT_READY' | 'KYC_READY' | 'KYC_PROCESSING' | 'KYC_INFO_REQUIRED' | 'KYC_DOC_REQUIRED' | 'KYC_MANUAL_REVIEW' | 'KYC_DENIED' | 'KYC_APPROVED' — The status of the KYC process. - `taxData` TaxData - `fatcaData` FATCAData - `applicable` boolean — Indicates if FATCA data is applicable. - `applicableFrom` string — The date and time when FATCA data became applicable. - `setBy` string — The source that set the FATCA data. - `vendor` object — A map of vendor name to vendor information. - `data` object — A map of tax status code to tax information. - `investorProfile` EntityInvestorProfile - `annualRevenue` number — The annual revenue of the entity in USD. - `netWorthTotal` number — The total net worth of the entity in USD. - `investmentObjective` 'CAPITAL_PRESERVATION' | 'INCOME' | 'GROWTH' | 'SPECULATION' — The investment objective of the entity. - `riskTolerance` 'LOW' | 'MODERATE' | 'HIGH' | 'SPECULATION' — The risk tolerance of the entity. - `liquidityNeeds` 'IMMEDIATE' | 'SHORT_TERM' | 'MODERATE_TERM' | 'LONG_TERM' — The degree to which the entity requires the ability to quickly and easily convert investments into cash without significant loss of value, penalties, or costs. - `investmentExperience` 'NONE' | 'YRS_1_2' | 'YRS_3_5' | 'YRS_5_10' | 'YRS_10_' — The investment experience in years. - `timeHorizon` 'SHORT_TERM' | 'MEDIUM_TERM' | 'LONG_TERM' — Expected investment duration - `equities` object — Equity investment profile - `monthlyTransactionAmount` 'UNDER_$1K' | '$1K_TO_$10K' | '$10K_TO_$50K' | '$50K_TO_$250K' | '$250K_TO_$1M' | 'OVER_$1M' — Anticipated monthly transaction volumes in dollar amount per instrument. - `investmentExperience` 'NONE' | 'YRS_1_2' | 'YRS_3_5' | 'YRS_5_10' | 'YRS_10_' — The investment experience in years. - `fixedIncome` object - `monthlyTransactionAmount` 'UNDER_$1K' | '$1K_TO_$10K' | '$10K_TO_$50K' | '$50K_TO_$250K' | '$250K_TO_$1M' | 'OVER_$1M' — Anticipated monthly transaction volumes in dollar amount per instrument. - `investmentExperience` 'NONE' | 'YRS_1_2' | 'YRS_3_5' | 'YRS_5_10' | 'YRS_10_' — The investment experience in years. - `kyb` EntityKybResponseModel - `status` string — The KYB status of the entity. - `statusWhen` string — The date and time when the KYB was done. - `verificationKey` string — The verification key provided by the KYB vendor. - `statusBy` string — The UUID of who set the KYB status. - `reasons` object[] — A list of reasons associated with the KYB status. - `code` string — The reason code for the KYB status. - `description` string — A descriptive message about the reason. - `tax` object - `status` string — The tax status of the entity. - `message` string — A message providing additional information about the tax status. - `status` 'PENDING' | 'APPROVED' | 'REJECTED' | 'REVOKED' | 'CLOSED' — The status of the business entity. - `createdAt` string — The date and time when the entity was created. - `updatedAt` string — The date and time when the entity was last updated. - `createdBy` string — The user who created the entity. - `updatedBy` string — The user who last updated the entity. ## Other responses - `400` — Bad Request - Invalid input. - `401` — Unauthorized - Authentication failed. - `403` — Forbidden - You do not have permission to access this resource. - `404` — Not Found - The requested resource was not found. - `500` — Internal Server Error - An unexpected error occurred. --- [API](https://skmtc.net/drivewealth/apis/authentication-apis.md) · [All operations](https://skmtc.net/drivewealth/apis/authentication-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/drivewealth/authentication-apis/revisions/9fced6d0ac41/schema)