Person Match Existence

A Person Match Existence request returns a boolean match results of people based on criteria of various match inputs. The values return are either 'True' if a match exists or 'False' if a match does not exist. Your partner agreement restricts the available returned match output. The HTTPS request for Person Match Existence begins with the URL structure:

https://partnerapi.zoominfo.com/partnerapi/v4/person/match/exist?

Input Parameters - Person Match Existence

The table below shows input parameters that can be used in Person Match Existence queries. Parameter descriptions are grouped as follows:

Group - Grouping for match field permissions.
Field Name - Name of input parameter.
Required - Denotes whether or not the field is required in a match request.
Value - Valid values for this input parameter.
Notes - Information related to the input parameter.

Group	Field Name	Required	Value	Notes
Request-level Default	pc	required		Partner code (or partner name) assigned to you
	numMatches	optional	number from 1 to 10	Limits the match results returned to the given number of match results per input record
	echoInput	optional	true or false	Default value is false. If you set it to be false, the XML output displays only the unique Id for each input record. Alternatively, the XML output displays the unique Id and all other input parameters for each input record
	outputFieldOptions	required (set by default)		Person Match Existence Query always returns the following output fields. They cannot be modified by outputFieldOptions: companyAddress companyRevenue companyEmployeeCount isEU These fields are set by default and can not be overwritten
	outputFieldOptions	optional		Person Match Existence Query has the following optional output field: lastChangedDate To return this field, specify the above output field name
Input Record-level Default	uniqueInputId	optional		Unique string you use to identify a particular match existence request input record within a match existence request
	personId	optional		Unique ZoomInfo identifier of the person to be matched by a particular input record
	firstName	optional		First name of person to be matched by a particular input record
	lastName	optional		Last name of the person to be matched by a particular input record
	emailAddress	optional		Email address of the person to be matched by a particular input record
	companyId	optional		Unique ZoomInfo identifier of the company that the person to be matched by a particular input record works or has worked
	companyName	optional		Name of the company for which the person to be matched by a particular input record works or has worked
	jobTitle	optional		Current job title of the person to be matched by a particular input record

Example Person Match Existence Request

The following example shows a Person Match Existence query. The input parameters include:

true for echoInput
jon for firstName
smith for lastName
[email protected] for emailAddress
leonard for companyName

The Person Match Existence query request can be structured like this:

https://partnerapi.zoominfo.com/partnerapi/v4/person/match/exist?pc=PartnerCode&firstName=jon&lastName=smith&[email protected]&companyName=leonard&echoInput=true

<?xml version="1.0" encoding="UTF-8"?>
<personMatchResponse xmlns="http://partnerapi.zoominfo.com/partnerapistatic/xsd/V4">
   <inputParameters>
      <parameter>
         <name>echoInput</name>
         <value>true</value>
      </parameter>
      <parameter>
         <name>outputFieldOptions</name>
         <value>companyaddress,companyemployeecount,companyrevenue</value>
      </parameter>
   </inputParameters>
   <matchResults>
      <personMatchResults>
         <personMatchResult>
            <personMatchInput>
               <uniqueInputId>Zoom-1</uniqueInputId>
               <firstName>jon</firstName>
               <lastName>smith</lastName>
               <emailAddress>[email protected]</emailAddress>
            </personMatchInput>
            <personMatchMatches>
               <personMatch>
                  <matchConfidence>99.99999999799999</matchConfidence>
                  <personId>-108503</personId>
                  <hasEmailAddress>True</hasEmailAddress>
                  <hasDirectPhone>True</hasDirectPhone>
                  <currentEmployment>
                     <hasJobTitle>True</hasJobTitle>
                     <company>
                        <companyId>22462584</companyId>
                        <hasCompanyName>True</hasCompanyName>
                        <hasCompanyPhone>True</hasCompanyPhone>
                        <companyAddress>
                           <hasStreet>True</hasStreet>
                           <hasCity>True</hasCity>
                           <hasState>True</hasState>
                           <hasZip>True</hasZip>
                           <hasCountry>True</hasCountry>
                        </companyAddress>
                        <hasCompanyRevenue>True</hasCompanyRevenue>
                        <hasCompanyEmployeeCount>True</hasCompanyEmployeeCount>
                     </company>
                  </currentEmployment>
                  <hasIndustry>True</hasIndustry>
               </personMatch>
            </personMatchMatches>
         </personMatchResult>
      </personMatchResults>
   </matchResults>
</personMatchResponse>

Output Parameters - Person Match Existence

The table below shows output parameters that can be used in Person Match Existence queries. These parameters are grouped in the following categories:

Group - The grouping for output field permissions. The permission groups configured for a partner determine the output fields present in a response.
Parent Name - Name of the output element
Child Name - Name of a child element of a parent element specified in the parent name column
Notes - Information related to the output field

Group	Parent Name	Child Name		Notes
Default	PersonID			Unique identifier for the person
	HasEmail			If email of the person exist
	HasDirectPhone			If direct phone of the person exist
	HasIndustry			If Industry the person currently works in exist. A person can have multiple industries. HasIndustry is 'True' if at least one industry exist. Industry tags are based on the current employment company.
	CurrentEmployment	HasJobTitle
				If Person has job title at current place of employment
		Company		Contains the following child elements with information about the person's current company
			HasCompanyName	If name of the company exist
			HasCompanyPhone	If phone number of the company headquarters exist
			CompanyAddress		Address for the person's current company headquarters.
				HasStreet	If street for the company address exist
				HasCity	If city for the company address exist
				HasState	If state or province for the company address exist
				HasZip	If postal code for the company address exist
				HasCountryCode	If country for the company address exist
			HasCompanyRevenue	If annual gross revenue for the company exist
			HasCompanyEmployeeCount	If employee head count for the company exist