increase-test
PATCH/entities/{entity_id}

Update an entity

Updates details for an existing legal entity without replacing fields you omit. Supply only the entity details to change, and include a details object that matches the entity's existing legal structure.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 9 body fields
entity_idstringrequired
The identifier of the entity to update.

Entity fields to update. Supply only the fields to change; any structure-specific details object must match the entity's existing legal structure.

corporationobjectoptional
Details of the corporation entity to update. If you specify this parameter and the entity is not a corporation, the request will fail.
details_confirmed_atstringoptional
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_authorityobjectoptional
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.
natural_personobjectoptional
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.
risk_ratingobjectoptional
An assessment of the entity’s potential risk of involvement in financial crimes, such as money laundering.
sole_proprietorshipobjectoptional
Details of the sole proprietorship entity to update. If you specify this parameter and the entity is not a sole proprietorship, the request will fail.
terms_agreementsarray<object>optional
New terms that the Entity agreed to. Not all programs are required to submit this data. This will not archive previously submitted terms.
third_party_verificationobjectoptional
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.
trustobjectoptional
Details of the trust entity to update. If you specify this parameter and the entity is not a trust, the request will fail.

3 status codes
200Returns the updated entity, including its identifier, legal structure, status, and associated details.
corporationobjectrequired
Details of the corporation entity. Will be present if `structure` is equal to `corporation`.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Entity was created.
creating_entity_onboarding_session_idstringrequired
The identifier of the Entity Onboarding Session that was used to create this Entity, if any.
descriptionstringrequired
The entity's description for display purposes.
details_confirmed_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Entity's details were most recently confirmed.
government_authorityobjectrequired
Details of the government authority entity. Will be present if `structure` is equal to `government_authority`.
idstringrequired
The entity's identifier.
idempotency_keystringrequired
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).
jointobjectrequired
Details of the joint entity. Will be present if `structure` is equal to `joint`.
natural_personobjectrequired
Details of the natural person entity. Will be present if `structure` is equal to `natural_person`.
risk_ratingobjectrequired
An assessment of the entity’s potential risk of involvement in financial crimes, such as money laundering.
sole_proprietorshipobjectrequired
Details of the sole proprietorship entity. Will be present if `structure` is equal to `sole_proprietorship`.
statusstringrequired
The status of the entity.
Allowed:activearchiveddisabled
structurestringrequired
The entity's legal structure.
Allowed:corporationnatural_personjointtrustgovernment_authoritysole_proprietorship
supplemental_documentsarray<SupplementalDocument>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.
terms_agreementsarray<EntityTermsAgreementsElement>required
The terms that the Entity agreed to. Not all programs are required to submit this data.
third_party_verificationobjectrequired
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.
trustobjectrequired
Details of the trust entity. Will be present if `structure` is equal to `trust`.
typestringrequired
A constant representing the object's type. For this resource it will always be `entity`.
Allowed:entity
validationobjectrequired
The validation results for the entity. Learn more about [validations](/documentation/entity-validation).
4XXReturned when the request encounters a client-side error.
5XXReturned when the server encounters an error.

Error handling

The entity_id path parameter must identify an existing entity. Each supplied structure-specific details object must match the entity's existing structure, and any supplied risk_rating.rating must be low, medium, or high. The third_party_verification.vendor must be alloy, middesk, oscilar, persona, or taktile.