Skip to content

Get address

View .md
GET

Get a specific regulatory address.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • addressIdstringrequired

Responses

200Address details.
  • 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>
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject
404Address not found.
  • codestringrequired
  • messagestringrequired
  • detailsobject