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": "c313232a-bc22-4597-b88d-13c0b948421e",
  "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": "1898834f-c60e-44aa-8200-590f2763b9f4",
  "EmailValidated": true,
  "EmailValidationKey": "sample string 22",
  "CreatedByPersonID": "887ef323-6d65-4c98-b13f-09f3a1cf0aaa",
  "DOB": "2025-04-23T00:09:09.9537003-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": "45a2b33b-f64e-46cd-ad6b-f778ee87207e",
  "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": "5b085601-a86d-425b-9111-613c2a5e5dd4",
    "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": "cadf2d77-f4a6-4c41-9e4a-52464062d14d",
    "EmailValidated": true,
    "EmailValidationKey": "sample string 22",
    "CreatedByPersonID": "0191cfdb-3c8e-434c-bcfb-113ee322fa0d",
    "DOB": "2025-04-23T00:09:09.9636838-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": "92c16278-a877-4ea8-a06e-f8011d244b42",
    "BPIContractorID": "sample string 28",
    "IdentificationType": "sample string 29",
    "IdentificationAgency": "sample string 30",
    "IdentificationNumber": "sample string 31",
    "NoMiddleInitial": true
  },
  {
    "PersonID": "5b085601-a86d-425b-9111-613c2a5e5dd4",
    "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": "cadf2d77-f4a6-4c41-9e4a-52464062d14d",
    "EmailValidated": true,
    "EmailValidationKey": "sample string 22",
    "CreatedByPersonID": "0191cfdb-3c8e-434c-bcfb-113ee322fa0d",
    "DOB": "2025-04-23T00:09:09.9636838-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": "92c16278-a877-4ea8-a06e-f8011d244b42",
    "BPIContractorID": "sample string 28",
    "IdentificationType": "sample string 29",
    "IdentificationAgency": "sample string 30",
    "IdentificationNumber": "sample string 31",
    "NoMiddleInitial": true
  },
  {
    "PersonID": "5b085601-a86d-425b-9111-613c2a5e5dd4",
    "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": "cadf2d77-f4a6-4c41-9e4a-52464062d14d",
    "EmailValidated": true,
    "EmailValidationKey": "sample string 22",
    "CreatedByPersonID": "0191cfdb-3c8e-434c-bcfb-113ee322fa0d",
    "DOB": "2025-04-23T00:09:09.9636838-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": "92c16278-a877-4ea8-a06e-f8011d244b42",
    "BPIContractorID": "sample string 28",
    "IdentificationType": "sample string 29",
    "IdentificationAgency": "sample string 30",
    "IdentificationNumber": "sample string 31",
    "NoMiddleInitial": true
  }
]