Individual Customer

The Individual Customer Find Similar call uses the IndividualMatchingAlgorithm to identify potential duplicate Individual Customers.

Required values for successful validation

  • Email

Request

REST

Copy
{
    "entity": {
        "dataContainers": {
            "PhoneDataContainer": {
                "dataContainers": [
                    {
                        "values": {
                            "PhoneNumber": {
                                "value": {
                                    "value": "(767) 800-9198"
                                }
                            },
                            "PhoneType": {
                                "value": {
                                    "value": "Home"
                                }
                            }
                        }
                    }
                ]
            }
        },
        "objectType": "IndividualCustomer",
        "parent": "111656",
        "values": {
            "FirstName": {
                "value": {
                    "value": "Jasmeen"
                }
            },
            "LastName": {
                "value": {
                    "value": "Kirby"
                }
            }
        }
    },
    "maxResults": "5"
}

SOAP

Copy
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://stibo.com/step/ws/step/1.0" xmlns:ns1="http://stibo.com/step/ws/types/1.0" xmlns:out="http://www.stibosystems.com/step/outputtemplate">
<soapenv:Header/>
  <soapenv:Body>
    <ns:getSimilarObjectsRequest>
      <ns:accessContext>
        <ns1:userName>stepsys</ns1:userName>
        <ns1:password>stepsys</ns1:password>
        <ns1:contextUrl>step://context?id=Context1</ns1:contextUrl>
        <ns1:workspaceUrl>step://workspace?id=Main</ns1:workspaceUrl>
      </ns:accessContext>
      <ns:values>
        <ns1:propertyURL>step://attribute?id=EmailField</ns1:propertyURL>
        <ns1:value>InesJung@armyspy.com</ns1:value>
      </ns:values>
      <ns:objectTypeURL>step://objecttype?id=IndividualCustomer</ns:objectTypeURL>
    <ns:matchingAlgorithmURL>step://matchingalgorithm?id=IndividualFindSimilar</ns:matchingAlgorithmURL>
      <ns:searchThreshold>1</ns:searchThreshold>
      <ns:maxCount>10</ns:maxCount>
       <ns:exportConfigurationXML>
         <ns1:Entity>
            <out:Entity/>   
            <out:Name/>
            <out:Values/>
            <out:DataContainers/>
            <out:EntityCrossReferences/>
            <out:Entity/>
        </ns1:Entity>
      </ns:exportConfigurationXML>
    </ns:getSimilarObjectsRequest>
  </soapenv:Body>
</soapenv:Envelope>

Response

REST

Copy
{
  "findSimilarExecutionReport": {
    "httpStatus": 200,
    "message": "Found similar records",
    "rejectedByBusinessRuleID": null,
    "businessRuleRejections": [],
    "httpReason": "OK"
  },
  "findSimilarResponses": [
    {
      "rank": 100,
      "entity": {
        "id": "274980",
        "name": null,
        "objectType": "IndividualCustomer",
        "parent": "111656",
        "values": {
          "FirstName": {
            "calculated": false,
            "contextLocal": true,
            "inherited": null,
            "value": {
              "value": "Jasmeen",
              "valueId": null,
              "unit": null
            }
          },
          "LastName": {
            "calculated": false,
            "contextLocal": true,
            "inherited": null,
            "value": {
              "value": "Kirby",
              "valueId": null,
              "unit": null
            }
          }
        },
        "references": {
          "CustomerSourceSystem": {
            "references": [
              {
                "contextLocal": true,
                "target": "SystemX",
                "targetType": "entity",
                "values": {
                  "SourceRecordID": {
                    "contextLocal": true,
                    "inherited": null,
                    "values": [
                      {
                        "value": "16670219-3647",
                        "valueId": null,
                        "unit": null
                      }
                    ]
                  }
                },
                "inherited": null,
                "entity": null
              }
            ]
          }
        },
        "dataContainers": {
          "PhoneDataContainer": {
            "dataContainers": [
              {
                "values": {
                  "PhoneNumber": {
                    "calculated": false,
                    "contextLocal": true,
                    "inherited": null,
                    "value": {
                      "value": "(767) 800-9198",
                      "valueId": null,
                      "unit": null
                    }
                  },
                  "PhoneType": {
                    "calculated": false,
                    "contextLocal": true,
                    "inherited": null,
                    "value": {
                      "value": "Home",
                      "valueId": null,
                      "unit": null
                    }
                  }
                },
                "references": {}
              },
              {
                "values": {
                  "PhoneNumber": {
                    "calculated": false,
                    "contextLocal": true,
                    "inherited": null,
                    "value": {
                      "value": "(458) 381-3513",
                      "valueId": null,
                      "unit": null
                    }
                  },
                  "PhoneType": {
                    "calculated": false,
                    "contextLocal": true,
                    "inherited": null,
                    "value": {
                      "value": "Cell",
                      "valueId": null,
                      "unit": null
                    }
                  }
                },
                "references": {}
              }
            ],
            "inherited": null
          },
          "MainAddressDataContainer": {
            "dataContainer": {
              "values": {
                "InputState": {
                  "calculated": false,
                  "contextLocal": true,
                  "inherited": null,
                  "value": {
                    "value": "PA",
                    "valueId": null,
                    "unit": null
                  }
                },
                "InputCity": {
                  "calculated": false,
                  "contextLocal": true,
                  "inherited": null,
                  "value": {
                    "value": "Ashlaand",
                    "valueId": null,
                    "unit": null
                  }
                },
                "InputCountry": {
                  "calculated": false,
                  "contextLocal": true,
                  "inherited": null,
                  "value": {
                    "value": "US",
                    "valueId": null,
                    "unit": null
                  }
                },
                "InputZip": {
                  "calculated": false,
                  "contextLocal": true,
                  "inherited": null,
                  "value": {
                    "value": "17921",
                    "valueId": null,
                    "unit": null
                  }
                },
                "InputStreet": {
                  "calculated": false,
                  "contextLocal": true,
                  "inherited": null,
                  "value": {
                    "value": "1056 Bever Dam Road",
                    "valueId": null,
                    "unit": null
                  }
                },
                "CalcFormattedAddress": {
                  "calculated": true,
                  "contextLocal": true,
                  "inherited": null,
                  "value": {
                    "value": "1056 Bever Dam Road\nAshlaand, PA, 17921\nUS",
                    "valueId": null,
                    "unit": null
                  }
                }
              },
              "references": {}
            },
            "inherited": null
          }
        }
      }
    }
  ]
}

