v4

OpenAPI 3.1.02026-08-012402353.8 MB

List Entities

get/entities

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

status.instring[]

Filter Entities for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

validation_status.instring[]

Filter Entities for those with the specified validation status. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

created_at.afterstring date-time

Return results after this ISO 8601 timestamp.

created_at.beforestring date-time

Return results before this ISO 8601 timestamp.

created_at.on_or_afterstring date-time

Return results on or after this ISO 8601 timestamp.

created_at.on_or_beforestring date-time

Return results on or before this ISO 8601 timestamp.

idempotency_keystring

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Response

Entity List

next_cursorstring nullable required

A pointer to a place in the list. Pass this as the cursor parameter to retrieve the next page of results. If there are no more results, the value will be null.

Example response

{
  "data": [
    {
      "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,
      "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": [],
      "third_party_verification": null,
      "trust": null,
      "type": "entity",
      "validation": null
    }
  ],
  "next_cursor": "v57w5d"
}