Increase.Entities.Entity (Increase v1.0.0)

Copy Markdown View Source

Entities are the legal entities that own accounts. They can be people, corporations, partnerships, government authorities, or trusts. To learn more, see [Entities].

Fields

  • id - The entity's identifier.
  • corporation - Details of the corporation entity. Will be present if structure is equal to corporation.
  • created_at - The ISO 8601 time at which the Entity was created.
  • creating_entity_onboarding_session_id - The identifier of the Entity Onboarding Session that was used to create this Entity, if any.
  • description - The entity's description for display purposes.
  • details_confirmed_at - The ISO 8601 time at which the Entity's details were most recently confirmed.
  • government_authority - Details of the government authority entity. Will be present if structure is equal to government_authority.
  • idempotency_key - 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.
  • joint - Details of the joint entity. Will be present if structure is equal to joint.
  • natural_person - Details of the natural person entity. Will be present if structure is equal to natural_person.
  • risk_rating - An assessment of the entity’s potential risk of involvement in financial crimes, such as money laundering.
  • status - The status of the entity.
  • structure - The entity's legal structure.
  • supplemental_documents - 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.
  • terms_agreements - The terms that the Entity agreed to. Not all programs are required to submit this data.
  • third_party_verification - 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.
  • trust - Details of the trust entity. Will be present if structure is equal to trust.
  • type - A constant representing the object's type. For this resource it will always be entity.
  • validation - The validation results for the entity. Learn more about [validations].

Summary

Types

t()

Types

t()

@type t() :: %Increase.Entities.Entity{
  corporation: Increase.Entities.Entity.Corporation.t() | nil,
  created_at: DateTime.t(),
  creating_entity_onboarding_session_id: String.t() | nil,
  description: String.t() | nil,
  details_confirmed_at: DateTime.t() | nil,
  government_authority: Increase.Entities.Entity.GovernmentAuthority.t() | nil,
  id: String.t(),
  idempotency_key: String.t() | nil,
  joint: Increase.Entities.Entity.Joint.t() | nil,
  natural_person: Increase.Entities.Entity.NaturalPerson.t() | nil,
  risk_rating: Increase.Entities.Entity.RiskRating.t() | nil,
  status: String.t(),
  structure: String.t(),
  supplemental_documents: [
    Increase.SupplementalDocuments.EntitySupplementalDocument.t()
  ],
  terms_agreements: [Increase.Entities.Entity.TermsAgreement.t()],
  third_party_verification:
    Increase.Entities.Entity.ThirdPartyVerification.t() | nil,
  trust: Increase.Entities.Entity.Trust.t() | nil,
  type: String.t(),
  validation: Increase.Entities.Entity.Validation.t() | nil
}