Archive an Entity

Changed on
post/entities/{entity_id}/archive

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/entities/{entity_id}/archive
  • Auth
    HTTP bearer

Path parameters

entity_idstring required

The identifier of the Entity to archive. Any accounts associated with an entity must be closed before the entity can be archived.

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' | 'sole_proprietorship' 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"
        ]
      }
    ],
    "beneficial_ownership_exemption_reason": null,
    "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,
  "sole_proprietorship": null,
  "status": "active",
  "structure": "corporation",
  "supplemental_documents": [],
  "terms_agreements": [],
  "third_party_verification": null,
  "trust": null,
  "type": "entity",
  "validation": {
    "issues": [],
    "status": "valid"
  }
}

Changes

  • 60063efd9429Revision changes
    • warning

      added the new beneficial_owner_tax_identifier enum value to the //// response property for the response status

    • info

      added the required property //// to the response with the status

  • 17aa1bcd9faeRevision changes
    • warning

      added the new social_security_number_last4 enum value to the /////// response property for the response status

    • warning

      added the new social_security_number_last4 enum value to the ////// response property for the response status

    • warning

      added the new social_security_number_last4 enum value to the //// response property for the response status

    • warning

      added the new social_security_number_last4 enum value to the ///// response property for the response status

    • warning

      added the new social_security_number_last4 enum value to the ////// response property for the response status

    • warning

      added the new social_security_number_last4 enum value to the //////// response property for the response status