Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ docs/BlockedWebhook.md
docs/BridgeCompleteCallback.md
docs/BridgeTargetCompleteCallback.md
docs/BusinessEntityTypeEnum.md
docs/BusinessRegistrationIssuingCountryEnum.md
docs/BusinessRegistrationTypeEnum.md
docs/CallDirectionEnum.md
docs/CallRecordingMetadata.md
Expand Down Expand Up @@ -213,6 +214,7 @@ models/blocked-webhook.ts
models/bridge-complete-callback.ts
models/bridge-target-complete-callback.ts
models/business-entity-type-enum.ts
models/business-registration-issuing-country-enum.ts
models/business-registration-type-enum.ts
models/call-direction-enum.ts
models/call-recording-metadata.ts
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,7 @@ 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)
Expand Down
111 changes: 88 additions & 23 deletions bandwidth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5828,38 +5828,106 @@ components:
type: string
businessRegistrationNumber:
type: string
description: >-
US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional
until early 2026. If a value is provided for this field, a value must be
provided for `businessRegistrationType` and `businessEntityType`.
Available starting October 1st, 2025.
description: Government-issued business identifying number.
nullable: true
maxLength: 500
example: 12-3456789
businessRegistrationTypeEnum:
type: string
description: >-
The type of business registration number. Optional until early 2026;
required if `businessRegistrationNumber` is provided. Available starting
October 1st, 2025.
description: The type of business registration number.
enum:
- EIN
- CBN
- NEQ
- PROVINCIAL_NUMBER
- CRN
- VAT
- ACN
- ABN
- BRN
- SIREN
- SIRET
- NZBN
- UST_IDNR
- CIF
- NIF
- CNPJ
- UID
- OTHER
nullable: true
businessRegistrationIssuingCountryEnum:
type: string
description: >-
The country issuing the business registration in ISO-3166-1 alpha-3
format.


| 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 |
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. Optional until early 2026;
required if `businessRegistrationNumber` is provided. Available starting
October 1st, 2025.
provide "SOLE_PROPRIETOR" as a value.
enum:
- SOLE_PROPRIETOR
- PRIVATE_PROFIT
- PUBLIC_PROFIT
- NON_PROFIT
- GOVERNMENT
nullable: true
nullable: false
helpMessageResponse:
type: string
description: A message that gets sent to users requesting help.
Expand Down Expand Up @@ -5914,6 +5982,7 @@ components:
- useCaseSummary
- productionMessageContent
- optInWorkflow
- businessEntityType
properties:
businessAddress:
$ref: '#/components/schemas/address'
Expand Down Expand Up @@ -5958,6 +6027,8 @@ components:
$ref: '#/components/schemas/businessRegistrationNumber'
businessRegistrationType:
$ref: '#/components/schemas/businessRegistrationTypeEnum'
businessRegistrationIssuingCountry:
$ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
businessEntityType:
$ref: '#/components/schemas/businessEntityTypeEnum'
helpMessageResponse:
Expand Down Expand Up @@ -6011,6 +6082,8 @@ components:
$ref: '#/components/schemas/businessRegistrationTypeEnum'
businessEntityType:
$ref: '#/components/schemas/businessEntityTypeEnum'
businessRegistrationIssuingCountry:
$ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
helpMessageResponse:
$ref: '#/components/schemas/helpMessageResponse'
ageGatedContent:
Expand Down Expand Up @@ -6503,20 +6576,12 @@ components:
$ref: '#/components/schemas/businessDba'
businessRegistrationNumber:
$ref: '#/components/schemas/businessRegistrationNumber'
description: >-
US Federal Tax ID Number (EIN) or Canada Business Number (CBN).
Available starting October 1st, 2025.
businessRegistrationType:
$ref: '#/components/schemas/businessRegistrationTypeEnum'
description: >-
The type of business registration number. Available starting October
1st, 2025.
businessRegistrationIssuingCountry:
$ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
businessEntityType:
$ref: '#/components/schemas/businessEntityTypeEnum'
description: >-
The type of registered business. If no option is applicable, please
provide "SOLE_PROPRIETOR" as a value. Available starting October
1st, 2025.
tfvStatusEnum:
type: string
enum:
Expand Down
2 changes: 1 addition & 1 deletion docs/BusinessEntityTypeEnum.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# BusinessEntityTypeEnum

