POST api/person/matches
No documentation available.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| person | No documentation available. |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{
"PersonID": "01efc1ae-abd9-42a5-ad43-d44f72777def",
"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": "9b95bcab-4d6d-4a93-871a-8b1a754c307f",
"EmailValidated": true,
"EmailValidationKey": "sample string 22",
"CreatedByPersonID": "98fccb85-e54f-4e5f-96b2-f9b4231f9e32",
"DOB": "2025-05-23T16:13:03.3440096-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": "ced57790-99c9-4bca-b52e-52724adb1137",
"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": "16e67b43-443f-4dd1-b189-e380c58aefe4",
"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": "ff505310-77be-49e3-a4f4-cf72694f0747",
"EmailValidated": true,
"EmailValidationKey": "sample string 22",
"CreatedByPersonID": "f26faa1d-60a6-425a-b7e9-84f819870b5e",
"DOB": "2025-05-23T16:13:03.3460102-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": "cad27eb0-2dca-4eef-b3c8-54dc6ac66e93",
"BPIContractorID": "sample string 28",
"IdentificationType": "sample string 29",
"IdentificationAgency": "sample string 30",
"IdentificationNumber": "sample string 31",
"NoMiddleInitial": true
},
{
"PersonID": "16e67b43-443f-4dd1-b189-e380c58aefe4",
"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": "ff505310-77be-49e3-a4f4-cf72694f0747",
"EmailValidated": true,
"EmailValidationKey": "sample string 22",
"CreatedByPersonID": "f26faa1d-60a6-425a-b7e9-84f819870b5e",
"DOB": "2025-05-23T16:13:03.3460102-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": "cad27eb0-2dca-4eef-b3c8-54dc6ac66e93",
"BPIContractorID": "sample string 28",
"IdentificationType": "sample string 29",
"IdentificationAgency": "sample string 30",
"IdentificationNumber": "sample string 31",
"NoMiddleInitial": true
},
{
"PersonID": "16e67b43-443f-4dd1-b189-e380c58aefe4",
"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": "ff505310-77be-49e3-a4f4-cf72694f0747",
"EmailValidated": true,
"EmailValidationKey": "sample string 22",
"CreatedByPersonID": "f26faa1d-60a6-425a-b7e9-84f819870b5e",
"DOB": "2025-05-23T16:13:03.3460102-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": "cad27eb0-2dca-4eef-b3c8-54dc6ac66e93",
"BPIContractorID": "sample string 28",
"IdentificationType": "sample string 29",
"IdentificationAgency": "sample string 30",
"IdentificationNumber": "sample string 31",
"NoMiddleInitial": true
}
]