Get customer accounts

introduction get all accounts owned by the given custome using this api it helps to get all the information of the account held by the customer by having customerid as the input api details customer id of the account holder that was received as the api response of create bank connect journey link docid\ nckrwlah4pry52vphhnpc should be used as the input sample curl curl location request post 'https //api signzy app/api/v3/bank connect/customer accounts' \\ \ header 'authorization \<token>' \\ \ header 'content type application/json' \\ \ data raw '{ "customerid" "6019521730" }' 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" }' request body parameters parameter required description customerid yes customer id of the account holder that was received in the response of create bank connect journey link docid\ nckrwlah4pry52vphhnpc 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 body parameters parameter 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 the 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 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 account 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 sample error { "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!