Endpoint: GET /dataExtracts/userData
The get user data service is used to get a user's modified data for a particular period of time for accounts, transactions, holdings, and provider account information.
The time difference between fromDate and toDate fields cannot be more than 60 minutes.
By default, pagination is available for the transaction entity in this API. In the first response, the API will retrieve 500 transactions along with other data. The response header will provide a link to retrieve the next set of transactions.
In the response body of the first API response, totalTransactionsCount indicates the total number of transactions the API will retrieve for the user.
This service is only invoked with either admin access token or a cobrand session.
Refer to dataExtracts page for more information.
curl -X GET /dataExtracts/userData \\
-H 'Content-Type: application/json' \\
-H "Authorization: Bearer {access_token}"
{
"userData": [
{
"holding": [
{
"symbol": "string",
"exercisedQuantity": 0,
"cusipNumber": "string",
"vestedQuantity": 0,
"description": "string",
"unvestedValue": {
"amount": 0,
"currency": "AUD"
},
"securityStyle": "string",
"vestedValue": {
"amount": 0,
"currency": "AUD"
},
"optionType": "put",
"lastUpdated": "string",
"matchStatus": "string",
"holdingType": "stock",
"maturityDate": "string",
"price": {
"amount": 0,
"currency": "AUD"
},
"term": "string",
"contractQuantity": 0,
"id": 0,
"isShort": true,
"value": {
"amount": 0,
"currency": "AUD"
},
"expirationDate": "string",
"interestRate": 0,
"quantity": 0,
"accruedInterest": {
"amount": 0,
"currency": "AUD"
},
"grantDate": "string",
"sedol": "string",
"vestedSharesExercisable": 0,
"spread": {
"amount": 0,
"currency": "AUD"
},
"accountId": 0,
"enrichedDescription": "string",
"couponRate": 0,
"createdDate": "string",
"accruedIncome": {
"amount": 0,
"currency": "AUD"
},
"securityType": "string",
"providerAccountId": 0,
"unvestedQuantity": 0,
"costBasis": {
"amount": 0,
"currency": "AUD"
},
"vestingDate": "string",
"isin": "string",
"strikePrice": {
"amount": 0,
"currency": "AUD"
}
}
],
"totalTransactionsCount": 0,
"user": {
"loginName": "string"
},
"account": [
{
"availableCash": {
"amount": 0,
"currency": "AUD"
},
"includeInNetWorth": true,
"moneyMarketBalance": {
"amount": 0,
"currency": "AUD"
},
"enrollmentDate": "string",
"estimatedDate": "string",
"memo": "string",
"guarantor": "string",
"interestPaidLastYear": {
"amount": 0,
"currency": "AUD"
},
"lastUpdated": "string",
"balance": {
"amount": 0,
"currency": "AUD"
},
"homeInsuranceType": "HOME_OWNER",
"id": 0,
"cash": {
"amount": 0,
"currency": "AUD"
},
"totalCreditLine": {
"amount": 0,
"currency": "AUD"
},
"providerName": "string",
"valuationType": "SYSTEM",
"marginBalance": {
"amount": 0,
"currency": "AUD"
},
"apr": 0,
"availableCredit": {
"amount": 0,
"currency": "AUD"
},
"currentBalance": {
"amount": 0,
"currency": "AUD"
},
"isManual": true,
"escrowBalance": {
"amount": 0,
"currency": "AUD"
},
"nextLevel": "string",
"classification": "OTHER",
"loanPayoffAmount": {
"amount": 0,
"currency": "AUD"
},
"interestRateType": "FIXED",
"loanPayByDate": "string",
"faceAmount": {
"amount": 0,
"currency": "AUD"
},
"policyFromDate": "string",
"premiumPaymentTerm": "string",
"policyTerm": "string",
"repaymentPlanType": "STANDARD",
"availableBalance": {
"amount": 0,
"currency": "AUD"
},
"accountStatus": "ACTIVE",
"lifeInsuranceType": "OTHER",
"premium": {
"amount": 0,
"currency": "AUD"
},
"aggregationSource": "SYSTEM",
"isDeleted": true,
"overDraftLimit": {
"amount": 0,
"currency": "AUD"
},
"nickname": "string",
"term": "string",
"interestRate": 0,
"deathBenefit": {
"amount": 0,
"currency": "AUD"
},
"address": {
"zip": "string",
"country": "string",
"address3": "string",
"address2": "string",
"city": "string",
"sourceType": "string",
"address1": "string",
"street": "string",
"state": "string",
"type": "HOME"
},
"cashValue": {
"amount": 0,
"currency": "AUD"
},
"401kLoan": {
"amount": 0,
"currency": "AUD"
},
"homeValue": {
"amount": 0,
"currency": "AUD"
},
"accountNumber": "string",
"createdDate": "string",
"interestPaidYTD": {
"amount": 0,
"currency": "AUD"
},
"providerAccountId": 0,
"collateral": "string",
"dataset": [
{
"lastUpdated": "string",
"updateEligibility": "ALLOW_UPDATE",
"additionalStatus": "LOGIN_IN_PROGRESS",
"nextUpdateScheduled": "string",
"name": "BASIC_AGG_DATA",
"lastUpdateAttempt": "string"
}
],
"runningBalance": {
"amount": 0,
"currency": "AUD"
},
"sourceId": "string",
"dueDate": "string",
"frequency": "DAILY",
"maturityAmount": {
"amount": 0,
"currency": "AUD"
},
"associatedProviderAccountId": [
0
],
"isAsset": true,
"principalBalance": {
"amount": 0,
"currency": "AUD"
},
"totalCashLimit": {
"amount": 0,
"currency": "AUD"
},
"maturityDate": "string",
"minimumAmountDue": {
"amount": 0,
"currency": "AUD"
},
"annualPercentageYield": 0,
"accountType": "string",
"originationDate": "string",
"totalVestedBalance": {
"amount": 0,
"currency": "AUD"
},
"rewardBalance": [
{
"expiryDate": "string",
"balanceToReward": "string",
"balanceType": "EXPIRING_BALANCE",
"balance": 0,
"description": "string",
"balanceToLevel": "string",
"units": "string"
}
],
"sourceAccountStatus": "IN_REPAYMENT",
"derivedApr": 0,
"policyEffectiveDate": "string",
"totalUnvestedBalance": {
"amount": 0,
"currency": "AUD"
},
"annuityBalance": {
"amount": 0,
"currency": "AUD"
},
"accountName": "string",
"totalCreditLimit": {
"amount": 0,
"currency": "AUD"
},
"policyStatus": "ACTIVE",
"shortBalance": {
"amount": 0,
"currency": "AUD"
},
"lender": "string",
"lastEmployeeContributionAmount": {
"amount": 0,
"currency": "AUD"
},
"providerId": "string",
"lastPaymentDate": "string",
"primaryRewardUnit": "string",
"lastPaymentAmount": {
"amount": 0,
"currency": "AUD"
},
"remainingBalance": {
"amount": 0,
"currency": "AUD"
},
"userClassification": "BUSINESS",
"bankTransferCode": [
{
"id": "string",
"type": "BSB"
}
],
"expirationDate": "string",
"coverage": [
{
"amount": [
{
"cover": {},
"unitType": "PER_FAMILY",
"type": "DEDUCTIBLE",
"limitType": "IN_NETWORK",
"met": {}
}
],
"planType": "PPO",
"endDate": "string",
"type": "VISION",
"startDate": "string"
}
],
"cashApr": 0,
"oauthMigrationStatus": "IN_PROGRESS",
"displayedName": "string",
"amountDue": {
"amount": 0,
"currency": "AUD"
},
"currentLevel": "string",
"originalLoanAmount": {
"amount": 0,
"currency": "AUD"
},
"policyToDate": "string",
"loanPayoffDetails": {
"payByDate": "string",
"payoffAmount": {
"amount": 0,
"currency": "AUD"
},
"outstandingBalance": {
"amount": 0,
"currency": "AUD"
}
},
"CONTAINER": "bank",
"lastEmployeeContributionDate": "string",
"lastPayment": {
"amount": 0,
"currency": "AUD"
},
"recurringPayment": {
"amount": 0,
"currency": "AUD"
}
}
],
"transaction": [
{
"date": "string",
"sourceId": "string",
"symbol": "string",
"cusipNumber": "string",
"highLevelCategoryId": 0,
"detailCategoryId": 0,
"description": {
"security": "string",
"original": "string",
"simple": "string",
"consumer": "string"
},
"memo": "string",
"settleDate": "string",
"type": "string",
"baseType": "CREDIT",
"categorySource": "SYSTEM",
"principal": {
"amount": 0,
"currency": "AUD"
},
"lastUpdated": "string",
"isDeleted": true,
"interest": {
"amount": 0,
"currency": "AUD"
},
"price": {
"amount": 0,
"currency": "AUD"
},
"commission": {
"amount": 0,
"currency": "AUD"
},
"id": 0,
"amount": {
"amount": 0,
"currency": "AUD"
},
"checkNumber": "string",
"quantity": 0,
"valoren": "string",
"isManual": true,
"merchant": {
"website": "string",
"address": {
"zip": "string",
"country": "string",
"address3": "string",
"address2": "string",
"city": "string",
"sourceType": "string",
"address1": "string",
"street": "string",
"state": "string",
"type": "HOME"
},
"contact": {
"phone": "string",
"email": "string"
},
"categoryLabel": [
"string"
],
"coordinates": {
"latitude": 0,
"longitude": 0
},
"name": "string",
"id": "string",
"source": "YODLEE"
},
"sedol": "string",
"transactionDate": "string",
"categoryType": "TRANSFER",
"accountId": 0,
"createdDate": "string",
"sourceType": "AGGREGATED",
"CONTAINER": "bank",
"postDate": "string",
"parentCategoryId": 0,
"subType": "AUTH_HOLD",
"category": "string",
"runningBalance": {
"amount": 0,
"currency": "AUD"
},
"categoryId": 0,
"holdingDescription": "string",
"isin": "string",
"status": "POSTED"
}
],
"providerAccount": [
{
"lastUpdated": "string",
"createdDate": "string",
"aggregationSource": "SYSTEM",
"isDeleted": true,
"oauthMigrationStatus": "IN_PROGRESS",
"providerId": 0,
"requestId": "string",
"isManual": true,
"id": 0,
"dataset": [
{
"lastUpdated": "string",
"updateEligibility": "ALLOW_UPDATE",
"additionalStatus": "LOGIN_IN_PROGRESS",
"nextUpdateScheduled": "string",
"name": "BASIC_AGG_DATA",
"lastUpdateAttempt": "string"
}
],
"status": "LOGIN_IN_PROGRESS"
}
]
}
]
}
Endpoint: GET /dataExtracts/events