Regulations

Overview

The Regulation module contains 11 methods that allow the management of the Local Address Requirements (LAR) of your DIDs.

The LAR of a DID group is indicated in the listDidGroup method (regulationAddress parameter in the response). This indicates whether a DID requires to be linked to an address, what type of address (local, national, etc.), and whether a proof of address is required. If there is a LAR for a given DID group, all the DIDs belonging to that group will be blocked after purchase until an address is linked to them.

If a proof of address is required, not only the address must be linked but a proof of address must be provided and verified by Voxbone. Therefore there are two different important notions when managing your regulation addresses:

  • Valid address: this is an address that contains all the data requested by the local regulator. Our systems can automatically check the validity of an address:
    • Extra mandatory information can be required in certain countries or for certain number types
    • A check is sometimes done on the zip code to verify that the number is in the same local area as the number
  • Verified address: this is an address which requires a proof of address and for which a Voxbone employee will manually check that the documents that have been submitted are the expected ones (e.g. correct type of document, correct address, etc.). The verification process can take up to 2 working days. Accepted documents are usually:
    • A recurring utility bill with Company/Customer name and address which is not older than 6 months
    • A government or state provided ID like passport, driver’s license or a letter from government verifying the customer’s address.

In the most complex cases (e.g. Germany), your geographic DIDs will have to be linked to a valid and verified address and the address will have to be local to the DID’s area code. An example of a possible call flow to implement Local Address Requirements could be the following (based on geographic German DID:

  • listDidGroup with the didGroupId of the purchased number will show proofRequired = true and addressType = LOCAL
  • If you have an existing address, you may use isAddressValid or directly try to link it to the DID using linkRegulationAddress, an error message will be returned indicating if there is any missing data.
  • Because for Germany the addressType is LOCAL, you have to use listZipCodes to make sure that a valid zip code is used for the number’s area code (otherwise the linkRegulationAddress will return an error even if the address is verified).
  • If there is no existing address, use the createRegulationAddress. Note that depending on the country of the DID (destinationCountryCodeA3) and its type (didType), the required data will differ.
  • Upload a proof of address. There are two different methods to upload a proof of address. You can upload a proof of address for an existing address using uploadProofOfAddress (only if the address is in status REJECTED or NOT VERIFIED), or you can specify the proofOfAddress field in the createRegulationAddress. The method will return an error if you try to upload an address proof for an address that is either “VERIFIED” or “VERIFICATION_NOT_REQUIRED” status.
  • You can use listRegulationAddress to check the status of your address, if the status is “VERIFIED” or “VERIFICATION_NOT_REQUIRED”, then linkRegulationAddress can link the DID to the address and unblock the number.
  • An address can be unlinked from a DID by using the same linkRegulationAddress method, and an unlinked address can be deleted by using deleteRegulationAddress.