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 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 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 docid\ nckrwlah4pry52vphhnpc api this is c ustomer id of the customer account whose owner details are to be fetched sample response { "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 { "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 help\@signzy com 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!