Qodex.ai

List already created addresses

GET {{baseUrl}}/v1/regulation/address?pageNumber=0&pageSize=20

Request Params

KeyDatatypeRequiredDescription
regulationAddressIdstringThis is the ID of the regulation address which is returned by createRegulationAddress.
companyNamestringName of the company.
firstNamestringFirst name of the customer.
lastNamestringLast name of the customer.
countryCodeA3stringThe three letter identifier for the address's country.
citystringThe city for the address.
zipCodestringThe zip code for the address.
streetNamestringThe street for the address.
buildingNumberstringThe building number for the address.
customerReferencestringThe reference for the customer.
statusstringThe status of the regulation address.
linkedstringFlag that specifies if the address has been linked to a DID.
pageNumbernumberThe page number, starting at 0.
pageSizenumberThe page size (max number of entities that are displayed in the response).

HEADERS

KeyDatatypeRequiredDescription
apikeystringAuthentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help.
Acceptstring

RESPONSES

status: OK

{"regulationAddresses":[{"addressId":"\u003cinteger\u003e","linked":"\u003cboolean\u003e","status":"\u003cstring\u003e","salutation":"\u003cstring\u003e","companyName":"\u003cstring\u003e","companyDescription":"\u003cstring\u003e","firstName":"\u003cstring\u003e","lastName":"\u003cstring\u003e","countryCodeA3":"\u003cstring\u003e","city":"\u003cstring\u003e","zipCode":"\u003cstring\u003e","streetName":"\u003cstring\u003e","buildingNumber":"\u003cstring\u003e","buildingLetter":"\u003cstring\u003e","customerReference":"\u003cstring\u003e","extraFields":{"title":"\u003cstring\u003e","province":"\u003cstring\u003e","firstName":"\u003cstring\u003e","lastName":"\u003cstring\u003e","nationality":"\u003cstring\u003e","streetCode":"\u003cstring\u003e","municipalityCode":"\u003cstring\u003e","idType":"\u003cstring\u003e","dateOfBirth":"\u003cstring\u003e","placeOfBirth":"\u003cstring\u003e","companyVatNumber":"\u003cstring\u003e","taxCode":"\u003cstring\u003e","idNumber":"\u003cstring\u003e","fiscalIdentificationCode":"\u003cstring\u003e","state":"\u003cstring\u003e"},"rejectionReasons":["\u003cstring\u003e","\u003cstring\u003e"]},{"addressId":"\u003cinteger\u003e","linked":"\u003cboolean\u003e","status":"\u003cstring\u003e","salutation":"\u003cstring\u003e","companyName":"\u003cstring\u003e","companyDescription":"\u003cstring\u003e","firstName":"\u003cstring\u003e","lastName":"\u003cstring\u003e","countryCodeA3":"\u003cstring\u003e","city":"\u003cstring\u003e","zipCode":"\u003cstring\u003e","streetName":"\u003cstring\u003e","buildingNumber":"\u003cstring\u003e","buildingLetter":"\u003cstring\u003e","customerReference":"\u003cstring\u003e","extraFields":{"title":"\u003cstring\u003e","province":"\u003cstring\u003e","firstName":"\u003cstring\u003e","lastName":"\u003cstring\u003e","nationality":"\u003cstring\u003e","streetCode":"\u003cstring\u003e","municipalityCode":"\u003cstring\u003e","idType":"\u003cstring\u003e","dateOfBirth":"\u003cstring\u003e","placeOfBirth":"\u003cstring\u003e","companyVatNumber":"\u003cstring\u003e","taxCode":"\u003cstring\u003e","idNumber":"\u003cstring\u003e","fiscalIdentificationCode":"\u003cstring\u003e","state":"\u003cstring\u003e"},"rejectionReasons":["\u003cstring\u003e","\u003cstring\u003e"]}],"resultCount":"\u003cinteger\u003e"}