Skip to main content
POST
/
v3
/
{customerId}
/
BankingServices
/
FieldMatch
Field Match
curl --request POST \
  --url https://{instance}-api.private.fin.ag/v3/{customerId}/BankingServices/FieldMatch \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "overallMatch": true,
  "fieldLevelMatch": {
    "fullName": true,
    "phone": true,
    "email": null,
    "civicAddress": true,
    "city": true,
    "province": true,
    "postalCode": true,
    "noData": []
  },
  "overallMatchRate": 0.93666667,
  "fieldLevelMatchRate": {
    "fullName": 0.83,
    "phone": 1,
    "email": null,
    "civicAddress": 0.79,
    "city": 1,
    "province": 1,
    "postalCode": 1,
    "noData": []
  }
}
Use the FieldMatch API to verify your customer’s identity, confirm account ownership, or validate the accuracy of their information before linking a bank account to your financial service. Provide your customer’s details in the request, and we’ll compare them against the data associated with the account they’re attempting to connect. Only the fields you include in the API call are evaluated when calculating the match score. To use this API, you must first obtain a loginId and successfully call the /GetAccountsDetail endpoint. For more information about this endpoint and to see an example, see our help article on Field Matching. The 200 response you receive may differ slightly from the example in the following use cases:
  • Any body parameters that are not included in the request will be missing from the response.
  • When a body parameter is included in the request and we do have data to review it against, we’ll return a value between 0 and 1 for that particular field.
  • When a body parameter is included in the request and we do not have data to review it against, we’ll return a 0 for that particular field. The field will also be added to the noData array in the response.
  • When the threshold parameter is missing from the request, you will only see the second part of the response with the decimals.

Path Parameters

​
customerId
string
default:43387ca6-0391-4c82-857d-70d95f087ecb
required

Unique GUID provided by Flinks.

Body

application/json
​
loginId
string

The loginId you received after successfully connecting a customer account.

​
fullName
string

The user's full name.

​
firstName
string

The user's first name.

​
middleName
string

The user's middle name.

​
lastName
string

The user's last name.

​
postalCode
string

The user's postal code.

​
civicAddress
string

The user's home address.

​
city
string

The user's city.

​
province
string

The user's province.

​
email
string

The user's email address.

​
phone
string

The user's phone number.

​
threshold
string

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

Response

Success

​
overallMatch
boolean

Indicates whether the overall match meets the threshold.

​
fieldLevelMatch
object

Boolean values indicating whether each field meets the threshold.

​
overallMatchRate
number<double>

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

​
fieldLevelMatchRate
object

Decimal values indicating the match rate for each field.