modern-treasury 3.3.0 → 4.4.2

package/src/resources/legal-entities.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 LegalEntityAssociationsAPI from './legal-entity-associations';
 import * as Shared from './shared';
 import { APIPromise } from '../core/api-promise';
@@ -84,6 +85,11 @@ export interface LegalEntity {
 
   bank_settings: LegalEntity.BankSettings | null;
 
+  /**
+   * A description of the business.
+   */
+  business_description: string | null;
+
   /**
    * The business's legal business name.
    */
@@ -94,7 +100,16 @@ export interface LegalEntity {
    */
   citizenship_country: string | null;
 
-  compliance_details: Shared.LegalEntityComplianceDetail | 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;
 
@@ -110,6 +125,8 @@ export interface LegalEntity {
 
   discarded_at: string | null;
 
+  documents: Array<DocumentsAPI.Document>;
+
   doing_business_as_names: Array<string>;
 
   /**
@@ -117,6 +134,16 @@ export interface LegalEntity {
    */
   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.
    */
@@ -133,14 +160,14 @@ export interface LegalEntity {
   industry_classifications: Array<Shared.LegalEntityIndustryClassification>;
 
   /**
-   * An individual's last name.
+   * A description of the intended use of the legal entity.
    */
-  last_name: string | null;
+  intended_use: string | null;
 
   /**
-   * The legal entity associations and its child legal entities.
+   * An individual's last name.
    */
-  legal_entity_associations: Array<LegalEntityAssociationsAPI.LegalEntityAssociation> | null;
+  last_name: string | null;
 
   /**
    * The type of legal entity.
@@ -159,6 +186,11 @@ export interface LegalEntity {
     | '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.
@@ -178,6 +210,12 @@ export interface LegalEntity {
 
   object: string;
 
+  /**
+   * A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
+   * codes).
+   */
+  operating_jurisdictions: Array<string>;
+
   phone_numbers: Array<LegalEntity.PhoneNumber>;
 
   /**
@@ -195,16 +233,42 @@ export interface LegalEntity {
    */
   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<LegalEntity.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: LegalEntity.ThirdPartyVerification | null;
+
+  /**
+   * Stock ticker symbol for publicly traded companies.
+   */
+  ticker_symbol: string | null;
+
   updated_at: string;
 
   wealth_and_employment_details: LegalEntity.WealthAndEmploymentDetails | null;
@@ -213,6 +277,11 @@ export interface LegalEntity {
    * The entity's primary website URL.
    */
   website: string | null;
+
+  /**
+   * The legal entity associations and its child legal entities.
+   */
+  legal_entity_associations?: Array<LegalEntityAssociationsAPI.LegalEntityAssociation> | null;
 }
 
 export namespace LegalEntity {
@@ -312,6 +381,8 @@ export namespace LegalEntity {
 
     discarded_at: string | null;
 
+    documents: Array<DocumentsAPI.Document>;
+
     /**
      * The date when the Identification is no longer considered valid by the issuing
      * authority.
@@ -374,11 +445,44 @@ export namespace LegalEntity {
     phone_number?: string;
   }
 
+  export interface Regulator {
+    /**
+     * The country code where the regulator operates in the ISO 3166-1 alpha-2 format
+     * (e.g., "US", "CA", "GB").
+     */
+    jurisdiction: string;
+
+    /**
+     * Full name of the regulatory body.
+     */
+    name: 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;
+  }
+
   export interface WealthAndEmploymentDetails {
     id: string;
 
     /**
-     * The annual income of the individual.
+     * The annual income of the individual in USD.
      */
     annual_income: number | null;
 
@@ -502,17 +606,24 @@ export namespace LegalEntity {
       | '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'
@@ -551,6 +662,11 @@ export interface LegalEntityCreateParams {
 
   bank_settings?: LegalEntityCreateParams.BankSettings | null;
 
+  /**
+   * A description of the business.
+   */
+  business_description?: string | null;
+
   /**
    * The business's legal business name.
    */
@@ -561,7 +677,20 @@ export interface LegalEntityCreateParams {
    */
   citizenship_country?: string | null;
 
-  compliance_details?: Shared.LegalEntityComplianceDetail | null;
+  /**
+   * The connection ID for the connection the legal entity is associated with.
+   * Defaults to the id of the connection designated with an is_default value of true
+   * or the id of an existing operational connection if only one is available. Pass
+   * in a value of null to prevent the connection from being associated with the
+   * legal entity.
+   */
+  connection_id?: string | 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;
 
   /**
    * A business's formation date (YYYY-MM-DD).
@@ -580,6 +709,16 @@ export interface LegalEntityCreateParams {
    */
   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.
    */
@@ -595,6 +734,11 @@ export interface LegalEntityCreateParams {
    */
   industry_classifications?: Array<Shared.LegalEntityIndustryClassification>;
 
+  /**
+   * A description of the intended use of the legal entity.
+   */
+  intended_use?: string | null;
+
   /**
    * An individual's last name.
    */
@@ -603,7 +747,7 @@ export interface LegalEntityCreateParams {
   /**
    * The legal entity associations and its child legal entities.
    */
-  legal_entity_associations?: Array<LegalEntityCreateParams.LegalEntityAssociation> | null;
+  legal_entity_associations?: Array<Shared.LegalEntityAssociationInlineCreate> | null;
 
   /**
    * The business's legal structure.
@@ -617,6 +761,11 @@ export interface LegalEntityCreateParams {
     | 'trust'
     | null;
 
+  /**
+   * ISO 10383 market identifier code.
+   */
+  listed_exchange?: string | null;
+
   /**
    * Additional data represented as key-value pairs. Both the key and value must be
    * strings.
@@ -628,6 +777,12 @@ export interface LegalEntityCreateParams {
    */
   middle_name?: string | null;
 
+  /**
+   * A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
+   * codes).
+   */
+  operating_jurisdictions?: Array<string>;
+
   phone_numbers?: Array<LegalEntityCreateParams.PhoneNumber>;
 
   /**
@@ -645,16 +800,42 @@ export interface LegalEntityCreateParams {
    */
   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<LegalEntityCreateParams.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?: LegalEntityCreateParams.ThirdPartyVerification | null;
+
+  /**
+   * Stock ticker symbol for publicly traded companies.
+   */
+  ticker_symbol?: string | null;
+
   wealth_and_employment_details?: LegalEntityCreateParams.WealthAndEmploymentDetails | null;
 
   /**
@@ -706,42 +887,51 @@ export namespace LegalEntityCreateParams {
     updated_at: string;
   }
 
-  export interface LegalEntityAssociation {
-    relationship_types: Array<'authorized_signer' | 'beneficial_owner' | 'control_person'>;
-
-    /**
-     * The child legal entity.
-     */
-    child_legal_entity?: Shared.ChildLegalEntityCreate;
+  /**
+   * A list of phone numbers in E.164 format.
+   */
+  export interface PhoneNumber {
+    phone_number?: string;
+  }
 
+  export interface Regulator {
     /**
-     * The ID of the child legal entity.
+     * The country code where the regulator operates in the ISO 3166-1 alpha-2 format
+     * (e.g., "US", "CA", "GB").
      */
-    child_legal_entity_id?: string;
+    jurisdiction: string;
 
     /**
-     * The child entity's ownership percentage iff they are a beneficial owner.
+     * Full name of the regulatory body.
      */
-    ownership_percentage?: number | null;
+    name: string;
 
     /**
-     * The job title of the child entity at the parent entity.
+     * Registration or identification number with the regulator.
      */
-    title?: string | null;
+    registration_number: string;
   }
 
   /**
-   * A list of phone numbers in E.164 format.
+   * Information describing a third-party verification run by an external vendor.
    */
-  export interface PhoneNumber {
-    phone_number?: string;
+  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;
   }
 
   export interface WealthAndEmploymentDetails {
     id: string;
 
     /**
-     * The annual income of the individual.
+     * The annual income of the individual in USD.
      */
     annual_income: number | null;
 
@@ -865,17 +1055,24 @@ export namespace LegalEntityCreateParams {
       | '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'
@@ -909,6 +1106,11 @@ export interface LegalEntityUpdateParams {
 
   bank_settings?: LegalEntityUpdateParams.BankSettings | null;
 
+  /**
+   * A description of the business.
+   */
+  business_description?: string | null;
+
   /**
    * The business's legal business name.
    */
@@ -919,7 +1121,11 @@ export interface LegalEntityUpdateParams {
    */
   citizenship_country?: string | null;
 
-  compliance_details?: Shared.LegalEntityComplianceDetail | 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;
 
   /**
    * A business's formation date (YYYY-MM-DD).
@@ -938,6 +1144,16 @@ export interface LegalEntityUpdateParams {
    */
   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.
    */
@@ -953,6 +1169,11 @@ export interface LegalEntityUpdateParams {
    */
   industry_classifications?: Array<Shared.LegalEntityIndustryClassification>;
 
+  /**
+   * A description of the intended use of the legal entity.
+   */
+  intended_use?: string | null;
+
   /**
    * An individual's last name.
    */
@@ -970,6 +1191,11 @@ export interface LegalEntityUpdateParams {
     | 'trust'
     | null;
 
+  /**
+   * ISO 10383 market identifier code.
+   */
+  listed_exchange?: string | null;
+
   /**
    * Additional data represented as key-value pairs. Both the key and value must be
    * strings.
@@ -981,6 +1207,12 @@ export interface LegalEntityUpdateParams {
    */
   middle_name?: string | null;
 
+  /**
+   * A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
+   * codes).
+   */
+  operating_jurisdictions?: Array<string>;
+
   phone_numbers?: Array<LegalEntityUpdateParams.PhoneNumber>;
 
   /**
@@ -998,16 +1230,42 @@ export interface LegalEntityUpdateParams {
    */
   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<LegalEntityUpdateParams.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?: LegalEntityUpdateParams.ThirdPartyVerification | null;
+
+  /**
+   * Stock ticker symbol for publicly traded companies.
+   */
+  ticker_symbol?: string | null;
+
   wealth_and_employment_details?: LegalEntityUpdateParams.WealthAndEmploymentDetails | null;
 
   /**
@@ -1066,11 +1324,44 @@ export namespace LegalEntityUpdateParams {
     phone_number?: string;
   }
 
+  export interface Regulator {
+    /**
+     * The country code where the regulator operates in the ISO 3166-1 alpha-2 format
+     * (e.g., "US", "CA", "GB").
+     */
+    jurisdiction: string;
+
+    /**
+     * Full name of the regulatory body.
+     */
+    name: 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;
+  }
+
   export interface WealthAndEmploymentDetails {
     id: string;
 
     /**
-     * The annual income of the individual.
+     * The annual income of the individual in USD.
      */
     annual_income: number | null;
 
@@ -1194,17 +1485,24 @@ export namespace LegalEntityUpdateParams {
       | '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'
@@ -1231,6 +1529,11 @@ export namespace LegalEntityUpdateParams {
 }
 
 export interface LegalEntityListParams extends PageParams {
+  /**
+   * An optional user-defined 180 character unique identifier.
+   */
+  external_id?: string;
+
   legal_entity_type?: 'business' | 'individual';
 
   /**
@@ -1241,6 +1544,8 @@ export interface LegalEntityListParams extends PageParams {
   metadata?: { [key: string]: string };
 
   show_deleted?: string;
+
+  status?: 'pending' | 'active' | 'suspended' | 'closed';
 }
 
 export declare namespace LegalEntities {