modern-treasury 3.3.0 → 4.4.2

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

@@ -1,4 +1,5 @@
 import { APIResource } from "../core/resource.js";
+import * as DocumentsAPI from "./documents.js";
 import * as Shared from "./shared.js";
 import { APIPromise } from "../core/api-promise.js";
 import { RequestOptions } from "../internal/request-options.js";
@@ -8,305 +9,388 @@ export declare class LegalEntityAssociations extends APIResource {
      */
     create(body: LegalEntityAssociationCreateParams, options?: RequestOptions): APIPromise<LegalEntityAssociation>;
 }
-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.
      */
-    child_legal_entity: LegalEntityAssociation.ChildLegalEntity;
+    business_name: string | null;
+    /**
+     * The country of citizenship for an individual.
+     */
+    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;
-    relationship_types: Array<'authorized_signer' | 'beneficial_owner' | 'control_person'>;
+    politically_exposed_person: boolean | null;
     /**
-     * The job title of the child entity at the parent entity.
+     * An individual's preferred name.
      */
-    title: string | null;
+    preferred_name: string | null;
+    /**
+     * An individual's prefix.
+     */
+    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 declare namespace LegalEntityAssociation {
+    wealth_and_employment_details: ChildLegalEntity.WealthAndEmploymentDetails | null;
     /**
-     * The child legal entity.
+     * The entity's primary website URL.
      */
-    interface ChildLegalEntity {
+    website: string | null;
+}
+export declare namespace ChildLegalEntity {
+    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>;
-        bank_settings: ChildLegalEntity.BankSettings | null;
+        country: string | null;
+        created_at: string;
+        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;
-        compliance_details: Shared.LegalEntityComplianceDetail | null;
-        created_at: string;
+        locality: string | null;
+        object: string;
         /**
-         * A business's formation date (YYYY-MM-DD).
+         * The postal code of the address.
          */
-        date_formed: string | null;
+        postal_code: string | null;
         /**
-         * An individual's date of birth (YYYY-MM-DD).
+         * Region or State.
          */
-        date_of_birth: string | null;
+        region: string | null;
+        updated_at: string;
+    }
+    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;
-        doing_business_as_names: Array<string>;
         /**
-         * The entity's primary email.
+         * Whether backup withholding is enabled. See more here -
+         * https://www.irs.gov/businesses/small-businesses-self-employed/backup-withholding.
          */
-        email: string | null;
+        enable_backup_withholding: boolean | null;
         /**
-         * An individual's first name.
+         * This field will be true if this object exists in the live environment or false
+         * if it exists in the test environment.
          */
-        first_name: string | null;
+        live_mode: boolean;
+        object: string;
         /**
-         * A list of identifications for the legal entity.
+         * Cross River Bank specific setting to opt out of privacy policy.
          */
-        identifications: Array<ChildLegalEntity.Identification>;
+        privacy_opt_out: boolean | null;
         /**
-         * A list of industry classifications 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.
          */
-        industry_classifications: Array<Shared.LegalEntityIndustryClassification>;
+        regulation_o: boolean | null;
+        updated_at: string;
+    }
+    interface Identification {
+        id: string;
+        created_at: string;
+        discarded_at: string | null;
+        documents: Array<DocumentsAPI.Document>;
+        /**
+         * The date when the Identification is no longer considered valid by the issuing
+         * authority.
+         */
+        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
          * if it exists in the test environment.
          */
         live_mode: boolean;
+        object: string;
+        updated_at: string;
+    }
+    /**
+     * A list of phone numbers in E.164 format.
+     */
+    interface PhoneNumber {
+        phone_number?: string;
+    }
+    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;
-        object: string;
-        phone_numbers: Array<ChildLegalEntity.PhoneNumber>;
+        name: string;
+        /**
+         * Registration or identification number with the regulator.
+         */
+        registration_number: string;
+    }
+    /**
+     * Information describing a third-party verification run by an external vendor.
+     */
+    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;
+    }
+    interface WealthAndEmploymentDetails {
+        id: string;
+        /**
+         * The annual income of the individual in USD.
+         */
+        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;
         /**
-         * Whether the individual is a politically exposed person.
+         * The country in which the individual's income is earned.
          */
-        politically_exposed_person: boolean | null;
+        income_country: string | null;
         /**
-         * An individual's preferred name.
+         * The source of the individual's income.
          */
-        preferred_name: string | null;
+        income_source: 'family_support' | 'government_benefits' | 'inheritance' | 'investments' | 'rental_income' | 'retirement' | 'salary' | 'self_employed' | null;
         /**
-         * An individual's prefix.
+         * The state in which the individual's income is earned.
          */
-        prefix: 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;
+        /**
+         * 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 risk rating of the legal entity. One of low, medium, high.
+         * The occupation of the individual.
          */
-        risk_rating: 'low' | 'medium' | 'high' | null;
+        occupation: 'consulting' | 'executive' | 'finance_accounting' | 'food_services' | 'government' | 'healthcare' | 'legal_services' | 'manufacturing' | 'other' | 'sales' | 'science_engineering' | 'technology' | null;
         /**
-         * An individual's suffix.
+         * The source of the individual's funds.
          */
-        suffix: string | null;
+        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;
         updated_at: string;
-        wealth_and_employment_details: ChildLegalEntity.WealthAndEmploymentDetails | null;
         /**
-         * The entity's primary website URL.
+         * The source of the individual's wealth.
          */
-        website: string | null;
-    }
-    namespace ChildLegalEntity {
-        interface Address {
-            id: string;
-            /**
-             * The types of this address.
-             */
-            address_types: Array<'business' | 'mailing' | 'other' | 'po_box' | 'residential'>;
-            /**
-             * Country code conforms to [ISO 3166-1 alpha-2]
-             */
-            country: string | null;
-            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;
-        }
-        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;
-        }
-        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.
-         */
-        interface PhoneNumber {
-            phone_number?: string;
-        }
-        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;
-        }
+        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
@@ -332,6 +416,6 @@ export interface LegalEntityAssociationCreateParams {
     title?: string | null;
 }
 export declare namespace LegalEntityAssociations {
-    export { type LegalEntityAssociation as LegalEntityAssociation, type LegalEntityAssociationCreateParams as LegalEntityAssociationCreateParams, };
+    export { type ChildLegalEntity as ChildLegalEntity, type LegalEntityAssociation as LegalEntityAssociation, type LegalEntityAssociationCreateParams as LegalEntityAssociationCreateParams, };
 }
 //# sourceMappingURL=legal-entity-associations.d.ts.map