Get customer accounts

6 min

Introduction

This API enables the transfer of bank account data between separate banks with the bank account holder's consent. The data that can be transferred includes:

Personal information and user details
6 month transaction details
12 month transaction details
Ongoing checks on monthly basis
On-demand data pull

This API helps to get all the information of the account held by the customer.

API Input Guidelines

Customer ID of the account holder that was received in the previous API response should be used as the input.

Sample Curl

Preproduction

curl --location --request POST 'https://api-preproduction.signzy.app/api/v3/bank-connect/customer-accounts' \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customerId": "6019521730"
}'

Input Parameters

PARAMETER NAME	REQUIRED/OPTIONAL	DESCRIPTION
Authorization	Required	Authorization token
Content-Type	Required	application/json
customerId	Required	Customer ID of the account holder that was received in the previous API response.

Sample Response

[{
  "id": string,
  "number": string,
  "accountNumberDisplay": string,
  "name": string,
  "balance": number,
  "type": string,
  "aggregationStatusCode": number,
  "status": string,
  "customerId": string,
  "institutionId": string,
  "balanceDate": number,
  "createdDate": number,
  "lastUpdatedDate": number,
  "currency": string,
  "institutionLoginId": number,
  "detail": {
      "payoffAmount": number,
      "principalBalance": number,
      "escrowBalance": number,
      "interestRate": string,
      "autoPayEnrolled": string,
      "collateral": string,
      "currentSchool": string,
      "firstMortgage": string,
      "loanPaymentFreq": string,
      "paymentMinAmount": number,
      "originalSchool": string,
      "recurringPaymentAmount": number,
      "lender": string,
      "availableBalanceAmount": number,
      "endingBalanceAmount": number,
      "loanTermType": string,
      "paymentsMade": number,
      "balloonAmount": number,
      "projectedInterest": number,
      "interestPaidLtd": number,
      "interestRateType": string,
      "loanPaymentType": string,
      "paymentsRemaining": number,
      "loanMinAmtDue": number,
      "initialInterestRate": number,
      "owner": string,
      "guarantor": string,
      "interestSubsidyType": string,
      "loanMinAmtDueDate": number,
      "loanStatusEndDate": number,
      "loanStatusStartDate": number,
      "repaymentPlanStartDate": number,
      "repaymentPlanEndDate": number,
      "expectedPayoffDate": number,
      "outOfSchoolDate": number,
  },
  "displayPosition": number,
  "financialinstitutionAccountStatus": string,
  "accountNickname": string,
  "marketSegment": string,
}]

Response Parameter

PARAMETER NAME	DESCRIPTION
result.id	An account ID
result.number	Use the accountNumberDisplay field. Starting July 1, 2021 the number field will sunset with limited support until April 1, 2022, at which time it will be deprecated (no longer available).
result.accountNumberDisplay	This displays the account number of the customer in truncated format.
result.name	Name of the account is shown here.
result.balance	The cleared balance in the bank account of the customer.
result.type	Type of account operated by the customer.
result.aggregationStatusCode	The status of the most recent aggregation attempt. Won't be present until you have run your first aggregation for the account.
result.status	"pending" during account discovery, always "active" following successful account activation.
result.customerId	This is the customer ID of the sccount holder.
result.institutionId	The ID of the financial institution in which the account is present.
result.balanceDate	A timestamp showing when the balance was captured..
result.createdDate	This shows the date on which the account was added to the system.
result.lastUpdatedDate	This shows the date on which the account was last updated.
result.currency	Currency in which the money is deposited in the account. Currency code.
result.institutionLoginId	An institution login ID (from the account record), represented as a number.
result.detail	Array of customer details.
detail.payoffAmount	The amount required to payoff the loan.
detail.principalBalance	The principal balance.
detail.escrowBalance	The escrow balance.
detail.interestRate	The APY for the current period interest rate.
detail.autoPayEnrolled	This shows if the customer has suscribed for auto pay method of repayment.
detail.collateral	This shows the details of the collateral on loan.
detail.currentSchool	This shows the current school of the customer.
detail.firstMortgage	Details of the first mortgage of the customer.
detail.loanPaymentFreq	This shows the number of times the loan has been repaid.
detail.paymentMinAmount	Min amount that is to be paid by the customer.
detail.originalSchool	Shows the name of the orifinal school.
detail.recurringPaymentAmount	The customer's monthly repayment amount is shown here.
detail.lender	This shows details of the lender.
detail.availableBalanceAmount	This shows the available balance amount.
detail.endingBalanceAmount	This shows the ending balance amount.
detail.loanTermType	Type of loan term is displayed.
detail.paymentsMade	This shows the payments that are already made by the customer.
detail.balloonAmount	Balloon payment amount of the loan
detail.projectedInterest	Projected interest on the loan is shown.
detail.interestPaidLtd	Interest paid since inception of loan.
detail.interestRateType	This shows the type of interest rate on which the interest is being calculated.
detail.loanPaymentType	This shows the loan payment type chosen by the customer.
detail.paymentsRemaining	Number of payments remaining before loan is paid off.
detail.loanMinAmtDue	Minimum loan amount due for payment.
detail.initialInterestRate	This is the interest rate charged in the initial stage.
detail.owner	The loan owner.
detail.guarantor	The person who has guaranteed that the loan will be repaid by the customer.
detail.interestSubsidyType	The indication of the presence of an interest subsidy.
detail.MinAmtDueDate	The date on which the minimum amount of the loan has to be repaid
detail.loanStatusEndDate	The date on which the loan period will end.
detail.loanStatusStartDate	The date on which the loan status started.
detail.repaymentPlanStartDate	This shows the date on which the customer started repayment of the current loan amount.
detail.repaymentPlanEndDate	This shows the date on which the current repayment plan will end.
detail.expectedPayoffDate	This is the date on which the whole amount will be paid back to the bank.
detail.outOfSchoolDate	The date the borrower graduated or dropped below half-time enrollment in school.
result.displayPosition	Display position of the account at the financial institution, "1" being the top listed account.
result.financialinstitutionAccountStatus	Account status of the financial instituton.
result.accountNickname	Nickname of the account holder linked with the account.
result.marketSegment	Market value of an investment position at the time of retrieval.

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].