Refresh Customer
Introduction
The "Refresh Customer" API by Signzy is integrated with Finicity. This helps you fetch the updated account owner details of a bank account which can be used to verify the bank account owner's information for your onboarding process.
API Input Guidelines
This API takes one inputs -
- CustomerID
Sample 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",
}'Input Parameters
Parameter name | Data type | Required | Description |
|---|---|---|---|
Authorization | Authorization token | Yes | Authorization token sent in the header |
Content-Type | application/json(fixed) | Yes | Sent in the headers |
customerId | string | Yes | The customer Id which was created and sent in the response after running create bank connect journey API |
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"
}
]
}
Output Parameters
Parameter name | Data type | Description |
|---|---|---|
accounts | Array | Details of account number in array |
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].