Refresh Customer

Introduction
The "Refresh Customer" API offered by Signzy is designed to seamlessly integrate with Finicity, enabling you to retrieve the most recent account owner details for a bank account. This functionality is particularly useful for verifying the information of the bank account owner during your onboarding process.
By utilizing this API, you can refresh and update both account and transaction data for all accounts associated with a specific customer ID. This operation relies on establishing a connection to the respective financial institution to ensure the information retrieved is up to date and accurate.
If you have a specific business case that requires real-time data, you have the option to invoke the Refresh services for a particular customer. For further clarification and guidance, it is recommended to discuss your requirements with your dedicated account manager.
To receive a response from the API call, it is advisable to set a timeout value of 120 seconds. However, even if you terminate the connection after making the call, the operation will continue to complete in the background. To determine when the refresh process is finished, you can retrieve the account records and check for an updated aggregation attempt date.
Supported regions: US
API Details
This API takes CustomerID as the input. 
Sample cURL
Production
Pre-Production
Curl
curl --location --request POST 'https://api.signzy.app/api/v3/bank-connect/refresh-customer' \
--header 'Authorization: <Token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customerId": "6018678884",
}'
curl --location --request POST 'https://api.signzy.app/api/v3/bank-connect/refresh-customer' \
--header 'Authorization: <Token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customerId": "6018678884",
}'
﻿
Curl
curl --location --request POST 'https://api-preproduction.signzy.app/api/v3/bank-connect/refresh-customer' \
--header 'Authorization: <Token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customerId": "6018678884",
}'
curl --location --request POST 'https://api-preproduction.signzy.app/api/v3/bank-connect/refresh-customer' \
--header 'Authorization: <Token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customerId": "6018678884",
}'
﻿
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
Sample Response
JSON
{
  "accounts": [
    {
      "id": "5011648377",
      "number": "2000004444",
      "realAccountNumberLast4": "5678",
      "name": "Super Checking",
      "balance": 401.26,
      "type": "checking",
      "status": "active",
      "customerId": "1005061234",
      "institutionId": "4222",
      "balanceDate": 1607450357,
      "aggregationSuccessDate": 1607450357,
      "aggregationAttemptDate": 1607450357,
      "createdDate": 1607450357,
      "currency": "USD",
      "lastTransactionDate": 1607450357,
      "oldestTransactionDate": 1607450357,
      "institutionLoginId": 1007302745,
      "detail": {
        "dateAsOf": 1607450357,
        "availableBalanceAmount": 5678.78,
        "openDate": 1607450357,
        "periodStartDate": 1607450357,
        "periodEndDate": 1607450357,
        "periodInterestRate": 13.245,
        "periodDepositAmount": 2356.56,
        "periodInterestAmount": 1234.56,
        "interestYtdAmount": 1056.67,
        "interestPriorYtdAmount": 3056.79,
        "maturityDate": 1607450357,
        "interestRate": "15.789",
        "creditAvailableAmount": 3000,
        "creditMaxAmount": 7000,
        "cashAdvanceAvailableAmount": 2000,
        "cashAdvanceMaxAmount": 3000,
        "cashAdvanceBalance": 1000,
        "cashAdvanceInterestRate": 21.5,
        "currentBalance": 5789.34,
        "paymentMinAmount": 456.78,
        "paymentDueDate": 1607450357,
        "previousBalance": 1234.56,
        "statementStartDate": 1607450357,
        "statementEndDate": 1607450357,
        "statementPurchaseAmount": 2345.9,
        "statementFinanceAmount": 156.78,
        "statementCreditAmount": 345,
        "rewardEarnedBalance": 500,
        "pastDueAmount": 3688.99,
        "lastPaymentAmount": 567.89,
        "lastPaymentDate": 1607450357,
        "statementCloseBalance": 2456.69,
        "termOfMl": "36",
        "mlHolderName": "John Smith",
        "description": "a description",
        "lateFeeAmount": 35,
        "payoffAmount": 45567.98,
        "payoffAmountDate": 1607450357,
        "originalMaturityDate": 1607450357,
        "principalBalance": 45056.7,
        "escrowBalance": 2345.01,
        "interestPeriod": "monthly",
        "initialMlAmount": 65000,
        "initialMlDate": 1607450357,
        "nextPaymentPrincipalAmount": 1256.67,
        "nextPaymentInterestAmount": 234.56,
        "nextPayment": 1578,
        "nextPaymentDate": 1607450357,
        "lastPaymentDueDate": 1607450357,
        "lastPaymentReceiveDate": 1607450357,
        "lastPaymentPrincipalAmount": 1256.67,
        "lastPaymentInterestAmount": 234.56,
        "lastPaymentEscrowAmount": 456.78,
        "lastPaymentLastFeeAmount": 150,
        "lastPaymentLateCharge": 50,
        "ytdPrincipalPaid": 5432.01,
        "ytdInterestPaid": 3948.56,
        "ytdInsurancePaid": 1345.89,
        "ytdTaxPaid": 1489,
        "autoPayEnrolled": true,
        "collateral": "nissan sentra",
        "currentSchool": "utah valley university",
        "firstPaymentDate": 1607450357,
        "firstMortgage": true,
        "loanPaymentFreq": "monthly",
        "originalSchool": "brigham young university",
        "recurringPaymentAmount": 456.23,
        "lender": "utah community credit union",
        "endingBalanceAmount": 234789.45,
        "loanTermType": "fixed",
        "paymentsMade": 14,
        "balloonAmount": 1678.56,
        "projectedInterest": 10456.78,
        "interestPaidLtd": 56789.34,
        "interestRateType": "variable",
        "loanPaymentType": "principle",
        "repaymentPlan": "Standard, Graduated, Extended, Pay As You Earn, and more.",
        "paymentsRemaining": 45,
        "marginBalance": 456,
        "shortBalance": 12456.89,
        "availableCashBalance": 3456.78,
        "maturityValueAmount": 34067.78,
        "vestedBalance": 45000,
        "empMatchAmount": 256.99,
        "empPretaxContribAmount": 450,
        "empPretaxContribAmountYtd": 700,
        "contribTotalYtd": 2045,
        "cashBalanceAmount": 2000,
        "preTaxAmount": 78564.99,
        "afterTaxAmount": 68564.99,
        "matchAmount": 378,
        "profitSharingAmount": 34678.89,
        "rolloverAmount": 101234.67,
        "otherVestAmount": 34000,
        "otherNonvestAmount": 26000,
        "currentLoanBalance": 345789.23,
        "loanRate": 3.275,
        "buyPower": 34567.89,
        "rolloverLtd": 23456.78,
        "loanAwardId": "1234568",
        "originalInterestRate": 12,
        "guarantor": "FinBank",
        "owner": "FinBank",
        "interestSubsidyType": "Subsidy type",
        "interestBalance": 2000,
        "remainingTermOfMl": 2,
        "initialInterestRate": 34567.89,
        "feesBalance": 150,
        "loanYtdInterestPaid": 5623.23,
        "loanYtdFeesPaid": 5621.23,
        "loanYtdPrincipalPaid": 5621.23,
        "loanStatus": "Deferment",
        "loanStatusStartDate": 1607450357,
        "loanStatusEndDate": 1607450357,
        "weightedInterestRate": 12,
        "repaymentPlanStartDate": 1607450357,
        "repaymentPlanEndDate": 1607450357,
        "expectedPayoffDate": 1607450357,
        "outOfSchoolDate": 1607450357,
        "convertToRepayment": 1607450357,
        "daysDelinquent": 5,
        "totalPrincipalPaid": 15000,
        "totalInterestPaid": 1125,
        "totalAmountPaid": 16125
      },
      "position": [
        {
          "id": 454678080,
          "description": "DELTA AIR LINES INC",
          "symbol": "DAL",
          "units": 6.537,
          "currentPrice": 41.585,
          "securityName": "DELTA AIR LINES INC",
          "transactionType": "Margin",
          "marketValue": 271.84,
          "costBasis": 190.01,
          "status": "A",
          "currentPriceDate": 1607450357,
          "securityType": "Stock",
          "mfType": "OPENEND",
          "posType": "Long",
          "totalGLDollar": 162742.9,
          "totalGLPercent": 68.89,
          "optionStrikePrice": 50,
          "optionType": "PUT",
          "optionSharesPerContract": 100,
          "optionExpireDate": "1644994800",
          "fiAssetClass": "COMNEQTY",
          "assetClass": "INTLSTOCK",
          "currencyRate": 1,
          "securityId": "25400W102",
          "securityIdType": "CUSIP",
          "costBasisPerShare": 13.38,
          "subAccountType": "CASH",
          "securityCurrency": "USD",
          "todayGLDollar": 16272.9,
          "todayGLPercent": 18.89
        }
      ],
      "displayPosition": 2,
      "parentAccount": "5011648377"
    }
  ]
}

