# Entities > 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). [Events](https://increase.com/documentation/events.md) will be generated for this resource. The possible event categories are: `entity.created` and `entity.updated`. ## The Entity object ### Example ```json { "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 } ``` ### Attributes - `corporation` (dictionary, nullable) Details of the corporation entity. Will be present if `structure` is equal to `corporation`. - `corporation.address` (dictionary) The corporation's address. - `corporation.address.city` (string, nullable) The city, district, town, or village of the address. - `corporation.address.country` (string) The two-letter ISO 3166-1 alpha-2 code for the country of the address. - `corporation.address.line1` (string) The first line of the address. - `corporation.address.line2` (string, nullable) The second line of the address. - `corporation.address.state` (string, nullable) The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. - `corporation.address.zip` (string, nullable) The ZIP or postal code of the address. - `corporation.beneficial_owners` (array of objects) The identifying details of anyone controlling or owning 25% or more of the corporation. - `corporation.beneficial_owners.company_title` (string, nullable) This person's role or title within the entity. - `corporation.beneficial_owners.id` (string) The identifier of this beneficial owner. - `corporation.beneficial_owners.individual` (dictionary) Personal details for the beneficial owner. - `corporation.beneficial_owners.individual.address` (dictionary) The person's address. - `corporation.beneficial_owners.individual.address.city` (string, nullable) The city, district, town, or village of the address. - `corporation.beneficial_owners.individual.address.country` (string) The two-letter ISO 3166-1 alpha-2 code for the country of the address. - `corporation.beneficial_owners.individual.address.line1` (string) The first line of the address. - `corporation.beneficial_owners.individual.address.line2` (string, nullable) The second line of the address. - `corporation.beneficial_owners.individual.address.state` (string, nullable) The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. - `corporation.beneficial_owners.individual.address.zip` (string, nullable) The ZIP or postal code of the address. - `corporation.beneficial_owners.individual.date_of_birth` (string) The person's date of birth in YYYY-MM-DD format. - `corporation.beneficial_owners.individual.identification` (dictionary, nullable) A means of verifying the person's identity. - `corporation.beneficial_owners.individual.identification.method` (enum) A method that can be used to verify the individual's identity. Cases: * `social_security_number` (A social security number.) * `individual_taxpayer_identification_number` (An individual taxpayer identification number (ITIN).) * `passport` (A passport number.) * `drivers_license` (A driver's license number.) * `other` (Another identifying document.) - `corporation.beneficial_owners.individual.identification.number_last4` (string) The last 4 digits of the identification number that can be used to verify the individual's identity. - `corporation.beneficial_owners.individual.name` (string) The person's legal name. - `corporation.beneficial_owners.prongs` (array of enums) Why this person is considered a beneficial owner of the entity. Cases: * `ownership` (A person with 25% or greater direct or indirect ownership of the entity.) * `control` (A person who manages, directs, or has significant control of the entity.) - `corporation.email` (string, nullable) An email address for the business. - `corporation.incorporation_state` (string, nullable) The two-letter United States Postal Service (USPS) abbreviation for the corporation's state of incorporation. - `corporation.industry_code` (string, nullable) The numeric North American Industry Classification System (NAICS) code submitted for the corporation. - `corporation.legal_identifier` (dictionary, nullable) The legal identifier of the corporation. - `corporation.legal_identifier.category` (enum) The category of the legal identifier. Cases: * `us_employer_identification_number` (The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS.) * `other` (A legal identifier issued by a foreign government, like a tax identification number or registration number.) - `corporation.legal_identifier.value` (string) The identifier of the legal identifier. - `corporation.name` (string) The legal name of the corporation. - `corporation.website` (string, nullable) The website of the corporation. - `created_at` (string) The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Entity was created. - `creating_entity_onboarding_session_id` (string, nullable) The identifier of the Entity Onboarding Session that was used to create this Entity, if any. - `description` (string, nullable) The entity's description for display purposes. - `details_confirmed_at` (string, nullable) The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Entity's details were most recently confirmed. - `government_authority` (dictionary, nullable) Details of the government authority entity. Will be present if `structure` is equal to `government_authority`. - `government_authority.address` (dictionary) The government authority's address. - `government_authority.address.city` (string, nullable) The city, district, town, or village of the address. - `government_authority.address.country` (string) The two-letter ISO 3166-1 alpha-2 code for the country of the address. - `government_authority.address.line1` (string) The first line of the address. - `government_authority.address.line2` (string, nullable) The second line of the address. - `government_authority.address.state` (string, nullable) The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. - `government_authority.address.zip` (string, nullable) The ZIP or postal code of the address. - `government_authority.authorized_persons` (array of objects) The identifying details of authorized persons of the government authority. - `government_authority.authorized_persons.authorized_person_id` (string) The identifier of this authorized person. - `government_authority.authorized_persons.name` (string) The person's legal name. - `government_authority.category` (enum) The category of the government authority. Cases: * `municipality` (A municipality.) * `state_agency` (A state agency.) * `state_government` (A state government.) * `federal_agency` (A federal agency.) - `government_authority.name` (string) The government authority's name. - `government_authority.tax_identifier` (string, nullable) The Employer Identification Number (EIN) of the government authority. - `government_authority.website` (string, nullable) The government authority's website. - `id` (string) The entity's identifier. - `idempotency_key` (string, nullable) 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). - `joint` (dictionary, nullable) Details of the joint entity. Will be present if `structure` is equal to `joint`. - `joint.individuals` (array of objects) The two individuals that share control of the entity. - `joint.individuals.address` (dictionary) The person's address. - `joint.individuals.address.city` (string, nullable) The city, district, town, or village of the address. - `joint.individuals.address.country` (string) The two-letter ISO 3166-1 alpha-2 code for the country of the address. - `joint.individuals.address.line1` (string) The first line of the address. - `joint.individuals.address.line2` (string, nullable) The second line of the address. - `joint.individuals.address.state` (string, nullable) The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. - `joint.individuals.address.zip` (string, nullable) The ZIP or postal code of the address. - `joint.individuals.date_of_birth` (string) The person's date of birth in YYYY-MM-DD format. - `joint.individuals.identification` (dictionary, nullable) A means of verifying the person's identity. - `joint.individuals.identification.method` (enum) A method that can be used to verify the individual's identity. Cases: * `social_security_number` (A social security number.) * `individual_taxpayer_identification_number` (An individual taxpayer identification number (ITIN).) * `passport` (A passport number.) * `drivers_license` (A driver's license number.) * `other` (Another identifying document.) - `joint.individuals.identification.number_last4` (string) The last 4 digits of the identification number that can be used to verify the individual's identity. - `joint.individuals.name` (string) The person's legal name. - `joint.name` (string) The entity's name. - `natural_person` (dictionary, nullable) Details of the natural person entity. Will be present if `structure` is equal to `natural_person`. - `natural_person.address` (dictionary) The person's address. - `natural_person.address.city` (string, nullable) The city, district, town, or village of the address. - `natural_person.address.country` (string) The two-letter ISO 3166-1 alpha-2 code for the country of the address. - `natural_person.address.line1` (string) The first line of the address. - `natural_person.address.line2` (string, nullable) The second line of the address. - `natural_person.address.state` (string, nullable) The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. - `natural_person.address.zip` (string, nullable) The ZIP or postal code of the address. - `natural_person.date_of_birth` (string) The person's date of birth in YYYY-MM-DD format. - `natural_person.identification` (dictionary, nullable) A means of verifying the person's identity. - `natural_person.identification.method` (enum) A method that can be used to verify the individual's identity. Cases: * `social_security_number` (A social security number.) * `individual_taxpayer_identification_number` (An individual taxpayer identification number (ITIN).) * `passport` (A passport number.) * `drivers_license` (A driver's license number.) * `other` (Another identifying document.) - `natural_person.identification.number_last4` (string) The last 4 digits of the identification number that can be used to verify the individual's identity. - `natural_person.name` (string) The person's legal name. - `risk_rating` (dictionary, nullable) An assessment of the entity’s potential risk of involvement in financial crimes, such as money laundering. - `risk_rating.rated_at` (string) The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk rating was performed. - `risk_rating.rating` (enum) The rating given to this entity. Cases: * `low` (Minimal risk of involvement in financial crime.) * `medium` (Moderate risk of involvement in financial crime.) * `high` (Elevated risk of involvement in financial crime.) - `status` (enum) The status of the entity. Cases: * `active` (The entity is active.) * `archived` (The entity is archived, and can no longer be used to create accounts.) * `disabled` (The entity is temporarily disabled and cannot be used for financial activity.) - `structure` (enum) The entity's legal structure. Cases: * `corporation` (A corporation.) * `natural_person` (An individual person.) * `joint` (Multiple individual people.) * `trust` (A trust.) * `government_authority` (A government authority.) - `supplemental_documents` (array of objects) 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. - `supplemental_documents.created_at` (string) The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Supplemental Document was created. - `supplemental_documents.entity_id` (string) The Entity the supplemental document is attached to. - `supplemental_documents.file_id` (string) The File containing the document. - `supplemental_documents.idempotency_key` (string, nullable) 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). - `supplemental_documents.type` (string) A constant representing the object's type. For this resource it will always be `entity_supplemental_document`. - `terms_agreements` (array of objects) The terms that the Entity agreed to. Not all programs are required to submit this data. - `terms_agreements.agreed_at` (string) The timestamp of when the Entity agreed to the terms. - `terms_agreements.ip_address` (string) The IP address the Entity accessed reviewed the terms from. - `terms_agreements.terms_url` (string) The URL of the terms agreement. This link will be provided by your bank partner. - `third_party_verification` (dictionary, nullable) 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. - `third_party_verification.reference` (string) The reference identifier for the third party verification. - `third_party_verification.vendor` (enum) The vendor that was used to perform the verification. Cases: * `alloy` (Alloy. See https://alloy.com for more information.) * `middesk` (Middesk. See https://middesk.com for more information.) * `oscilar` (Oscilar. See https://oscilar.com for more information.) * `persona` (Persona. See https://withpersona.com for more information.) * `taktile` (Taktile. See https://taktile.com for more information.) - `trust` (dictionary, nullable) Details of the trust entity. Will be present if `structure` is equal to `trust`. - `trust.address` (dictionary) The trust's address. - `trust.address.city` (string, nullable) The city, district, town, or village of the address. - `trust.address.country` (string) The two-letter ISO 3166-1 alpha-2 code for the country of the address. - `trust.address.line1` (string) The first line of the address. - `trust.address.line2` (string, nullable) The second line of the address. - `trust.address.state` (string, nullable) The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. - `trust.address.zip` (string, nullable) The ZIP or postal code of the address. - `trust.category` (enum) Whether the trust is `revocable` or `irrevocable`. Cases: * `revocable` (The trust is revocable by the grantor.) * `irrevocable` (The trust cannot be revoked.) - `trust.formation_document_file_id` (string, nullable) The ID for the File containing the formation document of the trust. - `trust.formation_state` (string, nullable) The two-letter United States Postal Service (USPS) abbreviation for the state in which the trust was formed. - `trust.grantor` (dictionary, nullable) The grantor of the trust. Will be present if the `category` is `revocable`. - `trust.grantor.address` (dictionary) The person's address. - `trust.grantor.address.city` (string, nullable) The city, district, town, or village of the address. - `trust.grantor.address.country` (string) The two-letter ISO 3166-1 alpha-2 code for the country of the address. - `trust.grantor.address.line1` (string) The first line of the address. - `trust.grantor.address.line2` (string, nullable) The second line of the address. - `trust.grantor.address.state` (string, nullable) The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. - `trust.grantor.address.zip` (string, nullable) The ZIP or postal code of the address. - `trust.grantor.date_of_birth` (string) The person's date of birth in YYYY-MM-DD format. - `trust.grantor.identification` (dictionary, nullable) A means of verifying the person's identity. - `trust.grantor.identification.method` (enum) A method that can be used to verify the individual's identity. Cases: * `social_security_number` (A social security number.) * `individual_taxpayer_identification_number` (An individual taxpayer identification number (ITIN).) * `passport` (A passport number.) * `drivers_license` (A driver's license number.) * `other` (Another identifying document.) - `trust.grantor.identification.number_last4` (string) The last 4 digits of the identification number that can be used to verify the individual's identity. - `trust.grantor.name` (string) The person's legal name. - `trust.name` (string) The trust's name. - `trust.tax_identifier` (string, nullable) The Employer Identification Number (EIN) of the trust itself. - `trust.trustees` (array of objects) The trustees of the trust. - `trust.trustees.individual` (dictionary, nullable) The individual trustee of the trust. Will be present if the trustee's `structure` is equal to `individual`. - `trust.trustees.individual.address` (dictionary) The person's address. - `trust.trustees.individual.address.city` (string, nullable) The city, district, town, or village of the address. - `trust.trustees.individual.address.country` (string) The two-letter ISO 3166-1 alpha-2 code for the country of the address. - `trust.trustees.individual.address.line1` (string) The first line of the address. - `trust.trustees.individual.address.line2` (string, nullable) The second line of the address. - `trust.trustees.individual.address.state` (string, nullable) The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. - `trust.trustees.individual.address.zip` (string, nullable) The ZIP or postal code of the address. - `trust.trustees.individual.date_of_birth` (string) The person's date of birth in YYYY-MM-DD format. - `trust.trustees.individual.identification` (dictionary, nullable) A means of verifying the person's identity. - `trust.trustees.individual.identification.method` (enum) A method that can be used to verify the individual's identity. Cases: * `social_security_number` (A social security number.) * `individual_taxpayer_identification_number` (An individual taxpayer identification number (ITIN).) * `passport` (A passport number.) * `drivers_license` (A driver's license number.) * `other` (Another identifying document.) - `trust.trustees.individual.identification.number_last4` (string) The last 4 digits of the identification number that can be used to verify the individual's identity. - `trust.trustees.individual.name` (string) The person's legal name. - `trust.trustees.structure` (enum) The structure of the trustee. Will always be equal to `individual`. Cases: * `individual` (The trustee is an individual.) - `type` (string) A constant representing the object's type. For this resource it will always be `entity`. - `validation` (dictionary, nullable) The validation results for the entity. Learn more about [validations](/documentation/entity-validation). - `validation.issues` (array of objects) The list of issues that need to be addressed. - `validation.issues.beneficial_owner_address` (dictionary, nullable) Details when the issue is with a beneficial owner's address. - `validation.issues.beneficial_owner_address.beneficial_owner_id` (string) The ID of the beneficial owner. - `validation.issues.beneficial_owner_address.reason` (enum) The reason the address is invalid. Cases: * `mailbox_address` (The address is a mailbox or other non-physical address.) - `validation.issues.beneficial_owner_identity` (dictionary, nullable) Details when the issue is with a beneficial owner's identity verification. - `validation.issues.beneficial_owner_identity.beneficial_owner_id` (string) The ID of the beneficial owner. - `validation.issues.category` (enum) The type of issue. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully. Cases: * `entity_tax_identifier` (The entity's tax identifier could not be validated. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.legal_identifier).) * `entity_address` (The entity's address could not be validated. Update the address with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.address).) * `beneficial_owner_identity` (A beneficial owner's identity could not be verified. Update the identification with the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner).) * `beneficial_owner_address` (A beneficial owner's address could not be validated. Update the address with the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner).) - `validation.issues.entity_address` (dictionary, nullable) Details when the issue is with the entity's address. - `validation.issues.entity_address.reason` (enum) The reason the address is invalid. Cases: * `mailbox_address` (The address is a mailbox or other non-physical address.) - `validation.issues.entity_tax_identifier` (dictionary, nullable) Details when the issue is with the entity's tax ID. - `validation.status` (enum) The validation status for the entity. If the status is `invalid`, the `issues` array will be populated. Cases: * `pending` (The submitted data is being validated.) * `valid` (The submitted data is valid.) * `invalid` (Additional information is required to validate the data.) ## List Entities GET /entities ### Example ```curl curl \ --url "${INCREASE_URL}/entities" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" ``` ### Query Parameters - `cursor` (string, optional) Return the page of entries after this one. - `limit` (integer, optional) Limit the size of the list that is returned. The default (and maximum) is 100 objects. - `status.in` (array of enums, optional) 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`. Cases: * `active` (The entity is active.) * `archived` (The entity is archived, and can no longer be used to create accounts.) * `disabled` (The entity is temporarily disabled and cannot be used for financial activity.) - `created_at.after` (string, optional) Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. - `created_at.before` (string, optional) Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. - `created_at.on_or_after` (string, optional) Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. - `created_at.on_or_before` (string, optional) Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. - `idempotency_key` (string, optional) 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). ### Returns a Entity List object: ```json { "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" ] } ], "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 } ], "next_cursor": "v57w5d" } ``` ## Create an Entity POST /entities ### Example ```curl curl -X "POST" \ --url "${INCREASE_URL}/entities" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "corporation": { "address": { "city": "New York", "line1": "33 Liberty Street", "state": "NY", "zip": "10045" }, "beneficial_owners": [ { "company_title": "CEO", "individual": { "address": { "city": "New York", "line1": "33 Liberty Street", "state": "NY", "zip": "10045" }, "date_of_birth": "1970-01-31", "identification": { "method": "social_security_number", "number": "078051120" }, "name": "Ian Crease" }, "prongs": [ "control" ] } ], "incorporation_state": "NY", "legal_identifier": { "category": "us_employer_identification_number", "value": "602214076" }, "name": "National Phonograph Company", "website": "https://example.com" }, "structure": "corporation", "supplemental_documents": [ { "file_id": "file_makxrc67oh9l6sg7w9yc" } ] }' ``` ### Body Parameters - `corporation` (dictionary, optional) Details of the corporation entity to create. Required if `structure` is equal to `corporation`. - `corporation.address` (dictionary, required) The entity's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed. - `corporation.address.city` (string, required) The city, district, town, or village of the address. - `corporation.address.country` (string, required) The two-letter ISO 3166-1 alpha-2 code for the country of the address. - `corporation.address.line1` (string, required) The first line of the address. This is usually the street number and street. - `corporation.address.line2` (string, optional) The second line of the address. This might be the floor or room number. - `corporation.address.state` (string, optional) The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. Required in certain countries. - `corporation.address.zip` (string, optional) The ZIP or postal code of the address. Required in certain countries. - `corporation.beneficial_owners` (array of objects, required) The identifying details of each person who owns 25% or more of the business and one control person, like the CEO, CFO, or other executive. You can submit between 1 and 5 people to this list. - `corporation.beneficial_owners.company_title` (string, optional) This person's role or title within the entity. - `corporation.beneficial_owners.individual` (dictionary, required) Personal details for the beneficial owner. - `corporation.beneficial_owners.individual.address` (dictionary, required) The individual's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed. - `corporation.beneficial_owners.individual.address.city` (string, required) The city, district, town, or village of the address. - `corporation.beneficial_owners.individual.address.country` (string, required) The two-letter ISO 3166-1 alpha-2 code for the country of the address. - `corporation.beneficial_owners.individual.address.line1` (string, required) The first line of the address. This is usually the street number and street. - `corporation.beneficial_owners.individual.address.line2` (string, optional) The second line of the address. This might be the floor or room number. - `corporation.beneficial_owners.individual.address.state` (string, optional) The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. Required in certain countries. - `corporation.beneficial_owners.individual.address.zip` (string, optional) The ZIP or postal code of the address. Required in certain countries. - `corporation.beneficial_owners.individual.confirmed_no_us_tax_id` (boolean, optional) The identification method for an individual can only be a passport, driver's license, or other document if you've confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number). - `corporation.beneficial_owners.individual.date_of_birth` (string, required) The person's date of birth in YYYY-MM-DD format. - `corporation.beneficial_owners.individual.identification` (dictionary, required) A means of verifying the person's identity. - `corporation.beneficial_owners.individual.identification.drivers_license` (dictionary, optional) Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`. - `corporation.beneficial_owners.individual.identification.drivers_license.back_file_id` (string, optional) The identifier of the File containing the back of the driver's license. - `corporation.beneficial_owners.individual.identification.drivers_license.expiration_date` (string, required) The driver's license's expiration date in YYYY-MM-DD format. - `corporation.beneficial_owners.individual.identification.drivers_license.file_id` (string, required) The identifier of the File containing the front of the driver's license. - `corporation.beneficial_owners.individual.identification.drivers_license.state` (string, required) The state that issued the provided driver's license. - `corporation.beneficial_owners.individual.identification.method` (enum, required) A method that can be used to verify the individual's identity. Cases: * `social_security_number` (A social security number.) * `individual_taxpayer_identification_number` (An individual taxpayer identification number (ITIN).) * `passport` (A passport number.) * `drivers_license` (A driver's license number.) * `other` (Another identifying document.) - `corporation.beneficial_owners.individual.identification.number` (string, required) An identification number that can be used to verify the individual's identity, such as a social security number. - `corporation.beneficial_owners.individual.identification.other` (dictionary, optional) Information about the identification document provided. Required if `method` is equal to `other`. - `corporation.beneficial_owners.individual.identification.other.back_file_id` (string, optional) The identifier of the File containing the back of the document. Not every document has a reverse side. - `corporation.beneficial_owners.individual.identification.other.country` (string, required) The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`). - `corporation.beneficial_owners.individual.identification.other.description` (string, required) A description of the document submitted. - `corporation.beneficial_owners.individual.identification.other.expiration_date` (string, optional) The document's expiration date in YYYY-MM-DD format. - `corporation.beneficial_owners.individual.identification.other.file_id` (string, required) The identifier of the File containing the front of the document. - `corporation.beneficial_owners.individual.identification.passport` (dictionary, optional) Information about the passport used for identification. Required if `method` is equal to `passport`. - `corporation.beneficial_owners.individual.identification.passport.country` (string, required) The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`). - `corporation.beneficial_owners.individual.identification.passport.expiration_date` (string, required) The passport's expiration date in YYYY-MM-DD format. - `corporation.beneficial_owners.individual.identification.passport.file_id` (string, required) The identifier of the File containing the passport. - `corporation.beneficial_owners.individual.name` (string, required) The person's legal name. - `corporation.beneficial_owners.prongs` (array of enums, required) Why this person is considered a beneficial owner of the entity. At least one option is required, if a person is both a control person and owner, submit an array containing both. Cases: * `ownership` (A person with 25% or greater direct or indirect ownership of the entity.) * `control` (A person who manages, directs, or has significant control of the entity.) - `corporation.beneficial_ownership_exemption_reason` (enum, optional) If the entity is exempt from the requirement to submit beneficial owners, provide the justification. If a reason is provided, you do not need to submit a list of beneficial owners. Cases: * `regulated_financial_institution` (A regulated financial institution.) * `publicly_traded_company` (A publicly traded company.) * `public_entity` (A public entity acting on behalf of the federal or a state government.) * `other` (Any other reason why this entity is exempt from the requirement to submit beneficial owners. You can only use this exemption after approval from your bank partner.) - `corporation.email` (string, optional) An email address for the business. Not every program requires an email for submitted Entities. - `corporation.incorporation_state` (string, optional) The two-letter United States Postal Service (USPS) abbreviation for the corporation's state of incorporation. - `corporation.industry_code` (string, optional) The North American Industry Classification System (NAICS) code for the corporation's primary line of business. This is a number, like `5132` for `Software Publishers`. A full list of classification codes is available [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes). - `corporation.legal_identifier` (dictionary, required) The legal identifier of the corporation. This is usually the Employer Identification Number (EIN). - `corporation.legal_identifier.category` (enum, optional) The category of the legal identifier. If not provided, the default is `us_employer_identification_number`. Cases: * `us_employer_identification_number` (The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS.) * `other` (A legal identifier issued by a foreign government, like a tax identification number or registration number.) - `corporation.legal_identifier.value` (string, required) The legal identifier. - `corporation.name` (string, required) The legal name of the corporation. - `corporation.website` (string, optional) The website of the corporation. - `description` (string, optional) The description you choose to give the entity. - `government_authority` (dictionary, optional) Details of the Government Authority entity to create. Required if `structure` is equal to `government_authority`. - `government_authority.address` (dictionary, required) The entity's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed. - `government_authority.address.city` (string, required) The city of the address. - `government_authority.address.line1` (string, required) The first line of the address. This is usually the street number and street. - `government_authority.address.line2` (string, optional) The second line of the address. This might be the floor or room number. - `government_authority.address.state` (string, required) The two-letter United States Postal Service (USPS) abbreviation for the state of the address. - `government_authority.address.zip` (string, required) The ZIP code of the address. - `government_authority.authorized_persons` (array of objects, required) The identifying details of authorized officials acting on the entity's behalf. - `government_authority.authorized_persons.name` (string, required) The person's legal name. - `government_authority.category` (enum, required) The category of the government authority. Cases: * `municipality` (A municipality.) * `state_agency` (A state agency.) * `state_government` (A state government.) * `federal_agency` (A federal agency.) - `government_authority.name` (string, required) The legal name of the government authority. - `government_authority.tax_identifier` (string, required) The Employer Identification Number (EIN) for the government authority. - `government_authority.website` (string, optional) The website of the government authority. - `joint` (dictionary, optional) Details of the joint entity to create. Required if `structure` is equal to `joint`. - `joint.individuals` (array of objects, required) The two individuals that share control of the entity. - `joint.individuals.address` (dictionary, required) The individual's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed. - `joint.individuals.address.city` (string, required) The city, district, town, or village of the address. - `joint.individuals.address.country` (string, required) The two-letter ISO 3166-1 alpha-2 code for the country of the address. - `joint.individuals.address.line1` (string, required) The first line of the address. This is usually the street number and street. - `joint.individuals.address.line2` (string, optional) The second line of the address. This might be the floor or room number. - `joint.individuals.address.state` (string, optional) The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. Required in certain countries. - `joint.individuals.address.zip` (string, optional) The ZIP or postal code of the address. Required in certain countries. - `joint.individuals.confirmed_no_us_tax_id` (boolean, optional) The identification method for an individual can only be a passport, driver's license, or other document if you've confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number). - `joint.individuals.date_of_birth` (string, required) The person's date of birth in YYYY-MM-DD format. - `joint.individuals.identification` (dictionary, required) A means of verifying the person's identity. - `joint.individuals.identification.drivers_license` (dictionary, optional) Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`. - `joint.individuals.identification.drivers_license.back_file_id` (string, optional) The identifier of the File containing the back of the driver's license. - `joint.individuals.identification.drivers_license.expiration_date` (string, required) The driver's license's expiration date in YYYY-MM-DD format. - `joint.individuals.identification.drivers_license.file_id` (string, required) The identifier of the File containing the front of the driver's license. - `joint.individuals.identification.drivers_license.state` (string, required) The state that issued the provided driver's license. - `joint.individuals.identification.method` (enum, required) A method that can be used to verify the individual's identity. Cases: * `social_security_number` (A social security number.) * `individual_taxpayer_identification_number` (An individual taxpayer identification number (ITIN).) * `passport` (A passport number.) * `drivers_license` (A driver's license number.) * `other` (Another identifying document.) - `joint.individuals.identification.number` (string, required) An identification number that can be used to verify the individual's identity, such as a social security number. - `joint.individuals.identification.other` (dictionary, optional) Information about the identification document provided. Required if `method` is equal to `other`. - `joint.individuals.identification.other.back_file_id` (string, optional) The identifier of the File containing the back of the document. Not every document has a reverse side. - `joint.individuals.identification.other.country` (string, required) The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`). - `joint.individuals.identification.other.description` (string, required) A description of the document submitted. - `joint.individuals.identification.other.expiration_date` (string, optional) The document's expiration date in YYYY-MM-DD format. - `joint.individuals.identification.other.file_id` (string, required) The identifier of the File containing the front of the document. - `joint.individuals.identification.passport` (dictionary, optional) Information about the passport used for identification. Required if `method` is equal to `passport`. - `joint.individuals.identification.passport.country` (string, required) The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`). - `joint.individuals.identification.passport.expiration_date` (string, required) The passport's expiration date in YYYY-MM-DD format. - `joint.individuals.identification.passport.file_id` (string, required) The identifier of the File containing the passport. - `joint.individuals.name` (string, required) The person's legal name. - `natural_person` (dictionary, optional) Details of the natural person entity to create. Required if `structure` is equal to `natural_person`. Natural people entities should be submitted with `social_security_number` or `individual_taxpayer_identification_number` identification methods. - `natural_person.address` (dictionary, required) The individual's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed. - `natural_person.address.city` (string, required) The city, district, town, or village of the address. - `natural_person.address.country` (string, required) The two-letter ISO 3166-1 alpha-2 code for the country of the address. - `natural_person.address.line1` (string, required) The first line of the address. This is usually the street number and street. - `natural_person.address.line2` (string, optional) The second line of the address. This might be the floor or room number. - `natural_person.address.state` (string, optional) The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. Required in certain countries. - `natural_person.address.zip` (string, optional) The ZIP or postal code of the address. Required in certain countries. - `natural_person.confirmed_no_us_tax_id` (boolean, optional) The identification method for an individual can only be a passport, driver's license, or other document if you've confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number). - `natural_person.date_of_birth` (string, required) The person's date of birth in YYYY-MM-DD format. - `natural_person.identification` (dictionary, required) A means of verifying the person's identity. - `natural_person.identification.drivers_license` (dictionary, optional) Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`. - `natural_person.identification.drivers_license.back_file_id` (string, optional) The identifier of the File containing the back of the driver's license. - `natural_person.identification.drivers_license.expiration_date` (string, required) The driver's license's expiration date in YYYY-MM-DD format. - `natural_person.identification.drivers_license.file_id` (string, required) The identifier of the File containing the front of the driver's license. - `natural_person.identification.drivers_license.state` (string, required) The state that issued the provided driver's license. - `natural_person.identification.method` (enum, required) A method that can be used to verify the individual's identity. Cases: * `social_security_number` (A social security number.) * `individual_taxpayer_identification_number` (An individual taxpayer identification number (ITIN).) * `passport` (A passport number.) * `drivers_license` (A driver's license number.) * `other` (Another identifying document.) - `natural_person.identification.number` (string, required) An identification number that can be used to verify the individual's identity, such as a social security number. - `natural_person.identification.other` (dictionary, optional) Information about the identification document provided. Required if `method` is equal to `other`. - `natural_person.identification.other.back_file_id` (string, optional) The identifier of the File containing the back of the document. Not every document has a reverse side. - `natural_person.identification.other.country` (string, required) The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`). - `natural_person.identification.other.description` (string, required) A description of the document submitted. - `natural_person.identification.other.expiration_date` (string, optional) The document's expiration date in YYYY-MM-DD format. - `natural_person.identification.other.file_id` (string, required) The identifier of the File containing the front of the document. - `natural_person.identification.passport` (dictionary, optional) Information about the passport used for identification. Required if `method` is equal to `passport`. - `natural_person.identification.passport.country` (string, required) The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`). - `natural_person.identification.passport.expiration_date` (string, required) The passport's expiration date in YYYY-MM-DD format. - `natural_person.identification.passport.file_id` (string, required) The identifier of the File containing the passport. - `natural_person.name` (string, required) The person's legal name. - `risk_rating` (dictionary, optional) An assessment of the entity's potential risk of involvement in financial crimes, such as money laundering. - `risk_rating.rated_at` (string, required) The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk rating was performed. - `risk_rating.rating` (enum, required) The rating given to this entity. Cases: * `low` (Minimal risk of involvement in financial crime.) * `medium` (Moderate risk of involvement in financial crime.) * `high` (Elevated risk of involvement in financial crime.) - `structure` (enum, required) The type of Entity to create. Cases: * `corporation` (A corporation.) * `natural_person` (An individual person.) * `joint` (Multiple individual people.) * `trust` (A trust.) * `government_authority` (A government authority.) - `supplemental_documents` (array of objects, optional) Additional documentation associated with the entity. - `supplemental_documents.file_id` (string, required) The identifier of the File containing the document. - `terms_agreements` (array of objects, optional) The terms that the Entity agreed to. Not all programs are required to submit this data. - `terms_agreements.agreed_at` (string, required) The timestamp of when the Entity agreed to the terms. - `terms_agreements.ip_address` (string, required) The IP address the Entity accessed reviewed the terms from. - `terms_agreements.terms_url` (string, required) The URL of the terms agreement. This link will be provided by your bank partner. - `third_party_verification` (dictionary, optional) 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. - `third_party_verification.reference` (string, required) The reference identifier for the third party verification. - `third_party_verification.vendor` (enum, required) The vendor that was used to perform the verification. Cases: * `alloy` (Alloy. See https://alloy.com for more information.) * `middesk` (Middesk. See https://middesk.com for more information.) * `oscilar` (Oscilar. See https://oscilar.com for more information.) * `persona` (Persona. See https://withpersona.com for more information.) * `taktile` (Taktile. See https://taktile.com for more information.) - `trust` (dictionary, optional) Details of the trust entity to create. Required if `structure` is equal to `trust`. - `trust.address` (dictionary, required) The trust's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed. - `trust.address.city` (string, required) The city of the address. - `trust.address.line1` (string, required) The first line of the address. This is usually the street number and street. - `trust.address.line2` (string, optional) The second line of the address. This might be the floor or room number. - `trust.address.state` (string, required) The two-letter United States Postal Service (USPS) abbreviation for the state of the address. - `trust.address.zip` (string, required) The ZIP code of the address. - `trust.category` (enum, required) Whether the trust is `revocable` or `irrevocable`. Irrevocable trusts require their own Employer Identification Number. Revocable trusts require information about the individual `grantor` who created the trust. Cases: * `revocable` (The trust is revocable by the grantor.) * `irrevocable` (The trust cannot be revoked.) - `trust.formation_document_file_id` (string, optional) The identifier of the File containing the formation document of the trust. - `trust.formation_state` (string, optional) The two-letter United States Postal Service (USPS) abbreviation for the state in which the trust was formed. - `trust.grantor` (dictionary, optional) The grantor of the trust. Required if `category` is equal to `revocable`. - `trust.grantor.address` (dictionary, required) The individual's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed. - `trust.grantor.address.city` (string, required) The city, district, town, or village of the address. - `trust.grantor.address.country` (string, required) The two-letter ISO 3166-1 alpha-2 code for the country of the address. - `trust.grantor.address.line1` (string, required) The first line of the address. This is usually the street number and street. - `trust.grantor.address.line2` (string, optional) The second line of the address. This might be the floor or room number. - `trust.grantor.address.state` (string, optional) The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. Required in certain countries. - `trust.grantor.address.zip` (string, optional) The ZIP or postal code of the address. Required in certain countries. - `trust.grantor.confirmed_no_us_tax_id` (boolean, optional) The identification method for an individual can only be a passport, driver's license, or other document if you've confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number). - `trust.grantor.date_of_birth` (string, required) The person's date of birth in YYYY-MM-DD format. - `trust.grantor.identification` (dictionary, required) A means of verifying the person's identity. - `trust.grantor.identification.drivers_license` (dictionary, optional) Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`. - `trust.grantor.identification.drivers_license.back_file_id` (string, optional) The identifier of the File containing the back of the driver's license. - `trust.grantor.identification.drivers_license.expiration_date` (string, required) The driver's license's expiration date in YYYY-MM-DD format. - `trust.grantor.identification.drivers_license.file_id` (string, required) The identifier of the File containing the front of the driver's license. - `trust.grantor.identification.drivers_license.state` (string, required) The state that issued the provided driver's license. - `trust.grantor.identification.method` (enum, required) A method that can be used to verify the individual's identity. Cases: * `social_security_number` (A social security number.) * `individual_taxpayer_identification_number` (An individual taxpayer identification number (ITIN).) * `passport` (A passport number.) * `drivers_license` (A driver's license number.) * `other` (Another identifying document.) - `trust.grantor.identification.number` (string, required) An identification number that can be used to verify the individual's identity, such as a social security number. - `trust.grantor.identification.other` (dictionary, optional) Information about the identification document provided. Required if `method` is equal to `other`. - `trust.grantor.identification.other.back_file_id` (string, optional) The identifier of the File containing the back of the document. Not every document has a reverse side. - `trust.grantor.identification.other.country` (string, required) The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`). - `trust.grantor.identification.other.description` (string, required) A description of the document submitted. - `trust.grantor.identification.other.expiration_date` (string, optional) The document's expiration date in YYYY-MM-DD format. - `trust.grantor.identification.other.file_id` (string, required) The identifier of the File containing the front of the document. - `trust.grantor.identification.passport` (dictionary, optional) Information about the passport used for identification. Required if `method` is equal to `passport`. - `trust.grantor.identification.passport.country` (string, required) The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`). - `trust.grantor.identification.passport.expiration_date` (string, required) The passport's expiration date in YYYY-MM-DD format. - `trust.grantor.identification.passport.file_id` (string, required) The identifier of the File containing the passport. - `trust.grantor.name` (string, required) The person's legal name. - `trust.name` (string, required) The legal name of the trust. - `trust.tax_identifier` (string, optional) The Employer Identification Number (EIN) for the trust. Required if `category` is equal to `irrevocable`. - `trust.trustees` (array of objects, required) The trustees of the trust. - `trust.trustees.individual` (dictionary, optional) Details of the individual trustee. Within the trustee object, this is required if `structure` is equal to `individual`. - `trust.trustees.individual.address` (dictionary, required) The individual's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed. - `trust.trustees.individual.address.city` (string, required) The city, district, town, or village of the address. - `trust.trustees.individual.address.country` (string, required) The two-letter ISO 3166-1 alpha-2 code for the country of the address. - `trust.trustees.individual.address.line1` (string, required) The first line of the address. This is usually the street number and street. - `trust.trustees.individual.address.line2` (string, optional) The second line of the address. This might be the floor or room number. - `trust.trustees.individual.address.state` (string, optional) The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. Required in certain countries. - `trust.trustees.individual.address.zip` (string, optional) The ZIP or postal code of the address. Required in certain countries. - `trust.trustees.individual.confirmed_no_us_tax_id` (boolean, optional) The identification method for an individual can only be a passport, driver's license, or other document if you've confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number). - `trust.trustees.individual.date_of_birth` (string, required) The person's date of birth in YYYY-MM-DD format. - `trust.trustees.individual.identification` (dictionary, required) A means of verifying the person's identity. - `trust.trustees.individual.identification.drivers_license` (dictionary, optional) Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`. - `trust.trustees.individual.identification.drivers_license.back_file_id` (string, optional) The identifier of the File containing the back of the driver's license. - `trust.trustees.individual.identification.drivers_license.expiration_date` (string, required) The driver's license's expiration date in YYYY-MM-DD format. - `trust.trustees.individual.identification.drivers_license.file_id` (string, required) The identifier of the File containing the front of the driver's license. - `trust.trustees.individual.identification.drivers_license.state` (string, required) The state that issued the provided driver's license. - `trust.trustees.individual.identification.method` (enum, required) A method that can be used to verify the individual's identity. Cases: * `social_security_number` (A social security number.) * `individual_taxpayer_identification_number` (An individual taxpayer identification number (ITIN).) * `passport` (A passport number.) * `drivers_license` (A driver's license number.) * `other` (Another identifying document.) - `trust.trustees.individual.identification.number` (string, required) An identification number that can be used to verify the individual's identity, such as a social security number. - `trust.trustees.individual.identification.other` (dictionary, optional) Information about the identification document provided. Required if `method` is equal to `other`. - `trust.trustees.individual.identification.other.back_file_id` (string, optional) The identifier of the File containing the back of the document. Not every document has a reverse side. - `trust.trustees.individual.identification.other.country` (string, required) The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`). - `trust.trustees.individual.identification.other.description` (string, required) A description of the document submitted. - `trust.trustees.individual.identification.other.expiration_date` (string, optional) The document's expiration date in YYYY-MM-DD format. - `trust.trustees.individual.identification.other.file_id` (string, required) The identifier of the File containing the front of the document. - `trust.trustees.individual.identification.passport` (dictionary, optional) Information about the passport used for identification. Required if `method` is equal to `passport`. - `trust.trustees.individual.identification.passport.country` (string, required) The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`). - `trust.trustees.individual.identification.passport.expiration_date` (string, required) The passport's expiration date in YYYY-MM-DD format. - `trust.trustees.individual.identification.passport.file_id` (string, required) The identifier of the File containing the passport. - `trust.trustees.individual.name` (string, required) The person's legal name. - `trust.trustees.structure` (enum, required) The structure of the trustee. Cases: * `individual` (The trustee is an individual.) ## Retrieve an Entity GET /entities/{entity_id} ### Example ```curl curl \ --url "${INCREASE_URL}/entities/entity_n8y8tnk2p9339ti393yi" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" ``` ### Path Parameters - `entity_id` (string, required) The identifier of the Entity to retrieve. ## Update an Entity PATCH /entities/{entity_id} ### Example ```curl curl -X "PATCH" \ --url "${INCREASE_URL}/entities/entity_n8y8tnk2p9339ti393yi" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "corporation": { "address": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": "Unit 2", "state": "NY", "zip": "10045" } }, "risk_rating": { "rated_at": "2020-01-31T23:59:59Z", "rating": "low" } }' ``` ### Path Parameters - `entity_id` (string, required) The entity identifier. ### Body Parameters - `corporation` (dictionary, optional) Details of the corporation entity to update. If you specify this parameter and the entity is not a corporation, the request will fail. - `corporation.address` (dictionary, optional) The entity's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed. - `corporation.address.city` (string, required) The city, district, town, or village of the address. - `corporation.address.country` (string, required) The two-letter ISO 3166-1 alpha-2 code for the country of the address. - `corporation.address.line1` (string, required) The first line of the address. This is usually the street number and street. - `corporation.address.line2` (string, optional) The second line of the address. This might be the floor or room number. - `corporation.address.state` (string, optional) The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. Required in certain countries. - `corporation.address.zip` (string, optional) The ZIP or postal code of the address. Required in certain countries. - `corporation.email` (string, optional) An email address for the business. Not every program requires an email for submitted Entities. - `corporation.incorporation_state` (string, optional) The two-letter United States Postal Service (USPS) abbreviation for the corporation's state of incorporation. - `corporation.industry_code` (string, optional) The North American Industry Classification System (NAICS) code for the corporation's primary line of business. This is a number, like `5132` for `Software Publishers`. A full list of classification codes is available [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes). - `corporation.legal_identifier` (dictionary, optional) The legal identifier of the corporation. This is usually the Employer Identification Number (EIN). - `corporation.legal_identifier.category` (enum, optional) The category of the legal identifier. Cases: * `us_employer_identification_number` (The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS.) * `other` (A legal identifier issued by a foreign government, like a tax identification number or registration number.) - `corporation.legal_identifier.value` (string, required) The identifier of the legal identifier. - `corporation.name` (string, optional) The legal name of the corporation. - `details_confirmed_at` (string, optional) When your user last confirmed the Entity's details. Depending on your program, you may be required to affirmatively confirm details with your users on an annual basis. - `government_authority` (dictionary, optional) Details of the government authority entity to update. If you specify this parameter and the entity is not a government authority, the request will fail. - `government_authority.address` (dictionary, optional) The entity's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed. - `government_authority.address.city` (string, required) The city of the address. - `government_authority.address.line1` (string, required) The first line of the address. This is usually the street number and street. - `government_authority.address.line2` (string, optional) The second line of the address. This might be the floor or room number. - `government_authority.address.state` (string, required) The two-letter United States Postal Service (USPS) abbreviation for the state of the address. - `government_authority.address.zip` (string, required) The ZIP code of the address. - `government_authority.name` (string, optional) The legal name of the government authority. - `natural_person` (dictionary, optional) Details of the natural person entity to update. If you specify this parameter and the entity is not a natural person, the request will fail. - `natural_person.address` (dictionary, optional) The entity's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed. - `natural_person.address.city` (string, required) The city, district, town, or village of the address. - `natural_person.address.country` (string, required) The two-letter ISO 3166-1 alpha-2 code for the country of the address. - `natural_person.address.line1` (string, required) The first line of the address. This is usually the street number and street. - `natural_person.address.line2` (string, optional) The second line of the address. This might be the floor or room number. - `natural_person.address.state` (string, optional) The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. Required in certain countries. - `natural_person.address.zip` (string, optional) The ZIP or postal code of the address. Required in certain countries. - `natural_person.confirmed_no_us_tax_id` (boolean, optional) The identification method for an individual can only be a passport, driver's license, or other document if you've confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number). - `natural_person.identification` (dictionary, optional) A means of verifying the person's identity. - `natural_person.identification.drivers_license` (dictionary, optional) Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`. - `natural_person.identification.drivers_license.back_file_id` (string, optional) The identifier of the File containing the back of the driver's license. - `natural_person.identification.drivers_license.expiration_date` (string, required) The driver's license's expiration date in YYYY-MM-DD format. - `natural_person.identification.drivers_license.file_id` (string, required) The identifier of the File containing the front of the driver's license. - `natural_person.identification.drivers_license.state` (string, required) The state that issued the provided driver's license. - `natural_person.identification.method` (enum, required) A method that can be used to verify the individual's identity. Cases: * `social_security_number` (A social security number.) * `individual_taxpayer_identification_number` (An individual taxpayer identification number (ITIN).) * `passport` (A passport number.) * `drivers_license` (A driver's license number.) * `other` (Another identifying document.) - `natural_person.identification.number` (string, required) An identification number that can be used to verify the individual's identity, such as a social security number. - `natural_person.identification.other` (dictionary, optional) Information about the identification document provided. Required if `method` is equal to `other`. - `natural_person.identification.other.back_file_id` (string, optional) The identifier of the File containing the back of the document. Not every document has a reverse side. - `natural_person.identification.other.country` (string, required) The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`). - `natural_person.identification.other.description` (string, required) A description of the document submitted. - `natural_person.identification.other.expiration_date` (string, optional) The document's expiration date in YYYY-MM-DD format. - `natural_person.identification.other.file_id` (string, required) The identifier of the File containing the front of the document. - `natural_person.identification.passport` (dictionary, optional) Information about the passport used for identification. Required if `method` is equal to `passport`. - `natural_person.identification.passport.country` (string, required) The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`). - `natural_person.identification.passport.expiration_date` (string, required) The passport's expiration date in YYYY-MM-DD format. - `natural_person.identification.passport.file_id` (string, required) The identifier of the File containing the passport. - `natural_person.name` (string, optional) The legal name of the natural person. - `risk_rating` (dictionary, optional) An assessment of the entity’s potential risk of involvement in financial crimes, such as money laundering. - `risk_rating.rated_at` (string, required) The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk rating was performed. - `risk_rating.rating` (enum, required) The rating given to this entity. Cases: * `low` (Minimal risk of involvement in financial crime.) * `medium` (Moderate risk of involvement in financial crime.) * `high` (Elevated risk of involvement in financial crime.) - `terms_agreements` (array of objects, optional) New terms that the Entity agreed to. Not all programs are required to submit this data. This will not archive previously submitted terms. - `terms_agreements.agreed_at` (string, required) The timestamp of when the Entity agreed to the terms. - `terms_agreements.ip_address` (string, required) The IP address the Entity accessed reviewed the terms from. - `terms_agreements.terms_url` (string, required) The URL of the terms agreement. This link will be provided by your bank partner. - `third_party_verification` (dictionary, optional) 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. - `third_party_verification.reference` (string, required) The reference identifier for the third party verification. - `third_party_verification.vendor` (enum, required) The vendor that was used to perform the verification. Cases: * `alloy` (Alloy. See https://alloy.com for more information.) * `middesk` (Middesk. See https://middesk.com for more information.) * `oscilar` (Oscilar. See https://oscilar.com for more information.) * `persona` (Persona. See https://withpersona.com for more information.) * `taktile` (Taktile. See https://taktile.com for more information.) - `trust` (dictionary, optional) Details of the trust entity to update. If you specify this parameter and the entity is not a trust, the request will fail. - `trust.address` (dictionary, optional) The entity's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed. - `trust.address.city` (string, required) The city of the address. - `trust.address.line1` (string, required) The first line of the address. This is usually the street number and street. - `trust.address.line2` (string, optional) The second line of the address. This might be the floor or room number. - `trust.address.state` (string, required) The two-letter United States Postal Service (USPS) abbreviation for the state of the address. - `trust.address.zip` (string, required) The ZIP code of the address. - `trust.name` (string, optional) The legal name of the trust. ## Archive an Entity POST /entities/{entity_id}/archive ### Example ```curl curl -X "POST" \ --url "${INCREASE_URL}/entities/entity_n8y8tnk2p9339ti393yi/archive" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" ``` ### Path Parameters - `entity_id` (string, required) The identifier of the Entity to archive. Any accounts associated with an entity must be closed before the entity can be archived.