increase 0.501.0 → 0.503.0

package/resources/entities.d.ts

@@ -199,17 +199,18 @@ export declare namespace Entity {
          */
         industry_code: string | null;
         /**
-         * The legal name of the corporation.
+         * The legal identifier of the corporation.
          */
-        name: string;
+        legal_identifier: Corporation.LegalIdentifier | null;
         /**
-         * The Employer Identification Number (EIN) for the corporation.
+         * The legal name of the corporation.
          */
-        tax_identifier: string | null;
+        name: string;
         /**
          * The website of the corporation.
          */
         website: string | null;
+        [k: string]: unknown;
     }
     namespace Corporation {
         /**
@@ -217,9 +218,13 @@ export declare namespace Entity {
          */
         interface Address {
             /**
-             * The city of the address.
+             * The city, district, town, or village of the address.
              */
-            city: string;
+            city: string | null;
+            /**
+             * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+             */
+            country: string;
             /**
              * The first line of the address.
              */
@@ -229,14 +234,14 @@ export declare namespace Entity {
              */
             line2: string | null;
             /**
-             * The two-letter United States Postal Service (USPS) abbreviation for the state of
-             * the address.
+             * The two-letter United States Postal Service (USPS) abbreviation for the US
+             * state, province, or region of the address.
              */
-            state: string;
+            state: string | null;
             /**
-             * The ZIP code of the address.
+             * The ZIP or postal code of the address.
              */
-            zip: string;
+            zip: string | null;
         }
         interface BeneficialOwner {
             /**
@@ -334,6 +339,24 @@ export declare namespace Entity {
                 }
             }
         }
+        /**
+         * The legal identifier of the corporation.
+         */
+        interface LegalIdentifier {
+            /**
+             * The category of the legal identifier.
+             *
+             * - `us_employer_identification_number` - The Employer Identification Number (EIN)
+             *   for the company. The EIN is a 9-digit number assigned by the IRS.
+             * - `other` - A legal identifier issued by a foreign government, like a tax
+             *   identification number or registration number.
+             */
+            category: 'us_employer_identification_number' | 'other';
+            /**
+             * The identifier of the legal identifier.
+             */
+            value: string;
+        }
     }
     /**
      * Details of the government authority entity. Will be present if `structure` is
@@ -376,9 +399,13 @@ export declare namespace Entity {
          */
         interface Address {
             /**
-             * The city of the address.
+             * The city, district, town, or village of the address.
              */
-            city: string;
+            city: string | null;
+            /**
+             * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+             */
+            country: string;
             /**
              * The first line of the address.
              */
@@ -388,14 +415,14 @@ export declare namespace Entity {
              */
             line2: string | null;
             /**
-             * The two-letter United States Postal Service (USPS) abbreviation for the state of
-             * the address.
+             * The two-letter United States Postal Service (USPS) abbreviation for the US
+             * state, province, or region of the address.
              */
-            state: string;
+            state: string | null;
             /**
-             * The ZIP code of the address.
+             * The ZIP or postal code of the address.
              */
-            zip: string;
+            zip: string | null;
         }
         interface AuthorizedPerson {
             /**
@@ -446,9 +473,13 @@ export declare namespace Entity {
              */
             interface Address {
                 /**
-                 * The city of the address.
+                 * The city, district, town, or village of the address.
                  */
-                city: string;
+                city: string | null;
+                /**
+                 * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+                 */
+                country: string;
                 /**
                  * The first line of the address.
                  */
@@ -458,14 +489,14 @@ export declare namespace Entity {
                  */
                 line2: string | null;
                 /**
-                 * The two-letter United States Postal Service (USPS) abbreviation for the state of
-                 * the address.
+                 * The two-letter United States Postal Service (USPS) abbreviation for the US
+                 * state, province, or region of the address.
                  */
-                state: string;
+                state: string | null;
                 /**
-                 * The ZIP code of the address.
+                 * The ZIP or postal code of the address.
                  */
-                zip: string;
+                zip: string | null;
             }
             /**
              * A means of verifying the person's identity.
@@ -519,9 +550,13 @@ export declare namespace Entity {
          */
         interface Address {
             /**
-             * The city of the address.
+             * The city, district, town, or village of the address.
              */
-            city: string;
+            city: string | null;
+            /**
+             * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+             */
+            country: string;
             /**
              * The first line of the address.
              */
@@ -531,14 +566,14 @@ export declare namespace Entity {
              */
             line2: string | null;
             /**
-             * The two-letter United States Postal Service (USPS) abbreviation for the state of
-             * the address.
+             * The two-letter United States Postal Service (USPS) abbreviation for the US
+             * state, province, or region of the address.
              */
-            state: string;
+            state: string | null;
             /**
-             * The ZIP code of the address.
+             * The ZIP or postal code of the address.
              */
-            zip: string;
+            zip: string | null;
         }
         /**
          * A means of verifying the person's identity.
@@ -664,9 +699,13 @@ export declare namespace Entity {
          */
         interface Address {
             /**
-             * The city of the address.
+             * The city, district, town, or village of the address.
              */
-            city: string;
+            city: string | null;
+            /**
+             * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+             */
+            country: string;
             /**
              * The first line of the address.
              */
@@ -676,14 +715,14 @@ export declare namespace Entity {
              */
             line2: string | null;
             /**
-             * The two-letter United States Postal Service (USPS) abbreviation for the state of
-             * the address.
+             * The two-letter United States Postal Service (USPS) abbreviation for the US
+             * state, province, or region of the address.
              */
-            state: string;
+            state: string | null;
             /**
-             * The ZIP code of the address.
+             * The ZIP or postal code of the address.
              */
-            zip: string;
+            zip: string | null;
         }
         /**
          * The grantor of the trust. Will be present if the `category` is `revocable`.
@@ -712,9 +751,13 @@ export declare namespace Entity {
              */
             interface Address {
                 /**
-                 * The city of the address.
+                 * The city, district, town, or village of the address.
                  */
-                city: string;
+                city: string | null;
+                /**
+                 * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+                 */
+                country: string;
                 /**
                  * The first line of the address.
                  */
@@ -724,14 +767,14 @@ export declare namespace Entity {
                  */
                 line2: string | null;
                 /**
-                 * The two-letter United States Postal Service (USPS) abbreviation for the state of
-                 * the address.
+                 * The two-letter United States Postal Service (USPS) abbreviation for the US
+                 * state, province, or region of the address.
                  */
-                state: string;
+                state: string | null;
                 /**
-                 * The ZIP code of the address.
+                 * The ZIP or postal code of the address.
                  */
-                zip: string;
+                zip: string | null;
             }
             /**
              * A means of verifying the person's identity.
@@ -798,9 +841,13 @@ export declare namespace Entity {
                  */
                 interface Address {
                     /**
-                     * The city of the address.
+                     * The city, district, town, or village of the address.
                      */
-                    city: string;
+                    city: string | null;
+                    /**
+                     * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+                     */
+                    country: string;
                     /**
                      * The first line of the address.
                      */
@@ -810,14 +857,14 @@ export declare namespace Entity {
                      */
                     line2: string | null;
                     /**
-                     * The two-letter United States Postal Service (USPS) abbreviation for the state of
-                     * the address.
+                     * The two-letter United States Postal Service (USPS) abbreviation for the US
+                     * state, province, or region of the address.
                      */
-                    state: string;
+                    state: string | null;
                     /**
-                     * The ZIP code of the address.
+                     * The ZIP or postal code of the address.
                      */
-                    zip: string;
+                    zip: string | null;
                 }
                 /**
                  * A means of verifying the person's identity.
@@ -1026,13 +1073,14 @@ export declare namespace EntityCreateParams {
          */
         beneficial_owners: Array<Corporation.BeneficialOwner>;
         /**
-         * The legal name of the corporation.
+         * The legal identifier of the corporation. This is usually the Employer
+         * Identification Number (EIN).
          */
-        name: string;
+        legal_identifier: Corporation.LegalIdentifier;
         /**
-         * The Employer Identification Number (EIN) for the corporation.
+         * The legal name of the corporation.
          */
-        tax_identifier: string;
+        name: string;
         /**
          * If the entity is exempt from the requirement to submit beneficial owners,
          * provide the justification. If a reason is provided, you do not need to submit a
@@ -1068,6 +1116,7 @@ export declare namespace EntityCreateParams {
          * The website of the corporation.
          */
         website?: string;
+        [k: string]: unknown;
     }
     namespace Corporation {
         /**
@@ -1076,26 +1125,30 @@ export declare namespace EntityCreateParams {
          */
         interface Address {
             /**
-             * The city of the address.
+             * The city, district, town, or village of the address.
              */
             city: string;
+            /**
+             * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+             */
+            country: 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.
+             * The second line of the address. This might be the floor or room number.
              */
-            state: string;
+            line2?: string;
             /**
-             * The ZIP code of the address.
+             * The two-letter United States Postal Service (USPS) abbreviation for the US
+             * state, province, or region of the address. Required in certain countries.
              */
-            zip: string;
+            state?: string;
             /**
-             * The second line of the address. This might be the floor or room number.
+             * The ZIP or postal code of the address. Required in certain countries.
              */
-            line2?: string;
+            zip?: string;
         }
         interface BeneficialOwner {
             /**
@@ -1286,6 +1339,26 @@ export declare namespace EntityCreateParams {
                 }
             }
         }
+        /**
+         * The legal identifier of the corporation. This is usually the Employer
+         * Identification Number (EIN).
+         */
+        interface LegalIdentifier {
+            /**
+             * The legal identifier.
+             */
+            value: string;
+            /**
+             * The category of the legal identifier. If not provided, the default is
+             * `us_employer_identification_number`.
+             *
+             * - `us_employer_identification_number` - The Employer Identification Number (EIN)
+             *   for the company. The EIN is a 9-digit number assigned by the IRS.
+             * - `other` - A legal identifier issued by a foreign government, like a tax
+             *   identification number or registration number.
+             */
+            category?: 'us_employer_identification_number' | 'other';
+        }
     }
     /**
      * Details of the Government Authority entity to create. Required if `structure` is
@@ -1402,26 +1475,30 @@ export declare namespace EntityCreateParams {
              */
             interface Address {
                 /**
-                 * The city of the address.
+                 * The city, district, town, or village of the address.
                  */
                 city: string;
+                /**
+                 * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+                 */
+                country: 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.
+                 * The second line of the address. This might be the floor or room number.
                  */
-                state: string;
+                line2?: string;
                 /**
-                 * The ZIP code of the address.
+                 * The two-letter United States Postal Service (USPS) abbreviation for the US
+                 * state, province, or region of the address. Required in certain countries.
                  */
-                zip: string;
+                state?: string;
                 /**
-                 * The second line of the address. This might be the floor or room number.
+                 * The ZIP or postal code of the address. Required in certain countries.
                  */
-                line2?: string;
+                zip?: string;
             }
             /**
              * A means of verifying the person's identity.
@@ -1572,26 +1649,30 @@ export declare namespace EntityCreateParams {
          */
         interface Address {
             /**
-             * The city of the address.
+             * The city, district, town, or village of the address.
              */
             city: string;
+            /**
+             * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+             */
+            country: 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.
+             * The second line of the address. This might be the floor or room number.
              */
-            state: string;
+            line2?: string;
             /**
-             * The ZIP code of the address.
+             * The two-letter United States Postal Service (USPS) abbreviation for the US
+             * state, province, or region of the address. Required in certain countries.
              */
-            zip: string;
+            state?: string;
             /**
-             * The second line of the address. This might be the floor or room number.
+             * The ZIP or postal code of the address. Required in certain countries.
              */
-            line2?: string;
+            zip?: string;
         }
         /**
          * A means of verifying the person's identity.
@@ -1887,26 +1968,30 @@ export declare namespace EntityCreateParams {
                  */
                 interface Address {
                     /**
-                     * The city of the address.
+                     * The city, district, town, or village of the address.
                      */
                     city: string;
+                    /**
+                     * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+                     */
+                    country: 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.
+                     * The second line of the address. This might be the floor or room number.
                      */
-                    state: string;
+                    line2?: string;
                     /**
-                     * The ZIP code of the address.
+                     * The two-letter United States Postal Service (USPS) abbreviation for the US
+                     * state, province, or region of the address. Required in certain countries.
                      */
-                    zip: string;
+                    state?: string;
                     /**
-                     * The second line of the address. This might be the floor or room number.
+                     * The ZIP or postal code of the address. Required in certain countries.
                      */
-                    line2?: string;
+                    zip?: string;
                 }
                 /**
                  * A means of verifying the person's identity.
@@ -2054,26 +2139,30 @@ export declare namespace EntityCreateParams {
              */
             interface Address {
                 /**
-                 * The city of the address.
+                 * The city, district, town, or village of the address.
                  */
                 city: string;
+                /**
+                 * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+                 */
+                country: 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.
+                 * The second line of the address. This might be the floor or room number.
                  */
-                state: string;
+                line2?: string;
                 /**
-                 * The ZIP code of the address.
+                 * The two-letter United States Postal Service (USPS) abbreviation for the US
+                 * state, province, or region of the address. Required in certain countries.
                  */
-                zip: string;
+                state?: string;
                 /**
-                 * The second line of the address. This might be the floor or room number.
+                 * The ZIP or postal code of the address. Required in certain countries.
                  */
-                line2?: string;
+                zip?: string;
             }
             /**
              * A means of verifying the person's identity.
@@ -2269,26 +2358,30 @@ export declare namespace EntityUpdateParams {
          */
         interface Address {
             /**
-             * The city of the address.
+             * The city, district, town, or village of the address.
              */
             city: string;
+            /**
+             * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+             */
+            country: 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.
+             * The second line of the address. This might be the floor or room number.
              */
-            state: string;
+            line2?: string;
             /**
-             * The ZIP code of the address.
+             * The two-letter United States Postal Service (USPS) abbreviation for the US
+             * state, province, or region of the address. Required in certain countries.
              */
-            zip: string;
+            state?: string;
             /**
-             * The second line of the address. This might be the floor or room number.
+             * The ZIP or postal code of the address. Required in certain countries.
              */
-            line2?: string;
+            zip?: string;
         }
     }
     /**
@@ -2357,26 +2450,30 @@ export declare namespace EntityUpdateParams {
          */
         interface Address {
             /**
-             * The city of the address.
+             * The city, district, town, or village of the address.
              */
             city: string;
+            /**
+             * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+             */
+            country: 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.
+             * The second line of the address. This might be the floor or room number.
              */
-            state: string;
+            line2?: string;
             /**
-             * The ZIP code of the address.
+             * The two-letter United States Postal Service (USPS) abbreviation for the US
+             * state, province, or region of the address. Required in certain countries.
              */
-            zip: string;
+            state?: string;
             /**
-             * The second line of the address. This might be the floor or room number.
+             * The ZIP or postal code of the address. Required in certain countries.
              */
-            line2?: string;
+            zip?: string;
         }
     }
     /**