SOAP

Copy
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns4:getSimilarObjectsResponse xmlns="http://www.stibosystems.com/step/outputtemplate" xmlns:ns2="http://stibo.com/step/ws/types/1.0" xmlns:ns3="http://www.stibosystems.com/step" xmlns:ns4="http://stibo.com/step/ws/step/1.0">
         <ns4:similarObjects>
            <ns2:id>233875</ns2:id>
            <ns2:url>step://entity?id=233875</ns2:url>
            <ns2:title>(233875)</ns2:title>
            <ns2:type>entity</ns2:type>
            <ns2:objectType>step://objecttype?id=IndividualCustomer</ns2:objectType>
            <ns2:rank>90.0</ns2:rank>
            <ns2:entity UserTypeID="IndividualCustomer" ID="233875" ParentID="111656">
               <ns3:Values>
                  <ns3:Value AttributeID="IncomeUpdateDate">2016-08-13</ns3:Value>
                  <ns3:Value AttributeID="PastDueDollars">3434</ns3:Value>
                  <ns3:Value AttributeID="RiskFlag">Y</ns3:Value>
                  <ns3:Value AttributeID="Income">561179</ns3:Value>
                  <ns3:Value AttributeID="CreditLimit">87802</ns3:Value>
                  <ns3:Value AttributeID="FirstName">Abrahim</ns3:Value>
                  <ns3:Value AttributeID="LastEditDateRecord">2018-04-02 18:06:44</ns3:Value>
                  <ns3:Value AttributeID="GoodPersonFlag">Y</ns3:Value>
                  <ns3:Value AttributeID="LastName">Jonathan</ns3:Value>
                  <ns3:Value AttributeID="SiblingDelinquencyFlag">Y</ns3:Value>
                  <ns3:Value AttributeID="PastDueDays">20</ns3:Value>
                  <ns3:Value Derived="true" AttributeID="CalcMetaphone3">APRHMJN0</ns3:Value>
                  <ns3:Value Derived="true" AttributeID="CalcName">Abrahim Jonathan</ns3:Value>
                  <ns3:Value Derived="true" AttributeID="CalcHouseholdMembers">Abrahim Jonathan
