POST api/person/matches

No documentation available.

Request Information

Parameters

NameDescriptionAdditional information
person
No documentation available.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "PersonID": "1cd7a7b3-821f-4e80-9be2-ccbb90cd5525",
  "FirstName": "sample string 2",
  "MiddleName": "sample string 3",
  "LastName": "sample string 4",
  "Suffix": "sample string 5",
  "Salutation": "sample string 6",
  "HomePhone": "sample string 7",
  "WorkPhone": "sample string 8",
  "CellPhone": "sample string 9",
  "Fax": "sample string 10",
  "PrimaryPhone": "sample string 11",
  "EmailAddress": "sample string 12",
  "Street1": "sample string 13",
  "Street2": "sample string 14",
  "City": "sample string 15",
  "State": "sample string 16",
  "Zip": "sample string 17",
  "Deleted": true,
  "Last4SSN": "sample string 19",
  "CompanyName": "sample string 20",
  "Password": "sample string 21",
  "HeadshotDocumentID": "27a5cbf0-78bd-4daa-9811-8b2a89e78f15",
  "EmailValidated": true,
  "EmailValidationKey": "sample string 22",
  "CreatedByPersonID": "1e8eae0f-659c-42fe-986b-dd27027389ad",
  "DOB": "2026-02-10T10:55:44.0135243-05:00",
  "SignatureFilePath": "sample string 23",
  "HeadshotFilePath": "sample string 24",
  "Acrobat_principal_id": "sample string 25",
  "UserName": "sample string 26",
  "NotificationEmail": "sample string 27",
  "CompanyID": "8d5969d9-ec49-423f-bb49-fbd5bd8908fa",
  "BPIContractorID": "sample string 28",
  "IdentificationType": "sample string 29",
  "IdentificationAgency": "sample string 30",
  "IdentificationNumber": "sample string 31",
  "NoMiddleInitial": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

No documentation available.

Response body formats

application/json, text/json

Sample:
[
  {
    "PersonID": "80af4c6d-640f-4755-9179-19a50d192233",
    "FirstName": "sample string 2",
    "MiddleName": "sample string 3",
    "LastName": "sample string 4",
    "Suffix": "sample string 5",
    "Salutation": "sample string 6",
    "HomePhone": "sample string 7",
    "WorkPhone": "sample string 8",
    "CellPhone": "sample string 9",
    "Fax": "sample string 10",
    "PrimaryPhone": "sample string 11",
    "EmailAddress": "sample string 12",
    "Street1": "sample string 13",
    "Street2": "sample string 14",
    "City": "sample string 15",
    "State": "sample string 16",
    "Zip": "sample string 17",
    "Deleted": true,
    "Last4SSN": "sample string 19",
    "CompanyName": "sample string 20",
    "Password": "sample string 21",
    "HeadshotDocumentID": "18b09bc4-2f3b-40c0-99e6-797ce8e9cf50",
    "EmailValidated": true,
    "EmailValidationKey": "sample string 22",
    "CreatedByPersonID": "8d777ccc-fe16-4730-b913-a1bb04eca0cb",
    "DOB": "2026-02-10T10:55:44.0291479-05:00",
    "SignatureFilePath": "sample string 23",
    "HeadshotFilePath": "sample string 24",
    "Acrobat_principal_id": "sample string 25",
    "UserName": "sample string 26",
    "NotificationEmail": "sample string 27",
    "CompanyID": "abf94926-8e15-4224-8c9e-60f299341e9e",
    "BPIContractorID": "sample string 28",
    "IdentificationType": "sample string 29",
    "IdentificationAgency": "sample string 30",
    "IdentificationNumber": "sample string 31",
    "NoMiddleInitial": true
  },
  {
    "PersonID": "80af4c6d-640f-4755-9179-19a50d192233",
    "FirstName": "sample string 2",
    "MiddleName": "sample string 3",
    "LastName": "sample string 4",
    "Suffix": "sample string 5",
    "Salutation": "sample string 6",
    "HomePhone": "sample string 7",
    "WorkPhone": "sample string 8",
    "CellPhone": "sample string 9",
    "Fax": "sample string 10",
    "PrimaryPhone": "sample string 11",
    "EmailAddress": "sample string 12",
    "Street1": "sample string 13",
    "Street2": "sample string 14",
    "City": "sample string 15",
    "State": "sample string 16",
    "Zip": "sample string 17",
    "Deleted": true,
    "Last4SSN": "sample string 19",
    "CompanyName": "sample string 20",
    "Password": "sample string 21",
    "HeadshotDocumentID": "18b09bc4-2f3b-40c0-99e6-797ce8e9cf50",
    "EmailValidated": true,
    "EmailValidationKey": "sample string 22",
    "CreatedByPersonID": "8d777ccc-fe16-4730-b913-a1bb04eca0cb",
    "DOB": "2026-02-10T10:55:44.0291479-05:00",
    "SignatureFilePath": "sample string 23",
    "HeadshotFilePath": "sample string 24",
    "Acrobat_principal_id": "sample string 25",
    "UserName": "sample string 26",
    "NotificationEmail": "sample string 27",
    "CompanyID": "abf94926-8e15-4224-8c9e-60f299341e9e",
    "BPIContractorID": "sample string 28",
    "IdentificationType": "sample string 29",
    "IdentificationAgency": "sample string 30",
    "IdentificationNumber": "sample string 31",
    "NoMiddleInitial": true
  },
  {
    "PersonID": "80af4c6d-640f-4755-9179-19a50d192233",
    "FirstName": "sample string 2",
    "MiddleName": "sample string 3",
    "LastName": "sample string 4",
    "Suffix": "sample string 5",
    "Salutation": "sample string 6",
    "HomePhone": "sample string 7",
    "WorkPhone": "sample string 8",
    "CellPhone": "sample string 9",
    "Fax": "sample string 10",
    "PrimaryPhone": "sample string 11",
    "EmailAddress": "sample string 12",
    "Street1": "sample string 13",
    "Street2": "sample string 14",
    "City": "sample string 15",
    "State": "sample string 16",
    "Zip": "sample string 17",
    "Deleted": true,
    "Last4SSN": "sample string 19",
    "CompanyName": "sample string 20",
    "Password": "sample string 21",
    "HeadshotDocumentID": "18b09bc4-2f3b-40c0-99e6-797ce8e9cf50",
    "EmailValidated": true,
    "EmailValidationKey": "sample string 22",
    "CreatedByPersonID": "8d777ccc-fe16-4730-b913-a1bb04eca0cb",
    "DOB": "2026-02-10T10:55:44.0291479-05:00",
    "SignatureFilePath": "sample string 23",
    "HeadshotFilePath": "sample string 24",
    "Acrobat_principal_id": "sample string 25",
    "UserName": "sample string 26",
    "NotificationEmail": "sample string 27",
    "CompanyID": "abf94926-8e15-4224-8c9e-60f299341e9e",
    "BPIContractorID": "sample string 28",
    "IdentificationType": "sample string 29",
    "IdentificationAgency": "sample string 30",
    "IdentificationNumber": "sample string 31",
    "NoMiddleInitial": true
  }
]