Increase Entities API
Entities are the legal entities that own accounts. They can be people, corporations, partnerships, government authorities, or trusts. To learn more, see [Entities](/documentation/entities).
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/increase-entities-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
description: Anything that you can achieve with PDFs, presence, and persistence in a bank branch you can do with our API. We've always wanted a fully programmatic bank so we built one. Our API faithfully exposes the data and capabilities of the Federal Reserve, Visa, The Clearing House, depository networks, and accounting tools. It's lovingly boring and exceptionally powerful. If you have any questions or want to get started, don't hesitate to ping us at sales@increase.com. We can't wait to see what you build!
title: Increase Entities API
version: 0.0.1
servers:
- url: https://api.increase.com
- url: https://sandbox.increase.com
security:
- bearerAuth: []
tags:
- description: Entities are the legal entities that own accounts. They can be people, corporations, partnerships, government authorities, or trusts. To learn more, see [Entities](/documentation/entities).
name: Entities
paths:
/entities:
get:
operationId: list_entities
parameters:
- in: query
name: cursor
required: false
schema:
description: Return the page of entries after this one.
type: string
x-documentation-priority: low
- in: query
name: limit
required: false
schema:
description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
minimum: 1
type: integer
x-documentation-priority: low
- in: query
name: status.in
required: false
schema:
description: 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`.
items:
enum:
- active
- archived
- disabled
type: string
x-enum-descriptions:
- The entity is active.
- The entity is archived, and can no longer be used to create accounts.
- The entity is temporarily disabled and cannot be used for financial activity.
type: array
x-documentation-priority: default
explode: false
- in: query
name: created_at.after
required: false
schema:
description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
format: date-time
type: string
x-documentation-priority: low
- in: query
name: created_at.before
required: false
schema:
description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
format: date-time
type: string
x-documentation-priority: low
- in: query
name: created_at.on_or_after
required: false
schema:
description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
format: date-time
type: string
x-documentation-priority: low
- in: query
name: created_at.on_or_before
required: false
schema:
description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
format: date-time
type: string
x-documentation-priority: low
- in: query
name: idempotency_key
required: false
schema:
description: 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](https://increase.com/documentation/idempotency-keys).
maxLength: 200
minLength: 1
type: string
x-documentation-priority: default
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/entity_list'
description: Entity List
4XX:
$ref: '#/components/responses/errorResponse'
5XX:
$ref: '#/components/responses/errorResponse'
summary: List Entities
x-sandbox-only: false
x-tag: Entities
tags:
- Entities
post:
operationId: create_an_entity
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/create_an_entity_parameters'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/entity'
description: Entity
4XX:
$ref: '#/components/responses/errorResponse'
5XX:
$ref: '#/components/responses/errorResponse'
summary: Create an Entity
x-sandbox-only: false
x-tag: Entities
tags:
- Entities
/entities/{entity_id}:
get:
operationId: retrieve_an_entity
parameters:
- example: entity_n8y8tnk2p9339ti393yi
in: path
name: entity_id
required: true
schema:
description: The identifier of the Entity to retrieve.
type: string
x-documentation-priority: default
x-id-reference-to: Entities
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/entity'
description: Entity
4XX:
$ref: '#/components/responses/errorResponse'
5XX:
$ref: '#/components/responses/errorResponse'
summary: Retrieve an Entity
x-sandbox-only: false
x-tag: Entities
tags:
- Entities
patch:
operationId: update_an_entity
parameters:
- example: entity_n8y8tnk2p9339ti393yi
in: path
name: entity_id
required: true
schema:
description: The entity identifier.
type: string
x-documentation-priority: default
x-id-reference-to: Entities
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/update_an_entity_parameters'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/entity'
description: Entity
4XX:
$ref: '#/components/responses/errorResponse'
5XX:
$ref: '#/components/responses/errorResponse'
summary: Update an Entity
x-sandbox-only: false
x-tag: Entities
tags:
- Entities
/entities/{entity_id}/archive:
post:
operationId: archive_an_entity
parameters:
- example: entity_n8y8tnk2p9339ti393yi
in: path
name: entity_id
required: true
schema:
description: The identifier of the Entity to archive. Any accounts associated with an entity must be closed before the entity can be archived.
type: string
x-documentation-priority: default
x-id-reference-to: Entities
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/entity'
description: Entity
4XX:
$ref: '#/components/responses/errorResponse'
5XX:
$ref: '#/components/responses/errorResponse'
summary: Archive an Entity
x-sandbox-only: false
x-tag: Entities
tags:
- Entities
components:
schemas:
entity:
additionalProperties: true
description: Entities are the legal entities that own accounts. They can be people, corporations, partnerships, government authorities, or trusts. To learn more, see [Entities](/documentation/entities).
example:
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
properties:
corporation:
anyOf:
- additionalProperties: true
description: Details of the corporation entity. Will be present if `structure` is equal to `corporation`.
properties:
address:
additionalProperties: false
description: The corporation's address.
example:
city: New York
country: US
line1: 33 Liberty Street
line2: null
state: NY
zip: '10045'
properties:
city:
anyOf:
- description: The city, district, town, or village of the address.
type: string
x-documentation-priority: default
- type: 'null'
country:
description: The two-letter ISO 3166-1 alpha-2 code for the country of the address.
type: string
x-documentation-priority: default
line1:
description: The first line of the address.
type: string
x-documentation-priority: default
line2:
anyOf:
- description: The second line of the address.
type: string
x-documentation-priority: default
- type: 'null'
state:
anyOf:
- description: The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address.
type: string
x-documentation-priority: default
- type: 'null'
zip:
anyOf:
- description: The ZIP or postal code of the address.
type: string
x-documentation-priority: default
- type: 'null'
required:
- line1
- line2
- city
- state
- zip
- country
title: Entity Corporation Address
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: Addresses
beneficial_owners:
description: The identifying details of anyone controlling or owning 25% or more of the corporation.
items:
additionalProperties: true
example:
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
properties:
company_title:
anyOf:
- description: This person's role or title within the entity.
type: string
x-documentation-priority: default
- type: 'null'
id:
description: The identifier of this beneficial owner.
type: string
x-documentation-priority: default
x-id-reference-to: Beneficial Owners
individual:
additionalProperties: false
description: Personal details for the beneficial owner.
properties:
address:
additionalProperties: false
description: The person's address.
example:
city: New York
country: US
line1: 33 Liberty Street
line2: null
state: NY
zip: '10045'
properties:
city:
anyOf:
- description: The city, district, town, or village of the address.
type: string
x-documentation-priority: default
- type: 'null'
country:
description: The two-letter ISO 3166-1 alpha-2 code for the country of the address.
type: string
x-documentation-priority: default
line1:
description: The first line of the address.
type: string
x-documentation-priority: default
line2:
anyOf:
- description: The second line of the address.
type: string
x-documentation-priority: default
- type: 'null'
state:
anyOf:
- description: The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address.
type: string
x-documentation-priority: default
- type: 'null'
zip:
anyOf:
- description: The ZIP or postal code of the address.
type: string
x-documentation-priority: default
- type: 'null'
required:
- line1
- line2
- city
- state
- zip
- country
title: Entity Corporation Beneficial Owner Reference Individual Address
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: Addresses
date_of_birth:
description: The person's date of birth in YYYY-MM-DD format.
format: date
type: string
x-documentation-priority: default
identification:
anyOf:
- additionalProperties: true
description: A means of verifying the person's identity.
properties:
method:
description: A method that can be used to verify the individual's identity.
enum:
- social_security_number
- individual_taxpayer_identification_number
- passport
- drivers_license
- other
type: string
x-documentation-priority: default
x-enum-descriptions:
- A social security number.
- An individual taxpayer identification number (ITIN).
- A passport number.
- A driver's license number.
- Another identifying document.
number_last4:
description: The last 4 digits of the identification number that can be used to verify the individual's identity.
type: string
x-documentation-priority: default
required:
- method
- number_last4
title: Entity Corporation Beneficial Owner Reference Individual Identification
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: Identifications
- type: 'null'
name:
description: The person's legal name.
type: string
x-documentation-priority: default
required:
- name
- date_of_birth
- address
- identification
title: Entity Corporation Beneficial Owner Reference Individual
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: Individuals
prongs:
description: Why this person is considered a beneficial owner of the entity.
items:
enum:
- ownership
- control
type: string
x-enum-descriptions:
- A person with 25% or greater direct or indirect ownership of the entity.
- A person who manages, directs, or has significant control of the entity.
type: array
x-documentation-priority: default
required:
- id
- individual
- company_title
- prongs
title: Entity Corporation Beneficial Owner Reference
type: object
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: Beneficial Owner References
type: array
x-documentation-priority: default
email:
anyOf:
- description: An email address for the business.
type: string
x-documentation-priority: default
- type: 'null'
incorporation_state:
anyOf:
- description: The two-letter United States Postal Service (USPS) abbreviation for the corporation's state of incorporation.
type: string
x-documentation-priority: default
- type: 'null'
industry_code:
anyOf:
- description: The numeric North American Industry Classification System (NAICS) code submitted for the corporation.
type: string
x-documentation-priority: default
- type: 'null'
legal_identifier:
anyOf:
- additionalProperties: false
description: The legal identifier of the corporation.
properties:
category:
description: The category of the legal identifier.
enum:
- us_employer_identification_number
- other
type: string
x-documentation-priority: default
x-enum-descriptions:
- The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS; submit it as nine digits with no dashes or other separators.
- A legal identifier issued by a foreign government, like a tax identification number or registration number.
value:
description: The identifier of the legal identifier.
type: string
x-documentation-priority: default
required:
- category
- value
title: Entity Corporation LegalIdentifier
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: LegalIdentifiers
- type: 'null'
name:
description: The legal name of the corporation.
type: string
x-documentation-priority: default
website:
anyOf:
- description: The website of the corporation.
type: string
x-documentation-priority: default
- type: 'null'
required:
- name
- website
- email
- legal_identifier
- incorporation_state
- industry_code
- address
- beneficial_owners
title: Entity Corporation
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: Corporations
- type: 'null'
created_at:
description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Entity was created.
format: date-time
type: string
x-documentation-priority: default
creating_entity_onboarding_session_id:
anyOf:
- description: The identifier of the Entity Onboarding Session that was used to create this Entity, if any.
type: string
x-documentation-priority: default
x-id-reference-to: Entity Onboarding Sessions
- type: 'null'
description:
anyOf:
- description: The entity's description for display purposes.
type: string
x-documentation-priority: low
- type: 'null'
details_confirmed_at:
anyOf:
- description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Entity's details were most recently confirmed.
format: date-time
type: string
x-documentation-priority: low
- type: 'null'
government_authority:
anyOf:
- additionalProperties: false
description: Details of the government authority entity. Will be present if `structure` is equal to `government_authority`.
properties:
address:
additionalProperties: false
description: The government authority's address.
example:
city: New York
country: US
line1: 33 Liberty Street
line2: null
state: NY
zip: '10045'
properties:
city:
anyOf:
- description: The city, district, town, or village of the address.
type: string
x-documentation-priority: default
- type: 'null'
country:
description: The two-letter ISO 3166-1 alpha-2 code for the country of the address.
type: string
x-documentation-priority: default
line1:
description: The first line of the address.
type: string
x-documentation-priority: default
line2:
anyOf:
- description: The second line of the address.
type: string
x-documentation-priority: default
- type: 'null'
state:
anyOf:
- description: The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address.
type: string
x-documentation-priority: default
- type: 'null'
zip:
anyOf:
- description: The ZIP or postal code of the address.
type: string
x-documentation-priority: default
- type: 'null'
required:
- line1
- line2
- city
- state
- zip
- country
title: Entity GovernmentAuthority Address
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: Addresses
authorized_persons:
description: The identifying details of authorized persons of the government authority.
items:
additionalProperties: false
properties:
authorized_person_id:
description: The identifier of this authorized person.
type: string
x-documentation-priority: default
name:
description: The person's legal name.
type: string
x-documentation-priority: default
required:
- name
- authorized_person_id
title: Entity GovernmentAuthority AuthorizedPersonsElement
type: object
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: AuthorizedPersonsElements
type: array
x-documentation-priority: default
category:
description: The category of the government authority.
enum:
- municipality
- state_agency
- state_government
- federal_agency
type: string
x-documentation-priority: default
x-enum-descriptions:
- A municipality.
- A state agency.
- A state government.
- A federal agency.
name:
description: The government authority's name.
type: string
x-documentation-priority: default
tax_identifier:
anyOf:
- description: The Employer Identification Number (EIN) of the government authority.
type: string
x-documentation-priority: default
- type: 'null'
website:
anyOf:
- description: The government authority's website.
type: string
x-documentation-priority: default
- type: 'null'
required:
- name
- category
- address
- website
- tax_identifier
- authorized_persons
title: Entity GovernmentAuthority
type: object
x-documentation-priority: low
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: GovernmentAuthorities
- type: 'null'
id:
description: The entity's identifier.
type: string
x-documentation-priority: default
x-id-reference-to: Entities
idempotency_key:
anyOf:
- description: 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).
type: string
x-documentation-priority: default
- type: 'null'
joint:
anyOf:
- additionalProperties: false
description: Details of the joint entity. Will be present if `structure` is equal to `joint`.
properties:
individuals:
description: The two individuals that share control of the entity.
items:
additionalProperties: false
properties:
address:
additionalProperties: false
description: The person's address.
example:
city: New York
country: US
line1: 33 Liberty Street
line2: null
state: NY
zip: '10045'
properties:
city:
anyOf:
- description: The city, district, town, or village of the address.
type: string
x-documentation-priority: default
- type: 'null'
country:
description: The two-letter ISO 3166-1 alpha-2 code for the country of the address.
type: string
x-documentation-priority: default
line1:
description: The first line of the address.
type: string
x-documentat
# --- truncated at 32 KB (186 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/increase/refs/heads/main/openapi/increase-entities-api-openapi.yml