increase-test
POST/simulations/entities/{entity_id}/update_validation

Simulate Entity validation in the sandbox

Simulates validation updates for an Entity in the sandbox. Supply issues to attach validation issues, or provide an empty array to set the validation status to valid.

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

1 parameter · 1 body field
entity_idstringrequired
The identifier of the Entity whose validation status to update.

Validation update containing the issues to attach to the Entity.

issuesarray<object>required
The validation issues to attach. If no issues are provided, the validation status will be set to `valid`.

3 status codes
200Returns the updated Entity, including its validation status and any attached validation issues.
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 cannot be processed because of a client error.
5XXReturned when the request cannot be processed because of a server error.

Error handling

The issues body field is required, and each issue must include category using an accepted value: entity_tax_identifier, entity_address, entity_identity, beneficial_owner_identity, or beneficial_owner_address. The entity_id path parameter must identify the Entity whose validation status you want to update.