The type of registered business. If no option is applicable, please provide \"SOLE_PROPRIETOR\" as a value. Optional until early 2026; required if `businessRegistrationNumber` is provided. Available starting October 1st, 2025.
The type of registered business. If no option is applicable, please provide \"SOLE_PROPRIETOR\" as a value.

## Enum

Expand Down
33 changes: 33 additions & 0 deletions docs/BusinessRegistrationIssuingCountryEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# BusinessRegistrationIssuingCountryEnum

The country issuing the business registration in ISO-3166-1 alpha-3 format. | 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 |

## Enum

* `Usa` (value: `'USA'`)

* `Can` (value: `'CAN'`)

* `Hkg` (value: `'HKG'`)

* `Gbr` (value: `'GBR'`)

* `Irl` (value: `'IRL'`)

* `Bra` (value: `'BRA'`)

* `Nld` (value: `'NLD'`)

* `Aus` (value: `'AUS'`)

* `Fra` (value: `'FRA'`)

* `Nzl` (value: `'NZL'`)

* `Deu` (value: `'DEU'`)

* `Esp` (value: `'ESP'`)

* `Che` (value: `'CHE'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
34 changes: 33 additions & 1 deletion docs/BusinessRegistrationTypeEnum.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,43 @@
# BusinessRegistrationTypeEnum

The type of business registration number. Optional until early 2026; required if `businessRegistrationNumber` is provided. Available starting October 1st, 2025.
The type of business registration number.

## Enum

* `Ein` (value: `'EIN'`)

* `Cbn` (value: `'CBN'`)

* `Neq` (value: `'NEQ'`)

* `ProvincialNumber` (value: `'PROVINCIAL_NUMBER'`)

* `Crn` (value: `'CRN'`)

* `Vat` (value: `'VAT'`)

* `Acn` (value: `'ACN'`)

* `Abn` (value: `'ABN'`)

* `Brn` (value: `'BRN'`)

* `Siren` (value: `'SIREN'`)

* `Siret` (value: `'SIRET'`)

* `Nzbn` (value: `'NZBN'`)

* `UstIdnr` (value: `'UST_IDNR'`)

* `Cif` (value: `'CIF'`)

* `Nif` (value: `'NIF'`)

* `Cnpj` (value: `'CNPJ'`)

* `Uid` (value: `'UID'`)

* `Other` (value: `'OTHER'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
4 changes: 3 additions & 1 deletion docs/TfvSubmissionInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@ Name | Type | Description | Notes
**privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. | [optional] [default to undefined]
**termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional] [default to undefined]
**businessDba** | **string** | The company \'Doing Business As\'. | [optional] [default to undefined]
**businessRegistrationNumber** | **string** | US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional until early 2026. If a value is provided for this field, a value must be provided for `businessRegistrationType` and `businessEntityType`. Available starting October 1st, 2025. | [optional] [default to undefined]
**businessRegistrationNumber** | **string** | Government-issued business identifying number. | [optional] [default to undefined]
**businessRegistrationType** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] [default to undefined]
**businessRegistrationIssuingCountry** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] [default to undefined]
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] [default to undefined]

