From f1d1e9f090b2189caeda60a4726c5c8b37dd7eb2 Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Tue, 17 Mar 2026 18:55:03 +0000 Subject: [PATCH] Generate SDK with OpenAPI Generator Version --- .openapi-generator/FILES | 2 - README.md | 1 - bandwidth.yml | 54 ++++++++++--------- bandwidth/__init__.py | 2 - bandwidth/models/__init__.py | 1 - bandwidth/models/business_entity_type_enum.py | 2 +- .../models/business_registration_type_enum.py | 2 +- bandwidth/models/tfv_submission_info.py | 5 +- bandwidth/models/verification_request.py | 5 +- .../models/verification_update_request.py | 5 +- docs/BusinessEntityTypeEnum.md | 2 +- docs/BusinessRegistrationTypeEnum.md | 2 +- docs/TfvSubmissionInfo.md | 4 +- docs/VerificationRequest.md | 4 +- docs/VerificationUpdateRequest.md | 4 +- 15 files changed, 46 insertions(+), 49 deletions(-) diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index bcfdec9d..1380f48c 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -28,7 +28,6 @@ bandwidth/models/blocked_webhook.py bandwidth/models/bridge_complete_callback.py bandwidth/models/bridge_target_complete_callback.py bandwidth/models/business_entity_type_enum.py -bandwidth/models/business_registration_issuing_country_enum.py bandwidth/models/business_registration_type_enum.py bandwidth/models/call_direction_enum.py bandwidth/models/call_recording_metadata.py @@ -207,7 +206,6 @@ docs/BlockedWebhook.md docs/BridgeCompleteCallback.md docs/BridgeTargetCompleteCallback.md docs/BusinessEntityTypeEnum.md -docs/BusinessRegistrationIssuingCountryEnum.md docs/BusinessRegistrationTypeEnum.md docs/CallDirectionEnum.md docs/CallRecordingMetadata.md diff --git a/README.md b/README.md index 2d261f30..1a9d687d 100644 --- a/README.md +++ b/README.md @@ -166,7 +166,6 @@ Class | Method | HTTP request | Description - [BridgeCompleteCallback](docs/BridgeCompleteCallback.md) - [BridgeTargetCompleteCallback](docs/BridgeTargetCompleteCallback.md) - [BusinessEntityTypeEnum](docs/BusinessEntityTypeEnum.md) - - [BusinessRegistrationIssuingCountryEnum](docs/BusinessRegistrationIssuingCountryEnum.md) - [BusinessRegistrationTypeEnum](docs/BusinessRegistrationTypeEnum.md) - [CallDirectionEnum](docs/CallDirectionEnum.md) - [CallRecordingMetadata](docs/CallRecordingMetadata.md) diff --git a/bandwidth.yml b/bandwidth.yml index 4948dd1d..0c6582e3 100644 --- a/bandwidth.yml +++ b/bandwidth.yml @@ -5828,13 +5828,21 @@ components: type: string businessRegistrationNumber: type: string - description: Government-issued business identifying number. + description: > + Government-issued business identifying number. + + + **Note:** If this field is provided, it is strongly recommended to also + provide `businessRegistrationType` and + `businessRegistrationIssuingCountry`. Submissions missing these fields + have a high likelihood of rejection. nullable: true maxLength: 500 example: 12-3456789 businessRegistrationTypeEnum: type: string - description: The type of business registration number. + description: | + The type of business registration number. enum: - EIN - CBN @@ -5855,11 +5863,20 @@ components: - UID - OTHER nullable: true - businessRegistrationIssuingCountryEnum: + businessRegistrationIssuingCountry: type: string description: >- The country issuing the business registration in ISO-3166-1 alpha-3 - format. + format. Alpha-2 country codes are acceptable, but the application will + convert them to alpha-3 when received, so alpha-3 is encouraged. + + + **Note:** If this field is omitted but `businessRegistrationType` is + provided, the application will attempt to infer the country based on the + registration type. However, if the application cannot confidently infer + the country, the submission may be rejected. To ensure the highest + likelihood of acceptance, it is recommended to provide both + `businessRegistrationType` and `businessRegistrationIssuingCountry`. | Registration Type | Supported Countries | @@ -5901,26 +5918,11 @@ components: | UID | CHE | | OTHER | Must Provide Country Code | - enum: - - USA - - CAN - - HKG - - GBR - - IRL - - BRA - - NLD - - AUS - - FRA - - NZL - - DEU - - ESP - - CHE nullable: false businessEntityTypeEnum: type: string - description: >- - The type of registered business. If no option is applicable, please - provide "SOLE_PROPRIETOR" as a value. + description: | + The type of registered business. enum: - SOLE_PROPRIETOR - PRIVATE_PROFIT @@ -6028,7 +6030,7 @@ components: businessRegistrationType: $ref: '#/components/schemas/businessRegistrationTypeEnum' businessRegistrationIssuingCountry: - $ref: '#/components/schemas/businessRegistrationIssuingCountryEnum' + $ref: '#/components/schemas/businessRegistrationIssuingCountry' businessEntityType: $ref: '#/components/schemas/businessEntityTypeEnum' helpMessageResponse: @@ -6083,7 +6085,7 @@ components: businessEntityType: $ref: '#/components/schemas/businessEntityTypeEnum' businessRegistrationIssuingCountry: - $ref: '#/components/schemas/businessRegistrationIssuingCountryEnum' + $ref: '#/components/schemas/businessRegistrationIssuingCountry' helpMessageResponse: $ref: '#/components/schemas/helpMessageResponse' ageGatedContent: @@ -6576,10 +6578,14 @@ components: $ref: '#/components/schemas/businessDba' businessRegistrationNumber: $ref: '#/components/schemas/businessRegistrationNumber' + description: Government-issued business identifying number. businessRegistrationType: $ref: '#/components/schemas/businessRegistrationTypeEnum' businessRegistrationIssuingCountry: - $ref: '#/components/schemas/businessRegistrationIssuingCountryEnum' + $ref: '#/components/schemas/businessRegistrationIssuingCountry' + description: >- + The country issuing the business registration in ISO-3166-1 alpha-3 + format. businessEntityType: $ref: '#/components/schemas/businessEntityTypeEnum' tfvStatusEnum: diff --git a/bandwidth/__init__.py b/bandwidth/__init__.py index 13b8760a..5d5b6304 100644 --- a/bandwidth/__init__.py +++ b/bandwidth/__init__.py @@ -48,7 +48,6 @@ "BridgeCompleteCallback", "BridgeTargetCompleteCallback", "BusinessEntityTypeEnum", - "BusinessRegistrationIssuingCountryEnum", "BusinessRegistrationTypeEnum", "CallDirectionEnum", "CallRecordingMetadata", @@ -252,7 +251,6 @@ from bandwidth.models.bridge_complete_callback import BridgeCompleteCallback as BridgeCompleteCallback from bandwidth.models.bridge_target_complete_callback import BridgeTargetCompleteCallback as BridgeTargetCompleteCallback from bandwidth.models.business_entity_type_enum import BusinessEntityTypeEnum as BusinessEntityTypeEnum -from bandwidth.models.business_registration_issuing_country_enum import BusinessRegistrationIssuingCountryEnum as BusinessRegistrationIssuingCountryEnum from bandwidth.models.business_registration_type_enum import BusinessRegistrationTypeEnum as BusinessRegistrationTypeEnum from bandwidth.models.call_direction_enum import CallDirectionEnum as CallDirectionEnum from bandwidth.models.call_recording_metadata import CallRecordingMetadata as CallRecordingMetadata diff --git a/bandwidth/models/__init__.py b/bandwidth/models/__init__.py index abab5129..58a7cc68 100644 --- a/bandwidth/models/__init__.py +++ b/bandwidth/models/__init__.py @@ -23,7 +23,6 @@ from bandwidth.models.bridge_complete_callback import BridgeCompleteCallback from bandwidth.models.bridge_target_complete_callback import BridgeTargetCompleteCallback from bandwidth.models.business_entity_type_enum import BusinessEntityTypeEnum -from bandwidth.models.business_registration_issuing_country_enum import BusinessRegistrationIssuingCountryEnum from bandwidth.models.business_registration_type_enum import BusinessRegistrationTypeEnum from bandwidth.models.call_direction_enum import CallDirectionEnum from bandwidth.models.call_recording_metadata import CallRecordingMetadata diff --git a/bandwidth/models/business_entity_type_enum.py b/bandwidth/models/business_entity_type_enum.py index 6b17ac2d..30b0fc38 100644 --- a/bandwidth/models/business_entity_type_enum.py +++ b/bandwidth/models/business_entity_type_enum.py @@ -21,7 +21,7 @@ class BusinessEntityTypeEnum(str, Enum): """ - The type of registered business. If no option is applicable, please provide \"SOLE_PROPRIETOR\" as a value. + The type of registered business. """ """ diff --git a/bandwidth/models/business_registration_type_enum.py b/bandwidth/models/business_registration_type_enum.py index 1c78e389..79e4c26f 100644 --- a/bandwidth/models/business_registration_type_enum.py +++ b/bandwidth/models/business_registration_type_enum.py @@ -21,7 +21,7 @@ class BusinessRegistrationTypeEnum(str, Enum): """ - The type of business registration number. + The type of business registration number. """ """ diff --git a/bandwidth/models/tfv_submission_info.py b/bandwidth/models/tfv_submission_info.py index f1118c32..fc876ff4 100644 --- a/bandwidth/models/tfv_submission_info.py +++ b/bandwidth/models/tfv_submission_info.py @@ -23,7 +23,6 @@ from typing_extensions import Annotated from bandwidth.models.address import Address from bandwidth.models.business_entity_type_enum import BusinessEntityTypeEnum -from bandwidth.models.business_registration_issuing_country_enum import BusinessRegistrationIssuingCountryEnum from bandwidth.models.business_registration_type_enum import BusinessRegistrationTypeEnum from bandwidth.models.contact import Contact from bandwidth.models.opt_in_workflow import OptInWorkflow @@ -46,9 +45,9 @@ class TfvSubmissionInfo(BaseModel): privacy_policy_url: Optional[StrictStr] = Field(default=None, description="The Toll-Free Verification request privacy policy URL.", alias="privacyPolicyUrl") terms_and_conditions_url: Optional[StrictStr] = Field(default=None, description="The Toll-Free Verification request terms and conditions policy URL.", alias="termsAndConditionsUrl") business_dba: Optional[StrictStr] = Field(default=None, description="The company 'Doing Business As'.", alias="businessDba") - business_registration_number: Optional[Annotated[str, Field(strict=True, max_length=500)]] = Field(default=None, description="Government-issued business identifying number.", alias="businessRegistrationNumber") + business_registration_number: Optional[Annotated[str, Field(strict=True, max_length=500)]] = Field(default=None, description="Government-issued business identifying number. **Note:** If this field is provided, it is strongly recommended to also provide `businessRegistrationType` and `businessRegistrationIssuingCountry`. Submissions missing these fields have a high likelihood of rejection. ", alias="businessRegistrationNumber") business_registration_type: Optional[BusinessRegistrationTypeEnum] = Field(default=None, alias="businessRegistrationType") - business_registration_issuing_country: Optional[BusinessRegistrationIssuingCountryEnum] = Field(default=None, alias="businessRegistrationIssuingCountry") + business_registration_issuing_country: Optional[StrictStr] = Field(default=None, description="The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 country codes are acceptable, but the application will convert them to alpha-3 when received, so alpha-3 is encouraged. **Note:** If this field is omitted but `businessRegistrationType` is provided, the application will attempt to infer the country based on the registration type. However, if the application cannot confidently infer the country, the submission may be rejected. To ensure the highest likelihood of acceptance, it is recommended to provide both `businessRegistrationType` and `businessRegistrationIssuingCountry`. | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code |", alias="businessRegistrationIssuingCountry") business_entity_type: Optional[BusinessEntityTypeEnum] = Field(default=None, alias="businessEntityType") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["businessAddress", "businessContact", "messageVolume", "useCase", "useCaseSummary", "productionMessageContent", "optInWorkflow", "additionalInformation", "isvReseller", "privacyPolicyUrl", "termsAndConditionsUrl", "businessDba", "businessRegistrationNumber", "businessRegistrationType", "businessRegistrationIssuingCountry", "businessEntityType"] diff --git a/bandwidth/models/verification_request.py b/bandwidth/models/verification_request.py index a3fa4234..6f9a4d71 100644 --- a/bandwidth/models/verification_request.py +++ b/bandwidth/models/verification_request.py @@ -23,7 +23,6 @@ from typing_extensions import Annotated from bandwidth.models.address import Address from bandwidth.models.business_entity_type_enum import BusinessEntityTypeEnum -from bandwidth.models.business_registration_issuing_country_enum import BusinessRegistrationIssuingCountryEnum from bandwidth.models.business_registration_type_enum import BusinessRegistrationTypeEnum from bandwidth.models.contact import Contact from bandwidth.models.opt_in_workflow import OptInWorkflow @@ -47,9 +46,9 @@ class VerificationRequest(BaseModel): privacy_policy_url: Optional[StrictStr] = Field(default=None, description="The Toll-Free Verification request privacy policy URL.", alias="privacyPolicyUrl") terms_and_conditions_url: Optional[StrictStr] = Field(default=None, description="The Toll-Free Verification request terms and conditions policy URL.", alias="termsAndConditionsUrl") business_dba: Optional[StrictStr] = Field(default=None, description="The company 'Doing Business As'.", alias="businessDba") - business_registration_number: Optional[Annotated[str, Field(strict=True, max_length=500)]] = Field(default=None, description="Government-issued business identifying number.", alias="businessRegistrationNumber") + business_registration_number: Optional[Annotated[str, Field(strict=True, max_length=500)]] = Field(default=None, description="Government-issued business identifying number. **Note:** If this field is provided, it is strongly recommended to also provide `businessRegistrationType` and `businessRegistrationIssuingCountry`. Submissions missing these fields have a high likelihood of rejection. ", alias="businessRegistrationNumber") business_registration_type: Optional[BusinessRegistrationTypeEnum] = Field(default=None, alias="businessRegistrationType") - business_registration_issuing_country: Optional[BusinessRegistrationIssuingCountryEnum] = Field(default=None, alias="businessRegistrationIssuingCountry") + business_registration_issuing_country: Optional[StrictStr] = Field(default=None, description="The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 country codes are acceptable, but the application will convert them to alpha-3 when received, so alpha-3 is encouraged. **Note:** If this field is omitted but `businessRegistrationType` is provided, the application will attempt to infer the country based on the registration type. However, if the application cannot confidently infer the country, the submission may be rejected. To ensure the highest likelihood of acceptance, it is recommended to provide both `businessRegistrationType` and `businessRegistrationIssuingCountry`. | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code |", alias="businessRegistrationIssuingCountry") business_entity_type: BusinessEntityTypeEnum = Field(alias="businessEntityType") help_message_response: Optional[Annotated[str, Field(strict=True, max_length=500)]] = Field(default=None, description="A message that gets sent to users requesting help.", alias="helpMessageResponse") age_gated_content: Optional[StrictBool] = Field(default=None, description="Indicates whether the content is age-gated.", alias="ageGatedContent") diff --git a/bandwidth/models/verification_update_request.py b/bandwidth/models/verification_update_request.py index 1dce7948..cb6b70d5 100644 --- a/bandwidth/models/verification_update_request.py +++ b/bandwidth/models/verification_update_request.py @@ -23,7 +23,6 @@ from typing_extensions import Annotated from bandwidth.models.address import Address from bandwidth.models.business_entity_type_enum import BusinessEntityTypeEnum -from bandwidth.models.business_registration_issuing_country_enum import BusinessRegistrationIssuingCountryEnum from bandwidth.models.business_registration_type_enum import BusinessRegistrationTypeEnum from bandwidth.models.contact import Contact from bandwidth.models.opt_in_workflow import OptInWorkflow @@ -46,10 +45,10 @@ class VerificationUpdateRequest(BaseModel): privacy_policy_url: Optional[StrictStr] = Field(default=None, description="The Toll-Free Verification request privacy policy URL.", alias="privacyPolicyUrl") terms_and_conditions_url: Optional[StrictStr] = Field(default=None, description="The Toll-Free Verification request terms and conditions policy URL.", alias="termsAndConditionsUrl") business_dba: Optional[StrictStr] = Field(default=None, description="The company 'Doing Business As'.", alias="businessDba") - business_registration_number: Optional[Annotated[str, Field(strict=True, max_length=500)]] = Field(default=None, description="Government-issued business identifying number.", alias="businessRegistrationNumber") + business_registration_number: Optional[Annotated[str, Field(strict=True, max_length=500)]] = Field(default=None, description="Government-issued business identifying number. **Note:** If this field is provided, it is strongly recommended to also provide `businessRegistrationType` and `businessRegistrationIssuingCountry`. Submissions missing these fields have a high likelihood of rejection. ", alias="businessRegistrationNumber") business_registration_type: Optional[BusinessRegistrationTypeEnum] = Field(default=None, alias="businessRegistrationType") business_entity_type: Optional[BusinessEntityTypeEnum] = Field(default=None, alias="businessEntityType") - business_registration_issuing_country: Optional[BusinessRegistrationIssuingCountryEnum] = Field(default=None, alias="businessRegistrationIssuingCountry") + business_registration_issuing_country: Optional[StrictStr] = Field(default=None, description="The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 country codes are acceptable, but the application will convert them to alpha-3 when received, so alpha-3 is encouraged. **Note:** If this field is omitted but `businessRegistrationType` is provided, the application will attempt to infer the country based on the registration type. However, if the application cannot confidently infer the country, the submission may be rejected. To ensure the highest likelihood of acceptance, it is recommended to provide both `businessRegistrationType` and `businessRegistrationIssuingCountry`. | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code |", alias="businessRegistrationIssuingCountry") help_message_response: Optional[Annotated[str, Field(strict=True, max_length=500)]] = Field(default=None, description="A message that gets sent to users requesting help.", alias="helpMessageResponse") age_gated_content: Optional[StrictBool] = Field(default=None, description="Indicates whether the content is age-gated.", alias="ageGatedContent") cv_token: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=500)]] = Field(default=None, description="The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted. Supplying an empty string will likely result in rejection.", alias="cvToken") diff --git a/docs/BusinessEntityTypeEnum.md b/docs/BusinessEntityTypeEnum.md index 81844eff..97dcd6ae 100644 --- a/docs/BusinessEntityTypeEnum.md +++ b/docs/BusinessEntityTypeEnum.md @@ -1,6 +1,6 @@ # BusinessEntityTypeEnum -The type of registered business. If no option is applicable, please provide \"SOLE_PROPRIETOR\" as a value. +The type of registered business. ## Enum diff --git a/docs/BusinessRegistrationTypeEnum.md b/docs/BusinessRegistrationTypeEnum.md index fb15fb9c..f9db0d4e 100644 --- a/docs/BusinessRegistrationTypeEnum.md +++ b/docs/BusinessRegistrationTypeEnum.md @@ -1,6 +1,6 @@ # BusinessRegistrationTypeEnum -The type of business registration number. +The type of business registration number. ## Enum diff --git a/docs/TfvSubmissionInfo.md b/docs/TfvSubmissionInfo.md index 701bc8ce..1f05c96b 100644 --- a/docs/TfvSubmissionInfo.md +++ b/docs/TfvSubmissionInfo.md @@ -17,9 +17,9 @@ Name | Type | Description | Notes **privacy_policy_url** | **str** | The Toll-Free Verification request privacy policy URL. | [optional] **terms_and_conditions_url** | **str** | The Toll-Free Verification request terms and conditions policy URL. | [optional] **business_dba** | **str** | The company 'Doing Business As'. | [optional] -**business_registration_number** | **str** | Government-issued business identifying number. | [optional] +**business_registration_number** | **str** | Government-issued business identifying number. **Note:** If this field is provided, it is strongly recommended to also provide `businessRegistrationType` and `businessRegistrationIssuingCountry`. Submissions missing these fields have a high likelihood of rejection. | [optional] **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] -**business_registration_issuing_country** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] +**business_registration_issuing_country** | **str** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 country codes are acceptable, but the application will convert them to alpha-3 when received, so alpha-3 is encouraged. **Note:** If this field is omitted but `businessRegistrationType` is provided, the application will attempt to infer the country based on the registration type. However, if the application cannot confidently infer the country, the submission may be rejected. To ensure the highest likelihood of acceptance, it is recommended to provide both `businessRegistrationType` and `businessRegistrationIssuingCountry`. | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] ## Example diff --git a/docs/VerificationRequest.md b/docs/VerificationRequest.md index 99e8b9cb..0170f710 100644 --- a/docs/VerificationRequest.md +++ b/docs/VerificationRequest.md @@ -18,9 +18,9 @@ Name | Type | Description | Notes **privacy_policy_url** | **str** | The Toll-Free Verification request privacy policy URL. | [optional] **terms_and_conditions_url** | **str** | The Toll-Free Verification request terms and conditions policy URL. | [optional] **business_dba** | **str** | The company 'Doing Business As'. | [optional] -**business_registration_number** | **str** | Government-issued business identifying number. | [optional] +**business_registration_number** | **str** | Government-issued business identifying number. **Note:** If this field is provided, it is strongly recommended to also provide `businessRegistrationType` and `businessRegistrationIssuingCountry`. Submissions missing these fields have a high likelihood of rejection. | [optional] **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] -**business_registration_issuing_country** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] +**business_registration_issuing_country** | **str** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 country codes are acceptable, but the application will convert them to alpha-3 when received, so alpha-3 is encouraged. **Note:** If this field is omitted but `businessRegistrationType` is provided, the application will attempt to infer the country based on the registration type. However, if the application cannot confidently infer the country, the submission may be rejected. To ensure the highest likelihood of acceptance, it is recommended to provide both `businessRegistrationType` and `businessRegistrationIssuingCountry`. | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | **help_message_response** | **str** | A message that gets sent to users requesting help. | [optional] **age_gated_content** | **bool** | Indicates whether the content is age-gated. | [optional] diff --git a/docs/VerificationUpdateRequest.md b/docs/VerificationUpdateRequest.md index f67cb6c6..9f2c7d95 100644 --- a/docs/VerificationUpdateRequest.md +++ b/docs/VerificationUpdateRequest.md @@ -17,10 +17,10 @@ Name | Type | Description | Notes **privacy_policy_url** | **str** | The Toll-Free Verification request privacy policy URL. | [optional] **terms_and_conditions_url** | **str** | The Toll-Free Verification request terms and conditions policy URL. | [optional] **business_dba** | **str** | The company 'Doing Business As'. | [optional] -**business_registration_number** | **str** | Government-issued business identifying number. | [optional] +**business_registration_number** | **str** | Government-issued business identifying number. **Note:** If this field is provided, it is strongly recommended to also provide `businessRegistrationType` and `businessRegistrationIssuingCountry`. Submissions missing these fields have a high likelihood of rejection. | [optional] **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] -**business_registration_issuing_country** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] +**business_registration_issuing_country** | **str** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 country codes are acceptable, but the application will convert them to alpha-3 when received, so alpha-3 is encouraged. **Note:** If this field is omitted but `businessRegistrationType` is provided, the application will attempt to infer the country based on the registration type. However, if the application cannot confidently infer the country, the submission may be rejected. To ensure the highest likelihood of acceptance, it is recommended to provide both `businessRegistrationType` and `businessRegistrationIssuingCountry`. | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] **help_message_response** | **str** | A message that gets sent to users requesting help. | [optional] **age_gated_content** | **bool** | Indicates whether the content is age-gated. | [optional] **cv_token** | **str** | The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted. Supplying an empty string will likely result in rejection. | [optional]