Create Regulation Address

The Regulation module allows the management of the Local Address Requirements (LAR) of your DIDs.

Create Regulation Address method – This method allows you to create a new end user’s address that can be linked to DIDs where a local address requirement (LAR) applies. The method allows the attachment of a proof of address. If a proof of address is attached, the system automatically triggers a “request for verification” so that Voxbone can manually verify the address elements. The media type to be used is multipart/form-data.

In some cases you will be asked to provide some additional information in order to create an address, in the shape of “extra fields” to be included in the address creation request. These extra fields are only required for specific countries and number types, as summarised in the table below :

Country Number type Field name Accepted values Description
Spain Mobile Nationality String, maximum length: 60 The exact format can be chosen freely as long as it allows a human to understand it. We recommend using the full country name but the ISO-3166-1 alpha-3 code is acceptable if it is easier to process by your system.
Spain Mobile Type of ID DNI, NIE, NIF, PASSPORT Only required for personal addresses (salutation is either MR or MS).
Spain Mobile ID Number String, maximum length: 60 Only required for personal addresses (salutation is either MR or MS), additional validation is performed depending on the type of ID.

  • DNI: 8 digits followed by 1 letter.
  • NIE: 1 letter (X,Y or Z), followed by 7 digits, followed by 1 letter.
  • NIF: 8 digits followed by 1 letter.
  • PASSPORT: no additional validation.
Spain Mobile Fiscal Identification Code String, maximum length: 60 Only required for professional addresses (salutation is COMPANY).
Denmark ALL Municipality Code String, maximum length: 4
Denmark ALL Street Code String, maximum length: 4
Italy GEOGRAPHIC and TOLL_FREE Signatory date of birth String (yyyy-mm-dd), maximum length: 10 Validation made for age > 18 years
Italy GEOGRAPHIC and TOLL_FREE Signatory place of birth String, maximum length: 60 Both City and country of birth is expected
Italy GEOGRAPHIC and TOLL_FREE Signatory tax code String, maximum length: 60 Mandatory field
Italy GEOGRAPHIC and TOLL_FREE Signatory title MR or MRS Mandatory for Company end user only
Italy GEOGRAPHIC and TOLL_FREE Signatory first name String, maximum length: 60 Mandatory for Company end user only
Italy GEOGRAPHIC & TOLL_FREE Signatory last name String, maximum length: 60 Mandatory for Company end user only
Italy GEOGRAPHIC & TOLL_FREE VAT number String, maximum length: 60 Mandatory for Company end user only

When destinationCountryCodeA3 is set as ZAF (South Africa) or ITA (Italy), you will have to fill the identityDocumentProof object containing the following fields:

Field name Accepted values Description
Nationality String, maximum length: 60 There is no specific format for this field. Either full country name or the ISO-3166-1 alpha-3 code is acceptable.
identityDocumentType PASSPORT,
NATIONAL_ID_CARD,
BUSINESS_REGISTRATION
Mandatory for South Africa and Italy. Only BUSINESS_REGISTRATION is applicable for ZAF
identityDocumentNumber String, maximum length: 60 Mandatory for South Africa and Italy
issuingAuthority String, maximum length: 60 Mandatory for Italy
issuingDate String, maximum length: 10 Mandatory for Italy – Format is yyyy-mm-dd. Has to be a date in the past