---
title: "Field Match"
method: POST
path: "/v3/{customerId}/BankingServices/FieldMatch"
tags: ["Connect"]
---

# Field Match

`POST /v3/{customerId}/BankingServices/FieldMatch`

Verify customer identity and validate information against account data.

## Path parameters

- `customerId` string, required

## Request body

- object
  - `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 `200`

Success

- object
  - `overallMatch` boolean — Indicates whether the overall match meets the threshold.
  - `fieldLevelMatch` object — Boolean values indicating whether each field meets the threshold.
    - `fullName` boolean — Whether the full name matches.
    - `phone` boolean — Whether the phone number matches.
    - `email` string, nullable — Whether the email matches (null if no data available).
    - `civicAddress` boolean — Whether the civic address matches.
    - `city` boolean — Whether the city matches.
    - `province` boolean — Whether the province matches.
    - `postalCode` boolean — Whether the postal code matches.
    - `noData` object[] — Fields for which no data was available to compare.
  - `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.
    - `fullName` number, double — Match rate for the full name.
    - `phone` integer — Match rate for the phone number.
    - `email` string, nullable — Match rate for the email (null if no data available).
    - `civicAddress` number, double — Match rate for the civic address.
    - `city` integer — Match rate for the city.
    - `province` integer — Match rate for the province.
    - `postalCode` integer — Match rate for the postal code.
    - `noData` object[] — Fields for which no data was available to compare.

## Other responses

- `400` — Invalid Request

---

[API](https://skmtc.dev/flinks/apis/flinks-api.md) · [All operations](https://skmtc.dev/flinks/apis/flinks-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/flinks/flinks-api/revisions/0983646f91b4/schema)