{
  "accounts": [
    {
      "id": "5011648377",
      "number": "2000004444",
      "realAccountNumberLast4": "5678",
      "name": "Super Checking",
      "balance": 401.26,
      "type": "checking",
      "status": "active",
      "customerId": "1005061234",
      "institutionId": "4222",
      "balanceDate": 1607450357,
      "aggregationSuccessDate": 1607450357,
      "aggregationAttemptDate": 1607450357,
      "createdDate": 1607450357,
      "currency": "USD",
      "lastTransactionDate": 1607450357,
      "oldestTransactionDate": 1607450357,
      "institutionLoginId": 1007302745,
      "detail": {
        "dateAsOf": 1607450357,
        "availableBalanceAmount": 5678.78,
        "openDate": 1607450357,
        "periodStartDate": 1607450357,
        "periodEndDate": 1607450357,
        "periodInterestRate": 13.245,
        "periodDepositAmount": 2356.56,
        "periodInterestAmount": 1234.56,
        "interestYtdAmount": 1056.67,
        "interestPriorYtdAmount": 3056.79,
        "maturityDate": 1607450357,
        "interestRate": "15.789",
        "creditAvailableAmount": 3000,
        "creditMaxAmount": 7000,
        "cashAdvanceAvailableAmount": 2000,
        "cashAdvanceMaxAmount": 3000,
        "cashAdvanceBalance": 1000,
        "cashAdvanceInterestRate": 21.5,
        "currentBalance": 5789.34,
        "paymentMinAmount": 456.78,
        "paymentDueDate": 1607450357,
        "previousBalance": 1234.56,
        "statementStartDate": 1607450357,
        "statementEndDate": 1607450357,
        "statementPurchaseAmount": 2345.9,
        "statementFinanceAmount": 156.78,
        "statementCreditAmount": 345,
        "rewardEarnedBalance": 500,
        "pastDueAmount": 3688.99,
        "lastPaymentAmount": 567.89,
        "lastPaymentDate": 1607450357,
        "statementCloseBalance": 2456.69,
        "termOfMl": "36",
        "mlHolderName": "John Smith",
        "description": "a description",
        "lateFeeAmount": 35,
        "payoffAmount": 45567.98,
        "payoffAmountDate": 1607450357,
        "originalMaturityDate": 1607450357,
        "principalBalance": 45056.7,
        "escrowBalance": 2345.01,
        "interestPeriod": "monthly",
        "initialMlAmount": 65000,
        "initialMlDate": 1607450357,
        "nextPaymentPrincipalAmount": 1256.67,
        "nextPaymentInterestAmount": 234.56,
        "nextPayment": 1578,
        "nextPaymentDate": 1607450357,
        "lastPaymentDueDate": 1607450357,
        "lastPaymentReceiveDate": 1607450357,
        "lastPaymentPrincipalAmount": 1256.67,
        "lastPaymentInterestAmount": 234.56,
        "lastPaymentEscrowAmount": 456.78,
        "lastPaymentLastFeeAmount": 150,
        "lastPaymentLateCharge": 50,
        "ytdPrincipalPaid": 5432.01,
        "ytdInterestPaid": 3948.56,
        "ytdInsurancePaid": 1345.89,
        "ytdTaxPaid": 1489,
        "autoPayEnrolled": true,
        "collateral": "nissan sentra",
        "currentSchool": "utah valley university",
        "firstPaymentDate": 1607450357,
        "firstMortgage": true,
        "loanPaymentFreq": "monthly",
        "originalSchool": "brigham young university",
        "recurringPaymentAmount": 456.23,
        "lender": "utah community credit union",
        "endingBalanceAmount": 234789.45,
        "loanTermType": "fixed",
        "paymentsMade": 14,
        "balloonAmount": 1678.56,
        "projectedInterest": 10456.78,
        "interestPaidLtd": 56789.34,
        "interestRateType": "variable",
        "loanPaymentType": "principle",
        "repaymentPlan": "Standard, Graduated, Extended, Pay As You Earn, and more.",
        "paymentsRemaining": 45,
        "marginBalance": 456,
        "shortBalance": 12456.89,
        "availableCashBalance": 3456.78,
        "maturityValueAmount": 34067.78,
        "vestedBalance": 45000,
        "empMatchAmount": 256.99,
        "empPretaxContribAmount": 450,
        "empPretaxContribAmountYtd": 700,
        "contribTotalYtd": 2045,
        "cashBalanceAmount": 2000,
        "preTaxAmount": 78564.99,
        "afterTaxAmount": 68564.99,
        "matchAmount": 378,
        "profitSharingAmount": 34678.89,
        "rolloverAmount": 101234.67,
        "otherVestAmount": 34000,
        "otherNonvestAmount": 26000,
        "currentLoanBalance": 345789.23,
        "loanRate": 3.275,
        "buyPower": 34567.89,
        "rolloverLtd": 23456.78,
        "loanAwardId": "1234568",
        "originalInterestRate": 12,
        "guarantor": "FinBank",
        "owner": "FinBank",
        "interestSubsidyType": "Subsidy type",
        "interestBalance": 2000,
        "remainingTermOfMl": 2,
        "initialInterestRate": 34567.89,
        "feesBalance": 150,
        "loanYtdInterestPaid": 5623.23,
        "loanYtdFeesPaid": 5621.23,
        "loanYtdPrincipalPaid": 5621.23,
        "loanStatus": "Deferment",
        "loanStatusStartDate": 1607450357,
        "loanStatusEndDate": 1607450357,
        "weightedInterestRate": 12,
        "repaymentPlanStartDate": 1607450357,
        "repaymentPlanEndDate": 1607450357,
        "expectedPayoffDate": 1607450357,
        "outOfSchoolDate": 1607450357,
        "convertToRepayment": 1607450357,
        "daysDelinquent": 5,
        "totalPrincipalPaid": 15000,
        "totalInterestPaid": 1125,
        "totalAmountPaid": 16125
      },
      "position": [
        {
          "id": 454678080,
          "description": "DELTA AIR LINES INC",
          "symbol": "DAL",
          "units": 6.537,
          "currentPrice": 41.585,
          "securityName": "DELTA AIR LINES INC",
          "transactionType": "Margin",
          "marketValue": 271.84,
          "costBasis": 190.01,
          "status": "A",
          "currentPriceDate": 1607450357,
          "securityType": "Stock",
          "mfType": "OPENEND",
          "posType": "Long",
          "totalGLDollar": 162742.9,
          "totalGLPercent": 68.89,
          "optionStrikePrice": 50,
          "optionType": "PUT",
          "optionSharesPerContract": 100,
          "optionExpireDate": "1644994800",
          "fiAssetClass": "COMNEQTY",
          "assetClass": "INTLSTOCK",
          "currencyRate": 1,
          "securityId": "25400W102",
          "securityIdType": "CUSIP",
          "costBasisPerShare": 13.38,
          "subAccountType": "CASH",
          "securityCurrency": "USD",
          "todayGLDollar": 16272.9,
          "todayGLPercent": 18.89
        }
      ],
      "displayPosition": 2,
      "parentAccount": "5011648377"
    }
  ]
}
﻿
Response Body Parameters
Parameter
Data Type
Description
accounts
array[CustomerAccount]
List of customer accounts
id
string
An account ID
example: "5011648377"
number
string
The account number from the institution
example: "2000004444"
realAccountNumberLast4
string
The last 4 digits of the ACH account number
example: "5678"
name
string
The account name from the institution
example: "Super Checking"
balance
number
The cleared balance of the account as of balanceDate
example: 401.26
type
string
Account Type. Please check the list of supported account types below.
example: "checking"
status
string
"pending" during account discovery, always "active" following successful account activation
example: "active
customerId
string
A customer ID
institutionId
string
The ID of a financial institution
balanceDate
integer
A timestamp showing when the balance was captured. A date in Unix epoch time (in seconds)
aggregationSuccessDate
integer
A timestamp showing the last successful aggregation of the account. This will not be present until you have run your first aggregation for the account. A date in Unix epoch time (in seconds)
aggregationAttemptDate
integer
A timestamp showing the last aggregation attempt, whether successful or not. This will not be present until you have run your first aggregation for the account. A date in Unix epoch time (in seconds)
createdDate
integer
A timestamp showing when the account was added to the system. A date in Unix epoch time (in seconds)
currency
string
A currency code
example: "USD"
lastTransactionDate
integer
The date of the latest transaction on the account. This will not be present until you have run your first aggregation for the account. A date in Unix epoch time (in seconds)
oldestTransactionDate
integer
The date of the oldest transaction in the transactions for the account. A date in Unix epoch time (in seconds)
institutionLoginId
integer
An institution login ID (from the account record), represented as a number
example: 1007302745
detail
﻿
CustomerAccountDetail
Additional customer account details. Not all data points will return for each account type. The data point are also subject to availability by the institution.
position
array[CustomerAccountPosition]
Investment holdings
displayPosition
integer
Display position of the account at the financial institution, "1" being the top listed account
example: 2
parentAccount
string
The assigned account ID for the account one level higher in the student loan account hierarchy
example: "5011648377"
List of Supported Account Types :- 
"checking": Standard checking
"savings": Standard savings
"cd": Certificates of deposit
"moneyMarket": Money Market
"creditCard": Standard credit cards
"lineOfCredit": Home equity, line of credit
"investment": Generic investment (no details)
"investmentTaxDeferred": Generic tax-advantaged investment (no details)
"employeeStockPurchasePlan": ESPP, Employee Stock Ownership Plans (ESOP), Stock Purchase Plans
"ira": Individual Retirement Account (not Rollover or Roth)
"401k": 401K Plan
"roth": Roth IRA, Roth 401K
"403b": 403B Plan
"529plan": 529 Plan (True value is 529)
"rollover": Rollover IRA
"ugma": Uniform Gifts to Minors Act
"utma": Uniform Transfers to Minors Act
"keogh": Keogh Plan
"457plan": 457 Plan (True value is 457)
"401a": 401A Plan
"brokerageAccount": Brokerage Account
"educationSavings": Education Savings Account that is not a 529
"healthSavingsAccount": HSA (Health Savings Accounts)
"pension": Pension
"profitSharingPlan": Profit Sharing Plan
"roth401k": Roth 401K
"sepIRA": Simplified Employee Pension IRA
"simpleIRA": Simple IRA
"thriftSavingsPlan": Thrift Savings Plan
"variableAnnuity": Variable Annuity
"cryptocurrency": Cryptocurrency Wallet, Cryptocurrency Account
"mortgage": Standard Mortgages
"loan": Auto loans, equity loans, other loans
"studentLoan": Student Loan
"studentLoanGroup": Student Loan Group
"studentLoanAccount": Student Loan Account
JSON
{
    "error": {
        "name": "error",
        "message": "Invalid Date",
        "status": 400,
        "reason": "VALIDATION_ERROR",
        "type": "Bad Request",
        "statusCode": 200
    }
}
{
    "error": {
        "name": "error",
        "message": "Invalid Date",
        "status": 400,
        "reason": "VALIDATION_ERROR",
        "type": "Bad Request",
        "statusCode": 200
    }
}
﻿
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!
﻿

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

