Match

Match

Methode: POST

Endpoint: /v3/matches

Example Request

{
  "ProductCode": "2901CMSNOM",
  "SearchedAddress": {
    "FirstName": "Gruener",
    "Name": "Green",
    "AddressLine1": "Teufener Strasse",
    "HouseNr": "38",
    "PostalCode": "9000",
    "City": "St. Gallen",
    "Country": "CH",
  },
  "SearchFilter": {
    "ArchiveType": {
      "Types": [
        "Consumer"
      ]
    },
    "MatchLevel": {
      "Level": "Regular"
    }
  },
  "ReasonOfInquiry": {
    "Type": "Claim"
  }
}

The choice of the correct product (consumer/business) is irrelevant, as the match products automatically select the correct product type.

Example Response

{
   "crefoId": "425298528",
   "uid": null,
   "hrNr": null,
   "status": {"status": "Alive"},
   "archiveType": {"types":    [
      "Consumer",
      "MainArchive",
      "Active"
   ]},
   "address":    {
      "id": null,
      "crefoId": "425298528",
      "uid": "",
      "hrNr": "",
      "addressType": {"type": "Consumer"},
      "gender": {"type": "Male"},
      "salutation": null,
      "firstName": "Grüner",
      "dateOfBirth": "1959-05-07T00:00:00",
      "yearOfBirth": 1959,
      "name": "Green",
      "addressLine1": "Teufener Strasse",
      "addressLine2": "",
      "houseNr": "38",
      "postalCode": "9000",
      "city": "St. Gallen",
      "canton": {"code": "SG"},
      "country": "CH",
      "communication":       {
         "phone1": "",
         "phone2": "",
         "phone3": null,
         "fax": "",
         "email": "",
         "url": ""
      }
   },
   "previousAddress": "Grüner Green, Teufener Strasse 38 9000 St. Gallen",
   "reportContents":    [
            {
         "key": "CreatedDate",
         "value": "01.10.2020 00:00:00"
      },
            {
         "key": "Signal",
         "value": "Red"
      },
            {
         "key": "Score",
         "value": "25"
      }
   ]
}