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": "560e3abc-02ec-44ea-b787-1adcb2a7b88e",
  "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": "08377673-d406-4426-9ee6-5845f368ab4f",
  "EmailValidated": true,
  "EmailValidationKey": "sample string 22",
  "CreatedByPersonID": "75d1540d-d0ee-4207-835d-3879c0d9ff31",
  "DOB": "2026-05-13T11:27:27.0001054-04:00",
  "SignatureFilePath": "sample string 23",
  "HeadshotFilePath": "sample string 24",
  "Acrobat_principal_id": "sample string 25",
  "UserName": "sample string 26",
  "NotificationEmail": "sample string 27",
  "CompanyID": "e3a6d6a7-d3a6-4566-b085-5500e3bfec88",
  "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": "f5557cb1-ea70-4ec3-bc8a-9d4a9f193599",
    "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": "d3e7cbd8-eedd-45ff-b9fb-fe2f5f5983a0",
    "EmailValidated": true,
    "EmailValidationKey": "sample string 22",
    "CreatedByPersonID": "9be2b626-fa36-431b-8599-75dc2cc22bb8",
    "DOB": "2026-05-13T11:27:27.0001054-04:00",
    "SignatureFilePath": "sample string 23",
    "HeadshotFilePath": "sample string 24",
    "Acrobat_principal_id": "sample string 25",
    "UserName": "sample string 26",
    "NotificationEmail": "sample string 27",
    "CompanyID": "89eaffb7-2ba4-4aaf-b272-7a1ccacc649e",
    "BPIContractorID": "sample string 28",
    "IdentificationType": "sample string 29",
    "IdentificationAgency": "sample string 30",
    "IdentificationNumber": "sample string 31",
    "NoMiddleInitial": true
  },
  {
    "PersonID": "f5557cb1-ea70-4ec3-bc8a-9d4a9f193599",
    "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": "d3e7cbd8-eedd-45ff-b9fb-fe2f5f5983a0",
    "EmailValidated": true,
    "EmailValidationKey": "sample string 22",
    "CreatedByPersonID": "9be2b626-fa36-431b-8599-75dc2cc22bb8",
    "DOB": "2026-05-13T11:27:27.0001054-04:00",
    "SignatureFilePath": "sample string 23",
    "HeadshotFilePath": "sample string 24",
    "Acrobat_principal_id": "sample string 25",
    "UserName": "sample string 26",
    "NotificationEmail": "sample string 27",
    "CompanyID": "89eaffb7-2ba4-4aaf-b272-7a1ccacc649e",
    "BPIContractorID": "sample string 28",
    "IdentificationType": "sample string 29",
    "IdentificationAgency": "sample string 30",
    "IdentificationNumber": "sample string 31",
    "NoMiddleInitial": true
  },
  {
    "PersonID": "f5557cb1-ea70-4ec3-bc8a-9d4a9f193599",
    "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": "d3e7cbd8-eedd-45ff-b9fb-fe2f5f5983a0",
    "EmailValidated": true,
    "EmailValidationKey": "sample string 22",
    "CreatedByPersonID": "9be2b626-fa36-431b-8599-75dc2cc22bb8",
    "DOB": "2026-05-13T11:27:27.0001054-04:00",
    "SignatureFilePath": "sample string 23",
    "HeadshotFilePath": "sample string 24",
    "Acrobat_principal_id": "sample string 25",
    "UserName": "sample string 26",
    "NotificationEmail": "sample string 27",
    "CompanyID": "89eaffb7-2ba4-4aaf-b272-7a1ccacc649e",
    "BPIContractorID": "sample string 28",
    "IdentificationType": "sample string 29",
    "IdentificationAgency": "sample string 30",
    "IdentificationNumber": "sample string 31",
    "NoMiddleInitial": true
  }
]