AddressSearch

GetAddressSearchResult

Methode: GET

Endpoint: /v3/hitlistitems/adresssearch

Parameter	Beschreibung	Erklärung
Address.Id
Address.CrefoId	CrefoID
Address.Uid	UID-Nr.	z.B. CHE123456789
Address.HrNr	HR-Nr.	z.B. CH12345678901
Address.AddressType.Type	Adresstyp	- Business - Consumer Ist für die Suche nicht relevant (siehe SearchFilter), hingegen bei einer Order kann diese Information nützlich sein für die Identifikation.
Address.Gender.Type	Geschlecht	- Male - Female - Void
Address.Salutation	Anrede	- Herr - Frau - Firma
Address.FirstName	Vorname
Address.DateOfBirth	Geburtsdatum
Address.YearOfBirth	Geburtsjahr
Address.Name	Name der Person/Firma
Address.AddressLine1	Anschrift 1
Address.AddressLine2	Anschrift 2
Address.HouseNr	Haus-Nr.
Address.PostalCode	Postleitzahl
Address.City	Ort
Address.Canton.Code	Kanton
Address.Country	Land	- CH - ISO-Code übrige Länder
Address.Communication.Phone1
Address.Communication.Phone2
Address.Communication.Phone3
Address.Communication.Fax
Address.Communication.Email
Address.Communication.Url
SearchFilter.ArchiveType.Types	Filter Archivtypen	Einschränkung der Suche. ArchiveType.Types können mehrfach aufgeführt werden Active / Inactive MainArchive / SubArchive Business/Consumer
SearchFilter.MatchLevel.Level	Filter Matchlevel	Übereinstimmung der Treffer: High / Regular / Low

Entweder die Eingabe von PostalCode oder City ist zwingend.

Beispiel 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

Beispiel 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"
   }]
}