POST api/Match

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
AuthKey	globally unique identifier	None.
Forename	string	None.
MiddleName	string	None.
Surname	string	None.
AddressLine1	string	None.
AddressLine2	string	None.
AddressLine3	string	None.
Town	string	None.
County	string	None.
Postcode	string	None.
Gender	string	None.
Date_Of_Birth	date	None.
Date_Of_Death	date	None.
Date_Of_Death_PartialDate_Year	integer	None.
Date_Of_Death_PartialDate_Month	integer	None.
Date_Of_Birth_PartialDate_Year	integer	None.
Date_Of_Birth_PartialDate_Month	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "AuthKey": "286e1621-575d-41a4-9e2d-19b8c04230b2",
  "Forename": "sample string 2",
  "MiddleName": "sample string 3",
  "Surname": "sample string 4",
  "AddressLine1": "sample string 5",
  "AddressLine2": "sample string 6",
  "AddressLine3": "sample string 7",
  "Town": "sample string 8",
  "County": "sample string 9",
  "Postcode": "sample string 10",
  "Gender": "sample string 11",
  "Date_Of_Birth": "2025-12-06T03:50:12.5638854+00:00",
  "Date_Of_Death": "2025-12-06T03:50:12.5638854+00:00",
  "Date_Of_Death_PartialDate_Year": 1,
  "Date_Of_Death_PartialDate_Month": 1,
  "Date_Of_Birth_PartialDate_Year": 1,
  "Date_Of_Birth_PartialDate_Month": 1
}

text/html

Sample:

{"AuthKey":"286e1621-575d-41a4-9e2d-19b8c04230b2","Forename":"sample string 2","MiddleName":"sample string 3","Surname":"sample string 4","AddressLine1":"sample string 5","AddressLine2":"sample string 6","AddressLine3":"sample string 7","Town":"sample string 8","County":"sample string 9","Postcode":"sample string 10","Gender":"sample string 11","Date_Of_Birth":"2025-12-06T03:50:12.5638854+00:00","Date_Of_Death":"2025-12-06T03:50:12.5638854+00:00","Date_Of_Death_PartialDate_Year":1,"Date_Of_Death_PartialDate_Month":1,"Date_Of_Birth_PartialDate_Year":1,"Date_Of_Birth_PartialDate_Month":1}

application/xml, text/xml

Sample:

<MatchParameter xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Forename>sample string 2</Forename>
  <MiddleName>sample string 3</MiddleName>
  <Surname>sample string 4</Surname>
  <AddressLine1>sample string 5</AddressLine1>
  <AddressLine2>sample string 6</AddressLine2>
  <AddressLine3>sample string 7</AddressLine3>
  <Town>sample string 8</Town>
  <County>sample string 9</County>
  <Postcode>sample string 10</Postcode>
  <Gender>sample string 11</Gender>
  <Date_Of_Birth>2025-12-06T03:50:12.5638854+00:00</Date_Of_Birth>
  <Date_Of_Death>2025-12-06T03:50:12.5638854+00:00</Date_Of_Death>
  <Date_Of_Death_PartialDate_Year>1</Date_Of_Death_PartialDate_Year>
  <Date_Of_Death_PartialDate_Month>1</Date_Of_Death_PartialDate_Month>
  <Date_Of_Birth_PartialDate_Year>1</Date_Of_Birth_PartialDate_Year>
  <Date_Of_Birth_PartialDate_Month>1</Date_Of_Birth_PartialDate_Month>
  <AuthKey>286e1621-575d-41a4-9e2d-19b8c04230b2</AuthKey>
</MatchParameter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MatchResult

Name	Type	Additional information
ResultCount	integer	None.
Results	Collection of MatchResultRow	None.
ErrorCount	integer	None.
Errors	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "ResultCount": 2,
  "Results": [
    {
      "URN": "sample string 1",
      "ProductName": "sample string 2",
      "RetrieveEndPointURL": "sample string 3",
      "MatchDetails": [
        {
          "Field": "sample string 1",
          "LevenshteinValue": 1.1,
          "JaroWinklerValue": 1.1,
          "Soundex": true,
          "SingleCharacterMatchOnly": true,
          "LikeMatch": true
        },
        {
          "Field": "sample string 1",
          "LevenshteinValue": 1.1,
          "JaroWinklerValue": 1.1,
          "Soundex": true,
          "SingleCharacterMatchOnly": true,
          "LikeMatch": true
        }
      ]
    },
    {
      "URN": "sample string 1",
      "ProductName": "sample string 2",
      "RetrieveEndPointURL": "sample string 3",
      "MatchDetails": [
        {
          "Field": "sample string 1",
          "LevenshteinValue": 1.1,
          "JaroWinklerValue": 1.1,
          "Soundex": true,
          "SingleCharacterMatchOnly": true,
          "LikeMatch": true
        },
        {
          "Field": "sample string 1",
          "LevenshteinValue": 1.1,
          "JaroWinklerValue": 1.1,
          "Soundex": true,
          "SingleCharacterMatchOnly": true,
          "LikeMatch": true
        }
      ]
    }
  ],
  "ErrorCount": 2,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

text/html

Sample:

{"ResultCount":2,"Results":[{"URN":"sample string 1","ProductName":"sample string 2","RetrieveEndPointURL":"sample string 3","MatchDetails":[{"Field":"sample string 1","LevenshteinValue":1.1,"JaroWinklerValue":1.1,"Soundex":true,"SingleCharacterMatchOnly":true,"LikeMatch":true},{"Field":"sample string 1","LevenshteinValue":1.1,"JaroWinklerValue":1.1,"Soundex":true,"SingleCharacterMatchOnly":true,"LikeMatch":true}]},{"URN":"sample string 1","ProductName":"sample string 2","RetrieveEndPointURL":"sample string 3","MatchDetails":[{"Field":"sample string 1","LevenshteinValue":1.1,"JaroWinklerValue":1.1,"Soundex":true,"SingleCharacterMatchOnly":true,"LikeMatch":true},{"Field":"sample string 1","LevenshteinValue":1.1,"JaroWinklerValue":1.1,"Soundex":true,"SingleCharacterMatchOnly":true,"LikeMatch":true}]}],"ErrorCount":2,"Errors":["sample string 1","sample string 2"]}