## Example
Expand All @@ -41,6 +42,7 @@ const instance: TfvSubmissionInfo = {
businessDba,
businessRegistrationNumber,
businessRegistrationType,
businessRegistrationIssuingCountry,
businessEntityType,
};
```
Expand Down
6 changes: 4 additions & 2 deletions docs/VerificationRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ Name | Type | Description | Notes
**privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. | [optional] [default to undefined]
**termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional] [default to undefined]
**businessDba** | **string** | The company \'Doing Business As\'. | [optional] [default to undefined]
**businessRegistrationNumber** | **string** | US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional until early 2026. If a value is provided for this field, a value must be provided for `businessRegistrationType` and `businessEntityType`. Available starting October 1st, 2025. | [optional] [default to undefined]
**businessRegistrationNumber** | **string** | Government-issued business identifying number. | [optional] [default to undefined]
**businessRegistrationType** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] [default to undefined]
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] [default to undefined]
**businessRegistrationIssuingCountry** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] [default to undefined]
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [default to undefined]
**helpMessageResponse** | **string** | A message that gets sent to users requesting help. | [optional] [default to undefined]
**ageGatedContent** | **boolean** | Indicates whether the content is age-gated. | [optional] [default to undefined]
**cvToken** | **string** | 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] [default to undefined]
Expand All @@ -46,6 +47,7 @@ const instance: VerificationRequest = {
businessDba,
businessRegistrationNumber,
businessRegistrationType,
businessRegistrationIssuingCountry,
businessEntityType,
helpMessageResponse,
ageGatedContent,
Expand Down
4 changes: 3 additions & 1 deletion docs/VerificationUpdateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@ Name | Type | Description | Notes
**privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. | [optional] [default to undefined]
**termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional] [default to undefined]
**businessDba** | **string** | The company \'Doing Business As\'. | [optional] [default to undefined]
**businessRegistrationNumber** | **string** | US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional until early 2026. If a value is provided for this field, a value must be provided for `businessRegistrationType` and `businessEntityType`. Available starting October 1st, 2025. | [optional] [default to undefined]
**businessRegistrationNumber** | **string** | Government-issued business identifying number. | [optional] [default to undefined]
**businessRegistrationType** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] [default to undefined]
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] [default to undefined]
**businessRegistrationIssuingCountry** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] [default to undefined]
**helpMessageResponse** | **string** | A message that gets sent to users requesting help. | [optional] [default to undefined]
**ageGatedContent** | **boolean** | Indicates whether the content is age-gated. | [optional] [default to undefined]
**cvToken** | **string** | 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] [default to undefined]
Expand All @@ -45,6 +46,7 @@ const instance: VerificationUpdateRequest = {
businessRegistrationNumber,
businessRegistrationType,
businessEntityType,
businessRegistrationIssuingCountry,
helpMessageResponse,
ageGatedContent,
cvToken,
Expand Down
2 changes: 1 addition & 1 deletion models/business-entity-type-enum.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@


/**
* The type of registered business. If no option is applicable, please provide \"SOLE_PROPRIETOR\" as a value. Optional until early 2026; required if `businessRegistrationNumber` is provided. Available starting October 1st, 2025.
* The type of registered business. If no option is applicable, please provide \"SOLE_PROPRIETOR\" as a value.
*/

export const BusinessEntityTypeEnum = {
Expand Down
40 changes: 40 additions & 0 deletions models/business-registration-issuing-country-enum.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
/* tslint:disable */
/* eslint-disable */
/**
* Bandwidth
* Bandwidth\'s Communication APIs
*
* The version of the OpenAPI document: 1.0.0
* Contact: letstalk@bandwidth.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/



/**
* The country issuing the business registration in ISO-3166-1 alpha-3 format. | 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 |
*/

export const BusinessRegistrationIssuingCountryEnum = {
Usa: 'USA',
Can: 'CAN',
Hkg: 'HKG',
Gbr: 'GBR',
Irl: 'IRL',
Bra: 'BRA',
Nld: 'NLD',
Aus: 'AUS',
Fra: 'FRA',
Nzl: 'NZL',
Deu: 'DEU',
Esp: 'ESP',
Che: 'CHE'
} as const;

export type BusinessRegistrationIssuingCountryEnum = typeof BusinessRegistrationIssuingCountryEnum[keyof typeof BusinessRegistrationIssuingCountryEnum];



Loading