Bank Account Verification
...
Consent-based
US

Get Account Owner Details (cloned)

Introduction

The "Get Account Owner Details" API facilitates the retrieval of account owner information for bank accounts. This integration is specifically designed to aid in verifying the identity and details of the bank account owner during the onboarding process.

By utilizing this service, you can access a comprehensive range of data objects pertaining to the account holder and their bank account. These data objects include information about the account holder, the classification of the account, the associated score for the account classification, as well as any available addresses associated with the account.

It is important to note that the specific data returned by the API may vary depending on the financial institution, as not all institutions provide the same set of data.

Supported regions: US

API Details

This API requires two inputs:

  1. CustomerID: The unique identifier for the customer.
  2. AccountID: The unique identifier for the account.

To obtain the required IDs, you need to follow these steps:

  1. Create a customer and initiate the Finicity journey for them by using the Create bank connect journey link API.
  2. Retrieve the results from the API to obtain the Customer ID and the corresponding Account IDs.
  3. Execute this API for each individual account to verify the owner's details.

Please note that the customer and Finicity journey need to be created beforehand in order to obtain the necessary IDs.

Sample cURL

Production
Pre-Production
Curl


Request Body Parameters

Parameter name

Data type

Required

Description

customerId

string

Yes

The customer Id which was obtained in the response of Create bank connect journey link API. This is customer ID of the customer account whose owner details are to be fetched

accountId

string

Yes

The account Id for a specific account of the customer obtained in the response of Create bank connect journey link API. This is account ID of the customer account whose owner details are to be fetched

Sample Response

JSON


Response Body Parameters

Parameter name

Data type

Description

result.holders

array[AccountOwnerDetails]

List of all the account owners

holders.ownerName

string

The full name of the account owner. Multiple account owners are returned in one string per the source data from the institution.

example: "John Smith, PhD"

holders.nameClassification

string

The classification of the account holder:

  • "person / personal / home"
  • "business"
  • "other"

example: "person"

holders.nameClassificationconfidencescore

float

The confidence score 0-1 of the name classification.

example: 0.81

holders.addresses

array[AccountOwnerAddress]

List of available addresses of the account owner

addresses.ownerAddress

string

Account owner address

Sample Error

JSON


Error Response Parameters

Parameter

Description

error

This parameter contains the error.

error.name

the name of the error

error.message

the error message

error.status

status of the api

error.reason

Reason for error

error.type

Type of the error

error.statusCode

Request Status code from Signzy

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!