Parameter	Data Type	Description
accounts	array[CustomerAccount]	List of customer accounts
id	string	An account ID example: "5011648377"
number	string	The account number from the institution example: "2000004444"
realAccountNumberLast4	string	The last 4 digits of the ACH account number example: "5678"
name	string	The account name from the institution example: "Super Checking"
balance	number	The cleared balance of the account as of balanceDate example: 401.26
type	string	Account Type. Please check the list of supported account types below. example: "checking"
status	string	"pending" during account discovery, always "active" following successful account activation example: "active
customerId	string	A customer ID
institutionId	string	The ID of a financial institution
balanceDate	integer	A timestamp showing when the balance was captured. A date in Unix epoch time (in seconds)
aggregationSuccessDate	integer	A timestamp showing the last successful aggregation of the account. This will not be present until you have run your first aggregation for the account. A date in Unix epoch time (in seconds)
aggregationAttemptDate	integer	A timestamp showing the last aggregation attempt, whether successful or not. This will not be present until you have run your first aggregation for the account. A date in Unix epoch time (in seconds)
createdDate	integer	A timestamp showing when the account was added to the system. A date in Unix epoch time (in seconds)
currency	string	A currency code example: "USD"
lastTransactionDate	integer	The date of the latest transaction on the account. This will not be present until you have run your first aggregation for the account. A date in Unix epoch time (in seconds)
oldestTransactionDate	integer	The date of the oldest transaction in the transactions for the account. A date in Unix epoch time (in seconds)
institutionLoginId	integer	An institution login ID (from the account record), represented as a number example: 1007302745
detail		CustomerAccountDetail Additional customer account details. Not all data points will return for each account type. The data point are also subject to availability by the institution.
position	array[CustomerAccountPosition]	Investment holdings
displayPosition	integer	Display position of the account at the financial institution, "1" being the top listed account example: 2
parentAccount	string	The assigned account ID for the account one level higher in the student loan account hierarchy example: "5011648377"

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

Did this page help you?

Get customer accounts

Delete Customer