Skip to main content
POST
Create address

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

A regulatory address. firstName and lastName are required: the carrier will not register an address without a named person. Requests that omit them are refused with 400 invalid_request, and the SDKs still type them as optional until their next release.

firstName
string
required

First name of the person the address is registered to.

Required string length: 1 - 100
lastName
string
required

Last name of the person the address is registered to.

Required string length: 1 - 100
streetAddress
string
required
Maximum string length: 200
locality
string
required
Maximum string length: 100
postalCode
string
required
Maximum string length: 20
countryCode
string
required
Required string length: 2
Example:

"DE"

businessName
string

Business name, when the address belongs to a business. Defaults to the person's full name.

Maximum string length: 200
extendedAddress
string
Maximum string length: 100
administrativeArea
string
Maximum string length: 100

Response

Address created.

address
object
required

A regulatory address for phone number requirements.