Create a new address

PUT {{baseUrl}}/v1/regulation/address

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.

Request Body Examples

The request body examples below demonstrate how to create an address with both proofs attached in a single request wherever required. You can copy and paste this on the right column while testing in console.

Note that identityDocumentProof object (which contains details on nationality, identityDocumentType and identityDocumentNumber) only needs to be set when; - destinationCountryCodeA3 is FRA(France) and didType is GEOGRAPHIC - destinationCountryCodeA3 is set as ZAF (South Africa) - destinationCountryCodeA3 is set as ITA (Italy)

Create an address without any proof document

--XXX
Content-ID: createRegulationAddressRequest
Content-Type: application/json

{
   "customerReference": "Regression testing - DNK",
   "didType": "GEOGRAPHIC",
   "companyName": "Regression Testing",
   "countryCodeA3": "DNK",
   "streetName": "Street",
   "destinationCountryCodeA3": "DNK",
   "salutation": "COMPANY",
   "zipCode": "1111",
   "city": "City",
   "buildingNumber": "1",
   "extraFields": {
       "Municipality Code":"XXXX",
        "Street Code":"XXXX"
   }
}
--XXX--

Create a Business Address with Identitiy and Address proof documents

In Italy, a WORLDWIDE address is required with proof documents. In this example, we're using a French company and a French National ID for activation. The below request can also be used as reference when creating addresses for service activation in France. ``` --XXX Content-ID: createRegulationAddressRequest Content-Type: application/json

{ salutation : COMPANY, companyName : TEST, didType : GEOGRAPHIC, destinationCountryCodeA3 : FRA, countryCodeA3 : FRA, city : RENNES, zipCode : 35000, streetName : 10 Rue de Guebriant, buildingNumber : 10, identityDocumentProof : { nationality : French, identityDocumentType : NATIONAL_ID_CARD, identityDocumentNumber : 123123 } } --XXX--

--XXX Content-ID: proofOfIdentityDocument Content-Type: application/octet-stream Content-Transfer-Encoding: binary Content-Disposition: file-data; name=proofOfIdentityDocument; filename=Proof.pdf

Identity document proof encoded content

--XXX--

--XXX Content-ID: proofOfAddress Content-Type: application/octet-stream Content-Disposition: filename=Proof.txt

Proof document encoded content

--XXX-- ```

Create a Business Address with Address proof document

Below example is a business address with address proof document attached on creation request for Germany. ```javascript --XXX Content-ID: createRegulationAddressRequest Content-Type: application/json

{ customerReference: address #123, didType: GEOGRAPHIC, companyName: TEST, countryCodeA3: DEU, streetName: Regrestreet, destinationCountryCodeA3: DEU, salutation: COMPANY, zipCode: 52062, city: Aachen, buildingNumber: 1 } --XXX--

Content-ID: proofOfAddress Content-Type: application/octet-stream Content-Disposition: filename=Proof.txt

This is a proof

--XXX-- ```

HEADERS

RESPONSES

status: OK

{"addressId":574531}