Sign in

v1

latestOpenAPI 3.0.32026-07-13347237.5 KB
Connect

Field Match

Verify customer identity and validate information against account data.

post/v3/{customerId}/BankingServices/FieldMatch

Path parameters

customerIdstring required

Unique GUID provided by Flinks.

Request body

loginIdstring

The loginId you received after successfully connecting a customer account.

fullNamestring

The user's full name.

firstNamestring

The user's first name.

middleNamestring

The user's middle name.

lastNamestring

The user's last name.

postalCodestring

The user's postal code.

civicAddressstring

The user's home address.

citystring

The user's city.

provincestring

The user's province.

emailstring

The user's email address.

phonestring

The user's phone number.

thresholdstring

A value between 0-1 that indicates the minimum threshold you require for a match.

Example request

{}

Response

Success

overallMatchboolean

Indicates whether the overall match meets the threshold.

overallMatchRatenumber double

The overall match rate as a decimal between 0 and 1.