Abra Jonathan
Deana Jonathan</ns3:Value>
                  <ns3:Value Derived="true" AttributeID="CalcSoundex">A165</ns3:Value>
                  <ns3:Value Derived="true" AttributeID="CalcNameCollection">Abrahim Jonathan</ns3:Value>
               </ns3:Values>
               <ns3:DataContainers>
                  <ns3:MultiDataContainer Type="EmailDataContainer">
                     <ns3:DataContainer ID="233878">
                        <ns3:Values>
                           <ns3:Value AttributeID="ValidationTimestamp">2021-01-20 15:30:18</ns3:Value>
                           <ns3:Value AttributeID="LastValidatedEmail">Lorem.ipsum.dolor@odiosempercursus.co.uk</ns3:Value>
                           <ns3:Value AttributeID="ExperianEmailValidationIntegrationStatus">success</ns3:Value>
                           <ns3:Value AttributeID="EmailField">Lorem.ipsum.dolor@odiosempercursus.co.uk</ns3:Value>
                           <ns3:Value AttributeID="EmailStatus">unreachable</ns3:Value>
                        </ns3:Values>
                     </ns3:DataContainer>
                     <ns3:DataContainer ID="233877">
                        <ns3:Values>
                           <ns3:Value AttributeID="LastEditDateEmail">2018-04-02 18:06:44</ns3:Value>
                           <ns3:Value AttributeID="ValidationTimestamp">2021-01-20 15:30:18</ns3:Value>
                           <ns3:Value AttributeID="LastValidatedEmail">InesJung@armyspy.com</ns3:Value>
                           <ns3:Value AttributeID="ExperianEmailValidationIntegrationStatus">success</ns3:Value>
                           <ns3:Value AttributeID="EmailField">InesJung@armyspy.com</ns3:Value>
                           <ns3:Value AttributeID="EmailStatus">disposable</ns3:Value>
                        </ns3:Values>
                     </ns3:DataContainer>
                  </ns3:MultiDataContainer>
                  <ns3:MultiDataContainer Type="PhoneDataContainer">
                     <ns3:DataContainer ID="233879">
                        <ns3:Values>
                           <ns3:Value AttributeID="PhoneNumber">(480) 339-9857</ns3:Value>
                        </ns3:Values>
                     </ns3:DataContainer>
                     <ns3:DataContainer ID="233880">
                        <ns3:Values>
                           <ns3:Value AttributeID="PhoneNumber">(931) 839-9039</ns3:Value>
                           <ns3:Value AttributeID="LastEditDatePhone">2018-04-02 18:06:44</ns3:Value>
                           <ns3:Value AttributeID="PhoneType">Home</ns3:Value>
                        </ns3:Values>
                     </ns3:DataContainer>
                  </ns3:MultiDataContainer>
                  <ns3:DataContainer Type="MainAddressDataContainer" ID="233876">
                     <ns3:Values>
                        <ns3:Value AttributeID="QualityIndex">B</ns3:Value>
                        <ns3:Value AttributeID="ValidationTime">2021-03-23 15:07:12</ns3:Value>
                        <ns3:Value AttributeID="StandardizedStreet">1065 Inverlieth Rd</ns3:Value>
                        <ns3:Value AttributeID="ValidationHash">274731544</ns3:Value>
                        <ns3:Value AttributeID="StandardizedCity">Lake Forest</ns3:Value>
                        <ns3:Value AttributeID="InputZip">60045</ns3:Value>
                        <ns3:Value AttributeID="StandardizedState">IL</ns3:Value>
                        <ns3:Value AttributeID="QualityVerificationCode">V42-I44-P7-097</ns3:Value>
                        <ns3:Value AttributeID="StandardizedCountryISOCode">US</ns3:Value>
                        <ns3:Value AttributeID="StandardizedStreetNumber">1065</ns3:Value>
                        <ns3:Value AttributeID="InputState">IL</ns3:Value>
                        <ns3:Value AttributeID="StandardizedZip">60045-1533</ns3:Value>
                        <ns3:Value AttributeID="InputCountry">USA</ns3:Value>
                        <ns3:Value AttributeID="InputAddress2">1065 Inverlieth</ns3:Value>
                        <ns3:Value AttributeID="InputCity">lake forest</ns3:Value>
                        <ns3:Value AttributeID="StandardizedFormattedAddress">1065 Inverlieth Rd
Lake Forest IL 60045-1533</ns3:Value>
                        <ns3:Value AttributeID="StandardizedCountry">United States</ns3:Value>
                        <ns3:Value AttributeID="StandardizedStreetName">Inverlieth Rd</ns3:Value>
                        <ns3:Value Derived="true" AttributeID="CalcFormattedAddress">1065 Inverlieth Rd
Lake Forest IL 60045-1533
United States</ns3:Value>
                     </ns3:Values>
                  </ns3:DataContainer>
               </ns3:DataContainers>
            </ns2:entity>
         </ns4:similarObjects>
      </ns4:getSimilarObjectsResponse>
   </S:Body>
</S:Envelope>