Skip to content
DashboardGet API key

Create address

View .md
POST

Create a regulatory address, to use as the value of an address requirement when buying a phone number. It is registered for review when it is created, with status pending.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Body

application/json

  • firstNamestringrequired

    First name of the person the address is registered to.

    Limitsmin length 1 · max length 100
  • lastNamestringrequired

    Last name of the person the address is registered to.

    Limitsmin length 1 · max length 100
  • businessNamestring

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

    Limitsmax length 200
  • streetAddressstringrequired
    Limitsmax length 200
  • extendedAddressstring
    Limitsmax length 100
  • localitystringrequired
    Limitsmax length 100
  • administrativeAreastring
    Limitsmax length 100
  • postalCodestringrequired
    Limitsmax length 20
  • countryCodestringrequired
    Limitsmin length 2 · max length 2

Responses

201Address created.
  • addressobjectrequired

    A regulatory address for phone number requirements.

    13 properties
    • idstringrequired
    • firstNamestringnullable
    • lastNamestringnullable
    • businessNamestringnullable
    • streetAddressstringrequired
    • extendedAddressstringnullable
    • localitystringrequired
    • administrativeAreastringnullable
    • postalCodestringrequired
    • countryCodestringrequired
    • statusstringrequired
      One ofpendingverifiedrejected
    • createdAtstring<date-time>required
    • updatedAtstring<date-time>
400Invalid request (first name and last name are required), or the address could not be registered for review.
  • codestringrequired
  • messagestringrequired
  • detailsobject
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject