---
title: "Update an Entity"
method: PATCH
path: "/entities/{entity_id}"
---

# Update an Entity

`PATCH /entities/{entity_id}`

## Path parameters

- `entity_id` string, required — The entity identifier.

## Request body

- UpdateAnEntityParameters
  - `corporation` object — Details of the corporation entity to update. If you specify this parameter and the entity is not a corporation, the request will fail.
    - `address` object — The entity's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed.
      - `city` string, required — The city, district, town, or village of the address.
      - `country` string, required — The two-letter ISO 3166-1 alpha-2 code for the country of the address.
      - `line1` string, required — The first line of the address. This is usually the street number and street.
      - `line2` string — The second line of the address. This might be the floor or room number.
      - `state` string — The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. Required in certain countries.
      - `zip` string — The ZIP or postal code of the address. Required in certain countries.
    - `email` string, email — An email address for the business. Not every program requires an email for submitted Entities.
    - `incorporation_state` string — The two-letter United States Postal Service (USPS) abbreviation for the corporation's state of incorporation.
    - `industry_code` string — The North American Industry Classification System (NAICS) code for the corporation's primary line of business. This is a number, like `5132` for `Software Publishers`. A full list of classification codes is available [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
    - `legal_identifier` object — The legal identifier of the corporation. This is usually the Employer Identification Number (EIN).
      - `category` 'us_employer_identification_number' | 'other' — The category of the legal identifier.
      - `value` string, required — The legal identifier itself. For US Employer Identification Numbers, submit nine digits with no dashes or other separators.
    - `name` string — The legal name of the corporation.
    - `website` string — A website for the business. Not every program requires a website for submitted Entities.
  - `details_confirmed_at` string, date-time — When your user last confirmed the Entity's details. Depending on your program, you may be required to affirmatively confirm details with your users on an annual basis.
  - `government_authority` object — Details of the government authority entity to update. If you specify this parameter and the entity is not a government authority, the request will fail.
    - `address` object — The entity's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed.
      - `city` string, required — The city of the address.
      - `line1` string, required — The first line of the address. This is usually the street number and street.
      - `line2` string — The second line of the address. This might be the floor or room number.
      - `state` string, required — The two-letter United States Postal Service (USPS) abbreviation for the state of the address.
      - `zip` string, required — The ZIP code of the address.
    - `name` string — The legal name of the government authority.
  - `natural_person` object — Details of the natural person entity to update. If you specify this parameter and the entity is not a natural person, the request will fail.
    - `address` object — The entity's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed.
      - `city` string, required — The city, district, town, or village of the address.
      - `country` string, required — The two-letter ISO 3166-1 alpha-2 code for the country of the address.
      - `line1` string, required — The first line of the address. This is usually the street number and street.
      - `line2` string — The second line of the address. This might be the floor or room number.
      - `state` string — The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. Required in certain countries.
      - `zip` string — The ZIP or postal code of the address. Required in certain countries.
    - `confirmed_no_us_tax_id` boolean — The identification method for an individual can only be a passport, driver's license, or other document if you've confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number).
    - `identification` object — A means of verifying the person's identity.
      - `drivers_license` object — Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`.
        - `back_file_id` string — The identifier of the File containing the back of the driver's license.
        - `expiration_date` string, date, required — The driver's license's expiration date in YYYY-MM-DD format.
        - `file_id` string, required — The identifier of the File containing the front of the driver's license.
        - `state` string, required — The state that issued the provided driver's license.
      - `method` 'social_security_number' | 'individual_taxpayer_identification_number' | 'passport' | 'drivers_license' | 'other', required — A method that can be used to verify the individual's identity.
      - `number` string, required — An identification number that can be used to verify the individual's identity, such as a social security number. For Social Security Numbers and Individual Taxpayer Identification Numbers, submit nine digits with no dashes or other separators. When testing in sandbox, use one of our [sandbox test values](https://increase.com/documentation/sandbox-test-values).
      - `other` object — Information about the identification document provided. Required if `method` is equal to `other`.
        - `back_file_id` string — The identifier of the File containing the back of the document. Not every document has a reverse side.
        - `country` string, required — The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`).
        - `description` string, required — A description of the document submitted.
        - `expiration_date` string, date — The document's expiration date in YYYY-MM-DD format.
        - `file_id` string, required — The identifier of the File containing the front of the document.
      - `passport` object — Information about the passport used for identification. Required if `method` is equal to `passport`.
        - `country` string, required — The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`).
        - `expiration_date` string, date, required — The passport's expiration date in YYYY-MM-DD format.
        - `file_id` string, required — The identifier of the File containing the passport.
    - `name` string — The legal name of the natural person.
  - `risk_rating` object — An assessment of the entity’s potential risk of involvement in financial crimes, such as money laundering.
    - `rated_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk rating was performed.
    - `rating` 'low' | 'medium' | 'high', required — The rating given to this entity.
  - `terms_agreements` object[] — New terms that the Entity agreed to. Not all programs are required to submit this data. This will not archive previously submitted terms.
    - `agreed_at` string, date-time, required — The timestamp of when the Entity agreed to the terms.
    - `ip_address` string, required — The IP address the Entity accessed reviewed the terms from.
    - `terms_url` string, required — The URL of the terms agreement. This link will be provided by your bank partner.
  - `third_party_verification` object — If you are using a third-party service for identity verification, you can use this field to associate this Entity with the identifier that represents them in that service.
    - `reference` string, required — The reference identifier for the third party verification.
    - `vendor` 'alloy' | 'middesk' | 'oscilar' | 'persona' | 'taktile', required — The vendor that was used to perform the verification.
  - `trust` object — Details of the trust entity to update. If you specify this parameter and the entity is not a trust, the request will fail.
    - `address` object — The entity's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed.
      - `city` string, required — The city of the address.
      - `line1` string, required — The first line of the address. This is usually the street number and street.
      - `line2` string — The second line of the address. This might be the floor or room number.
      - `state` string, required — The two-letter United States Postal Service (USPS) abbreviation for the state of the address.
      - `zip` string, required — The ZIP code of the address.
    - `name` string — The legal name of the trust.
    - `trustees` object[] — The trustees of the trust. If you specify this parameter, the trust's existing trustees will be archived and replaced with the trustees you provide.
      - `individual` object — Details of the individual trustee. Within the trustee object, this is required if `structure` is equal to `individual`.
        - `address` object, required — The individual's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed.
          - `city` string, required — The city, district, town, or village of the address.
          - `country` string, required — The two-letter ISO 3166-1 alpha-2 code for the country of the address.
          - `line1` string, required — The first line of the address. This is usually the street number and street.
          - `line2` string — The second line of the address. This might be the floor or room number.
          - `state` string — The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. Required in certain countries.
          - `zip` string — The ZIP or postal code of the address. Required in certain countries.
        - `confirmed_no_us_tax_id` boolean — The identification method for an individual can only be a passport, driver's license, or other document if you've confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number).
        - `date_of_birth` string, date, required — The person's date of birth in YYYY-MM-DD format.
        - `identification` object, required — A means of verifying the person's identity.
          - `drivers_license` object — Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`.
            - `back_file_id` string — The identifier of the File containing the back of the driver's license.
            - `expiration_date` string, date, required — The driver's license's expiration date in YYYY-MM-DD format.
            - `file_id` string, required — The identifier of the File containing the front of the driver's license.
            - `state` string, required — The state that issued the provided driver's license.
          - `method` 'social_security_number' | 'individual_taxpayer_identification_number' | 'passport' | 'drivers_license' | 'other', required — A method that can be used to verify the individual's identity.
          - `number` string, required — An identification number that can be used to verify the individual's identity, such as a social security number. For Social Security Numbers and Individual Taxpayer Identification Numbers, submit nine digits with no dashes or other separators. When testing in sandbox, use one of our [sandbox test values](https://increase.com/documentation/sandbox-test-values).
          - `other` object — Information about the identification document provided. Required if `method` is equal to `other`.
            - `back_file_id` string — The identifier of the File containing the back of the document. Not every document has a reverse side.
            - `country` string, required — The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`).
            - `description` string, required — A description of the document submitted.
            - `expiration_date` string, date — The document's expiration date in YYYY-MM-DD format.
            - `file_id` string, required — The identifier of the File containing the front of the document.
          - `passport` object — Information about the passport used for identification. Required if `method` is equal to `passport`.
            - `country` string, required — The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`).
            - `expiration_date` string, date, required — The passport's expiration date in YYYY-MM-DD format.
            - `file_id` string, required — The identifier of the File containing the passport.
        - `name` string, required — The person's legal name.
      - `structure` 'individual', required — The structure of the trustee.

## Response `200`

Entity

- Entity — Entities are the legal entities that own accounts. They can be people, corporations, joint accounts, trusts, or government authorities. To learn more, see [Entities](/documentation/entities).
  - `corporation` object, nullable, required — Details of the corporation entity. Will be present if `structure` is equal to `corporation`.
    - `address` object, required — The corporation's address.
      - `city` string, nullable, required — The city, district, town, or village of the address.
      - `country` string, required — The two-letter ISO 3166-1 alpha-2 code for the country of the address.
      - `line1` string, required — The first line of the address.
      - `line2` string, nullable, required — The second line of the address.
      - `state` string, nullable, required — The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address.
      - `zip` string, nullable, required — The ZIP or postal code of the address.
    - `beneficial_owners` object[], required — The identifying details of anyone controlling or owning 25% or more of the corporation.
      - `company_title` string, nullable, required — This person's role or title within the entity.
      - `id` string, required — The identifier of this beneficial owner.
      - `individual` object, required — Personal details for the beneficial owner.
        - `address` object, required — The person's address.
          - `city` string, nullable, required — The city, district, town, or village of the address.
          - `country` string, required — The two-letter ISO 3166-1 alpha-2 code for the country of the address.
          - `line1` string, required — The first line of the address.
          - `line2` string, nullable, required — The second line of the address.
          - `state` string, nullable, required — The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address.
          - `zip` string, nullable, required — The ZIP or postal code of the address.
        - `date_of_birth` string, date, required — The person's date of birth in YYYY-MM-DD format.
        - `identification` object, nullable, required — A means of verifying the person's identity.
          - `method` 'social_security_number' | 'individual_taxpayer_identification_number' | 'passport' | 'drivers_license' | 'other', required — A method that can be used to verify the individual's identity.
          - `number_last4` string, required — The last 4 digits of the identification number that can be used to verify the individual's identity.
        - `name` string, required — The person's legal name.
      - `prongs` string[], required — Why this person is considered a beneficial owner of the entity.
    - `beneficial_ownership_exemption_reason` 'regulated_financial_institution' | 'publicly_traded_company' | 'public_entity' | 'other', nullable, required — If the entity is exempt from the requirement to submit beneficial owners, the justification for the exemption.
    - `email` string, nullable, required — An email address for the business.
    - `incorporation_state` string, nullable, required — The two-letter United States Postal Service (USPS) abbreviation for the corporation's state of incorporation.
    - `industry_code` string, nullable, required — The numeric North American Industry Classification System (NAICS) code submitted for the corporation.
    - `legal_identifier` object, nullable, required — The legal identifier of the corporation, like an Employer Identification Number (EIN).
      - `category` 'us_employer_identification_number' | 'other', required — The category of the legal identifier.
      - `value` string, required — The legal identifier itself.
    - `name` string, required — The legal name of the corporation.
    - `website` string, nullable, required — The website of the corporation.
  - `created_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Entity was created.
  - `creating_entity_onboarding_session_id` string, nullable, required — The identifier of the Entity Onboarding Session that was used to create this Entity, if any.
  - `description` string, nullable, required — The entity's description for display purposes.
  - `details_confirmed_at` string, date-time, nullable, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Entity's details were most recently confirmed.
  - `government_authority` object, nullable, required — Details of the government authority entity. Will be present if `structure` is equal to `government_authority`.
    - `address` object, required — The government authority's address.
      - `city` string, nullable, required — The city, district, town, or village of the address.
      - `country` string, required — The two-letter ISO 3166-1 alpha-2 code for the country of the address.
      - `line1` string, required — The first line of the address.
      - `line2` string, nullable, required — The second line of the address.
      - `state` string, nullable, required — The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address.
      - `zip` string, nullable, required — The ZIP or postal code of the address.
    - `authorized_persons` object[], required — The identifying details of authorized persons of the government authority.
      - `authorized_person_id` string, required — The identifier of this authorized person.
      - `name` string, required — The person's legal name.
    - `category` 'municipality' | 'state_agency' | 'state_government' | 'federal_agency', required — The category of the government authority.
    - `name` string, required — The government authority's name.
    - `tax_identifier` string, nullable, required — The Employer Identification Number (EIN) of the government authority.
    - `website` string, nullable, required — The government authority's website.
  - `id` string, required — The entity's identifier.
  - `idempotency_key` string, nullable, required — The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).
  - `joint` object, nullable, required — Details of the joint entity. Will be present if `structure` is equal to `joint`.
    - `individuals` object[], required — The two individuals that share control of the entity.
      - `address` object, required — The person's address.
        - `city` string, nullable, required — The city, district, town, or village of the address.
        - `country` string, required — The two-letter ISO 3166-1 alpha-2 code for the country of the address.
        - `line1` string, required — The first line of the address.
        - `line2` string, nullable, required — The second line of the address.
        - `state` string, nullable, required — The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address.
        - `zip` string, nullable, required — The ZIP or postal code of the address.
      - `date_of_birth` string, date, required — The person's date of birth in YYYY-MM-DD format.
      - `identification` object, nullable, required — A means of verifying the person's identity.
        - `method` 'social_security_number' | 'individual_taxpayer_identification_number' | 'passport' | 'drivers_license' | 'other', required — A method that can be used to verify the individual's identity.
        - `number_last4` string, required — The last 4 digits of the identification number that can be used to verify the individual's identity.
      - `name` string, required — The person's legal name.
    - `name` string, required — The entity's name.
  - `natural_person` object, nullable, required — Details of the natural person entity. Will be present if `structure` is equal to `natural_person`.
    - `address` object, required — The person's address.
      - `city` string, nullable, required — The city, district, town, or village of the address.
      - `country` string, required — The two-letter ISO 3166-1 alpha-2 code for the country of the address.
      - `line1` string, required — The first line of the address.
      - `line2` string, nullable, required — The second line of the address.
      - `state` string, nullable, required — The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address.
      - `zip` string, nullable, required — The ZIP or postal code of the address.
    - `date_of_birth` string, date, required — The person's date of birth in YYYY-MM-DD format.
    - `identification` object, nullable, required — A means of verifying the person's identity.
      - `method` 'social_security_number' | 'individual_taxpayer_identification_number' | 'passport' | 'drivers_license' | 'other', required — A method that can be used to verify the individual's identity.
      - `number_last4` string, required — The last 4 digits of the identification number that can be used to verify the individual's identity.
    - `name` string, required — The person's legal name.
  - `risk_rating` object, nullable, required — An assessment of the entity’s potential risk of involvement in financial crimes, such as money laundering.
    - `rated_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk rating was performed.
    - `rating` 'low' | 'medium' | 'high', required — The rating given to this entity.
  - `status` 'active' | 'archived' | 'disabled', required — The status of the entity.
  - `structure` 'corporation' | 'natural_person' | 'joint' | 'trust' | 'government_authority', required — The entity's legal structure.
  - `supplemental_documents` EntitySupplementalDocument[], required — Additional documentation associated with the entity. This is limited to the first 10 documents for an entity. If an entity has more than 10 documents, use the GET /entity_supplemental_documents list endpoint to retrieve them.
    - `created_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Supplemental Document was created.
    - `entity_id` string, required — The Entity the supplemental document is attached to.
    - `file_id` string, required — The File containing the document.
    - `idempotency_key` string, nullable, required — The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).
    - `type` 'entity_supplemental_document', required — A constant representing the object's type. For this resource it will always be `entity_supplemental_document`.
  - `terms_agreements` object[], required — The terms that the Entity agreed to. Not all programs are required to submit this data.
    - `agreed_at` string, date-time, required — The timestamp of when the Entity agreed to the terms.
    - `ip_address` string, nullable, required — The IP address the Entity accessed reviewed the terms from.
    - `terms_url` string, required — The URL of the terms agreement. This link will be provided by your bank partner.
  - `third_party_verification` object, nullable, required — If you are using a third-party service for identity verification, you can use this field to associate this Entity with the identifier that represents them in that service.
    - `reference` string, required — The reference identifier for the third party verification.
    - `vendor` 'alloy' | 'middesk' | 'oscilar' | 'persona' | 'taktile', required — The vendor that was used to perform the verification.
  - `trust` object, nullable, required — Details of the trust entity. Will be present if `structure` is equal to `trust`.
    - `address` object, required — The trust's address.
      - `city` string, nullable, required — The city, district, town, or village of the address.
      - `country` string, required — The two-letter ISO 3166-1 alpha-2 code for the country of the address.
      - `line1` string, required — The first line of the address.
      - `line2` string, nullable, required — The second line of the address.
      - `state` string, nullable, required — The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address.
      - `zip` string, nullable, required — The ZIP or postal code of the address.
    - `category` 'revocable' | 'irrevocable', required — Whether the trust is `revocable` or `irrevocable`.
    - `formation_document_file_id` string, nullable, required — The ID for the File containing the formation document of the trust.
    - `formation_state` string, nullable, required — The two-letter United States Postal Service (USPS) abbreviation for the state in which the trust was formed.
    - `grantor` object, nullable, required — The grantor of the trust. Will be present if the `category` is `revocable`.
      - `address` object, nullable, required — The grantor's address.
        - `city` string, nullable, required — The city, district, town, or village of the address.
        - `country` string, required — The two-letter ISO 3166-1 alpha-2 code for the country of the address.
        - `line1` string, required — The first line of the address.
        - `line2` string, nullable, required — The second line of the address.
        - `state` string, nullable, required — The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address.
        - `zip` string, nullable, required — The ZIP or postal code of the address.
      - `date_of_birth` string, date, nullable, required — The grantor's date of birth in YYYY-MM-DD format.
      - `identification` object, nullable, required — A means of verifying the grantor's identity.
        - `method` 'social_security_number' | 'individual_taxpayer_identification_number' | 'passport' | 'drivers_license' | 'other', required — A method that can be used to verify the grantor's identity.
        - `number_last4` string, required — The last 4 digits of the identification number that can be used to verify the grantor's identity.
      - `name` string, required — The grantor's legal name.
    - `name` string, required — The trust's name.
    - `tax_identifier` string, nullable, required — The Employer Identification Number (EIN) of the trust itself.
    - `trustees` object[], required — The trustees of the trust.
      - `individual` object, nullable, required — The individual trustee of the trust. Will be present if the trustee's `structure` is equal to `individual`.
        - `address` object, required — The person's address.
          - `city` string, nullable, required — The city, district, town, or village of the address.
          - `country` string, required — The two-letter ISO 3166-1 alpha-2 code for the country of the address.
          - `line1` string, required — The first line of the address.
          - `line2` string, nullable, required — The second line of the address.
          - `state` string, nullable, required — The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address.
          - `zip` string, nullable, required — The ZIP or postal code of the address.
        - `date_of_birth` string, date, required — The person's date of birth in YYYY-MM-DD format.
        - `identification` object, nullable, required — A means of verifying the person's identity.
          - `method` 'social_security_number' | 'individual_taxpayer_identification_number' | 'passport' | 'drivers_license' | 'other', required — A method that can be used to verify the individual's identity.
          - `number_last4` string, required — The last 4 digits of the identification number that can be used to verify the individual's identity.
        - `name` string, required — The person's legal name.
      - `structure` 'individual', required — The structure of the trustee. Will always be equal to `individual`.
  - `type` 'entity', required — A constant representing the object's type. For this resource it will always be `entity`.
  - `validation` object, nullable, required — The validation results for the entity. Learn more about [validations](/documentation/entity-validation).
    - `issues` object[], required — The list of issues that need to be addressed.
      - `beneficial_owner_address` object, nullable, required — Details when the issue is with a beneficial owner's address.
        - `beneficial_owner_id` string, required — The ID of the beneficial owner.
        - `reason` 'mailbox_address', required — The reason the address is invalid.
      - `beneficial_owner_identity` object, nullable, required — Details when the issue is with a beneficial owner's identity verification.
        - `beneficial_owner_id` string, required — The ID of the beneficial owner.
      - `category` 'entity_tax_identifier' | 'entity_address' | 'entity_identity' | 'beneficial_owner_identity' | 'beneficial_owner_address', required — The type of issue. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
      - `entity_address` object, nullable, required — Details when the issue is with the entity's address.
        - `reason` 'mailbox_address', required — The reason the address is invalid.
      - `entity_identity` object, nullable, required — Details when the issue is with the entity's identity verification.
      - `entity_tax_identifier` object, nullable, required — Details when the issue is with the entity's tax ID.
    - `status` 'pending' | 'valid' | 'invalid', required — The validation status for the entity. If the status is `invalid`, the `issues` array will be populated.

## Other responses

- `4XX` — Error
- `5XX` — Error

---

[API](https://skmtc.net/increase/apis/increase-api-2.md) · [All operations](https://skmtc.net/increase/apis/increase-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/increase/increase-api-2/versions/c6111f49e8b7/schema)