Perform name cross validation

Performs a name cross validation.

Overview

Use this method to perform the comparison between names.

🚧

Attention

The list within .idDocs can take only two objects.

Possible comparisonMode values

ValueDescription
strictAllows only the exact match:
- Dr. John Smith and John Smith are acceptable.
- John D Smith and John Smith are unacceptable.
containmentCompares the most similar name parts separately:
- Emanuel Burns and Burns Emanuel are acceptable.
- Mike Wazowski and Michael Wazowski are unacceptable.
fuzzyContainmentAllows greater flexibility in spelling and accepts rearrangement of given and family names. For example, Judy Smith, Smith Judith, J Smith, and Smith J M are acceptable.
weakContainmentA flexible name matching that converts names to lowercase and removes spaces for broader matches. For example, John Manuel Smith will match with Johnmanuel Smith.
defAllows a wide range of spelling variations. For example, John M Smith and Dr. J Manuel Smith are acceptable.

Response explained

As a response, you will get a JSON representing the comparison results.

NameTypeDescription
fullNameMatchBooleanThe full name comparison result.
Language
Authorization
Header
Click Try It! to start a request and see the response here!