Sign in

v1

latestOpenAPI 3.0.32026-07-14108241269.2 KB
Name Match

Name Match Verification

Matches two names for similarity. Accepts JSON with name_1 and name_2. Requires X-API-KEY and X-Client-ID headers.

post/verify/name_match

Request body

user_idstring

Optional caller-supplied reference for the end user

name_1string required

First name to compare

name_2string required

Second name to compare

Response

Successful name comparison

name_1string required

First name as supplied in the request

name_2string required

Second name as supplied in the request

match_scorenumber float required

Similarity score from 0 to 100

match_statusboolean required

True when match_score is at or above the match threshold (80)

statusstring required

Operation status (e.g., success)

chargeblestring

Billing flag, present on success (string for backward compatibility)

user_consentstring

Consent flag, present on success (string for backward compatibility)