/FieldMatch

post https://{instance}-api.private.fin.ag/v3/{customerId}/BankingServices/FieldMatch

Use the /FieldMatch API to confirm your customers’ identity, confirm account ownership, or verify the accuracy of the information before connecting a customer’s bank account to your financial service. Pass us your customer’s information and we’ll review it against the data points on the account they’re attempting to connect. Only the fields that you include in the API call are analyzed in 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, click here.

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 thresholdparameter is missing from the request, you will only see the second part of the response with the decimals.

Language

URL