Sign in

v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-012382333.4 MB

Sandbox: Simulate the status for an Entity's validation

Set the status for an Entity's validation. In production, Know Your Customer validations run automatically. While developing, it can be helpful to override the behavior in Sandbox.

post/simulations/entities/{entity_id}/validation

Path parameters

entity_idstring required

The identifier of the Entity whose validation status to update.

Request body

status'valid' | 'invalid' | 'pending' required

The validation status to set on the Entity.

Example request

{
  "issues": [
    {
      "category": "entity_tax_identifier"
    }
  ],
  "status": "invalid"
}

Response

Entity

created_atstring date-time required

The ISO 8601 time at which the Entity was created.

creating_entity_onboarding_session_idstring nullable required

The identifier of the Entity Onboarding Session that was used to create this Entity, if any.

descriptionstring nullable required

The entity's description for display purposes.

details_confirmed_atstring date-time nullable required

The ISO 8601 time at which the Entity's details were most recently confirmed.

idstring required

The entity's identifier.

idempotency_keystring 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.

status'active' | 'archived' | 'disabled' required

The status of the entity.

structure'corporation' | 'natural_person' | 'joint' | 'trust' | 'government_authority' required

The entity's legal structure.

type'entity' required

A constant representing the object's type. For this resource it will always be entity.

Example response

{
  "corporation": {
    "address": {
      "city": "New York",
      "country": "US",
      "line1": "33 Liberty Street",
      "line2": null,
      "state": "NY",
      "zip": "10045"
    },
    "beneficial_owners": [
      {
        "company_title": "CEO",
        "id": "entity_beneficial_owner_vozma8szzu1sxezp5zq6",
        "individual": {
          "address": {
            "city": "New York",
            "country": "US",
            "line1": "33 Liberty Street",
            "line2": null,
            "state": "NY",
            "zip": "10045"
          },
          "date_of_birth": "1970-01-31",
          "identification": {
            "method": "social_security_number",
            "number_last4": "1120"
          },
          "name": "Ian Crease"
        },
        "prongs": [
          "control",
          "ownership"
        ]
      }
    ],
    "email": null,
    "incorporation_state": "NY",
    "industry_code": null,
    "legal_identifier": {
      "category": "us_employer_identification_number",
      "value": "602214076"
    },
    "name": "National Phonograph Company",
    "website": "https://example.com"
  },
  "created_at": "2020-01-31T23:59:59Z",
  "creating_entity_onboarding_session_id": null,
  "description": null,
  "details_confirmed_at": null,
  "government_authority": null,
  "id": "entity_n8y8tnk2p9339ti393yi",
  "idempotency_key": null,
  "joint": null,
  "natural_person": null,
  "risk_rating": null,
  "status": "active",
  "structure": "corporation",
  "supplemental_documents": [
    {
      "created_at": "2020-01-31T23:59:59Z",
      "entity_id": "entity_n8y8tnk2p9339ti393yi",
      "file_id": "file_makxrc67oh9l6sg7w9yc",
      "idempotency_key": null,
      "type": "entity_supplemental_document"
    }
  ],
  "terms_agreements": [
    {
      "agreed_at": "2020-01-31T23:59:59Z",
      "ip_address": "128.32.0.1",
      "terms_url": "https://increase.com/example_terms"
    }
  ],
  "third_party_verification": null,
  "trust": null,
  "type": "entity",
  "validation": null
}