AddressSearch

GetAddressSearchResult

Methode: GET

Endpoint: /v3/hitlistitems/adresssearch

Parameter	Description	Explanation
Address.Id
Address.CrefoId	CrefoID
Address.Uid	UID No.	e.g. CHE123456789
Address. HrNr	HR No.	e.g. CH12345678901
Address.AddressType.Type	Address type	- Business <br />- Consumer <br /> Not relevant for the search (see SearchFilter), but this information may be useful for identification in the case of an order.
Address.Gender.Type	Gender	- Male <br />- Female <br />- Void
Address.Salutation	Salutation	- Mr <br />- Mrs <br />- Company
Address.FirstName	First name
Address.DateOfBirth	Date of birth
Address.AddressLine1	Address 1
Address.AddressLine2	Address 2
Address.HouseNr	House number
Address.PostalCode	Postcode
Address.City	Town
Address.Canton.Code	Canton
Address.Country	Country	- CH <br />- ISO code for other countries
Address.Communication.Phone1
Address.Communication.Phone2
Address.Communication.Phone3
Address.Communication.Fax
Address.Communication.Email
Address.Communication.Url
SearchFilter.ArchiveType.Types	Filter archive types	Restriction of the search. ArchiveType.Types can be listed multiple times <br /><br />Active / Inactive <br /> MainArchive / SubArchive <br />Business/Consumer
SearchFilter.MatchLevel.Level	Filter match level	Matching hits:<br /><br />High / Regular / Low

Either the postalcode or city must be entered.

Example Request URL

https://api.crediconnect.ch/v3/hitlistitems/adresssearch?Address.Name=Demo%20Credinet%20AG&Address.AddressLine1=Roter%20Platz&Address.PostalCode=9000&Address.City=St.%20Gallen&Address.Country=CH&SearchFilter.ArchiveType=Business&SearchFilter.ArchiveType=Active&SearchFilter.MatchLevel=Regular

Example Response

{
   "totalCount": 1,
   "data": [   {
      "crefoId": "406635386",
      "reportingCrefoId": "406635386",
      "uid": "CHX108775401",
      "hrNr": "CH99999999985",
      "status": "Active",
      "archiveType":       [
         "Business",
         "MainArchive",
         "Active"
      ],
      "address":       {
         "id": null,
         "crefoId": "406635386",
         "uid": "CHX108775401",
         "hrNr": "CH99999999985",
         "addressType": "Business",
         "gender": "Void",
         "salutation": null,
         "firstName": null,
         "name": "Demo CrediNet AG",
         "dateOfBirth": null,
         "yearOfBirth": null,
         "addressLine1": "Roter Platz",
         "addressLine2": "c/o Creditreform AG",
         "houseNr": "42",
         "postalCode": "9000",
         "city": "St. Gallen",
         "canton": "SG",
         "country": "CH",
         "communication":          {
            "phone1": "071222212121",
            "phone2": "079222212121",
            "phone3": null,
            "fax": "071222212123",
            "email": "st.gallen@democredinet.ri",
            "url": "www.democredinet.ri"
         }
      },
      "previousAddress": "Demo CrediNet AG, Roter Platz 33 9000 St. Gallen"
   }]
}