increase 0.2.0 → 0.3.0

package/resources/entities/entities.ts

@@ -3,8 +3,8 @@
 import * as Core from '~/core';
 import { APIResource } from '~/resource';
 import { isRequestOptions } from '~/core';
-import { Page, PageParams } from '~/pagination';
 import { SupplementalDocuments } from './supplemental-documents';
+import { Page, PageParams } from '~/pagination';
 
 export class Entities extends APIResource {
   supplementalDocuments: SupplementalDocuments = new SupplementalDocuments(this.client);
@@ -35,7 +35,6 @@ export class Entities extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/entities', EntitiesPage, { query, ...options });
   }
 }
@@ -102,6 +101,10 @@ export interface Entity {
 }
 
 export namespace Entity {
+  /**
+   * Details of the corporation entity. Will be present if `structure` is equal to
+   * `corporation`.
+   */
   export interface Corporation {
     /**
      * The corporation's address.
@@ -137,6 +140,9 @@ export namespace Entity {
   }
 
   export namespace Corporation {
+    /**
+     * The corporation's address.
+     */
     export interface Address {
       /**
        * The city of the address.
@@ -183,6 +189,9 @@ export namespace Entity {
     }
 
     export namespace BeneficialOwners {
+      /**
+       * Personal details for the beneficial owner.
+       */
       export interface Individual {
         /**
          * The person's address.
@@ -206,6 +215,9 @@ export namespace Entity {
       }
 
       export namespace Individual {
+        /**
+         * The person's address.
+         */
         export interface Address {
           /**
            * The city of the address.
@@ -234,6 +246,9 @@ export namespace Entity {
           zip: string;
         }
 
+        /**
+         * A means of verifying the person's identity.
+         */
         export interface Identification {
           /**
            * A method that can be used to verify the individual's identity.
@@ -255,6 +270,10 @@ export namespace Entity {
     }
   }
 
+  /**
+   * Details of the natural person entity. Will be present if `structure` is equal to
+   * `natural_person`.
+   */
   export interface NaturalPerson {
     /**
      * The person's address.
@@ -278,6 +297,9 @@ export namespace Entity {
   }
 
   export namespace NaturalPerson {
+    /**
+     * The person's address.
+     */
     export interface Address {
       /**
        * The city of the address.
@@ -306,6 +328,9 @@ export namespace Entity {
       zip: string;
     }
 
+    /**
+     * A means of verifying the person's identity.
+     */
     export interface Identification {
       /**
        * A method that can be used to verify the individual's identity.
@@ -325,6 +350,9 @@ export namespace Entity {
     }
   }
 
+  /**
+   * Details of the joint entity. Will be present if `structure` is equal to `joint`.
+   */
   export interface Joint {
     /**
      * The two individuals that share control of the entity.
@@ -361,6 +389,9 @@ export namespace Entity {
     }
 
     export namespace Individuals {
+      /**
+       * The person's address.
+       */
       export interface Address {
         /**
          * The city of the address.
@@ -389,6 +420,9 @@ export namespace Entity {
         zip: string;
       }
 
+      /**
+       * A means of verifying the person's identity.
+       */
       export interface Identification {
         /**
          * A method that can be used to verify the individual's identity.
@@ -409,6 +443,9 @@ export namespace Entity {
     }
   }
 
+  /**
+   * Details of the trust entity. Will be present if `structure` is equal to `trust`.
+   */
   export interface Trust {
     /**
      * The trust's address.
@@ -453,6 +490,9 @@ export namespace Entity {
   }
 
   export namespace Trust {
+    /**
+     * The trust's address.
+     */
     export interface Address {
       /**
        * The city of the address.
@@ -495,6 +535,10 @@ export namespace Entity {
     }
 
     export namespace Trustees {
+      /**
+       * The individual trustee of the trust. Will be present if the trustee's
+       * `structure` is equal to `individual`.
+       */
       export interface Individual {
         /**
          * The person's address.
@@ -518,6 +562,9 @@ export namespace Entity {
       }
 
       export namespace Individual {
+        /**
+         * The person's address.
+         */
         export interface Address {
           /**
            * The city of the address.
@@ -546,6 +593,9 @@ export namespace Entity {
           zip: string;
         }
 
+        /**
+         * A means of verifying the person's identity.
+         */
         export interface Identification {
           /**
            * A method that can be used to verify the individual's identity.
@@ -566,6 +616,9 @@ export namespace Entity {
       }
     }
 
+    /**
+     * The grantor of the trust. Will be present if the `category` is `revocable`.
+     */
     export interface Grantor {
       /**
        * The person's address.
@@ -589,6 +642,9 @@ export namespace Entity {
     }
 
     export namespace Grantor {
+      /**
+       * The person's address.
+       */
       export interface Address {
         /**
          * The city of the address.
@@ -617,6 +673,9 @@ export namespace Entity {
         zip: string;
       }
 
+      /**
+       * A means of verifying the person's identity.
+       */
       export interface Identification {
         /**
          * A method that can be used to verify the individual's identity.
@@ -646,16 +705,6 @@ export namespace Entity {
 }
 
 export interface EntityCreateParams {
-  /**
-   * The relationship between your group and the entity.
-   */
-  relationship: 'affiliated' | 'informational' | 'unaffiliated';
-
-  /**
-   * The type of Entity to create.
-   */
-  structure: 'corporation' | 'natural_person' | 'joint' | 'trust';
-
   /**
    * Details of the corporation entity to create. Required if `structure` is equal to
    * `corporation`.
@@ -681,6 +730,16 @@ export interface EntityCreateParams {
    */
   natural_person?: EntityCreateParams.NaturalPerson;
 
+  /**
+   * The relationship between your group and the entity.
+   */
+  relationship: 'affiliated' | 'informational' | 'unaffiliated';
+
+  /**
+   * The type of Entity to create.
+   */
+  structure: 'corporation' | 'natural_person' | 'joint' | 'trust';
+
   /**
    * Additional documentation associated with the entity.
    */
@@ -694,6 +753,10 @@ export interface EntityCreateParams {
 }
 
 export namespace EntityCreateParams {
+  /**
+   * Details of the corporation entity to create. Required if `structure` is equal to
+   * `corporation`.
+   */
   export interface Corporation {
     /**
      * The corporation's address.
@@ -729,6 +792,9 @@ export namespace EntityCreateParams {
   }
 
   export namespace Corporation {
+    /**
+     * The corporation's address.
+     */
     export interface Address {
       /**
        * The city of the address.
@@ -775,6 +841,9 @@ export namespace EntityCreateParams {
     }
 
     export namespace BeneficialOwners {
+      /**
+       * Personal details for the beneficial owner.
+       */
       export interface Individual {
         /**
          * The individual's address.
@@ -806,6 +875,9 @@ export namespace EntityCreateParams {
       }
 
       export namespace Individual {
+        /**
+         * The individual's address.
+         */
         export interface Address {
           /**
            * The city of the address.
@@ -834,6 +906,9 @@ export namespace EntityCreateParams {
           line2?: string;
         }
 
+        /**
+         * A means of verifying the person's identity.
+         */
         export interface Identification {
           /**
            * A method that can be used to verify the individual's identity.
@@ -871,6 +946,10 @@ export namespace EntityCreateParams {
         }
 
         export namespace Identification {
+          /**
+           * Information about the passport used for identification. Required if `method` is
+           * equal to `passport`.
+           */
           export interface Passport {
             /**
              * The country that issued the passport.
@@ -888,6 +967,10 @@ export namespace EntityCreateParams {
             file_id: string;
           }
 
+          /**
+           * Information about the United States driver's license used for identification.
+           * Required if `method` is equal to `drivers_license`.
+           */
           export interface DriversLicense {
             /**
              * The driver's license's expiration date in YYYY-MM-DD format.
@@ -905,6 +988,10 @@ export namespace EntityCreateParams {
             state: string;
           }
 
+          /**
+           * Information about the identification document provided. Required if `method` is
+           * equal to `other`.
+           */
           export interface Other {
             /**
              * The two-character ISO 3166-1 code representing the country that issued the
@@ -932,6 +1019,12 @@ export namespace EntityCreateParams {
     }
   }
 
+  /**
+   * 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.
+   */
   export interface NaturalPerson {
     /**
      * The individual's address.
@@ -963,6 +1056,9 @@ export namespace EntityCreateParams {
   }
 
   export namespace NaturalPerson {
+    /**
+     * The individual's address.
+     */
     export interface Address {
       /**
        * The city of the address.
@@ -991,6 +1087,9 @@ export namespace EntityCreateParams {
       line2?: string;
     }
 
+    /**
+     * A means of verifying the person's identity.
+     */
     export interface Identification {
       /**
        * A method that can be used to verify the individual's identity.
@@ -1028,6 +1127,10 @@ export namespace EntityCreateParams {
     }
 
     export namespace Identification {
+      /**
+       * Information about the passport used for identification. Required if `method` is
+       * equal to `passport`.
+       */
       export interface Passport {
         /**
          * The country that issued the passport.
@@ -1045,6 +1148,10 @@ export namespace EntityCreateParams {
         file_id: string;
       }
 
+      /**
+       * Information about the United States driver's license used for identification.
+       * Required if `method` is equal to `drivers_license`.
+       */
       export interface DriversLicense {
         /**
          * The driver's license's expiration date in YYYY-MM-DD format.
@@ -1062,6 +1169,10 @@ export namespace EntityCreateParams {
         state: string;
       }
 
+      /**
+       * Information about the identification document provided. Required if `method` is
+       * equal to `other`.
+       */
       export interface Other {
         /**
          * The two-character ISO 3166-1 code representing the country that issued the
@@ -1087,6 +1198,10 @@ export namespace EntityCreateParams {
     }
   }
 
+  /**
+   * Details of the joint entity to create. Required if `structure` is equal to
+   * `joint`.
+   */
   export interface Joint {
     /**
      * The two individuals that share control of the entity.
@@ -1131,6 +1246,9 @@ export namespace EntityCreateParams {
     }
 
     export namespace Individuals {
+      /**
+       * The individual's address.
+       */
       export interface Address {
         /**
          * The city of the address.
@@ -1159,6 +1277,9 @@ export namespace EntityCreateParams {
         line2?: string;
       }
 
+      /**
+       * A means of verifying the person's identity.
+       */
       export interface Identification {
         /**
          * A method that can be used to verify the individual's identity.
@@ -1196,6 +1317,10 @@ export namespace EntityCreateParams {
       }
 
       export namespace Identification {
+        /**
+         * Information about the passport used for identification. Required if `method` is
+         * equal to `passport`.
+         */
         export interface Passport {
           /**
            * The country that issued the passport.
@@ -1213,6 +1338,10 @@ export namespace EntityCreateParams {
           file_id: string;
         }
 
+        /**
+         * Information about the United States driver's license used for identification.
+         * Required if `method` is equal to `drivers_license`.
+         */
         export interface DriversLicense {
           /**
            * The driver's license's expiration date in YYYY-MM-DD format.
@@ -1230,6 +1359,10 @@ export namespace EntityCreateParams {
           state: string;
         }
 
+        /**
+         * Information about the identification document provided. Required if `method` is
+         * equal to `other`.
+         */
         export interface Other {
           /**
            * The two-character ISO 3166-1 code representing the country that issued the
@@ -1256,6 +1389,10 @@ export namespace EntityCreateParams {
     }
   }
 
+  /**
+   * Details of the trust entity to create. Required if `structure` is equal to
+   * `trust`.
+   */
   export interface Trust {
     /**
      * The trust's address.
@@ -1303,6 +1440,9 @@ export namespace EntityCreateParams {
   }
 
   export namespace Trust {
+    /**
+     * The trust's address.
+     */
     export interface Address {
       /**
        * The city of the address.
@@ -1345,6 +1485,10 @@ export namespace EntityCreateParams {
     }
 
     export namespace Trustees {
+      /**
+       * Details of the individual trustee. Required when the trustee `structure` is
+       * equal to `individual`.
+       */
       export interface Individual {
         /**
          * The individual's address.
@@ -1376,6 +1520,9 @@ export namespace EntityCreateParams {
       }
 
       export namespace Individual {
+        /**
+         * The individual's address.
+         */
         export interface Address {
           /**
            * The city of the address.
@@ -1404,6 +1551,9 @@ export namespace EntityCreateParams {
           line2?: string;
         }
 
+        /**
+         * A means of verifying the person's identity.
+         */
         export interface Identification {
           /**
            * A method that can be used to verify the individual's identity.
@@ -1441,6 +1591,10 @@ export namespace EntityCreateParams {
         }
 
         export namespace Identification {
+          /**
+           * Information about the passport used for identification. Required if `method` is
+           * equal to `passport`.
+           */
           export interface Passport {
             /**
              * The country that issued the passport.
@@ -1458,6 +1612,10 @@ export namespace EntityCreateParams {
             file_id: string;
           }
 
+          /**
+           * Information about the United States driver's license used for identification.
+           * Required if `method` is equal to `drivers_license`.
+           */
           export interface DriversLicense {
             /**
              * The driver's license's expiration date in YYYY-MM-DD format.
@@ -1475,6 +1633,10 @@ export namespace EntityCreateParams {
             state: string;
           }
 
+          /**
+           * Information about the identification document provided. Required if `method` is
+           * equal to `other`.
+           */
           export interface Other {
             /**
              * The two-character ISO 3166-1 code representing the country that issued the
@@ -1501,6 +1663,9 @@ export namespace EntityCreateParams {
       }
     }
 
+    /**
+     * The grantor of the trust. Required if `category` is equal to `revocable`.
+     */
     export interface Grantor {
       /**
        * The individual's address.
@@ -1532,6 +1697,9 @@ export namespace EntityCreateParams {
     }
 
     export namespace Grantor {
+      /**
+       * The individual's address.
+       */
       export interface Address {
         /**
          * The city of the address.
@@ -1560,6 +1728,9 @@ export namespace EntityCreateParams {
         line2?: string;
       }
 
+      /**
+       * A means of verifying the person's identity.
+       */
       export interface Identification {
         /**
          * A method that can be used to verify the individual's identity.
@@ -1597,6 +1768,10 @@ export namespace EntityCreateParams {
       }
 
       export namespace Identification {
+        /**
+         * Information about the passport used for identification. Required if `method` is
+         * equal to `passport`.
+         */
         export interface Passport {
           /**
            * The country that issued the passport.
@@ -1614,6 +1789,10 @@ export namespace EntityCreateParams {
           file_id: string;
         }
 
+        /**
+         * Information about the United States driver's license used for identification.
+         * Required if `method` is equal to `drivers_license`.
+         */
         export interface DriversLicense {
           /**
            * The driver's license's expiration date in YYYY-MM-DD format.
@@ -1631,6 +1810,10 @@ export namespace EntityCreateParams {
           state: string;
         }
 
+        /**
+         * Information about the identification document provided. Required if `method` is
+         * equal to `other`.
+         */
         export interface Other {
           /**
            * The two-character ISO 3166-1 code representing the country that issued the
@@ -1663,6 +1846,1152 @@ export namespace EntityCreateParams {
      */
     file_id: string;
   }
-}
 
-export interface EntityListParams extends PageParams {}
+  /**
+   * Details of the corporation entity to create. Required if `structure` is equal to
+   * `corporation`.
+   */
+  export interface Corporation {
+    /**
+     * The corporation's address.
+     */
+    address: Corporation.Address;
+
+    /**
+     * The identifying details of anyone controlling or owning 25% or more of the
+     * corporation.
+     */
+    beneficial_owners: Array<Corporation.BeneficialOwners>;
+
+    /**
+     * The legal name of the corporation.
+     */
+    name: string;
+
+    /**
+     * The Employer Identification Number (EIN) for the corporation.
+     */
+    tax_identifier: string;
+
+    /**
+     * The two-letter United States Postal Service (USPS) abbreviation for the
+     * corporation's state of incorporation.
+     */
+    incorporation_state?: string;
+
+    /**
+     * The website of the corporation.
+     */
+    website?: string;
+  }
+
+  export namespace Corporation {
+    /**
+     * The corporation's address.
+     */
+    export interface Address {
+      /**
+       * The city of the address.
+       */
+      city: string;
+
+      /**
+       * The first line of the address. This is usually the street number and street.
+       */
+      line1: string;
+
+      /**
+       * The two-letter United States Postal Service (USPS) abbreviation for the state of
+       * the address.
+       */
+      state: string;
+
+      /**
+       * The ZIP code of the address.
+       */
+      zip: string;
+
+      /**
+       * The second line of the address. This might be the floor or room number.
+       */
+      line2?: string;
+    }
+
+    export interface BeneficialOwners {
+      /**
+       * Personal details for the beneficial owner.
+       */
+      individual: BeneficialOwners.Individual;
+
+      /**
+       * Why this person is considered a beneficial owner of the entity.
+       */
+      prong: 'ownership' | 'control';
+
+      /**
+       * This person's role or title within the entity.
+       */
+      company_title?: string;
+    }
+
+    export namespace BeneficialOwners {
+      /**
+       * Personal details for the beneficial owner.
+       */
+      export interface Individual {
+        /**
+         * The individual's address.
+         */
+        address: Individual.Address;
+
+        /**
+         * The person's date of birth in YYYY-MM-DD format.
+         */
+        date_of_birth: string;
+
+        /**
+         * A means of verifying the person's identity.
+         */
+        identification: Individual.Identification;
+
+        /**
+         * The person's legal name.
+         */
+        name: string;
+
+        /**
+         * 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).
+         */
+        confirmed_no_us_tax_id?: boolean;
+      }
+
+      export namespace Individual {
+        /**
+         * The individual's address.
+         */
+        export interface Address {
+          /**
+           * The city of the address.
+           */
+          city: string;
+
+          /**
+           * The first line of the address. This is usually the street number and street.
+           */
+          line1: string;
+
+          /**
+           * The two-letter United States Postal Service (USPS) abbreviation for the state of
+           * the address.
+           */
+          state: string;
+
+          /**
+           * The ZIP code of the address.
+           */
+          zip: string;
+
+          /**
+           * The second line of the address. This might be the floor or room number.
+           */
+          line2?: string;
+        }
+
+        /**
+         * A means of verifying the person's identity.
+         */
+        export interface Identification {
+          /**
+           * A method that can be used to verify the individual's identity.
+           */
+          method:
+            | 'social_security_number'
+            | 'individual_taxpayer_identification_number'
+            | 'passport'
+            | 'drivers_license'
+            | 'other';
+
+          /**
+           * An identification number that can be used to verify the individual's identity,
+           * such as a social security number.
+           */
+          number: string;
+
+          /**
+           * Information about the United States driver's license used for identification.
+           * Required if `method` is equal to `drivers_license`.
+           */
+          drivers_license?: Identification.DriversLicense;
+
+          /**
+           * Information about the identification document provided. Required if `method` is
+           * equal to `other`.
+           */
+          other?: Identification.Other;
+
+          /**
+           * Information about the passport used for identification. Required if `method` is
+           * equal to `passport`.
+           */
+          passport?: Identification.Passport;
+        }
+
+        export namespace Identification {
+          /**
+           * Information about the passport used for identification. Required if `method` is
+           * equal to `passport`.
+           */
+          export interface Passport {
+            /**
+             * The country that issued the passport.
+             */
+            country: string;
+
+            /**
+             * The passport's expiration date in YYYY-MM-DD format.
+             */
+            expiration_date: string;
+
+            /**
+             * The identifier of the File containing the passport.
+             */
+            file_id: string;
+          }
+
+          /**
+           * Information about the United States driver's license used for identification.
+           * Required if `method` is equal to `drivers_license`.
+           */
+          export interface DriversLicense {
+            /**
+             * The driver's license's expiration date in YYYY-MM-DD format.
+             */
+            expiration_date: string;
+
+            /**
+             * The identifier of the File containing the driver's license.
+             */
+            file_id: string;
+
+            /**
+             * The state that issued the provided driver's license.
+             */
+            state: string;
+          }
+
+          /**
+           * Information about the identification document provided. Required if `method` is
+           * equal to `other`.
+           */
+          export interface Other {
+            /**
+             * The two-character ISO 3166-1 code representing the country that issued the
+             * document.
+             */
+            country: string;
+
+            /**
+             * A description of the document submitted.
+             */
+            description: string;
+
+            /**
+             * The identifier of the File containing the document.
+             */
+            file_id: string;
+
+            /**
+             * The document's expiration date in YYYY-MM-DD format.
+             */
+            expiration_date?: string;
+          }
+        }
+      }
+    }
+  }
+
+  /**
+   * Details of the joint entity to create. Required if `structure` is equal to
+   * `joint`.
+   */
+  export interface Joint {
+    /**
+     * The two individuals that share control of the entity.
+     */
+    individuals: Array<Joint.Individuals>;
+
+    /**
+     * The name of the joint entity.
+     */
+    name?: string;
+  }
+
+  export namespace Joint {
+    export interface Individuals {
+      /**
+       * The individual's address.
+       */
+      address: Individuals.Address;
+
+      /**
+       * The person's date of birth in YYYY-MM-DD format.
+       */
+      date_of_birth: string;
+
+      /**
+       * A means of verifying the person's identity.
+       */
+      identification: Individuals.Identification;
+
+      /**
+       * The person's legal name.
+       */
+      name: string;
+
+      /**
+       * 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).
+       */
+      confirmed_no_us_tax_id?: boolean;
+    }
+
+    export namespace Individuals {
+      /**
+       * The individual's address.
+       */
+      export interface Address {
+        /**
+         * The city of the address.
+         */
+        city: string;
+
+        /**
+         * The first line of the address. This is usually the street number and street.
+         */
+        line1: string;
+
+        /**
+         * The two-letter United States Postal Service (USPS) abbreviation for the state of
+         * the address.
+         */
+        state: string;
+
+        /**
+         * The ZIP code of the address.
+         */
+        zip: string;
+
+        /**
+         * The second line of the address. This might be the floor or room number.
+         */
+        line2?: string;
+      }
+
+      /**
+       * A means of verifying the person's identity.
+       */
+      export interface Identification {
+        /**
+         * A method that can be used to verify the individual's identity.
+         */
+        method:
+          | 'social_security_number'
+          | 'individual_taxpayer_identification_number'
+          | 'passport'
+          | 'drivers_license'
+          | 'other';
+
+        /**
+         * An identification number that can be used to verify the individual's identity,
+         * such as a social security number.
+         */
+        number: string;
+
+        /**
+         * Information about the United States driver's license used for identification.
+         * Required if `method` is equal to `drivers_license`.
+         */
+        drivers_license?: Identification.DriversLicense;
+
+        /**
+         * Information about the identification document provided. Required if `method` is
+         * equal to `other`.
+         */
+        other?: Identification.Other;
+
+        /**
+         * Information about the passport used for identification. Required if `method` is
+         * equal to `passport`.
+         */
+        passport?: Identification.Passport;
+      }
+
+      export namespace Identification {
+        /**
+         * Information about the passport used for identification. Required if `method` is
+         * equal to `passport`.
+         */
+        export interface Passport {
+          /**
+           * The country that issued the passport.
+           */
+          country: string;
+
+          /**
+           * The passport's expiration date in YYYY-MM-DD format.
+           */
+          expiration_date: string;
+
+          /**
+           * The identifier of the File containing the passport.
+           */
+          file_id: string;
+        }
+
+        /**
+         * Information about the United States driver's license used for identification.
+         * Required if `method` is equal to `drivers_license`.
+         */
+        export interface DriversLicense {
+          /**
+           * The driver's license's expiration date in YYYY-MM-DD format.
+           */
+          expiration_date: string;
+
+          /**
+           * The identifier of the File containing the driver's license.
+           */
+          file_id: string;
+
+          /**
+           * The state that issued the provided driver's license.
+           */
+          state: string;
+        }
+
+        /**
+         * Information about the identification document provided. Required if `method` is
+         * equal to `other`.
+         */
+        export interface Other {
+          /**
+           * The two-character ISO 3166-1 code representing the country that issued the
+           * document.
+           */
+          country: string;
+
+          /**
+           * A description of the document submitted.
+           */
+          description: string;
+
+          /**
+           * The identifier of the File containing the document.
+           */
+          file_id: string;
+
+          /**
+           * The document's expiration date in YYYY-MM-DD format.
+           */
+          expiration_date?: string;
+        }
+      }
+    }
+  }
+
+  /**
+   * 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.
+   */
+  export interface NaturalPerson {
+    /**
+     * The individual's address.
+     */
+    address: NaturalPerson.Address;
+
+    /**
+     * The person's date of birth in YYYY-MM-DD format.
+     */
+    date_of_birth: string;
+
+    /**
+     * A means of verifying the person's identity.
+     */
+    identification: NaturalPerson.Identification;
+
+    /**
+     * The person's legal name.
+     */
+    name: string;
+
+    /**
+     * 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).
+     */
+    confirmed_no_us_tax_id?: boolean;
+  }
+
+  export namespace NaturalPerson {
+    /**
+     * The individual's address.
+     */
+    export interface Address {
+      /**
+       * The city of the address.
+       */
+      city: string;
+
+      /**
+       * The first line of the address. This is usually the street number and street.
+       */
+      line1: string;
+
+      /**
+       * The two-letter United States Postal Service (USPS) abbreviation for the state of
+       * the address.
+       */
+      state: string;
+
+      /**
+       * The ZIP code of the address.
+       */
+      zip: string;
+
+      /**
+       * The second line of the address. This might be the floor or room number.
+       */
+      line2?: string;
+    }
+
+    /**
+     * A means of verifying the person's identity.
+     */
+    export interface Identification {
+      /**
+       * A method that can be used to verify the individual's identity.
+       */
+      method:
+        | 'social_security_number'
+        | 'individual_taxpayer_identification_number'
+        | 'passport'
+        | 'drivers_license'
+        | 'other';
+
+      /**
+       * An identification number that can be used to verify the individual's identity,
+       * such as a social security number.
+       */
+      number: string;
+
+      /**
+       * Information about the United States driver's license used for identification.
+       * Required if `method` is equal to `drivers_license`.
+       */
+      drivers_license?: Identification.DriversLicense;
+
+      /**
+       * Information about the identification document provided. Required if `method` is
+       * equal to `other`.
+       */
+      other?: Identification.Other;
+
+      /**
+       * Information about the passport used for identification. Required if `method` is
+       * equal to `passport`.
+       */
+      passport?: Identification.Passport;
+    }
+
+    export namespace Identification {
+      /**
+       * Information about the passport used for identification. Required if `method` is
+       * equal to `passport`.
+       */
+      export interface Passport {
+        /**
+         * The country that issued the passport.
+         */
+        country: string;
+
+        /**
+         * The passport's expiration date in YYYY-MM-DD format.
+         */
+        expiration_date: string;
+
+        /**
+         * The identifier of the File containing the passport.
+         */
+        file_id: string;
+      }
+
+      /**
+       * Information about the United States driver's license used for identification.
+       * Required if `method` is equal to `drivers_license`.
+       */
+      export interface DriversLicense {
+        /**
+         * The driver's license's expiration date in YYYY-MM-DD format.
+         */
+        expiration_date: string;
+
+        /**
+         * The identifier of the File containing the driver's license.
+         */
+        file_id: string;
+
+        /**
+         * The state that issued the provided driver's license.
+         */
+        state: string;
+      }
+
+      /**
+       * Information about the identification document provided. Required if `method` is
+       * equal to `other`.
+       */
+      export interface Other {
+        /**
+         * The two-character ISO 3166-1 code representing the country that issued the
+         * document.
+         */
+        country: string;
+
+        /**
+         * A description of the document submitted.
+         */
+        description: string;
+
+        /**
+         * The identifier of the File containing the document.
+         */
+        file_id: string;
+
+        /**
+         * The document's expiration date in YYYY-MM-DD format.
+         */
+        expiration_date?: string;
+      }
+    }
+  }
+
+  export interface SupplementalDocuments {
+    /**
+     * The identifier of the File containing the document.
+     */
+    file_id: string;
+  }
+
+  /**
+   * Details of the trust entity to create. Required if `structure` is equal to
+   * `trust`.
+   */
+  export interface Trust {
+    /**
+     * The trust's address.
+     */
+    address: Trust.Address;
+
+    /**
+     * 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.
+     */
+    category: 'revocable' | 'irrevocable';
+
+    /**
+     * The legal name of the trust.
+     */
+    name: string;
+
+    /**
+     * The trustees of the trust.
+     */
+    trustees: Array<Trust.Trustees>;
+
+    /**
+     * The identifier of the File containing the formation document of the trust.
+     */
+    formation_document_file_id?: string;
+
+    /**
+     * The two-letter United States Postal Service (USPS) abbreviation for the state in
+     * which the trust was formed.
+     */
+    formation_state?: string;
+
+    /**
+     * The grantor of the trust. Required if `category` is equal to `revocable`.
+     */
+    grantor?: Trust.Grantor;
+
+    /**
+     * The Employer Identification Number (EIN) for the trust. Required if `category`
+     * is equal to `irrevocable`.
+     */
+    tax_identifier?: string;
+  }
+
+  export namespace Trust {
+    /**
+     * The trust's address.
+     */
+    export interface Address {
+      /**
+       * The city of the address.
+       */
+      city: string;
+
+      /**
+       * The first line of the address. This is usually the street number and street.
+       */
+      line1: string;
+
+      /**
+       * The two-letter United States Postal Service (USPS) abbreviation for the state of
+       * the address.
+       */
+      state: string;
+
+      /**
+       * The ZIP code of the address.
+       */
+      zip: string;
+
+      /**
+       * The second line of the address. This might be the floor or room number.
+       */
+      line2?: string;
+    }
+
+    export interface Trustees {
+      /**
+       * The structure of the trustee.
+       */
+      structure: 'individual';
+
+      /**
+       * Details of the individual trustee. Required when the trustee `structure` is
+       * equal to `individual`.
+       */
+      individual?: Trustees.Individual;
+    }
+
+    export namespace Trustees {
+      /**
+       * Details of the individual trustee. Required when the trustee `structure` is
+       * equal to `individual`.
+       */
+      export interface Individual {
+        /**
+         * The individual's address.
+         */
+        address: Individual.Address;
+
+        /**
+         * The person's date of birth in YYYY-MM-DD format.
+         */
+        date_of_birth: string;
+
+        /**
+         * A means of verifying the person's identity.
+         */
+        identification: Individual.Identification;
+
+        /**
+         * The person's legal name.
+         */
+        name: string;
+
+        /**
+         * 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).
+         */
+        confirmed_no_us_tax_id?: boolean;
+      }
+
+      export namespace Individual {
+        /**
+         * The individual's address.
+         */
+        export interface Address {
+          /**
+           * The city of the address.
+           */
+          city: string;
+
+          /**
+           * The first line of the address. This is usually the street number and street.
+           */
+          line1: string;
+
+          /**
+           * The two-letter United States Postal Service (USPS) abbreviation for the state of
+           * the address.
+           */
+          state: string;
+
+          /**
+           * The ZIP code of the address.
+           */
+          zip: string;
+
+          /**
+           * The second line of the address. This might be the floor or room number.
+           */
+          line2?: string;
+        }
+
+        /**
+         * A means of verifying the person's identity.
+         */
+        export interface Identification {
+          /**
+           * A method that can be used to verify the individual's identity.
+           */
+          method:
+            | 'social_security_number'
+            | 'individual_taxpayer_identification_number'
+            | 'passport'
+            | 'drivers_license'
+            | 'other';
+
+          /**
+           * An identification number that can be used to verify the individual's identity,
+           * such as a social security number.
+           */
+          number: string;
+
+          /**
+           * Information about the United States driver's license used for identification.
+           * Required if `method` is equal to `drivers_license`.
+           */
+          drivers_license?: Identification.DriversLicense;
+
+          /**
+           * Information about the identification document provided. Required if `method` is
+           * equal to `other`.
+           */
+          other?: Identification.Other;
+
+          /**
+           * Information about the passport used for identification. Required if `method` is
+           * equal to `passport`.
+           */
+          passport?: Identification.Passport;
+        }
+
+        export namespace Identification {
+          /**
+           * Information about the passport used for identification. Required if `method` is
+           * equal to `passport`.
+           */
+          export interface Passport {
+            /**
+             * The country that issued the passport.
+             */
+            country: string;
+
+            /**
+             * The passport's expiration date in YYYY-MM-DD format.
+             */
+            expiration_date: string;
+
+            /**
+             * The identifier of the File containing the passport.
+             */
+            file_id: string;
+          }
+
+          /**
+           * Information about the United States driver's license used for identification.
+           * Required if `method` is equal to `drivers_license`.
+           */
+          export interface DriversLicense {
+            /**
+             * The driver's license's expiration date in YYYY-MM-DD format.
+             */
+            expiration_date: string;
+
+            /**
+             * The identifier of the File containing the driver's license.
+             */
+            file_id: string;
+
+            /**
+             * The state that issued the provided driver's license.
+             */
+            state: string;
+          }
+
+          /**
+           * Information about the identification document provided. Required if `method` is
+           * equal to `other`.
+           */
+          export interface Other {
+            /**
+             * The two-character ISO 3166-1 code representing the country that issued the
+             * document.
+             */
+            country: string;
+
+            /**
+             * A description of the document submitted.
+             */
+            description: string;
+
+            /**
+             * The identifier of the File containing the document.
+             */
+            file_id: string;
+
+            /**
+             * The document's expiration date in YYYY-MM-DD format.
+             */
+            expiration_date?: string;
+          }
+        }
+      }
+    }
+
+    /**
+     * The grantor of the trust. Required if `category` is equal to `revocable`.
+     */
+    export interface Grantor {
+      /**
+       * The individual's address.
+       */
+      address: Grantor.Address;
+
+      /**
+       * The person's date of birth in YYYY-MM-DD format.
+       */
+      date_of_birth: string;
+
+      /**
+       * A means of verifying the person's identity.
+       */
+      identification: Grantor.Identification;
+
+      /**
+       * The person's legal name.
+       */
+      name: string;
+
+      /**
+       * 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).
+       */
+      confirmed_no_us_tax_id?: boolean;
+    }
+
+    export namespace Grantor {
+      /**
+       * The individual's address.
+       */
+      export interface Address {
+        /**
+         * The city of the address.
+         */
+        city: string;
+
+        /**
+         * The first line of the address. This is usually the street number and street.
+         */
+        line1: string;
+
+        /**
+         * The two-letter United States Postal Service (USPS) abbreviation for the state of
+         * the address.
+         */
+        state: string;
+
+        /**
+         * The ZIP code of the address.
+         */
+        zip: string;
+
+        /**
+         * The second line of the address. This might be the floor or room number.
+         */
+        line2?: string;
+      }
+
+      /**
+       * A means of verifying the person's identity.
+       */
+      export interface Identification {
+        /**
+         * A method that can be used to verify the individual's identity.
+         */
+        method:
+          | 'social_security_number'
+          | 'individual_taxpayer_identification_number'
+          | 'passport'
+          | 'drivers_license'
+          | 'other';
+
+        /**
+         * An identification number that can be used to verify the individual's identity,
+         * such as a social security number.
+         */
+        number: string;
+
+        /**
+         * Information about the United States driver's license used for identification.
+         * Required if `method` is equal to `drivers_license`.
+         */
+        drivers_license?: Identification.DriversLicense;
+
+        /**
+         * Information about the identification document provided. Required if `method` is
+         * equal to `other`.
+         */
+        other?: Identification.Other;
+
+        /**
+         * Information about the passport used for identification. Required if `method` is
+         * equal to `passport`.
+         */
+        passport?: Identification.Passport;
+      }
+
+      export namespace Identification {
+        /**
+         * Information about the passport used for identification. Required if `method` is
+         * equal to `passport`.
+         */
+        export interface Passport {
+          /**
+           * The country that issued the passport.
+           */
+          country: string;
+
+          /**
+           * The passport's expiration date in YYYY-MM-DD format.
+           */
+          expiration_date: string;
+
+          /**
+           * The identifier of the File containing the passport.
+           */
+          file_id: string;
+        }
+
+        /**
+         * Information about the United States driver's license used for identification.
+         * Required if `method` is equal to `drivers_license`.
+         */
+        export interface DriversLicense {
+          /**
+           * The driver's license's expiration date in YYYY-MM-DD format.
+           */
+          expiration_date: string;
+
+          /**
+           * The identifier of the File containing the driver's license.
+           */
+          file_id: string;
+
+          /**
+           * The state that issued the provided driver's license.
+           */
+          state: string;
+        }
+
+        /**
+         * Information about the identification document provided. Required if `method` is
+         * equal to `other`.
+         */
+        export interface Other {
+          /**
+           * The two-character ISO 3166-1 code representing the country that issued the
+           * document.
+           */
+          country: string;
+
+          /**
+           * A description of the document submitted.
+           */
+          description: string;
+
+          /**
+           * The identifier of the File containing the document.
+           */
+          file_id: string;
+
+          /**
+           * The document's expiration date in YYYY-MM-DD format.
+           */
+          expiration_date?: string;
+        }
+      }
+    }
+  }
+}
+
+export interface EntityListParams extends PageParams {
+  /**
+   * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+   * timestamp.
+   */
+  'created_at.after'?: string;
+
+  /**
+   * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+   * timestamp.
+   */
+  'created_at.before'?: string;
+
+  /**
+   * Return results on or after this
+   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+   */
+  'created_at.on_or_after'?: string;
+
+  /**
+   * Return results on or before this
+   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+   */
+  'created_at.on_or_before'?: string;
+}
+
+export namespace EntityListParams {
+  export interface CreatedAt {
+    /**
+     * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+     * timestamp.
+     */
+    after?: string;
+
+    /**
+     * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+     * timestamp.
+     */
+    before?: string;
+
+    /**
+     * Return results on or after this
+     * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+     */
+    on_or_after?: string;
+
+    /**
+     * Return results on or before this
+     * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+     */
+    on_or_before?: string;
+  }
+}