modern-treasury 3.3.0 → 4.4.2

package/src/resources/legal-entity-associations.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
+import * as DocumentsAPI from './documents';
 import * as Shared from './shared';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
@@ -17,130 +18,357 @@ export class LegalEntityAssociations extends APIResource {
   }
 }
 
-export interface LegalEntityAssociation {
+export interface ChildLegalEntity {
   id: string;
 
   /**
-   * The child legal entity.
+   * A list of addresses for the entity.
+   */
+  addresses: Array<ChildLegalEntity.Address>;
+
+  bank_settings: ChildLegalEntity.BankSettings | null;
+
+  /**
+   * A description of the business.
+   */
+  business_description: string | null;
+
+  /**
+   * The business's legal business name.
+   */
+  business_name: string | null;
+
+  /**
+   * The country of citizenship for an individual.
    */
-  child_legal_entity: LegalEntityAssociation.ChildLegalEntity;
+  citizenship_country: string | null;
+
+  /**
+   * @deprecated
+   */
+  compliance_details: unknown | null;
+
+  /**
+   * The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
+   * alpha-3 formats.
+   */
+  country_of_incorporation: string | null;
 
   created_at: string;
 
+  /**
+   * A business's formation date (YYYY-MM-DD).
+   */
+  date_formed: string | null;
+
+  /**
+   * An individual's date of birth (YYYY-MM-DD).
+   */
+  date_of_birth: string | null;
+
   discarded_at: string | null;
 
+  documents: Array<DocumentsAPI.Document>;
+
+  doing_business_as_names: Array<string>;
+
+  /**
+   * The entity's primary email.
+   */
+  email: string | null;
+
+  /**
+   * Monthly expected transaction volume in USD.
+   */
+  expected_activity_volume: number | null;
+
+  /**
+   * An optional user-defined 180 character unique identifier.
+   */
+  external_id: string | null;
+
+  /**
+   * An individual's first name.
+   */
+  first_name: string | null;
+
+  /**
+   * A list of identifications for the legal entity.
+   */
+  identifications: Array<ChildLegalEntity.Identification>;
+
+  /**
+   * A list of industry classifications for the legal entity.
+   */
+  industry_classifications: Array<Shared.LegalEntityIndustryClassification>;
+
+  /**
+   * A description of the intended use of the legal entity.
+   */
+  intended_use: string | null;
+
+  /**
+   * An individual's last name.
+   */
+  last_name: string | null;
+
+  /**
+   * The legal entity associations and its child legal entities.
+   */
+  legal_entity_associations: Array<LegalEntityAssociation> | null;
+
+  /**
+   * The type of legal entity.
+   */
+  legal_entity_type: 'business' | 'individual' | 'joint';
+
+  /**
+   * The business's legal structure.
+   */
+  legal_structure:
+    | 'corporation'
+    | 'llc'
+    | 'non_profit'
+    | 'partnership'
+    | 'sole_proprietorship'
+    | 'trust'
+    | null;
+
+  /**
+   * ISO 10383 market identifier code.
+   */
+  listed_exchange: string | null;
+
   /**
    * This field will be true if this object exists in the live environment or false
    * if it exists in the test environment.
    */
   live_mode: boolean;
 
+  /**
+   * Additional data represented as key-value pairs. Both the key and value must be
+   * strings.
+   */
+  metadata: { [key: string]: string };
+
+  /**
+   * An individual's middle name.
+   */
+  middle_name: string | null;
+
   object: string;
 
   /**
-   * The child entity's ownership percentage iff they are a beneficial owner.
+   * A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
+   * codes).
    */
-  ownership_percentage: number | null;
+  operating_jurisdictions: Array<string>;
+
+  phone_numbers: Array<ChildLegalEntity.PhoneNumber>;
 
   /**
-   * The ID of the parent legal entity. This must be a business or joint legal
-   * entity.
+   * Whether the individual is a politically exposed person.
    */
-  parent_legal_entity_id: string;
+  politically_exposed_person: boolean | null;
 
-  relationship_types: Array<'authorized_signer' | 'beneficial_owner' | 'control_person'>;
+  /**
+   * An individual's preferred name.
+   */
+  preferred_name: string | null;
 
   /**
-   * The job title of the child entity at the parent entity.
+   * An individual's prefix.
    */
-  title: string | null;
+  prefix: string | null;
+
+  /**
+   * A list of primary social media URLs for the business.
+   */
+  primary_social_media_sites: Array<string>;
+
+  /**
+   * Array of regulatory bodies overseeing this institution.
+   */
+  regulators: Array<ChildLegalEntity.Regulator> | null;
+
+  /**
+   * The risk rating of the legal entity. One of low, medium, high.
+   */
+  risk_rating: 'low' | 'medium' | 'high' | null;
+
+  /**
+   * The activation status of the legal entity. One of pending, active, suspended, or
+   * closed.
+   */
+  status: 'active' | 'closed' | 'pending' | 'suspended' | null;
+
+  /**
+   * An individual's suffix.
+   */
+  suffix: string | null;
+
+  /**
+   * Information describing a third-party verification run by an external vendor.
+   */
+  third_party_verification: ChildLegalEntity.ThirdPartyVerification | null;
+
+  /**
+   * Stock ticker symbol for publicly traded companies.
+   */
+  ticker_symbol: string | null;
 
   updated_at: string;
-}
 
-export namespace LegalEntityAssociation {
+  wealth_and_employment_details: ChildLegalEntity.WealthAndEmploymentDetails | null;
+
   /**
-   * The child legal entity.
+   * The entity's primary website URL.
    */
-  export interface ChildLegalEntity {
+  website: string | null;
+}
+
+export namespace ChildLegalEntity {
+  export interface Address {
     id: string;
 
     /**
-     * A list of addresses for the entity.
+     * The types of this address.
+     */
+    address_types: Array<'business' | 'mailing' | 'other' | 'po_box' | 'residential'>;
+
+    /**
+     * Country code conforms to [ISO 3166-1 alpha-2]
      */
-    addresses: Array<ChildLegalEntity.Address>;
+    country: string | null;
+
+    created_at: string;
 
-    bank_settings: ChildLegalEntity.BankSettings | null;
+    discarded_at: string | null;
+
+    line1: string | null;
+
+    line2: string | null;
 
     /**
-     * The business's legal business name.
+     * This field will be true if this object exists in the live environment or false
+     * if it exists in the test environment.
      */
-    business_name: string | null;
+    live_mode: boolean;
 
     /**
-     * The country of citizenship for an individual.
+     * Locality or City.
      */
-    citizenship_country: string | null;
+    locality: string | null;
 
-    compliance_details: Shared.LegalEntityComplianceDetail | null;
+    object: string;
 
-    created_at: string;
+    /**
+     * The postal code of the address.
+     */
+    postal_code: string | null;
 
     /**
-     * A business's formation date (YYYY-MM-DD).
+     * Region or State.
      */
-    date_formed: string | null;
+    region: string | null;
+
+    updated_at: string;
+  }
+
+  export interface BankSettings {
+    id: string;
 
     /**
-     * An individual's date of birth (YYYY-MM-DD).
+     * The percentage of backup withholding to apply to the legal entity.
      */
-    date_of_birth: string | null;
+    backup_withholding_percentage: number | null;
+
+    created_at: string;
 
     discarded_at: string | null;
 
-    doing_business_as_names: Array<string>;
+    /**
+     * Whether backup withholding is enabled. See more here -
+     * https://www.irs.gov/businesses/small-businesses-self-employed/backup-withholding.
+     */
+    enable_backup_withholding: boolean | null;
 
     /**
-     * The entity's primary email.
+     * This field will be true if this object exists in the live environment or false
+     * if it exists in the test environment.
      */
-    email: string | null;
+    live_mode: boolean;
+
+    object: string;
 
     /**
-     * An individual's first name.
+     * Cross River Bank specific setting to opt out of privacy policy.
      */
-    first_name: string | null;
+    privacy_opt_out: boolean | null;
 
     /**
-     * A list of identifications for the legal entity.
+     * It covers, among other types of insider loans, extensions of credit by a member
+     * bank to an executive officer, director, or principal shareholder of the member
+     * bank; a bank holding company of which the member bank is a subsidiary; and any
+     * other subsidiary of that bank holding company.
      */
-    identifications: Array<ChildLegalEntity.Identification>;
+    regulation_o: boolean | null;
+
+    updated_at: string;
+  }
+
+  export interface Identification {
+    id: string;
+
+    created_at: string;
+
+    discarded_at: string | null;
+
+    documents: Array<DocumentsAPI.Document>;
 
     /**
-     * A list of industry classifications for the legal entity.
+     * The date when the Identification is no longer considered valid by the issuing
+     * authority.
      */
-    industry_classifications: Array<Shared.LegalEntityIndustryClassification>;
+    expiration_date: string | null;
 
     /**
-     * An individual's last name.
+     * The type of ID number.
      */
-    last_name: string | null;
+    id_type:
+      | 'ar_cuil'
+      | 'ar_cuit'
+      | 'br_cnpj'
+      | 'br_cpf'
+      | 'cl_run'
+      | 'cl_rut'
+      | 'co_cedulas'
+      | 'co_nit'
+      | 'drivers_license'
+      | 'hn_id'
+      | 'hn_rtn'
+      | 'in_lei'
+      | 'kr_brn'
+      | 'kr_crn'
+      | 'kr_rrn'
+      | 'passport'
+      | 'sa_tin'
+      | 'sa_vat'
+      | 'us_ein'
+      | 'us_itin'
+      | 'us_ssn'
+      | 'vn_tin';
 
     /**
-     * The type of legal entity.
+     * The ISO 3166-1 alpha-2 country code of the country that issued the
+     * identification
      */
-    legal_entity_type: 'business' | 'individual' | 'joint';
+    issuing_country: string | null;
 
     /**
-     * The business's legal structure.
+     * The region in which the identifcation was issued.
      */
-    legal_structure:
-      | 'corporation'
-      | 'llc'
-      | 'non_profit'
-      | 'partnership'
-      | 'sole_proprietorship'
-      | 'trust'
-      | null;
+    issuing_region: string | null;
 
     /**
      * This field will be true if this object exists in the live environment or false
@@ -148,380 +376,263 @@ export namespace LegalEntityAssociation {
      */
     live_mode: boolean;
 
+    object: string;
+
+    updated_at: string;
+  }
+
+  /**
+   * A list of phone numbers in E.164 format.
+   */
+  export interface PhoneNumber {
+    phone_number?: string;
+  }
+
+  export interface Regulator {
     /**
-     * Additional data represented as key-value pairs. Both the key and value must be
-     * strings.
+     * The country code where the regulator operates in the ISO 3166-1 alpha-2 format
+     * (e.g., "US", "CA", "GB").
      */
-    metadata: { [key: string]: string };
+    jurisdiction: string;
 
     /**
-     * An individual's middle name.
+     * Full name of the regulatory body.
      */
-    middle_name: string | null;
+    name: string;
 
-    object: string;
+    /**
+     * Registration or identification number with the regulator.
+     */
+    registration_number: string;
+  }
+
+  /**
+   * Information describing a third-party verification run by an external vendor.
+   */
+  export interface ThirdPartyVerification {
+    /**
+     * The vendor that performed the verification, e.g. `persona`.
+     */
+    vendor: 'persona';
+
+    /**
+     * The identification of the third party verification in `vendor`'s system.
+     */
+    vendor_verification_id: string;
+  }
 
-    phone_numbers: Array<ChildLegalEntity.PhoneNumber>;
+  export interface WealthAndEmploymentDetails {
+    id: string;
 
     /**
-     * Whether the individual is a politically exposed person.
+     * The annual income of the individual in USD.
      */
-    politically_exposed_person: boolean | null;
+    annual_income: number | null;
+
+    created_at: string;
+
+    discarded_at: string | null;
 
     /**
-     * An individual's preferred name.
+     * The country in which the employer is located.
      */
-    preferred_name: string | null;
+    employer_country: string | null;
 
     /**
-     * An individual's prefix.
+     * The name of the employer.
      */
-    prefix: string | null;
+    employer_name: string | null;
 
     /**
-     * The risk rating of the legal entity. One of low, medium, high.
+     * The state in which the employer is located.
      */
-    risk_rating: 'low' | 'medium' | 'high' | null;
+    employer_state: string | null;
 
     /**
-     * An individual's suffix.
+     * The employment status of the individual.
      */
-    suffix: string | null;
+    employment_status: 'employed' | 'retired' | 'self_employed' | 'student' | 'unemployed' | null;
 
-    updated_at: string;
+    /**
+     * The country in which the individual's income is earned.
+     */
+    income_country: string | null;
 
-    wealth_and_employment_details: ChildLegalEntity.WealthAndEmploymentDetails | null;
+    /**
+     * The source of the individual's income.
+     */
+    income_source:
+      | 'family_support'
+      | 'government_benefits'
+      | 'inheritance'
+      | 'investments'
+      | 'rental_income'
+      | 'retirement'
+      | 'salary'
+      | 'self_employed'
+      | null;
 
     /**
-     * The entity's primary website URL.
+     * The state in which the individual's income is earned.
      */
-    website: string | null;
-  }
+    income_state: string | null;
+
+    /**
+     * The industry of the individual.
+     */
+    industry:
+      | 'accounting'
+      | 'agriculture'
+      | 'automotive'
+      | 'chemical_manufacturing'
+      | 'construction'
+      | 'educational_medical'
+      | 'food_service'
+      | 'finance'
+      | 'gasoline'
+      | 'health_stores'
+      | 'laundry'
+      | 'maintenance'
+      | 'manufacturing'
+      | 'merchant_wholesale'
+      | 'mining'
+      | 'performing_arts'
+      | 'professional_non_legal'
+      | 'public_administration'
+      | 'publishing'
+      | 'real_estate'
+      | 'recreation_gambling'
+      | 'religious_charity'
+      | 'rental_services'
+      | 'retail_clothing'
+      | 'retail_electronics'
+      | 'retail_food'
+      | 'retail_furnishing'
+      | 'retail_home'
+      | 'retail_non_store'
+      | 'retail_sporting'
+      | 'transportation'
+      | 'travel'
+      | 'utilities'
+      | null;
 
-  export namespace ChildLegalEntity {
-    export interface Address {
-      id: string;
+    /**
+     * This field will be true if this object exists in the live environment or false
+     * if it exists in the test environment.
+     */
+    live_mode: boolean;
 
-      /**
-       * The types of this address.
-       */
-      address_types: Array<'business' | 'mailing' | 'other' | 'po_box' | 'residential'>;
+    object: string;
+
+    /**
+     * The occupation of the individual.
+     */
+    occupation:
+      | 'consulting'
+      | 'executive'
+      | 'finance_accounting'
+      | 'food_services'
+      | 'government'
+      | 'healthcare'
+      | 'legal_services'
+      | 'manufacturing'
+      | 'other'
+      | 'sales'
+      | 'science_engineering'
+      | 'technology'
+      | null;
+
+    /**
+     * The source of the individual's funds.
+     */
+    source_of_funds:
+      | 'alimony'
+      | 'annuity'
+      | 'business_owner'
+      | 'business_revenue'
+      | 'debt_financing'
+      | 'general_employee'
+      | 'government_benefits'
+      | 'homemaker'
+      | 'inheritance_gift'
+      | 'intercompany_loan'
+      | 'investment'
+      | 'investor_funding'
+      | 'legal_settlement'
+      | 'lottery'
+      | 'real_estate'
+      | 'retained_earnings_or_savings'
+      | 'retired'
+      | 'retirement'
+      | 'salary'
+      | 'sale_of_business_assets'
+      | 'sale_of_real_estate'
+      | 'self_employed'
+      | 'senior_executive'
+      | 'trust_income'
+      | null;
 
-      /**
-       * Country code conforms to [ISO 3166-1 alpha-2]
-       */
-      country: string | null;
+    updated_at: string;
 
-      created_at: string;
-
-      discarded_at: string | null;
-
-      line1: string | null;
-
-      line2: string | null;
-
-      /**
-       * This field will be true if this object exists in the live environment or false
-       * if it exists in the test environment.
-       */
-      live_mode: boolean;
-
-      /**
-       * Locality or City.
-       */
-      locality: string | null;
-
-      object: string;
-
-      /**
-       * The postal code of the address.
-       */
-      postal_code: string | null;
-
-      /**
-       * Region or State.
-       */
-      region: string | null;
-
-      updated_at: string;
-    }
-
-    export interface BankSettings {
-      id: string;
-
-      /**
-       * The percentage of backup withholding to apply to the legal entity.
-       */
-      backup_withholding_percentage: number | null;
-
-      created_at: string;
-
-      discarded_at: string | null;
-
-      /**
-       * Whether backup withholding is enabled. See more here -
-       * https://www.irs.gov/businesses/small-businesses-self-employed/backup-withholding.
-       */
-      enable_backup_withholding: boolean | null;
-
-      /**
-       * This field will be true if this object exists in the live environment or false
-       * if it exists in the test environment.
-       */
-      live_mode: boolean;
-
-      object: string;
-
-      /**
-       * Cross River Bank specific setting to opt out of privacy policy.
-       */
-      privacy_opt_out: boolean | null;
-
-      /**
-       * It covers, among other types of insider loans, extensions of credit by a member
-       * bank to an executive officer, director, or principal shareholder of the member
-       * bank; a bank holding company of which the member bank is a subsidiary; and any
-       * other subsidiary of that bank holding company.
-       */
-      regulation_o: boolean | null;
-
-      updated_at: string;
-    }
-
-    export interface Identification {
-      id: string;
-
-      created_at: string;
-
-      discarded_at: string | null;
-
-      /**
-       * The date when the Identification is no longer considered valid by the issuing
-       * authority.
-       */
-      expiration_date: string | null;
-
-      /**
-       * The type of ID number.
-       */
-      id_type:
-        | 'ar_cuil'
-        | 'ar_cuit'
-        | 'br_cnpj'
-        | 'br_cpf'
-        | 'cl_run'
-        | 'cl_rut'
-        | 'co_cedulas'
-        | 'co_nit'
-        | 'drivers_license'
-        | 'hn_id'
-        | 'hn_rtn'
-        | 'in_lei'
-        | 'kr_brn'
-        | 'kr_crn'
-        | 'kr_rrn'
-        | 'passport'
-        | 'sa_tin'
-        | 'sa_vat'
-        | 'us_ein'
-        | 'us_itin'
-        | 'us_ssn'
-        | 'vn_tin';
-
-      /**
-       * The ISO 3166-1 alpha-2 country code of the country that issued the
-       * identification
-       */
-      issuing_country: string | null;
-
-      /**
-       * The region in which the identifcation was issued.
-       */
-      issuing_region: string | null;
-
-      /**
-       * This field will be true if this object exists in the live environment or false
-       * if it exists in the test environment.
-       */
-      live_mode: boolean;
-
-      object: string;
-
-      updated_at: string;
-    }
-
-    /**
-     * A list of phone numbers in E.164 format.
-     */
-    export interface PhoneNumber {
-      phone_number?: string;
-    }
-
-    export interface WealthAndEmploymentDetails {
-      id: string;
-
-      /**
-       * The annual income of the individual.
-       */
-      annual_income: number | null;
-
-      created_at: string;
-
-      discarded_at: string | null;
-
-      /**
-       * The country in which the employer is located.
-       */
-      employer_country: string | null;
-
-      /**
-       * The name of the employer.
-       */
-      employer_name: string | null;
-
-      /**
-       * The state in which the employer is located.
-       */
-      employer_state: string | null;
-
-      /**
-       * The employment status of the individual.
-       */
-      employment_status: 'employed' | 'retired' | 'self_employed' | 'student' | 'unemployed' | null;
-
-      /**
-       * The country in which the individual's income is earned.
-       */
-      income_country: string | null;
-
-      /**
-       * The source of the individual's income.
-       */
-      income_source:
-        | 'family_support'
-        | 'government_benefits'
-        | 'inheritance'
-        | 'investments'
-        | 'rental_income'
-        | 'retirement'
-        | 'salary'
-        | 'self_employed'
-        | null;
-
-      /**
-       * The state in which the individual's income is earned.
-       */
-      income_state: string | null;
-
-      /**
-       * The industry of the individual.
-       */
-      industry:
-        | 'accounting'
-        | 'agriculture'
-        | 'automotive'
-        | 'chemical_manufacturing'
-        | 'construction'
-        | 'educational_medical'
-        | 'food_service'
-        | 'finance'
-        | 'gasoline'
-        | 'health_stores'
-        | 'laundry'
-        | 'maintenance'
-        | 'manufacturing'
-        | 'merchant_wholesale'
-        | 'mining'
-        | 'performing_arts'
-        | 'professional_non_legal'
-        | 'public_administration'
-        | 'publishing'
-        | 'real_estate'
-        | 'recreation_gambling'
-        | 'religious_charity'
-        | 'rental_services'
-        | 'retail_clothing'
-        | 'retail_electronics'
-        | 'retail_food'
-        | 'retail_furnishing'
-        | 'retail_home'
-        | 'retail_non_store'
-        | 'retail_sporting'
-        | 'transportation'
-        | 'travel'
-        | 'utilities'
-        | null;
-
-      /**
-       * This field will be true if this object exists in the live environment or false
-       * if it exists in the test environment.
-       */
-      live_mode: boolean;
-
-      object: string;
-
-      /**
-       * The occupation of the individual.
-       */
-      occupation:
-        | 'consulting'
-        | 'executive'
-        | 'finance_accounting'
-        | 'food_services'
-        | 'government'
-        | 'healthcare'
-        | 'legal_services'
-        | 'manufacturing'
-        | 'other'
-        | 'sales'
-        | 'science_engineering'
-        | 'technology'
-        | null;
-
-      /**
-       * The source of the individual's funds.
-       */
-      source_of_funds:
-        | 'alimony'
-        | 'annuity'
-        | 'business_owner'
-        | 'general_employee'
-        | 'government_benefits'
-        | 'homemaker'
-        | 'inheritance_gift'
-        | 'investment'
-        | 'legal_settlement'
-        | 'lottery'
-        | 'real_estate'
-        | 'retired'
-        | 'retirement'
-        | 'salary'
-        | 'self_employed'
-        | 'senior_executive'
-        | 'trust_income'
-        | null;
-
-      updated_at: string;
-
-      /**
-       * The source of the individual's wealth.
-       */
-      wealth_source:
-        | 'business_sale'
-        | 'family_support'
-        | 'government_benefits'
-        | 'inheritance'
-        | 'investments'
-        | 'other'
-        | 'rental_income'
-        | 'retirement'
-        | 'salary'
-        | 'self_employed'
-        | null;
-    }
+    /**
+     * The source of the individual's wealth.
+     */
+    wealth_source:
+      | 'business_sale'
+      | 'family_support'
+      | 'government_benefits'
+      | 'inheritance'
+      | 'investments'
+      | 'other'
+      | 'rental_income'
+      | 'retirement'
+      | 'salary'
+      | 'self_employed'
+      | null;
   }
 }
 
+export interface LegalEntityAssociation {
+  id: string;
+
+  /**
+   * The child legal entity.
+   */
+  child_legal_entity: ChildLegalEntity;
+
+  created_at: string;
+
+  discarded_at: string | null;
+
+  /**
+   * This field will be true if this object exists in the live environment or false
+   * if it exists in the test environment.
+   */
+  live_mode: boolean;
+
+  object: string;
+
+  /**
+   * The child entity's ownership percentage iff they are a beneficial owner.
+   */
+  ownership_percentage: number | null;
+
+  /**
+   * The ID of the parent legal entity. This must be a business or joint legal
+   * entity.
+   */
+  parent_legal_entity_id: string;
+
+  relationship_types: Array<'authorized_signer' | 'beneficial_owner' | 'control_person'>;
+
+  /**
+   * The job title of the child entity at the parent entity.
+   */
+  title: string | null;
+
+  updated_at: string;
+}
+
 export interface LegalEntityAssociationCreateParams {
   /**
    * The ID of the parent legal entity. This must be a business or joint legal
@@ -554,6 +665,7 @@ export interface LegalEntityAssociationCreateParams {
 
 export declare namespace LegalEntityAssociations {
   export {
+    type ChildLegalEntity as ChildLegalEntity,
     type LegalEntityAssociation as LegalEntityAssociation,
     type LegalEntityAssociationCreateParams as LegalEntityAssociationCreateParams,
   };