Verify user identity by comparing submitted personal information with account owner data.
Accepts name, address, phone number, and email, then returns match scores for each field plus an overall confidence score. Scores range from 0 to 1.
Name can be either personal (first, middle, last) or company, but not both.
When a member has multiple account owners, such as on joint accounts, the endpoint compares the submitted information against each owner and returns the scores for the best match.
Use either the user id you defined or the MX-defined user guid. See Assigning Resource IDs.
member_identifier
string
required
Use either the member id you defined or the MX-defined member guid. See Assigning Resource IDs.
Body
application/json
name
object
required
User's name. Can be personal (first, middle, last) or company, but not both.
Hide child attributes
name.first
string | null
First name. Required if company is not provided.
Example:
"John"
name.middle
string | null
Middle name.
Example:
"Q"
name.last
string | null
Last name. Required if company is not provided.
Example:
"Doe"
name.company
string | null
Company name. Required if first and last are not provided.
Example:
"Acme Corporation"
address
object
required
User's address. line_1, city, region, postal_code, and country are required.
Hide child attributes
address.line_1
string | null
required
First line of street address.
Example:
"123 Main St"
address.city
string | null
required
City.
Example:
"Anytown"
address.region
string | null
required
State, province, or region.
Example:
"CA"
address.postal_code
string | null
required
Postal code.
Example:
"12345"
address.country
string | null
required
Country.
Example:
"US"
address.line_2
string | null
Second line of street address.
Example:
"Apt 4B"
address.line_3
string | null
Third line of street address.
Example:
"Building C"
email
string
required
User's email address.
Example:
"john.doe@example.com"
phone_number
string
required
Phone number. Must contain at least 10 digits. Can include dashes, parentheses, and spaces.
Example:
"(555) 555-5555"
Response
200 - application/json
Identity match successfully processed.
identity_match
object
required
The confidence scores for an identity match. Identity match results aren't stored, so the response has no mx_record companion.
Hide child attributes
identity_match.composite_confidence_score
number<double>
required
Overall confidence score from 0 to 1, rounded to four decimal places.
Required range: 0 <= x <= 1
Example:
0.92
identity_match.individual_scores
object
required
Individual match scores.
Hide child attributes
identity_match.individual_scores.name_score
number<double>
required
Name match confidence from 0 to 1, rounded to four decimal places. Returns 0 when there's no match.
Required range: 0 <= x <= 1
Example:
0.95
identity_match.individual_scores.address_score
number<double>
required
Address match confidence from 0 to 1, rounded to four decimal places. Returns 0 when there's no match.
Required range: 0 <= x <= 1
Example:
0.9
identity_match.individual_scores.email_score
number<double>
required
Email match confidence from 0 to 1, rounded to four decimal places. Returns 0 when there's no match.
Required range: 0 <= x <= 1
Example:
0.98
identity_match.individual_scores.phone_score
number<double>
required
Phone match confidence from 0 to 1, rounded to four decimal places. Returns 0 when there's no match.
Required range: 0 <= x <= 1
Example:
0.85
identity_match.member
object
required
The base fields for a member, which is a user's connection to an institution. Returned as the member companion on related resources such as accounts and transactions, and as the foundation of full member responses.
Hide child attributes
identity_match.member.guid
string
required
The unique identifier for the member. Defined by MX.
Example:
"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b"
identity_match.member.id
string | null
required
The unique partner-defined identifier for the member.
Example:
"unique_id"
identity_match.member.metadata
string | null
required
Additional information you can store about the member.
The base fields for a user. Returned as the user companion on related resources such as members, accounts, and transactions, and as the foundation of full user responses.
Hide child attributes
identity_match.user.guid
string
required
The unique identifier for the user. Defined by MX.
Example:
"USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
identity_match.user.id
string | null
required
The unique partner-defined identifier for the user.
Example:
"unique_id"
identity_match.user.metadata
string | null
required
Additional information you can store about the user.