v1

latestOpenAPI 3.0.02026-08-063524105.9 KB

Telephony - Address Bundles

Create address bundle

Create a new address bundle for regulatory compliance.

post/internal/telephony/address-bundles

Request body

workspaceIdstring uuid required

Workspace ID

businessNamestring required

Business name

streetAddressstring required

Street address

citystring required

City

statestring required

State

zipstring required

Postal code

countryCode'US' | 'GB' | 'MX' | 'CO'

Country code

Example request

{
  "businessName": "Acme Corp",
  "streetAddress": "123 Main St",
  "city": "New York",
  "state": "NY",
  "zip": "10001",
  "countryCode": "US"
}

Response

Address bundle created

idstring uuid required

Unique identifier

workspaceIdstring uuid required

Workspace ID

providerIdstring nullable required

Provider bundle ID

status'pending' | 'approved' | 'rejected' required

Bundle status

countryCode'US' | 'GB' | 'MX' | 'CO' required

Country code

businessNamestring required

Business name

streetAddressstring required

Street address

citystring required

City

statestring required

State/Province

zipstring required

Postal code

createdAtstring date-time required

Creation timestamp

updatedAtstring date-time required

Last update timestamp

Example response

{
  "status": "approved",
  "countryCode": "US",
  "businessName": "Acme Corp",
  "streetAddress": "123 Main St",
  "city": "New York",
  "state": "NY",
  "zip": "10001"
}