Match NamesRecord Similarity

Match records

Record Similarity compares two lists of records and returns a similarity score for each pair of records, where each record is made up of fields of the following entity types: PERSON, ORGANIZATION, ADDRESS, DATE, or IDENTIFIER/TEXT. The records do not have to contain the same fields; only fields with the same field name are compared. If one record has three fields and the other has two fields, the missing field will be ignored and the other two fields compared.

Field Weighting

When determining match scores, some fields may be more important than others. For example, you may decide the name is more important than the address in determining if the two records match. To accomplish this, the fields can be weighted, where a field’s weight represents the magnitude of its impact on the final match score. If no weights are provided, the weight is distributed equally among all fields. If field weights are used, they must be used for all fields.

Request Structure

The request is a combination of json objects:

  • Fields: A required field whose value is the mapping information for each record. There must be a minimum of 1 field.

  • Properties: An optional field whose value specifies certain properties for the request.

  • Records: A required field that holds the “left” and “right” arrays of records to be compared. Each left record is compared to the associated right record. A record is a collection of name, address, and/or date objects.

Headers

X-RosetteAPI-KeystringRequired

Request

This endpoint expects an object.
fieldsmap from strings to objectsOptional
propertiesobjectOptional
recordsobjectOptional

Response

OK
fieldsmap from strings to objects or null
resultslist of objects or null