Akoya APIs
By hovering on the code, a clipboard icon will appear on the top right. Use it to copy the code. Then paste into your favorite text or code editor and save as a YAML file.
openapi: 3.1.0
x-stoplight:
id: 4xysx7evb4pa8
info:
title: Akoya APIs v2.4.0
version: 2.4.0
description: |-
Akoya product APIs for data access. Default servers are set for the Akoya sandbox environment.
Akoya APIs include the following updates:
- v2.4.0
- Added Tax product
- v2.3.0
- Removed erroneous `accountId` query param from Taxlots endpoint
- Added TaxLots endpoint
- v2.2.2
- Added mode query parameter to Account Information, Balances, Investments, and Transactions to support standard mode.
- Edited callouts for Account Holder endpoint
- v2.2.1
- Fixed typo in `accountIds` query parameter for `/accounts-info`, `/balances`, `/accounts`
- Added security method for `Account holder information` to bear token. Missing method defaulted to basic auth.
- Added examples and descriptions to some schemas
- Added HTTP status `429` FDX error `1207`.
- v2.2 Additions
- Added optional `x-akoya-interaction-type` header to all endpoints to specify if a request is part of a batch process
- Update of tags to organize endpoints by Akoya product
- `206` response added to `/accounts-info`, `/balances`, `/accounts`
- v2.1 New Statements product and Customers product updated with additional endpoint, `Account holder information`.
- v2.0 Launch of Akoya products: Account Info, Balances, Investments, Transactions, Payments, Customers.
contact:
name: API Support
url: 'http://www.akoya.com'
email: [email protected]
license:
name: Akoya Terms of Use
url: 'https://recipient.ddp.akoya.com/terms-of-use'
summary: ''
tags:
- name: Account information
description: Account information
- name: Balances
description: Balances
- name: Customers
description: Customers
- name: Investments
description: Investments
- name: Payments
description: Payments
- name: Statements
description: Statements
- name: Tax
description: Tax
- name: Transactions
description: Transactions
security:
- basicAuth: []
servers:
- url: 'https://sandbox-products.ddp.akoya.com'
description: Sandbox server
- url: 'https://products.ddp.akoya.com'
description: Products server
paths:
'/accounts-info/{version}/{providerId}':
get:
summary: Account information
tags:
- Account information
operationId: get-accounts-info
description: "Get basic account information including accountId, masked account number, type, description, etc.\n\nTo view the response schema, select the `200` response below. Then pick an option for annuity, deposit, insurance, investment, loan, and line of credit account types. \n\nFor an example payload response, see the `200` example response below the `Try it` feature. The example is from a deposit account but all account types are supported by this endpoint.\n\n> \U0001F6D1\n> \n> The *id_token* should be used as the bearer token with this call.\n\nUse the `mode` query param to receive FDX-aligned, standardized data values (Beta). For example:\n\n`https://sandbox-products.ddp.akoya.com/accounts-info/v2/mikomo?mode=standard`\n\n`mode` is available in both sandbox and production.\n\n`mode` is supported by a subset of providers. Log into the [Data Recipient Hub](https://recipient.ddp.akoya.com/login) and click [here](https://recipient.ddp.akoya.com/support/article/kA0Uw00000015GzKAI) to view a list of all providers supporting the `mode` parameter.\n\n"
security:
- bearerAuth: []
responses:
'200':
description: OK
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
content:
application/json:
schema:
$ref: '#/components/schemas/account-info'
examples:
Successful Response:
value:
accounts:
- investmentAccount:
accountId: '839502593'
accountType: College Savings
balanceType: ASSET
currency:
currencyCode: USD
nickname: 529 for Kid
- investmentAccount:
accountId: '5426873'
accountNumberDisplay: ...7054
accountType: BROKERAGE
allowedCheckWriting: false
currency:
currencyCode: USD
lastActivityDate: '2021-07-06T00:00:00Z'
margin: false
nickname: Self-Directed
status: OPEN
transactionsIncluded: false
- depositAccount:
accountId: g833202fb0866d0ad83472c429
accountNumberDisplay: xxxxxxxx0071
accountType: CHECKING
balanceType: ASSET
currency:
currencyCode: USD
description: Checking Plus
fiAttributes:
- name: accountOpenedDate
value: '2020-04-23'
- name: interestPaidLastYear
value: '3.20'
interestRate: 0.0125
interestRateAsOf: '2022-04-24T14:15:22Z'
interestRateType: FIXED
lastActivityDate: '2022-04-24T14:15:22Z'
lineOfBusiness: Personal
nickname: Nickname Checking Plus 0071
productName: Checking Plus
status: OPEN
transferIn: true
transferOut: true
- depositAccount:
accountId: 5dbda8de96eeff05f23934523a1fc258
accountNumberDisplay: xxxx0134
accountType: CHECKING
annualPercentageYield: 0
currency:
currencyCode: USD
description: Virtual Wallet Student Reserve
interestRateAsOf: '2022-04-24T14:15:22Z'
interestRateType: FIXED
lastActivityDate: '2022-04-01T10:05:00Z'
lineOfBusiness: LBRB
productName: Virtual Wallet Student Reserve
transactionsIncluded: false
- depositAccount:
accountId: 11719ae5-2399-1278-e43c-43f24abb3058
accountType: CD
annualPercentageYield: 0.75
balanceType: ASSET
currency:
currencyCode: USD
originalCurrencyCode: USD
description: Certificate of Deposit
fiAttributes:
- name: eStatements
value: 'False'
- name: interestPaidLastYear
value: '50.72'
- name: isTransactionsSupported
value: 'False'
- name: issueDate
value: '2019-03-21T00:00:00.000Z'
- name: interestPayoutFrequency
value: Semi-Annually (And At Maturity)
interestRate: 0.75
lineOfBusiness: CONSUMER
maturityDate: '2024-03-21T00:00:00Z'
nickname: Certificate of Deposit - 3691
parentAccountId: 11719ae5-2399-1278-e43c-43f24abb3058
status: OPEN
term: 60
transactionsIncluded: false
transferIn: false
transferOut: false
- depositAccount:
accountId: 33fbd9e5-9cc3-3d7d-15b3-70d97d87ca1d
accountType: SAVINGS
balanceType: ASSET
currency:
currencyCode: USD
originalCurrencyCode: USD
description: Savings
fiAttributes:
- name: eStatements
value: 'True'
interestRate: 0.01
lineOfBusiness: CONSUMER
nickname: Savings - 8537
parentAccountId: 33fbd9e5-9cc3-3d7d-15b3-70d97d87ca1d
status: OPEN
transactionsIncluded: false
'206':
description: Partial Content. Success searching for accounts. Some errors are being returned.
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
content:
application/json:
schema:
$ref: '#/components/schemas/account-info'
examples:
Partial Content:
value:
value:
accounts:
- investmentAccount:
accountId: '839502593'
accountType: College Savings
balanceType: ASSET
currency:
currencyCode: USD
nickname: '529'
- investmentAccount:
error:
code: 704
message: Account type not supported
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
'405':
description: Method Not Allowed
content:
text/plain:
schema:
type: string
examples:
Method Not Allowed:
value: Method Not Allowed
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'406':
$ref: '#/components/responses/406'
'408':
description: Request timed out (round trip call took >10 seconds).
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
content:
application/json:
schema:
$ref: '#/components/schemas/error'
x-examples:
Example 1:
code: 701
message: Account not found
debugMessage: No accounts were found for this customer.
examples:
Request Timeout:
value:
code: 408
message: request timeout
debugMessage: request timeout.
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
parameters:
- schema:
type: string
example: batch
enum:
- user
- batch
in: header
name: x-akoya-interaction-type
description: |-
Optional but recommended header to include with each data request.
Allowed values are `user` or `batch`.
`user` indicates a request is prompted by an end-user action.
`batch` indicates the request is part of a batch process.
- schema:
type: string
enum:
- raw
- standard
example: raw
in: query
name: mode
description: 'BETA. Default is raw. Use standard for FDX-aligned, standardized data values.'
x-stoplight:
id: afq2wv681u05q
parameters:
- $ref: '#/components/parameters/versionPath'
- $ref: '#/components/parameters/providerIdPath'
'/balances/{version}/{providerId}':
get:
summary: Balances
tags:
- Balances
operationId: get-balances
description: "Account information that includes balances and rates of bank accounts, credit cards, loans, investments, and more.\n\nTo view the response schema, select the `200` response below. Then pick an option for annuity, deposit, insurance, investment, loan, and line of credit account types. \n\nFor an example payload response, see the `200` example response below the `Try it` feature. The example is from a deposit account but all account types are supported by this endpoint.\n\n> \U0001F6D1\n> \n> The *id_token* should be used as the bearer token with this call.\n\nUse the `mode` query param to receive FDX-aligned, standardized data values (Beta). For example:\n\n`https://sandbox-products.ddp.akoya.com/balances/v2/mikomo?mode=standard`\n\n`mode` is available in both sandbox and production.\n\n`mode` is supported by a subset of providers. Log into the [Data Recipient Hub](https://recipient.ddp.akoya.com/login) and click [here](https://recipient.ddp.akoya.com/support/article/kA0Uw00000015GzKAI) to view a list of all providers supporting the `mode` parameter."
security:
- bearerAuth: []
responses:
'200':
description: OK
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
content:
application/json:
schema:
$ref: '#/components/schemas/balances'
examples:
Successful Response:
value:
accounts:
- investmentAccount:
accountId: '839502593'
accountType: College Savings
availableCashBalance: 0
balanceAsOf: '2022-03-16T04:00:00Z'
balanceType: ASSET
currency:
currencyCode: USD
currentValue: 52672.49
marginBalance: 0
nickname: 529 for Kid
- investmentAccount:
accountId: '5426873'
accountNumberDisplay: ...7054
accountType: BROKERAGE
allowedCheckWriting: false
availableCashBalance: 0
balanceList:
- balanceDate: '2021-07-06'
balanceDescription: Margin Call
balanceName: MARGINCALL
balanceType: AMOUNT
balanceValue: 0
currency:
currencyCode: USD
- balanceDate: '2021-07-06'
balanceDescription: Fed Call
balanceName: FEDCALL
balanceType: AMOUNT
balanceValue: 0
currency:
currencyCode: USD
- balanceDate: '2021-07-06'
balanceDescription: Intra Day
balanceName: INTRADAY
balanceType: AMOUNT
balanceValue: 0
currency:
currencyCode: USD
- balanceDate: '2021-07-05'
balanceDescription: Prior Day
balanceName: PRIORDAY
balanceType: AMOUNT
balanceValue: 0
currency:
currencyCode: USD
currency:
currencyCode: USD
lastActivityDate: '2021-07-06T00:00:00Z'
margin: false
marginBalance: 0
nickname: Self-Directed
shortBalance: 0
status: OPEN
transactionsIncluded: false
- depositAccount:
accountId: g833202fb0866d0ad83472c429
accountNumberDisplay: xxxxxxxx0071
accountType: CHECKING
availableBalance: 106717.06
balanceAsOf: '2022-04-24T14:15:22Z'
balanceType: ASSET
currency:
currencyCode: USD
currentBalance: 106717.06
description: Checking Plus
fiAttributes:
- name: accountOpenedDate
value: '2020-04-23'
- name: interestPaidLastYear
value: '3.20'
interestRate: 0.0125
interestRateAsOf: '2022-04-24T14:15:22Z'
interestRateType: FIXED
interestYtd: 20.33
lastActivityDate: '2022-04-24T14:15:22Z'
lineOfBusiness: Personal
nickname: Nickname Checking Plus 0071
productName: Checking Plus
status: OPEN
transferIn: true
transferOut: true
- depositAccount:
accountId: 5dbda8de96eeff05f23934523a1fc258
accountNumberDisplay: xxxx0134
accountType: CHECKING
annualPercentageYield: 0
availableBalance: 0
balanceAsOf: '2022-04-24T14:15:22Z'
currency:
currencyCode: USD
currentBalance: 0
description: Virtual Wallet Student Reserve
interestRateAsOf: '2022-04-24T14:15:22Z'
interestRateType: FIXED
lastActivityDate: '2022-04-01T10:05:00Z'
lineOfBusiness: LBRB
openingDayBalance: 0
productName: Virtual Wallet Student Reserve
transactionsIncluded: false
- depositAccount:
accountId: 11719ae5-2399-1278-e43c-43f24abb3058
accountType: CD
annualPercentageYield: 0.75
availableBalance: 6808.29
balanceAsOf: '2021-04-07T10:20:43.276Z'
balanceType: ASSET
currency:
currencyCode: USD
originalCurrencyCode: USD
currentBalance: 6808.29
description: Certificate of Deposit
fiAttributes:
- name: eStatements
value: 'False'
- name: interestPaidLastYear
value: '50.72'
- name: isTransactionsSupported
value: 'False'
- name: issueDate
value: '2019-03-21T00:00:00.000Z'
- name: interestPayoutFrequency
value: Semi-Annually (And At Maturity)
interestRate: 0.75
interestYtd: 25.24
lineOfBusiness: CONSUMER
maturityDate: '2024-03-21T00:00:00Z'
nickname: Certificate of Deposit - 3691
openingDayBalance: 2000
parentAccountId: 11719ae5-2399-1278-e43c-43f24abb3058
status: OPEN
term: 60
transactionsIncluded: false
transferIn: false
transferOut: false
- depositAccount:
accountId: 33fbd9e5-9cc3-3d7d-15b3-70d97d87ca1d
accountType: SAVINGS
availableBalance: 20608.9
balanceAsOf: '2021-04-07T10:08:11.833Z'
balanceType: ASSET
currency:
currencyCode: USD
originalCurrencyCode: USD
currentBalance: 20608.9
description: Savings
fiAttributes:
- name: eStatements
value: 'True'
interestRate: 0.01
interestYtd: 0.29
lineOfBusiness: CONSUMER
nickname: Savings - 8537
openingDayBalance: 20608.9
parentAccountId: 33fbd9e5-9cc3-3d7d-15b3-70d97d87ca1d
status: OPEN
transactionsIncluded: false
'206':
description: Partial Content. Success searching for accounts. Some errors are being returned.
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
content:
application/json:
schema:
$ref: '#/components/schemas/balances'
examples:
Partial Content:
value:
accounts:
- investmentAccount:
accountId: '839502593'
accountType: College Savings
availableCashBalance: 0
balanceAsOf: '2022-03-16T04:00:00Z'
balanceType: ASSET
currency:
currencyCode: USD
currentValue: 52672.49
marginBalance: 0
nickname: 529 for Kid
- depositAccount:
error:
code: 704
message: Account type not supported
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
'405':
description: Method Not Allowed
content:
text/plain:
schema:
type: string
examples:
Method Not Allowed:
value: Method Not Allowed
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'406':
$ref: '#/components/responses/406'
'408':
description: Request timed out (round trip call took >10 seconds).
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
content:
application/json:
schema:
$ref: '#/components/schemas/error'
x-examples:
Example 1:
code: 701
message: Request timed out
debugMessage: Request timed out.
examples:
Request Timeout:
value:
code: 701
message: Request timed out
debugMessage: Request timed out.
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
parameters:
- schema:
type: string
example: batch
enum:
- user
- batch
in: header
name: x-akoya-interaction-type
description: |-
Optional but recommended header to include with each data request.
Allowed values are `user` or `batch`.
`user` indicates a request is prompted by an end-user action.
`batch` indicates the request is part of a batch process.
- schema:
type: string
enum:
- raw
- standard
example: raw
in: query
name: mode
description: 'BETA. Default is raw. Use standard for FDX-aligned, standardized data values.'
x-stoplight:
id: 6xx6ysx9r54m4
parameters:
- $ref: '#/components/parameters/versionPath'
- $ref: '#/components/parameters/providerIdPath'
'/transactions/{version}/{providerId}/{accountId}':
get:
summary: Transactions
tags:
- Transactions
operationId: get-transactions
description: "The transactions API allows you to retrieve transaction history of consumer-permissioned accounts.\n\n> \U0001F6D1\n> \n> The *id_token* should be used as the bearer token with this call.\n\nFor more information on how to paginate transaction results, please see: [Pagination](https://docs.akoya.com/v2/docs/pagination)\n\nUse the `mode` query param to receive FDX-aligned, standardized data values (Beta). For example:\n\n`https://sandbox-products.ddp.akoya.com/transactions/v2/mikomo?mode=standard`\n\n`mode` is available in both sandbox and production.\n\n`mode` is supported by a subset of providers. Log into the [Data Recipient Hub](https://recipient.ddp.akoya.com/login) and click [here](https://recipient.ddp.akoya.com/support/article/kA0Uw00000015GzKAI) to view a list of all providers supporting the `mode` parameter."
security:
- bearerAuth: []
responses:
'200':
description: OK
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
content:
application/json:
schema:
$ref: '#/components/schemas/transactions'
examples:
Successful Response - Savings Transactions:
value:
links:
prev:
href: /transactions/v2/mikomo/33fbd9e5-9cc3-3d7d-15b3-70d97d87ca1d?endTime=2021-02-26T00%3A00%3A00Z&limit=5&offset=0&startTime=2019-02-26T00%3A00%3A00Z
transactions:
- depositTransaction:
accountId: 33fbd9e5-9cc3-3d7d-15b3-70d97d87ca1d
amount: 0.29
debitCreditMemo: CREDIT
description: Interest Paid This Period
postedTimestamp: '2021-01-27T00:00:00Z'
status: POSTED
transactionId: 22ef95ee-6127-382d-a28c-5b8b7a15d2eb
transactionTimestamp: '2021-01-27T00:00:00Z'
transactionType: INTEREST
- depositTransaction:
accountId: 33fbd9e5-9cc3-3d7d-15b3-70d97d87ca1d
amount: 0.13
debitCreditMemo: CREDIT
description: Interest Paid This Period
postedTimestamp: '2021-02-24T00:00:00Z'
status: POSTED
transactionId: f3fced9d-a7a2-4194-5a17-a2a9b09ff64a
transactionTimestamp: '2021-02-24T00:00:00Z'
transactionType: INTEREST
Successful Response - Deposit TX - Limit 5 with Next & Prev:
value:
links:
next:
href: /transactions/v2/mikomo/g833202fb0866d0ad83472c429?endTime=2021-02-26T00%3A00%3A00Z&limit=5&offset=5&startTime=2019-02-26T00%3A00%3A00Z
prev:
href: /transactions/v2/mikomo/g833202fb0866d0ad83472c429?endTime=2021-02-26T00%3A00%3A00Z&limit=5&offset=0&startTime=2019-02-26T00%3A00%3A00Z
transactions:
- depositTransaction:
accountId: g833202fb0866d0ad83472c429
amount: -449.07
checkNumber: 31505
description: CHECK
postedTimestamp: '2019-07-08T00:00:00Z'
status: POSTED
transactionId: '30191890000030'
transactionTimestamp: '2019-07-08T00:00:00Z'
transactionType: CHECK
- depositTransaction:
accountId: g833202fb0866d0ad83472c429
amount: -4000.4
checkNumber: 31528
description: CHECK
postedTimestamp: '2019-07-08T00:00:00Z'
status: POSTED
transactionId: '30191890000020'
transactionTimestamp: '2019-07-08T00:00:00Z'
transactionType: CHECK
- depositTransaction:
accountId: g833202fb0866d0ad83472c429
amount: 5048.13
description: DEPOSIT
postedTimestamp: '2019-07-08T00:00:00Z'
status: POSTED
transactionId: '30191890000010'
transactionTimestamp: '2019-07-08T00:00:00Z'
transactionType: DEPOSIT
- depositTransaction:
accountId: g833202fb0866d0ad83472c429
amount: -8.6
checkNumber: 31530
description: CHECK
postedTimestamp: '2019-07-09T00:00:00Z'
status: POSTED
transactionId: '30191900000030'
transactionTimestamp: '2019-07-09T00:00:00Z'
transactionType: CHECK
- depositTransaction:
accountId: g833202fb0866d0ad83472c429
amount: -42.94
checkNumber: 31525
description: CHECK##TRANINITDATE# 07/09
postedTimestamp: '2019-07-09T00:00:00Z'
status: POSTED
transactionId: '30191900000020'
transactionTimestamp: '2019-07-09T00:00:00Z'
transactionType: CHECK
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Invalid Date Range:
value:
code: 703
message: Invalid date range
debugMessage: Invalid date range.
Invalid Start or End Date:
value:
code: 702
message: Invalid start or end date
debugMessage: Invalid start or end date.
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
'405':
description: Method Not Allowed
content:
text/plain:
schema:
type: string
examples:
Method Not Allowed:
value: Method Not Allowed
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'406':
$ref: '#/components/responses/406'
'408':
description: Request timed out (round trip call took >10 seconds).
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
content:
application/json:
schema:
$ref: '#/components/schemas/error'
x-examples:
Example 1:
code: 408
message: Request timeout
debugMessage: Request timeout.
examples:
Request Timeout:
value:
code: 408
message: Request timeout
debugMessage: Request timeout.
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
parameters:
- $ref: '#/components/parameters/startTimeQuery'
- $ref: '#/components/parameters/endTimeQuery'
- $ref: '#/components/parameters/offsetQuery'
- $ref: '#/components/parameters/limitQuery'
- schema:
type: string
example: batch
enum:
- user
- batch
in: header
name: x-akoya-interaction-type
description: |-
Optional but recommended header to include with each data request.
Allowed values are `user` or `batch`.
`user` indicates a request is prompted by an end-user action.
`batch` indicates the request is part of a batch process.
- schema:
type: string
enum:
- raw
- standard
example: raw
in: query
name: mode
description: 'BETA. Default is raw. Use standard for FDX-aligned, standardized data values.'
x-stoplight:
id: 9waqnqydcjvnw
parameters:
- $ref: '#/components/parameters/versionPath'
- $ref: '#/components/parameters/providerIdPath'
- $ref: '#/components/parameters/accountIdPath'
'/accounts/{version}/{providerId}':
get:
summary: Accounts
tags:
- Investments
operationId: get-accounts
description: "Get detailed account information that includes Akoya products Account Info and Balances for all account types (annunity, deposit, insurance, investments, line of credit, and loan) and adds the Investments product to investment accounts including contributions, holdings, vesting information, and more.\n\nTo view the response schema, select the `200` response below. Then pick an option for annuity, deposit, insurance, investment, loan, and line of credit account types. \n\nFor an example payload response, see the `200` example response below the `Try it` feature. The example is from an investment account but all account types are supported and returned by this endpoint.\n\n> \U0001F6D1\n> \n> The *id_token* should be used as the bearer token with this call.\n\nUse the `mode` query param to receive FDX-aligned, standardized data values (Beta). For example:\n\n`https://sandbox-products.ddp.akoya.com/accounts/v2/mikomo?mode=standard`\n\n`mode` is available in both sandbox and production.\n\n`mode` is supported by a subset of providers. Log into the [Data Recipient Hub](https://recipient.ddp.akoya.com/login) and click [here](https://recipient.ddp.akoya.com/support/article/kA0Uw00000015GzKAI) to view a list of all providers supporting the `mode` parameter."
security:
- bearerAuth: []
responses:
'200':
description: OK
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
content:
application/json:
schema:
$ref: '#/components/schemas/investments'
examples:
Successful Response:
value:
accounts:
- investmentAccount:
accountId: '839502593'
accountType: College Savings
availableCashBalance: 0
balanceAsOf: '2022-03-16T04:00:00Z'
balanceType: ASSET
currency:
currencyCode: USD
currentValue: 52672.49
holdings:
- assetClasses:
- assetClass: DOMESTICBOND
percent: 0
cashAccount: false
marketValue: 52672.49
mutualFundSecurity:
mutualFundType: OPENEND
reinvestCapitalGains: true
reinvestDividends: true
unitsStreet: 0
unitsUser: 0
yield: 0
yieldAsOfDate: '2019-08-24T14:15:22Z'
positionType: LONG
purchasedPrice: 18.42
securityIdType: ISIN
units: 2088.521
marginBalance: 0
nickname: 529 for Kid
- investmentAccount:
accountId: '5426873'
accountNumberDisplay: ...7054
accountType: BROKERAGE
allowedCheckWriting: false
availableCashBalance: 0
balanceList:
- balanceDate: '2021-07-06'
balanceDescription: Margin Call
balanceName: MARGINCALL
balanceType: AMOUNT
balanceValue: 0
currency:
currencyCode: USD
- balanceDate: '2021-07-06'
balanceDescription: Fed Call
balanceName: FEDCALL
balanceType: AMOUNT
balanceValue: 0
currency:
currencyCode: USD
- balanceDate: '2021-07-06'
balanceDescription: Intra Day
balanceName: INTRADAY
balanceType: AMOUNT
balanceValue: 0
currency:
currencyCode: USD
- balanceDate: '2021-07-05'
balanceDescription: Prior Day
balanceName: PRIORDAY
balanceType: AMOUNT
balanceValue: 0
currency:
currencyCode: USD
currency:
currencyCode: USD
lastActivityDate: '2021-07-06T00:00:00Z'
margin: false
marginBalance: 0
nickname: Self-Directed
shortBalance: 0
status: OPEN
transactionsIncluded: false
- depositAccount:
accountId: g833202fb0866d0ad83472c429
accountNumberDisplay: xxxxxxxx0071
accountType: CHECKING
availableBalance: 106717.06
balanceAsOf: '2022-04-24T14:15:22Z'
balanceType: ASSET
currency:
currencyCode: USD
currentBalance: 106717.06
description: Checking Plus
fiAttributes:
- name: accountOpenedDate
value: '2020-04-23'
- name: interestPaidLastYear
value: '3.20'
interestRate: 0.0125
interestRateAsOf: '2022-04-24T14:15:22Z'
interestRateType: FIXED
interestYtd: 20.33
lastActivityDate: '2022-04-24T14:15:22Z'
lineOfBusiness: Personal
nickname: Nickname Checking Plus 0071
productName: Checking Plus
status: OPEN
transferIn: true
transferOut: true
- depositAccount:
accountId: 5dbda8de96eeff05f23934523a1fc258
accountNumberDisplay: xxxx0134
accountType: CHECKING
annualPercentageYield: 0
availableBalance: 0
balanceAsOf: '2022-04-24T14:15:22Z'
currency:
currencyCode: USD
currentBalance: 0
description: Virtual Wallet Student Reserve
interestRateAsOf: '2022-04-24T14:15:22Z'
interestRateType: FIXED
lastActivityDate: '2022-04-01T10:05:00Z'
lineOfBusiness: LBRB
openingDayBalance: 0
productName: Virtual Wallet Student Reserve
transactionsIncluded: false
- depositAccount:
accountId: 11719ae5-2399-1278-e43c-43f24abb3058
accountType: CD
annualPercentageYield: 0.75
availableBalance: 6808.29
balanceAsOf: '2021-04-07T10:20:43.276Z'
balanceType: ASSET
currency:
currencyCode: USD
originalCurrencyCode: USD
currentBalance: 6808.29
description: Certificate of Deposit
fiAttributes:
- name: eStatements
value: 'False'
- name: interestPaidLastYear
value: '50.72'
- name: isTransactionsSupported
value: 'False'
- name: issueDate
value: '2019-03-21T00:00:00.000Z'
- name: interestPayoutFrequency
value: Semi-Annually (And At Maturity)
interestRate: 0.75
interestYtd: 25.24
lineOfBusiness: CONSUMER
maturityDate: '2024-03-21T00:00:00Z'
nickname: Certificate of Deposit - 3691
openingDayBalance: 2000
parentAccountId: 11719ae5-2399-1278-e43c-43f24abb3058
status: OPEN
term: 60
transactionsIncluded: false
transferIn: false
transferOut: false
- depositAccount:
accountId: 33fbd9e5-9cc3-3d7d-15b3-70d97d87ca1d
accountType: SAVINGS
availableBalance: 20608.9
balanceAsOf: '2021-04-07T10:08:11.833Z'
balanceType: ASSET
currency:
currencyCode: USD
originalCurrencyCode: USD
currentBalance: 20608.9
description: Savings
fiAttributes:
- name: eStatements
value: 'True'
interestRate: 0.01
interestYtd: 0.29
lineOfBusiness: CONSUMER
nickname: Savings - 8537
openingDayBalance: 20608.9
parentAccountId: 33fbd9e5-9cc3-3d7d-15b3-70d97d87ca1d
status: OPEN
transactionsIncluded: false
'206':
description: Partial Content. Success searching for accounts. Some errors are being returned.
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
content:
application/json:
schema:
$ref: '#/components/schemas/balances'
examples:
Partial Content:
value:
accounts:
- investmentAccount:
accountId: '839502593'
accountType: College Savings
availableCashBalance: 0
balanceAsOf: '2022-03-16T04:00:00Z'
balanceType: ASSET
currency:
currencyCode: USD
currentValue: 52672.49
holdings:
- assetClasses:
- assetClass: DOMESTICBOND
percent: 0
cashAccount: false
marketValue: 52672.49
mutualFundSecurity:
mutualFundType: OPENEND
reinvestCapitalGains: true
reinvestDividends: true
unitsStreet: 0
unitsUser: 0
yield: 0
yieldAsOfDate: '2019-08-24T14:15:22Z'
positionType: LONG
purchasedPrice: 18.42
securityIdType: ISIN
units: 2088.521
marginBalance: 0
nickname: 529 for Kid
- investmentAccount:
error:
code: 704
message: Account type not supported
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
'405':
description: Method Not Allowed
content:
text/plain:
schema:
type: string
examples:
Method Not Allowed:
value: Method Not Allowed
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'406':
$ref: '#/components/responses/406'
'408':
description: Request timed out (round trip call took >10 seconds).
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
content:
application/json:
schema:
$ref: '#/components/schemas/error'
x-examples:
Example 1:
error: request timeout
examples:
Request Timeout:
value:
code: 408
message: Request timeout
debugMessage: Request timeout.
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
parameters:
- schema:
type: string
example: batch
enum:
- user
- batch
in: header
name: x-akoya-interaction-type
description: |-
Optional but recommended header to include with each data request.
Allowed values are `user` or `batch`.
`user` indicates a request is prompted by an end-user action.
`batch` indicates the request is part of a batch process.
- schema:
type: string
enum:
- raw
- standard
example: raw
in: query
name: mode
description: 'BETA. Default is raw. Use standard for FDX-aligned, standardized data values.'
x-stoplight:
id: ojb31d0tcggxu
parameters:
- $ref: '#/components/parameters/versionPath'
- $ref: '#/components/parameters/providerIdPath'
'/taxlots/{version}/{providerId}/{accountId}/{holdingId}':
get:
summary: Taxlots
tags:
- Investments
operationId: get-taxlots
description: "The taxlots API allows you to retrieve tax lots of consumer-permissioned accounts.\n\n> \U0001F6D1\n> \n> The *id_token* should be used as the bearer token with this call."
security:
- bearerAuth: []
responses:
'200':
description: OK
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
content:
application/json:
schema:
type: object
properties:
accountId:
type: string
holding:
type: object
properties:
holdingId:
type: string
securityId:
type: string
securityIdType:
type: string
taxLots:
type: array
items:
type: object
properties:
originalPurchaseDate:
type: string
quantity:
type: integer
purchasedPrice:
type: integer
costBasis:
type: number
currentValue:
type: integer
positionType:
type: string
x-examples:
Example 1:
accountId: '1755209824'
holding:
holdingId: 987654-321
securityId: '315994103'
securityIdType: CUSIP
taxLots:
- originalPurchaseDate: '2024-04-04T14:15:22Z'
quantity: 10
purchasedPrice: 58
costBasis: 1.5
currentValue: 2
positionType: LONG
- originalPurchaseDate: '2024-10-14T18:16:22Z'
quantity: 20
purchasedPrice: 80
costBasis: 2.5
currentValue: 4
positionType: LONG
examples:
Successful Response:
value:
accountId: string
holding:
holdingId: string
securityId: string
securityIdType: string
taxLots:
- originalPurchaseDate: string
quantity: 0
purchasedPrice: 0
costBasis: 0
currentValue: 0
positionType: string
'401':
$ref: '#/components/responses/401'
'403':
description: The `providerId` is wrong or your app doesn't have a subscription to the provider.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
x-examples:
Example 1:
code: 403
message: Subscription not found
examples:
Incorrect providerId or No Sub to Provider:
value:
code: 403
message: Subscription not found
debugMessage: Subscription not found.
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'404':
$ref: '#/components/responses/404'
'405':
description: Method Not Allowed
content:
text/plain:
schema:
type: string
examples:
Method Not Allowed:
value: Method Not Allowed
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'408':
description: Request timed out (round trip call took >10 seconds).
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
content:
application/json:
schema:
$ref: '#/components/schemas/error'
x-examples:
Example 1:
error: request timeout
examples:
Request Timeout:
value:
code: 408
message: request timeout
debugMessage: request timeout
parameters:
- schema:
type: string
example: batch
enum:
- user
- batch
in: header
name: x-akoya-interaction-type
description: |-
Optional but recommended header to include with each data request.
Allowed values are `user` or `batch`.
`user` indicates a request is prompted by an end-user action.
`batch` indicates the request is part of a batch process.
- schema:
type: string
in: query
name: offset
description: The number of items to skip before the first in the response. The default is 0
- schema:
type: string
in: query
name: limit
description: The maximum number of items to be returned in the response. The default is 50
x-stoplight:
id: edhi33bywijjv
parameters:
- name: version
in: path
description: 'Akoya major version number. Do not use minor version numbers. For instance, use v2 and not v2.2'
required: true
schema:
type: string
default: v2
- name: providerId
in: path
description: Id of provider
schema:
type: string
default: mikomo
required: true
- schema:
type: string
name: accountId
in: path
required: true
description: Account Identifier
- schema:
type: string
name: holdingId
in: path
required: true
description: Consumer's holdingId under investments
'/customers/{version}/{providerId}/current':
get:
operationId: customer-info
tags:
- Customers
description: "This product supports use cases such as payment enablement, account opening, and identity verification. Responses return information about the authorized end-user, the customer associated with the `id_token` used in the call. This information may include, but is not limited to, the customer identifier, name, email, address, and phone number.\n\n<br>\n\nTo see the response schema, select the `200` response below. For an example payload response, see the `200` example response below the *Try it* feature. \n\nThis product requires consumer consent to share all account holder information.\n\n> \U0001F6D1 The `id_token` should be used as the bearer token with this call.\n> "
summary: Customer info
parameters:
- $ref: '#/components/parameters/versionPath'
- $ref: '#/components/parameters/providerIdPath'
- schema:
type: string
example: batch
enum:
- user
- batch
in: header
name: x-akoya-interaction-type
description: |-
Optional but recommended header to include with each data request.
Allowed values are `user` or `batch`.
`user` indicates a request is prompted by an end-user action.
`batch` indicates the request is part of a batch process.
security:
- bearerAuth: []
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/currentCustomer'
examples: {}
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya tracking id for logging or support.
'405':
description: Method Not Allowed
content:
text/plain:
schema:
type: string
examples:
Method Not Allowed:
value: Method Not Allowed
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya tracking id for logging or support.
'408':
description: Request timed out (round trip call took >10 seconds).
content:
application/json:
schema:
$ref: '#/components/schemas/error'
x-examples:
Example 1:
error: request timeout
examples:
Request Timeout:
value:
code: 408
message: request timeout
debugMessage: Request timeout.
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya tracking id for logging or support.
x-stoplight:
id: d7i899r9ggukh
parameters:
- schema:
type: string
name: version
in: path
required: true
description: 'Akoya major version number. Do not use minor version numbers. For instance, use v2 and not v2.2'
- schema:
type: string
name: providerId
in: path
required: true
description: Id of provider
'/contacts/{version}/{providerId}/{accountId}':
get:
operationId: get-account-holder
tags:
- Customers
description: "This product supports use cases such as payment enablement, account opening, identity verification,or lending & credit enhancement. Responses return information about the authorized consumer, the customer associated with the `id_token` used in the call, and the relationship specific to the provided `accountId`.\n\n> \U0001F4CC Please note!\n>\n> This endpoint provides additional information which may not be required for your use case, making it inefficient compared to the [/customer info](https://docs.akoya.com/reference/customer-info) endpoint. Please refer to to the [Customers guide](https://docs.akoya.com/reference/customers) for more information about this endpoint.\n\nGet account holder information. Based on FDX 5.2.1.\n\nThis product requires consumer consent to share all account holder information.\n\n> \U0001F6D1 The `id_token` should be used as the bearer token with this call.\n> \n"
summary: Account holder information
parameters:
- $ref: '#/components/parameters/accountIdPath'
- $ref: '#/components/parameters/versionPath'
- $ref: '#/components/parameters/providerIdPath'
- schema:
type: string
example: batch
enum:
- user
- batch
in: header
name: x-akoya-interaction-type
description: |-
Optional but recommended header to include with each data request.
Allowed values are `user` or `batch`.
`user` indicates a request is prompted by an end-user action.
`batch` indicates the request is part of a batch process.
security:
- bearerAuth: []
responses:
'200':
description: OK
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
content:
application/json:
schema:
$ref: '#/components/schemas/accountContact'
examples:
Successful Response:
value:
holders:
- customerId: string
name:
first: string
middle: string
last: string
prefix: string
suffix: string
company: string
businessCustomer:
name: string
registeredAgents:
- first: string
middle: string
last: string
prefix: string
suffix: string
company: string
registeredId: string
industryCode:
type: string
code: string
domicile:
region: string
country: string
addresses:
- line1: string
line2: string
line3: string
city: string
state: string
region: string
postalCode: string
country: string
type: string
telephones:
- number: string
type: HOME
country: string
email:
- string
accounts:
- accountId: string
relationship: AUTHORIZED_USER
relationship: AUTHORIZED_USER
emails:
- string
addresses:
- line1: string
line2: string
line3: string
city: string
state: string
region: string
postalCode: string
country: string
type: string
telephones:
- type: HOME
country: string
number: '8675309'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Account Not Found:
value:
code: 701
message: Account not found.
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'405':
description: Method Not Allowed
content:
text/plain:
schema:
type: string
examples:
Method Not Allowed:
value: Method Not Allowed
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'408':
description: Request timed out (round trip call took >10 seconds).
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya tracking id for logging or support.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
x-examples:
Example 1:
error: request timeout
examples:
Request Timeout:
value:
code: 408
message: Request Timeout
debugMessage: Request timeout.
x-stoplight:
id: 42nhgntf5yr7c
parameters:
- schema:
type: string
name: version
in: path
required: true
description: 'Akoya major version number. Do not use minor version numbers. For instance, use v2 and not v2.2'
- schema:
type: string
name: providerId
in: path
required: true
description: Id of provider
- schema:
type: string
name: accountId
in: path
required: true
description: Unique identifier used to represent a consumer account. Not the actual account number.
'/payments/{version}/{providerId}/{accountId}payment-networks':
get:
tags:
- Payments
summary: Payments
description: "This product supports use cases such as payment enablement or account opening. The response includes identifiers necessary to make ACH and RTP payments. Identifiers include account number, routing number, identifier type (actual or tokenized account number), and payment network type such as ACH or RTP.\n\n<br>\n\nTo see the response schema, select the `200` response below. For an example payload response, see the `200` example response below the *Try it* feature. \n\n> \U0001F6D1\n> \n> The *id_token* should be used as the bearer token with this call."
operationId: payment-networks
parameters:
- $ref: '#/components/parameters/versionPath'
- $ref: '#/components/parameters/providerIdPath'
- $ref: '#/components/parameters/accountIdPath'
- schema:
type: string
example: batch
enum:
- user
- batch
in: header
name: x-akoya-interaction-type
description: |-
Optional but recommended header to include with each data request.
Allowed values are `user` or `batch`.
`user` indicates a request is prompted by an end-user action.
`batch` indicates the request is part of a batch process.
deprecated: false
security:
- bearerAuth: []
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/accountPaymentNetworkList'
examples:
Successful Response:
value:
paymentNetworks:
- bankId: '125000024'
identifier: '454992210071'
identifierType: ACCOUNT_NUMBER
type: US_ACH
transferIn: true
transferOut: true
Successful Response - No Content:
value:
paymentNetworks: []
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'401':
description: 602 - Customer does not have authorization to perform this action. The customer may have revoked access through the provider and would need to reauthenticate.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
example:
code: 602
message: Customer not authorized
examples:
Customer Not Authorized:
value:
code: 602
message: Customer not authorized
debugMessage: Customer not authorized.
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'403':
description: 403 - The `providerId` is wrong or your app doesn't have a subscription to the provider.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
example:
code: 403
message: Subscription not found
examples:
Subscription Not Found:
value:
code: 403
message: Subscription not found
debugMessage: Subscription not found.
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'404':
description: 701 - Account not found. The `accountId` may be wrong.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
example:
code: 701
message: Account not found
examples:
Account Not Found:
value:
code: 701
message: Account not found
debugMessage: Account not found.
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'405':
description: Method Not Allowed
content:
text/plain:
schema:
type: string
examples:
Method Not Allowed:
value: Method Not Allowed
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'408':
description: Request timed out (round trip call took >10 seconds).
content:
application/json:
schema:
$ref: '#/components/schemas/error'
x-examples:
Example 1:
error: request timeout
examples:
Request Timeout:
value:
code: 408
message: Request timeout
debugMessage: Request timeout.
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
x-stoplight:
id: veznfxdid6ech
parameters:
- schema:
type: string
name: version
in: path
required: true
description: 'Akoya major version number. Do not use minor version numbers. For instance, use v2 and not v2.2'
- schema:
type: string
name: providerId
in: path
required: true
description: Id of provider
- schema:
type: string
name: accountId
in: path
required: true
description: Unique identifier used to represent a consumer account. Not the actual account number.
'/statements/{version}/{providerId}/{accountId}':
parameters:
- $ref: '#/components/parameters/accountIdPath'
- $ref: '#/components/parameters/versionPath'
- $ref: '#/components/parameters/providerIdPath'
get:
summary: Statement list
tags:
- Statements
operationId: get-statement-list
description: |-
Retrieve a list of available statements for the end-user's consented accounts. You may request a date range of up to two years of historical statements (maximum date ranges vary by provider).
The paginated response includes an array of statement information with the end-user's account id and statement details such as statement id, date, description, and status. The results also include links to GET the statement image.
security:
- bearerAuth: []
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/statements'
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'400':
description: Start or end date value is not in the ISO 8601 format.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Invalid Start or End Date:
value:
code: 702
message: Invalid start or end date
debugMessage: Invalid start or end date.
Invalid Date Range:
value:
code: 703
message: Invalid date range
debugMessage: Invalid date range.
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'404':
description: 404 - Not found
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Account Not Found:
value:
code: 701
message: Account not found
debugMessage: Account not found.
Data Not Found for Request Parameters:
value:
code: 1107
message: Data not found for request parameters
debugMessage: Data not found for request parameters.
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'405':
description: Method Not Allowed
content:
text/plain:
schema:
type: string
examples:
Method Not Allowed:
value: Method Not Allowed
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'408':
description: Request timed out (round trip call took >10 seconds).
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
content:
application/json:
schema:
$ref: '#/components/schemas/error'
x-examples:
Example 1:
error: request timeout
examples:
Request Timeout:
value:
code: 408
message: Request timeout
debugMessage: Request timeout.
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
parameters:
- $ref: '#/components/parameters/startDateQuery'
- $ref: '#/components/parameters/endDateQuery'
- $ref: '#/components/parameters/offsetQuery'
- $ref: '#/components/parameters/limitQuery'
- schema:
type: string
example: batch
enum:
- user
- batch
in: header
name: x-akoya-interaction-type
description: |-
Optional but recommended header to include with each data request.
Allowed values are `user` or `batch`.
`user` indicates a request is prompted by an end-user action.
`batch` indicates the request is part of a batch process.
x-stoplight:
id: f42oxl7ht3c11
'/statements/{version}/{providerId}/{accountId}/{statementId}':
parameters:
- $ref: '#/components/parameters/accountIdPath'
- $ref: '#/components/parameters/versionPath'
- $ref: '#/components/parameters/providerIdPath'
- $ref: '#/components/parameters/statementIdPath'
get:
summary: Statement
tags:
- Statements
operationId: get-statements
description: |-
Retrieve a specific account statement file. Use [HTTP Accept request-header](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html) to specify desired content types.
For the initial launch, only PDF statements are supported. PDFs are returned in the response.
### cURL request
We recommend using the auto-generated cURL request with the {idToken}, accountId, providerId, statementId, and version with an added cURL parameter to return the output to a file. For example:
```curl
curl --request GET --url https://sandbox-products.ddp.akoya.com/statements/v2/mikomo/513815781465/P9CvLPKDaFRMbNDkhu1 --header "accept: application/pdf" --header "authorization: Bearer {idtoken}" --output example.pdf
```
security:
- bearerAuth: []
parameters:
- schema:
type: string
example: batch
enum:
- user
- batch
in: header
name: x-akoya-interaction-type
description: |-
Optional but recommended header to include with each data request.
Allowed values are `user` or `batch`.
`user` indicates a request is prompted by an end-user action.
`batch` indicates the request is part of a batch process.
responses:
'200':
description: OK - An image of an account statement
content:
application/pdf:
schema:
description: A pdf of an account statement
type: string
format: binary
image/gif:
schema:
description: A gif image of an account statement
type: string
format: binary
image/jpeg:
schema:
description: A jpeg image of an account statement
type: string
format: binary
image/tiff:
schema:
description: A tiff image of an account statement
type: string
format: binary
image/png:
schema:
description: A png image of an account statement
type: string
format: binary
headers:
Accept:
schema:
type: string
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'302':
description: 302 - Statement is available at specified location. URL is returned via the `Location` HTTP header
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'400':
description: Statement is processing and is not yet available.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Statement is Processing But Not Yet Available:
value:
code: 1300
message: Statement is Processing
debugMessage: Statement is Processing.
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'404':
description: Account exists but contains no statements.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Statements not Found for Given Account:
value:
code: 1108
message: Statements not found for given Account
debugMessage: Statements not found for given Account.
Statement Id not Found for Account:
value:
code: 1104
message: Statement id not found for Account
debugMessage: Statement id not found for Account.
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'405':
description: Method Not Allowed
content:
text/plain:
schema:
type: string
examples:
Method Not Allowed:
value: Method Not Allowed
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'406':
$ref: '#/components/responses/406'
'408':
description: Request timed out (round trip call took >10 seconds).
content:
application/json:
schema:
$ref: '#/components/schemas/error'
x-examples:
Example 1:
error: request timeout
examples:
Request Timeout:
value:
code: 408
message: Request timeout
debugMessage: Request timeout.
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
x-stoplight:
id: y8a1kjgdyptsb
'/tax-forms/{version}/{providerId}':
get:
operationId: taxFormsSearch
tags:
- Tax
summary: Search Tax Forms
description: Get the full lists of tax document data and tax form images available for a specific year for the current authorized customer.
security:
- bearerAuth: []
parameters:
- name: version
in: path
description: Endpoint version.
schema:
type: string
enum:
- v2
default: v2
required: true
- name: providerId
in: path
description: Provider to query for Tax data.
schema:
type: string
required: true
- name: x-akoya-interaction-id
in: header
description: Unique identifier to associate with this request. No specific format required.
schema:
type: string
example: unique-request-id-001
- name: x-akoya-interaction-type
in: header
schema:
type: string
enum:
- user
- batch
default: user
description: Identifies whether the customer is present (USER) or it is a BATCH operation. Case-insensitive.
example: user
- name: Accept
in: header
description: 'Use the [Accept HTTP request header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept) to indicate one or more content types to request for the search result response. Use `application/json` to request data or `application/pdf to request images in comma-separated array format. Use in combination with TaxDataTypeQuery parameter to request `application/json` responses in ''''JSON'''' or ''''BASE64_PDF'''' format for tax form data'''
schema:
type: array
items:
type: string
enum:
- application/json
- application/pdf
- application/zip
- image/gif
- image/jpeg
- image/png
- image/tiff
examples:
Only JSON data:
value:
- application/json
Multiple types accepted:
value:
- application/json
- name: taxYear
in: query
description: Tax year in which to search for tax forms.
schema:
type: string
example: '2024'
- name: taxForms
in: query
description: One or more tax form type enums for the specific documents being requested. Comma separated
style: form
explode: false
schema:
type: array
items:
$ref: '#/components/schemas/TaxFormType'
example:
- Tax1099Div
- Tax1099Int
- schema:
type: string
in: query
name: accountId
description: Unique account identifier (not the account number)
responses:
'200':
description: Array of all the tax document data and tax form images available for the customer matching search criteria
headers:
x-akoya-interaction-id:
description: Akoya supplied interaction id used for logging and error tracking
schema:
type: string
example: unique-request-id-001
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
$ref: '#/components/schemas/TaxStatementList'
example:
ResultType lightweight Search Response with Forms 1099-DIV and 1099-INT:
value:
statements:
- taxYear: 2020
taxStatementId: '9876987698769876'
attributes:
- name: federalTaxWithheld
value: '4014.00'
taxDataType: JSON
forms:
- tax1099Div:
taxYear: 2020
taxFormId: '9876987698769876'
taxFormDate: '2021-03-30'
additionalInformation: FDX v6.0
taxFormType: Tax1099Div
- taxYear: 2020
taxStatementId: '6543654365436543'
attributes:
- name: federalTaxWithheld
value: '4011.00'
taxDataType: JSON
forms:
- tax1099Int:
taxYear: 2020
taxFormId: '6543654365436543'
taxFormDate: '2021-03-30'
additionalInformation: FDX v6.0
taxFormType: Tax1099Int
ResultType details Search Response with Form 1098: null
'206':
description: Partial Content
headers:
x-akoya-interaction-id:
description: Akoya supplied interaction id used for logging and error tracking
schema:
type: string
example: unique-request-id-001
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
$ref: '#/components/schemas/TaxStatementList'
example:
Lightweight Response With Error:
value:
statements:
- taxYear: 2020
taxStatementId: '9876987698769876'
attributes:
- name: federalTaxWithheld
value: '4014.00'
taxDataType: JSON
forms:
- tax1099Div:
taxYear: 2020
taxFormId: '9876987698769876'
taxFormDate: '2021-03-30'
additionalInformation: FDX v6.0
taxFormType: Tax1099Div
- taxYear: 2020
taxDataType: JSON
forms:
- tax1099Int:
taxYear: 2020
taxFormType: Tax1099Int
error:
code: '1205'
message: Tax Forms not yet been made available
debugMessage: 1099-INT forms should be available after 02-01-2021
'400':
description: Bad Request
headers:
x-akoya-interaction-id:
schema:
type: string
example: <string>
description: Akoya supplied interaction id used for logging and error tracking
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
$ref: '#/components/schemas/error'
x-examples:
Example 1:
code: 400
message: Invalid input
debugMessage: Invalid input
examples:
Invalid Input:
value:
code: 400
message: Invalid input
debugMessage: Invalid input.
'404':
description: Not Found
headers:
x-akoya-interaction-id:
schema:
type: string
example: <string>
description: Akoya supplied interaction id used for logging and error tracking
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
$ref: '#/components/schemas/error'
x-examples:
Example 1:
code: 404
message: Customer not found
debugMessage: Customer not found
examples:
Customer Not Found:
value:
code: 404
message: Customer not found
debugMessage: Customer not found.
'405':
description: Method Not Allowed
content:
text/plain:
schema:
type: string
examples:
Method Not Allowed:
value: Method Not Allowed
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'406':
description: Not Acceptable
headers:
x-akoya-interaction-id:
schema:
type: string
example: <string>
description: Akoya supplied interaction id used for logging and error tracking
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: <string>
message: <string>
debugMessage: <string>
'408':
description: Request timed out (round trip call took >10 seconds).
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
content:
application/json:
schema:
$ref: '#/components/schemas/error'
x-examples:
Example 1:
code: 408
message: Request timeout
debugMessage: Request timeout
examples:
Request Timeout:
value:
code: 408
message: Request timeout
debugMessage: Request timeout.
'409':
description: Conflict
headers:
x-akoya-interaction-id:
schema:
type: string
example: <string>
description: Akoya supplied interaction id used for logging and error tracking
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: <string>
message: <string>
debugMessage: <string>
'500':
description: Internal Server Error
headers:
x-akoya-interaction-id:
schema:
type: string
example: <string>
description: Akoya supplied interaction id used for logging and error tracking
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
$ref: '#/components/schemas/error'
x-examples:
Example 1:
code: 500
message: Internal server error
debugMessage: Internal server error
examples:
Internal Server Error:
value:
code: 500
message: Internal server error
debugMessage: Internal server error.
'501':
description: FDX Version Not Supported or Not Implemented
headers:
x-akoya-interaction-id:
schema:
type: string
example: <string>
description: Akoya supplied interaction id used for logging and error tracking
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
FDX Version Not Supported or Not Implemented:
value:
code: 1106
message: FdxVersion not supported or not implemented
debugMessage: Data Provider's custom developer-level error details for troubleshooting.
'503':
description: Scheduled Maintenance
headers:
x-akoya-interaction-id:
schema:
type: string
example: <string>
description: Akoya supplied interaction id used for logging and error tracking
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
$ref: '#/components/schemas/error'
x-examples:
Example 1:
code: 503
message: Scheduled Maintenance
debugMessage: Scheduled Maintenance
examples:
Scheduled Maintenance:
value:
code: 503
message: Scheduled Maintenance
debugMessage: Scheduled Maintenance
x-stoplight:
id: 7embq6rhwey5g
parameters:
- schema:
type: string
name: version
in: path
required: true
description: 'Akoya major version number. Do not use minor version numbers. For instance, use v2 and not v2.2'
- schema:
type: string
name: providerId
in: path
required: true
description: Id of provider
'/tax-forms/{version}/{providerId}/{taxFormId}':
get:
operationId: getTaxForm
summary: Retrieve tax form
description: "Get the Tax Statement as JSON or PDF for a single tax document for the customer. Use [HTTP Accept request-header](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html) to specify desired content types. See `AcceptHeader` definition for typical values.\r\n\r\nNot all providers support PDF payloads. See [this article](https://recipient.ddp.akoya.com/support/article/kA0Uw00000026VxKAI) in the Data Recipent Hub for a list of providers that support document PDFs."
tags:
- Tax
security:
- bearerAuth: []
parameters:
- name: version
in: path
description: Endpoint version.
schema:
type: string
enum:
- v2
default: v2
required: true
- name: providerId
in: path
description: Provider to query for Tax data.
schema:
type: string
required: true
- name: taxFormId
in: path
description: Unique identifier of the tax form to request.
schema:
type: string
required: true
- name: x-akoya-interaction-id
in: header
description: Unique identifier to associate with this request. No specific format required.
schema:
type: string
example: unique-request-id-001
- name: x-akoya-interaction-type
in: header
schema:
type: string
enum:
- user
- batch
default: user
description: Identifies whether the customer is present (USER) or it is a BATCH operation. Case-insensitive.
example: user
- name: taxDataType
in: query
description: Use taxDataType to request `application/json` tax form data response in 'JSON' or 'BASE64_PDF' format. Omit if either format is acceptable. Used in combination with AcceptHeader requesting `application/json` response
schema:
$ref: '#/components/schemas/TaxDataType'
example: JSON
- name: Accept
in: header
description: 'Use the [Accept HTTP request header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept) to indicate one or more content types to request for the search result response. Use `application/json` to request data or `application/pdf`to request images. In comma-separated array format. Use in combination with TaxDataTypeQuery parameter to request `application/json` responses in ''''JSON'''' or ''''BASE64_PDF'''' format for tax form data'''
schema:
type: array
items:
type: string
enum:
- application/json
- application/pdf
- application/zip
- image/gif
- image/jpeg
- image/png
- image/tiff
responses:
'200':
description: The document image or TaxStatement as json for a single tax document for the customer. A single document can include multiple IRS tax forms and/or other reporting statements as delivered by providers
headers:
x-akoya-interaction-id:
description: Akoya supplied interaction id used for logging and error tracking
schema:
type: string
example: unique-request-id-001
Content-Type:
schema:
type: string
example: application/json
content:
application/pdf:
schema:
description: The document image downloaded as pdf
type: string
format: binary
application/json:
schema:
description: The TaxStatement json for a single tax document containing one or more tax reporting forms for the customer
$ref: '#/components/schemas/TaxStatement'
examples:
Tax1099Div and Tax1099Int:
value:
taxYear: 2020
taxStatementId: '1234123412341234'
attributes:
- name: Total tax withheld
value: '8025.00'
issuer:
tin: 12-3456789
partyType: BUSINESS
businessName:
name1: Financial Data Exchange
address:
line1: 12020 Sunrise Valley Dr
line2: Suite 230
city: Reston
region: VA
postalCode: '20191'
country: US
phone:
number: '8885551212'
recipient:
tin: xxx-xx-1234
partyType: INDIVIDUAL
individualName:
first: Kris
middle: Q
last: Public
address:
line1: 1 Main St
city: Melrose
region: NY
postalCode: '12121'
country: US
taxDataType: JSON
forms:
- tax1099Div:
taxYear: 2020
taxFormId: '9876987698769876'
taxFormDate: '2021-03-30'
additionalInformation: FDX v6.0
taxFormType: Tax1099Div
foreignAccountTaxCompliance: false
accountNumber: 111-5555555
ordinaryDividends: 1107
qualifiedDividends: 1208
totalCapitalGain: 2109
unrecaptured1250Gain: 2210
section1202Gain: 2311
collectiblesGain: 2412
nonTaxableDistribution: 3013
federalTaxWithheld: 4014
section199ADividends: 5015
investmentExpenses: 6016
foreignTaxPaid: 7017
foreignCountry: Mexico
cashLiquidation: 9019
nonCashLiquidation: 10020
taxExemptInterestDividend: 11021
specifiedPabInterestDividend: 12022
stateAndLocal:
- stateCode: NY
state:
taxWithheld: 15023
taxId: 14-000023
- tax1099Int:
taxYear: 2020
taxFormId: '6543654365436543'
taxFormDate: '2021-03-30'
additionalInformation: FDX v6.0
taxFormType: Tax1099Int
foreignAccountTaxCompliance: false
accountNumber: 111-5555555
payerRtn: '007007007'
interestIncome: 1008
earlyWithdrawalPenalty: 2009
usBondInterest: 3010
federalTaxWithheld: 4011
investmentExpenses: 5012
foreignTaxPaid: 6013
foreignCountry: Canada
taxExemptInterest: 8015
specifiedPabInterest: 9016
marketDiscount: 10017
bondPremium: 11018
usBondPremium: 12019
taxExemptBondPremium: 13020
cusipNumber: CUSIP
stateAndLocal:
- stateCode: NY
state:
taxWithheld: 17022
taxId: 15-000022
'206':
description: 'Partial Content success retrieving a customer tax document, some errors are being returned'
headers:
x-akoya-interaction-id:
description: Akoya supplied interaction id used for logging and error tracking
schema:
type: string
example: unique-request-id-001
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
description: 'The TaxStatement json for a single tax document containing one or more tax reporting forms for the customer, one or more of which contain an Error'
$ref: '#/components/schemas/TaxStatement'
'400':
description: Account ID is required for searching or validating authorization
headers:
x-akoya-interaction-id:
description: Akoya supplied interaction id used for logging and error tracking
schema:
type: string
example: unique-request-id-001
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Tax Form not Found:
value:
code: 1204
message: Account ID is Required
debugMessage: Provider custom developer-level error details for troubleshooting.
'404':
description: Tax Form for provided Tax Form ID was not found
headers:
x-akoya-interaction-id:
description: Akoya supplied interaction id used for logging and error tracking
schema:
type: string
example: unique-request-id-001
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Tax Form not Found:
value:
code: 1200
message: Tax Form not Found
debugMessage: Provider custom developer-level error details for troubleshooting.
'405':
description: Method Not Allowed
content:
text/plain:
schema:
type: string
examples:
Method Not Allowed:
value: Method Not Allowed
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'406':
$ref: '#/components/responses/406'
'408':
description: Request timed out (round trip call took >10 seconds).
content:
application/json:
schema:
$ref: '#/components/schemas/error'
x-examples:
Example 1:
code: 408
message: Request Timeout
debugMessage: Request Timeout
examples:
Request Timeout:
value:
code: 408
message: Request Timeout
debugMessage: Request Timeout.
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'409':
description: Tax forms are not currently available for this account or this year
headers:
x-akoya-interaction-id:
description: Akoya supplied interaction id used for logging and error tracking
schema:
type: string
example: unique-request-id-001
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Account is Closed:
value:
code: 705
message: Account is Closed
debugMessage: Provider custom developer-level error details for troubleshooting.
Tax Forms not yet been made available:
value:
code: 1205
message: Tax Forms not yet been made available
debugMessage: Provider custom developer-level error details for troubleshooting.
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
x-stoplight:
id: bzh9xouzzzf2w
parameters:
- schema:
type: string
name: version
in: path
required: true
description: 'Akoya major version number. Do not use minor version numbers. For instance, use v2 and not v2.2'
- schema:
type: string
name: providerId
in: path
required: true
description: Id of provider
- schema:
type: string
name: taxFormId
in: path
required: true
description: Unique identifier of the tax form to request
components:
responses:
'400':
description: Invalid Input
content:
application/json:
schema:
$ref: '#/components/schemas/error'
example:
code: 401
message: Invalid input
debugMessage: Invalid Input.
examples:
Invalid Input:
value:
code: 401
message: Invalid input
debugMessage: Invalid Input.
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'401':
description: Customer not authorized.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
x-examples:
Example 1:
code: 602
message: Customer not authorized
debugMessage: Customer not authorized.
example:
code: 602
message: Customer not authorized
debugMessage: Customer not authorized.
examples:
Customer Not Authorized:
value:
code: 602
message: Customer not authorized
debugMessage: Customer not authorized.
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'404':
description: 701 - Tax Lots not found. The `holdingId` may be wrong.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
x-examples:
Example 1:
code: 707
message: Tax Lots not found
debugMessage: Tax Lots not found.
example:
code: 701
message: Account not found
debugMessage: Account not found.
examples:
Tax Lots Not Found:
value:
code: 701
message: Account not found
debugMessage: Account not found.
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'406':
description: Content Type not Supported
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Content Type not Supported:
value:
code: 1203
message: Content Type not Supported
debugMessage: Data Provider's custom developer-level error details for troubleshooting.
'429':
description: 1207 - Too many requests
content:
application/json:
schema:
$ref: '#/components/schemas/error'
example:
code: 1207
message: Too many requests
debugMessage: Too many requests.
examples:
Too Many Requests:
value:
code: 1207
message: Too many requests
debugMessage: Too many requests.
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
'500':
description: Catch-all exception where request was not processed due to an internal outage/issue.
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Internal Server Error:
value:
code: 500
message: Internal server error
debugMessage: Data Provider's custom developer-level error details for troubleshooting.
'501':
description: FdxVersion in header is not implemented.
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
FDX Version Not Supported or Not Implemented:
value:
code: 1106
message: FdxVersion not supported or not implemented
debugMessage: Data Provider's custom developer-level error details for troubleshooting.
'503':
description: System is down for maintenance.
headers:
x-akoya-interaction-id:
schema:
type: string
description: Akoya supplied interaction id used for logging and error tracking
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Scheduled Maintenance:
value:
code: 503
message: Scheduled Maintenance
debugMessage: Data Provider's custom developer-level error details for troubleshooting.
securitySchemes:
basicAuth:
type: http
scheme: basic
bearerAuth:
description: The `id_token` should be used as the bearer token in this call.
type: http
scheme: bearer
bearerFormat: JWT
schemas:
accountInfo:
title: Account information
type: object
properties:
accountId:
description: Long-term persistent identity of the account. Not an account number. This identity must be unique to the owning institution.
type: string
accountType:
description: 'The type of an account. For instance, CHECKING, SAVINGS, 401K, etc.'
type: string
accountNumberDisplay:
description: Account display number for the end user’s handle at owning institution. This is to be displayed by the Interface Provider.
type: string
currency:
$ref: '#/components/schemas/currency'
description:
type: string
fiAttributes:
type: array
items:
$ref: '#/components/schemas/fiAttribute'
nickname:
description: Name given by the user. Used in UIs to assist in account selection
type: string
productName:
type: string
description: 'Marketed product name for this account. Used in UIs to assist in account selection '
status:
type: string
enum:
- OPEN
- CLOSED
- PENDINGOPEN
- PENDINGCLOSE
- DELINQUENT
- PAID
- NEGATIVECURRENTBALANCE
description: The status of an account.
lineOfBusiness:
description: 'The line of business, such as consumer, consumer joint, small business, corporate, etc.'
type: string
balanceType:
type: string
description: 'ASSET (positive transaction amount increases balance), LIABILITY (positive transaction amount decreases balance)'
enum:
- ASSET
- LIABILITY
interestRate:
description: Interest Rate of Account
type: number
interestRateType:
type: string
enum:
- FIXED
- VARIABLE
description: The type of interest rate. FIXED or VARIABLE.
interestRateAsOf:
type: string
description: Date of account’s interest rate
format: date-time
lastActivityDate:
type: string
description: Date that last transaction occurred on account
format: date-time
micrNumber:
description: MICR Number
type: string
parentAccountId:
description: Long-term persistent identity of the parent account. This is used to group accounts.
type: string
priorInterestRate:
description: Previous Interest Rate of Account
type: number
transferIn:
type: boolean
description: Account is eligible for incoming transfers
transferOut:
type: boolean
description: Account is eligible for outgoing transfers
x-stoplight:
id: 716ifibyjbiyp
account-info:
title: Akoya Account Info product
description: An optionally paginated array of accounts
type: object
allOf:
- type: object
properties:
accounts:
type: array
description: 'An array of accounts with entity types dependent on the account type (deposit, investment, loan, line of credit, annuity or insurance)'
items:
anyOf:
- properties:
depositAccount:
$ref: '#/components/schemas/depositAccount'
- properties:
loanAccount:
$ref: '#/components/schemas/loanAccount'
- properties:
locAccount:
$ref: '#/components/schemas/locAccount'
- properties:
investmentAccount:
$ref: '#/components/schemas/investmentAccount'
- properties:
insuranceAccount:
$ref: '#/components/schemas/insuranceAccount'
- properties:
annuityAccount:
$ref: '#/components/schemas/annuityAccount'
x-stoplight:
id: 5sqod7wtkq6m7
accountPaymentNetworkList:
title: Array of account payment networks
description: An optionally paginated array of payment networks supported by the account
allOf:
- type: object
properties:
paymentNetworks:
type: array
items:
$ref: '#/components/schemas/accountPaymentNetwork'
description: Array of payment networks
x-stoplight:
id: 3yepsors73aq9
accountPaymentNetwork:
title: Payment Network Supported by Account
description: This provides details required to execute a transaction against the account within the payment network
type: object
properties:
bankId:
type: string
description: Bank identifier used by the payment network ie. Routing Number
identifier:
type: string
description: 'The number used to identify the account within the payment network. If identifierType is ACCOUNT_NUMBER, this is the account number.'
identifierType:
type: string
description: Type of identifier
type:
type: string
description: Type of payment network
transferIn:
type: boolean
description: Can transfer funds to the account using this information
transferOut:
type: boolean
description: Can transfer funds from the account using this information
x-stoplight:
id: fbcs2h7ls1w8f
Address:
title: Address
description: U.S. domestic address or a foreign address with country other than 'US'
type: object
properties:
line1:
type: string
description: Address line 1
line2:
type: string
description: Address line 2
line3:
type: string
description: Address line 3
city:
type: string
description: City
region:
type: string
description: 'State, Province, Territory, Canton or Prefecture. From [Universal Postal Union](https://www.upu.int/en/Postal-Solutions/Programmes-Services/Addressing-Solutions#addressing-s42-standard) as of 2-26-2020, [S42 International Address Standards](https://www.upu.int/UPU/media/upu/documents/PostCode/S42_International-Addressing-Standards.pdf). For U.S. addresses can be 2-character code from ''#/components/schemas/StateCode'''
postalCode:
type: string
maxLength: 16
description: Postal code
country:
$ref: '#/components/schemas/Iso3166CountryCode'
description: Country code
x-stoplight:
id: q5ta2hc29lzbk
balances:
title: ''
type: object
allOf:
- type: object
properties:
accounts:
type: array
description: 'An array of accounts with entity types dependent on the account type (deposit, investment, loan, line of credit, annuity or insurance)'
items:
anyOf:
- properties:
depositAccount:
$ref: '#/components/schemas/depositBalance'
- properties:
loanAccount:
$ref: '#/components/schemas/loanBalance'
- properties:
locAccount:
$ref: '#/components/schemas/locBalance'
- properties:
investmentAccount:
$ref: '#/components/schemas/investmentBalance'
- properties:
insuranceAccount:
$ref: '#/components/schemas/insuranceBalance'
- properties:
annuityAccount:
$ref: '#/components/schemas/annuityBalance'
x-stoplight:
id: 9we3ww7n8avmz
balanceList:
title: Investment Balance List
type: object
properties:
balanceName:
type: string
description: Name of the balance.
balanceDescription:
type: string
description: Description of balance.
balanceType:
type: string
enum:
- AMOUNT
- PERCENTAGE
description: The type of an investment balance. AMOUNT or PERCENTAGE.
balanceValue:
type: number
description: Value of balance name.
balanceDate:
type: string
description: Date as of this balance.
format: date-time
currency:
$ref: '#/components/schemas/currency'
x-stoplight:
id: akmdqmcvjpiaw
BusinessName:
title: Business name
description: 'Name 1, Name 2'
type: object
properties:
name1:
description: Name line 1
type: string
name2:
description: Name line 2
type: string
x-stoplight:
id: cmwffnpbk26wy
BusinessIncomeStatement:
title: Business Income Statement
description: Business Income Statement for IRS Form 1040 Schedule C
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
businessName:
type: string
description: 'Box C, Business name'
sales:
type: number
description: 'Box 1, Gross receipts or sales'
returns:
type: number
description: 'Box 2, Returns and allowances'
otherIncome:
type: array
description: 'Box 6, Other income, including federal and state gasoline or fuel tax credit or refund'
items:
$ref: '#/components/schemas/DescriptionAmount'
advertising:
type: number
description: 'Box 8, Advertising'
carAndTruck:
type: number
description: 'Box 9, Car and truck expenses'
commissions:
type: number
description: 'Box 10, Commissions and fees'
contractLabor:
type: number
description: 'Box 11, Contract labor'
depletion:
type: number
description: 'Box 12, Depletion'
depreciation:
type: number
description: 'Box 13, Depreciation'
employeeBenefits:
type: number
description: 'Box 14, Employee benefit programs'
insurance:
type: number
description: 'Box 15, Insurance'
mortgageInterest:
type: number
description: 'Box 16a, Mortgage interest'
otherInterest:
type: number
description: 'Box 16b, Other interest'
legal:
type: number
description: 'Box 17, Legal and professional services'
office:
type: number
description: 'Box 18, Office expense'
pension:
type: number
description: 'Box 19, Pension and profit-sharing plans'
equipmentRent:
type: number
description: 'Box 20a, Equipment rent'
otherRent:
type: number
description: 'Box 20b, Other rent'
repairs:
type: number
description: 'Box 21, Repairs and maintenance'
supplies:
type: number
description: 'Box 22, Supplies'
taxes:
type: number
description: 'Box 23, Taxes and licenses'
travel:
type: number
description: 'Box 24a, Travel'
meals:
type: number
description: 'Box 24b, Deductible meals'
utilities:
type: number
description: 'Box 25, Utilities'
wages:
type: number
description: 'Box 26, Wages'
otherExpenses:
type: array
description: 'Box 27, Other expenses'
items:
$ref: '#/components/schemas/DescriptionAmount'
beginningInventory:
type: number
description: 'Box 35, Inventory at beginning of year'
purchases:
type: number
description: 'Box 36, Purchases'
costOfLabor:
type: number
description: 'Box 37, Cost of labor'
materials:
type: number
description: 'Box 38, Materials and supplies'
otherCosts:
type: array
description: 'Box 39, Other costs'
items:
$ref: '#/components/schemas/DescriptionAmount'
endingInventory:
type: number
description: 'Box 41, Inventory at end of year'
capitalExpenditures:
type: array
description: 'Capital expenditures, for use in calculating Depreciation'
items:
$ref: '#/components/schemas/DateAmount'
x-stoplight:
id: vyaxgw8sf7d7s
annuityAccount:
title: AnnuityAccount
description: Annuity Account
allOf:
- $ref: '#/components/schemas/accountInfo'
- type: object
properties:
annuityProductType:
enum:
- CURRENCY
- SHARES
type: string
annuityValueBasis:
enum:
- FIXED
- VARIABLE
type: string
paymentFrequency:
type: string
enum:
- ANNUALLY
- QUARTERLY
- MONTHLY
- WEEKLY
x-stoplight:
id: yalzqbkm7ynpe
annuityBalance:
title: Annuity balances
description: Data elements included with balances specific to annuity accounts
allOf:
- $ref: '#/components/schemas/annuityAccount'
- type: object
properties:
annualIncrease:
description: Percent or dollar amount of annual payment increase
type: number
annualIncreaseType:
type: string
enum:
- FIXED
- PERCENT
- DOLLAR
netPresentValue:
description: Surrender or cash balance value
type: number
paymentAmount:
description: Amount of the recurring payment
type: number
paymentEndDate:
type: string
description: Date last payment will be made
format: date-time
paymentStartDate:
type: string
description: Date of first payment; could be a future date
format: date-time
periodCertainGuarantee:
type: string
enum:
- NO PERIOD CERTAIN
- 5-YEAR
- 10-YEAR
- 20-YEAR
- 30-YEAR
totalPaymentCount:
description: Total number of payments that will be produced by the annuity
type: number
x-stoplight:
id: o1nup2j29ih4d
CodeAmount:
title: Code and Amount
description: 'Code and amount pair used on IRS W-2, K-1, etc.'
type: object
properties:
code:
description: Code
type: string
amount:
description: Amount
type: number
x-stoplight:
id: 2v99b9u9727yq
contribution:
title: Contribution Entity
type: object
description: Describes how new contributions are distributed among the available securities.
properties:
securityId:
type: string
description: Unique identifier of security
securityIdType:
type: string
description: Security identifier type
enum:
- CUSIP
- ISIN
- SEDOL
- SICC
- VALOR
- WKN
employerMatchPercentage:
type: number
description: Employer contribution match percentage
employerMatchAmount:
type: number
description: Employer contribution match amount
employeePreTaxAmount:
type: number
description: Employee pre‐tax contribution amount
employeePreTaxPercentage:
type: number
description: Employee pre‐tax contribution percentage
employeeAfterTaxAmount:
type: number
description: Employee after tax contribution amount
employeeAfterTaxPercentage:
type: number
description: Employee after tax contribution percentage
employeeDeferPreTaxAmount:
type: number
description: Employee defer pre‐tax contribution match amount
employeeDeferPreTaxPercentage:
type: number
description: Employee defer pre‐tax contribution match percentage
employeeYearToDate:
type: number
description: Employee total year to date contribution
employerYearToDate:
type: number
description: Employer total year to date contribution
rolloverContributionPercentage:
type: number
description: Rollover contribution percentage
rolloverContributionAmount:
type: number
description: Rollover contribution Amount
x-stoplight:
id: 29xfzlzprlsnm
CoverageMonth:
title: Coverage Month
description: Month enumeration used on forms 1095-A and 1095-C
type: string
enum:
- ANNUAL
- JANUARY
- FEBRUARY
- MARCH
- APRIL
- MAY
- JUNE
- JULY
- AUGUST
- SEPTEMBER
- OCTOBER
- NOVEMBER
- DECEMBER
x-stoplight:
id: 6xl49i0wifn4r
CryptocurrencyGainOrLoss:
title: Gain or loss from cryptocurrency transaction
description: 'Tax information for a single cryptocurrency transaction. If reported on Form 1099-B, use Tax1099B and SecurityDetail instead of this entity.'
type: object
properties:
cryptocurrencyName:
description: Cryptocurrency name (e.g. Bitcoin)
type: string
symbol:
description: Cryptocurrency abbreviation or symbol (e.g. BTC)
type: string
quantity:
description: Quantity (e.g. 0.0125662)
type: number
saleDescription:
description: Description of property (1099-B box 1a)
type: string
dateAcquired:
$ref: '#/components/schemas/DateString'
description: Date acquired (1099-B box 1b)
variousDatesAcquired:
type: boolean
description: Acquired on various dates (1099-B box 1b)
dateOfSale:
$ref: '#/components/schemas/DateString'
description: Date sold or disposed (1099-B box 1c)
salesPrice:
description: 'Proceeds (not price per share, 1099-B box 1d)'
type: number
costBasis:
description: Cost or other basis (1099-B box 1e)
type: number
longOrShort:
$ref: '#/components/schemas/SaleTermType'
description: LONG or SHORT (1099-B box 2)
x-stoplight:
id: g57uli6cvzh9c
CryptocurrencyTaxStatement:
title: Cryptocurrency Tax Statement list
description: Array of cryptocurrency gains and losses
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
gainsAndLosses:
type: array
description: The list of cryptocurrency gains and losses
items:
$ref: '#/components/schemas/CryptocurrencyGainOrLoss'
x-stoplight:
id: 9yngp07u90k7x
currency:
title: Currency Entity
type: object
properties:
currencyCode:
description: Iso 4217 currency code.
type: string
currencyRate:
description: Currency rate between original and converted currency.
type: number
originalCurrencyCode:
description: Iso 4217 currency code.
type: string
description: Indicates the currency code used by the account. May also include currency rate.
x-stoplight:
id: jj8ugost45sqc
customer:
description: Represents a customer (end-user)
type: object
properties:
customer:
type: object
description: Represents a customer (end-user)
properties:
customerId:
type: string
description: Long-term persistent identity of the end-user. This identity must be unique to the owning institution
name:
type: object
description: The end-user's name
properties:
first:
type: string
description: First or given name. This data element may contain first & last name if not separated.
middle:
type: string
last:
type: string
prefix:
description: 'Name prefix, e.g. Mr.'
type: string
suffix:
description: Generational or academic suffix
type: string
company:
type: string
description: Company name
addresses:
type: array
uniqueItems: true
minItems: 1
description: An array of the end-user's physical mail addresses
items:
type: object
properties:
type:
description: The location type of an address
type: string
enum:
- BUSINESS
- HOME
- MAILING
line1:
type: string
description: May contain full address if not separated
line2:
type: string
line3:
type: string
city:
type: string
state:
type: string
postalCode:
type: string
country:
type: string
description: ISO 3166 Country Code
telephones:
type: array
uniqueItems: true
minItems: 1
items:
type: object
properties:
number:
type: string
type:
type: string
enum:
- HOME
- BUSINESS
- CELL
- FAX
country:
type: string
description: Country calling codes defined by ITU-T recommendations E.123 and E.164
email:
type: array
description: An array of the end-user's electronic mail addresses
items:
type: string
accounts:
type: array
uniqueItems: true
minItems: 1
description: List of accounts related to this end-user
items:
type: object
properties:
accountId:
type: string
description: Account ID of the related account
relationship:
type: string
description: Types of relationships between accounts and holders. Suggested values
enum:
- AUTHORIZED_USER
- BUSINESS
- FOR_BENEFIT_OF
- FOR_BENEFIT_OF_PRIMARY
- FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED
- FOR_BENEFIT_OF_SECONDARY
- FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED
- FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED
- POWER_OF_ATTORNEY
- PRIMARY_JOINT_TENANTS
- PRIMARY
- PRIMARY_BORROWER
- PRIMARY_JOINT
- SECONDARY
- SECONDARY_JOINT_TENANTS
- SECONDARY_BORROWER
- SECONDARY_JOINT
- SOLE_OWNER
- TRUSTEE
- UNIFORM_TRANSFER_TO_MINOR
x-stoplight:
id: juaa4slz7yvtn
DateString:
title: Date String
description: 'ISO 8601 full-date in format ''YYYY-MM-DD'' according to [IETF RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339.html#section-5.6)'
type: string
format: date
maxLength: 10
example: '2021-07-15'
x-stoplight:
id: 846lzpouil5z6
debtSecurity:
title: DebtSecurity Entity
description: Information about the debt security specific to the type of security
type: object
properties:
parValue:
type: number
description: Par value amount
debtType:
type: string
description: Debt type
enum:
- ASSET
- COUPON
debtClass:
type: string
description: Classification of debt
enum:
- TREASURY
- MUNICIPAL
- CORPORATE
- OTHER
couponRate:
type: number
description: Bond coupon rate for next closest call date
couponDate:
type: string
format: date-time
description: Maturity date for next coupon
couponMatureFrequency:
type: string
description: When coupons mature
enum:
- MONTHLY
- QUARTERLY
- SEMIANNUAL
- ANNUAL
- OTHER
callPrice:
type: number
description: Bond call price
yieldToCall:
type: number
description: Yield to next call
callDate:
type: string
format: date-time
description: Next call date
callType:
type: string
description: Type of next call
enum:
- CALL
- PUT
- PREFUND
- MATURITY
yieldToMaturity:
type: number
description: Yield to maturity
bondMaturityDate:
type: string
format: date-time
description: Bond Maturity date
x-stoplight:
id: 739gdzi2bhj3l
depositAccount:
title: DepositAccount
description: Deposit Account
allOf:
- $ref: '#/components/schemas/accountInfo'
- type: object
properties:
annualPercentageYield:
description: Annual Percentage Yield.
type: number
term:
type: integer
description: Term of CD in months
maturityDate:
type: string
description: Maturity date for CDs.
format: date-time
x-stoplight:
id: x3czr65h2ka8u
depositBalance:
title: Deposit balances
description: Data elements included with balances specific to deposit accounts
allOf:
- $ref: '#/components/schemas/depositAccount'
- type: object
properties:
balanceAsOf:
type: string
description: As-of date of balances
format: date-time
openingDayBalance:
description: Day's opening fund balance
type: number
availableBalance:
description: Balance of funds available for use
type: number
interestYtd:
description: YTD Interest
type: number
currentBalance:
description: Balance of funds in account
type: number
x-stoplight:
id: 5ba8x05nxuuc6
depositTransaction:
description: Deposit transaction
allOf:
- $ref: '#/components/schemas/transaction'
- type: object
properties:
payee:
type: string
description: Payee name
checkNumber:
type: integer
description: Check Number
transactionType:
type: string
description: DepositTransaction Type
enum:
- CHECK
- WITHDRAWAL
- TRANSFER
- POSDEBIT
- ATMWITHDRAWAL
- BILLPAYMENT
- FEE
- DEPOSIT
- ADJUSTMENT
- INTEREST
- DIVIDEND
- DIRECTDEPOSIT
- ATMDEPOSIT
- POSCREDIT
x-stoplight:
id: mzlg1k4f5og02
DateAmount:
title: Date and Amount
description: 'Date, description, and amount. When used in 1098-Q, description is optional'
type: object
properties:
date:
description: 'Date of amount. When used in 1098-Q, date of last payment in month'
$ref: '#/components/schemas/DateString'
description:
description: 'Description of amount. When used in 1098-Q, may use MonthAbbreviation'
type: string
amount:
type: number
description: 'Amount of payment or receipt. When used in 1098-Q, monthly total'
x-stoplight:
id: utphqvp8mcrpr
DescriptionAmount:
title: Description and Amount
description: 'Description and amount pair used on IRS W-2, etc.'
type: object
properties:
description:
description: Description
type: string
amount:
description: Amount
type: number
x-stoplight:
id: ncx3mvtg9nrfd
equityGrant:
title: equityGrant
type: object
properties:
grantId:
type: string
description: Unique identifier of grant
grantDate:
type: string
format: date-time
description: Date grant was given
grantType:
type: string
description: Type of grant
seqNum:
type: number
grantPrice:
type: number
description: Grant price
grantCurrencyCode:
type: string
description: 'Indicates the currency of grant USD vs AUD vs EUR etc (for share awards, you will still get a USD)'
quantityGranted:
type: number
description: Number of options
quantityOutstanding:
type: number
expirationDate:
type: string
format: date-time
description: Date grant expires
vestings:
type: array
description: 'An array of equityGrant vestings. Provides the past, present, and future vesting schedule and percentages.'
items:
type: object
properties:
vestedQuantity:
description: Vested quantity (Vested shares total qty of vesting tranche)
type: number
vestedValue:
type: number
description: Vested balance at grant (aggregate of all vestings)
vestingDate:
type: string
format: date-time
vestExpireDate:
type: string
format: date-time
vestedStatus:
type: string
x-stoplight:
id: y1vjyy0b08o2n
error:
title: Error
description: 'An error entity which can be used at the API level for error responses or at the account level to indicate a problem specific to a particular account. See the error codes and descriptions defined in the latest FDX API Specification document, section 6.2 Errors'
type: object
properties:
code:
type: integer
description: Error code defined by FDX API Specification or Data Provider indicating the error situation which has occurred
message:
type: string
description: End user displayable information which might help the customer diagnose an error
debugMessage:
type: string
description: Message used to debug the root cause of the error. Contents should not be used in consumer's business logic. Can change at any time and should only be used for consumer to communicate with the data provider about an issue. Provider can include an error GUID in message for their use.
x-stoplight:
id: h2moyxw0p9os5
ExpiredOptionType:
title: Expired Option Type
description: Type of expired stock option. Used by IRS Form 8949
type: string
enum:
- GRANTED
- PURCHASED
x-stoplight:
id: 3ux655e5wqmqq
FarmIncomeStatement:
title: Farm Income Statement
description: Farm Income Statement for IRS Form 1040 Schedule F
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
cropOrActivity:
type: string
description: 'Box A, Principal crop or activity'
sales:
type: number
description: 'Box 1a, Sales of livestock and other resale items'
costOfItemsSold:
type: number
description: 'Box 1b, Cost or other basis of livestock or other items'
salesOfRaised:
type: number
description: 'Box 2, Sales of livestock, produce, grains, and other products you raised'
coopDistributions:
type: number
description: 'Box 3a, Cooperative distributions'
agProgramPayments:
type: number
description: 'Box 4a, Agricultural program payments'
cccLoans:
type: number
description: 'Box 5a, Commodity Credit Corporation (CCC) loans reported under election'
cropInsuranceProceeds:
type: number
description: 'Box 6a, Crop insurance proceeds and federal crop disaster payments'
customHireIncome:
type: number
description: 'Box 7, Custom hire (machine work) income'
otherIncome:
type: array
description: 'Box 8, Other income'
items:
$ref: '#/components/schemas/DescriptionAmount'
carAndTruck:
type: number
description: 'Box 10, Car and truck expenses'
chemicals:
type: number
description: 'Box 11, Chemicals'
conservation:
type: number
description: 'Box 12, Conservation expenses'
customHireExpenses:
type: number
description: 'Box 13, Custom hire (machine work) '
depreciation:
type: number
description: 'Box 14, Depreciation'
employeeBenefitPrograms:
type: number
description: 'Box 15, Employee benefit programs'
feed:
type: number
description: 'Box 16, Feed'
fertilizers:
type: number
description: 'Box 17, Fertilizers and lime'
freight:
type: number
description: 'Box 18, Freight and trucking'
fuel:
type: number
description: 'Box 19, Gasoline, fuel, and oil'
insurance:
type: number
description: 'Box 20, Insurance (other than health)'
mortgageInterest:
type: number
description: 'Box 21a, Mortgage Interest'
otherInterest:
type: number
description: 'Box 21b, Other interest'
laborHired:
type: number
description: 'Box 22, Labor hired'
pension:
type: number
description: 'Box 23, Pension and profit-sharing plans'
equipmentRent:
type: number
description: 'Box 24a, Rent or lease: Vehicles, machinery, equipment'
otherRent:
type: number
description: 'Box 24b, Rent or lease: Other'
repairs:
type: number
description: 'Box 25, Repairs and maintenance'
seeds:
type: number
description: 'Box 26, Seeds and plants'
storage:
type: number
description: 'Box 27, Storage and warehousing'
supplies:
type: number
description: 'Box 28, Supplies'
taxes:
type: number
description: 'Box 29, Taxes'
utilities:
type: number
description: 'Box 30, Utilities'
veterinary:
type: number
description: 'Box 31, Veterinary, breeding, and medicine'
otherExpenses:
type: array
description: 'Box 32, Other expenses'
items:
$ref: '#/components/schemas/DescriptionAmount'
capitalExpenditures:
type: array
description: 'Capital expenditures, for use in calculating Depreciation'
items:
$ref: '#/components/schemas/DateAmount'
x-stoplight:
id: 0qmmzzkrn8xq0
FarmRentalIncomeStatement:
title: Farm Rental Income Statement
description: Farm Rental Income Statement for IRS Form 4835
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
incomeFromProduction:
type: number
description: 'Box 1, Income from production of livestock, produce, grains, and other crops'
coopDistributions:
type: number
description: 'Box 2a, Cooperative distributions'
agProgramPayments:
type: number
description: 'Box 3a, Agricultural program payments'
cccLoans:
type: number
description: 'Box 4a, Commodity Credit Corporation (CCC) loans reported under election'
cropInsuranceProceeds:
type: number
description: 'Box 5a, Crop insurance proceeds and federal crop disaster payments'
otherIncome:
type: array
description: 'Box 6, Other income'
items:
$ref: '#/components/schemas/DescriptionAmount'
carAndTruck:
type: number
description: 'Box 8, Car and truck expenses'
chemicals:
type: number
description: 'Box 9, Chemicals'
conservation:
type: number
description: 'Box 10, Conservation expenses'
customHireExpenses:
type: number
description: 'Box 11, Custom hire (machine work) '
depreciation:
type: number
description: 'Box 12, Depreciation'
employeeBenefitPrograms:
type: number
description: 'Box 13, Employee benefit programs'
feed:
type: number
description: 'Box 14, Feed'
fertilizers:
type: number
description: 'Box 15, Fertilizers and lime'
freight:
type: number
description: 'Box 16, Freight and trucking'
fuel:
type: number
description: 'Box 17, Gasoline, fuel, and oil'
insurance:
type: number
description: 'Box 18, Insurance (other than health)'
mortgageInterest:
type: number
description: 'Box 19a, Mortgage Interest'
otherInterest:
type: number
description: 'Box 19b, Other interest'
laborHired:
type: number
description: 'Box 20, Labor hired'
pension:
type: number
description: 'Box 21, Pension and profit-sharing plans'
equipmentRent:
type: number
description: 'Box 22a, Rent or lease: Vehicles, machinery, equipment'
otherRent:
type: number
description: 'Box 22b, Rent or lease: Other'
repairs:
type: number
description: 'Box 23, Repairs and maintenance'
seeds:
type: number
description: 'Box 24, Seeds and plants'
storage:
type: number
description: 'Box 25, Storage and warehousing'
supplies:
type: number
description: 'Box 26, Supplies'
taxes:
type: number
description: 'Box 27, Taxes'
utilities:
type: number
description: 'Box 28, Utilities'
veterinary:
type: number
description: 'Box 29, Veterinary, breeding, and medicine'
otherExpenses:
type: array
description: 'Box 30, Other expenses'
items:
$ref: '#/components/schemas/DescriptionAmount'
capitalExpenditures:
type: array
description: 'Capital expenditures, for use in calculating Depreciation'
items:
$ref: '#/components/schemas/DateAmount'
x-stoplight:
id: oju6nwd8enuyh
fiAttribute:
title: FiAttribute Entity
description: Data provider-specific attribute
properties:
name:
type: string
description: Name of attribute
value:
type: string
description: Value of attribute
type: object
x-stoplight:
id: o2djdq6u6k11u
Form1042Agent:
title: Form 1042-S Agent
description: |-
One of various persons or businesses involved in Form 1042-S reporting. Use
* `tin` for
* Box 12a, Withholding Agent EIN,
* Box 13e, Recipient U.S. TIN,
* Box 14b, Primary Withholding Agent EIN,
* Box 15a, Intermediary or flow-through entity EIN,
* Box 16b, Payer TIN
* `individualName` or `businessName` for
* Box 12d, Withholding Agent name,
* Box 13a, Recipient name,
* Box 14a, Primary Withholding Agent name,
* Box 15d, Intermediary or flow-through entity name,
* Box 16a, Payer name
* `address.country` for
* Box 12f, Withholding Agent Country code,
* Box 13b, Recipient Country code,
* Box 15f, Intermediary or flow-through entity Country code
* `address` for
* Boxes 12h-i, Withholding Agent Address,
* Boxes 13c-d, Recipient Address,
* Boxes 15h-i, Intermediary or flow-through entity Address
type: object
allOf:
- $ref: '#/components/schemas/TaxParty'
- type: object
properties:
ch3StatusCode:
type: string
description: |-
Ch. 3 status code,
* Box 12b, Withholding Agent,
* Box 13f, Recipient,
* Box 15b, Intermediary or flow-through entity,
* Box 16d, Payer
ch4StatusCode:
type: string
description: |-
Ch. 4 status code,
* Box 12c, Withholding Agent,
* Box 13g, Recipient,
* Box 15c, Intermediary or flow-through entity,
* Box 16e, Payer
giin:
type: string
description: |-
Agent's Global Intermediary Identification Number (GIIN),
* Box 12e, Withholding Agent,
* Box 13h, Recipient,
* Box 15e, Intermediary or flow-through entity,
* Box 16c, Payer
foreignTin:
type: string
description: |-
Foreign tax identification number, if any,
* Box 12g, Withholding Agent,
* Box 13i, Recipient,
* Box 15g, Intermediary or flow-through entity
x-stoplight:
id: f1ws7xsoiln1u
Form1042Recipient:
title: Form 1042-S Recipient
description: 'Recipient for Form 1042-S, Boxes 13a-j, 13l'
type: object
allOf:
- $ref: '#/components/schemas/Form1042Agent'
- type: object
properties:
lobCode:
type: string
description: 'Box 13j, Recipient''s LOB code, if any'
dateOfBirth:
$ref: '#/components/schemas/DateString'
description: 'Box 13l, Recipient''s date of birth'
x-stoplight:
id: j96e04bqmn7q2
hateoasLink:
title: HATEOAS Link
description: REST application constraint (Hypermedia As The Engine Of Application State)
type: object
properties:
href:
type: string
format: uri-reference
description: URL to invoke the action on the resource
example: 'https://api.fi.com/fdx/v4/accounts/12345'
action:
type: string
enum:
- GET
- POST
- PATCH
- DELETE
- PUT
description: HTTP Method to use for the request
types:
type: array
description: Content-types that can be used in the Accept header.
items:
type: string
enum:
- application/pdf
- image/gif
- image/jpeg
- image/tiff
- image/png
- application/json
example: application/json
required:
- href
x-stoplight:
id: if54k8o7qii2a
HateoasLinks:
title: HATEOAS Links array
description: Links relative to this containing entity
type: array
items:
$ref: '#/components/schemas/hateoasLink'
x-stoplight:
id: 5n8tjhmdx7gm8
HealthInsuranceCoverage:
title: Health Insurance Coverage
description: Used on Form 1095-A Part III
type: object
properties:
enrollmentPremium:
description: Monthly enrollment premiums
type: number
slcspPremium:
description: Monthly second lowest cost silver plan (SLCSP) premium
type: number
advancePremiumTaxCreditPayment:
description: Monthly advance payment of premium tax credit
type: number
month:
$ref: '#/components/schemas/CoverageMonth'
description: Month of coverage
x-stoplight:
id: ngk4xun8joiht
HealthInsuranceCoveredIndividual:
title: Health Insurance Covered Individual
description: Used on Form 1095-B Part IV and Form 1095-C Part III
type: object
properties:
name:
$ref: '#/components/schemas/IndividualName'
description: Name of responsible individual
tin:
description: Social security number or other TIN
type: string
dateOfBirth:
$ref: '#/components/schemas/DateString'
description: Date of birth
coveredAll12Months:
type: boolean
description: Covered all 12 months
coveredMonths:
description: Months covered
type: array
items:
$ref: '#/components/schemas/MonthAbbreviation'
x-stoplight:
id: x83u1qvlbqlub
HealthInsuranceMarketplaceCoveredIndividual:
title: Health Insurance Marketplace Covered Individual
description: Used on Form 1095-A Part II
type: object
properties:
name:
description: Covered individual name
type: string
tin:
description: Covered individual SSN
type: string
dateOfBirth:
$ref: '#/components/schemas/DateString'
description: Covered individual date of birth
policyStartDate:
$ref: '#/components/schemas/DateString'
description: Coverage start date
policyTerminationDate:
$ref: '#/components/schemas/DateString'
description: Coverage termination date
x-stoplight:
id: 55mz2sxydockf
holding:
title: An investment holding
allOf:
- type: object
- type: object
properties:
assetClasses:
type: array
uniqueItems: true
minItems: 1
description: Percent breakdown by asset class.
items:
type: object
properties:
assetClass:
type: string
enum:
- DOMESTICBOND
- INTLBOND
- LARGESTOCK
- SMALLSTOCK
- INTLSTOCK
- MONEYMARKET
- OTHER
percent:
type: number
description: Percentage of asset class that falls under this asset
averageCost:
type: boolean
description: Cost is average of all purchases for holding.
cashAccount:
type: boolean
description: 'If true, indicates that this holding is used to maintain proceeds from sales, dividends, and other cash postings to the investment account.'
changeInPrice:
type: number
description: Change in current price compared to previous day's close
currency:
$ref: '#/components/schemas/currency'
currentUnitPrice:
type: number
currentUnitPriceDate:
type: string
format: date-time
description: Current unit price as of date
description:
type: string
description: Description of the holding
expirationDate:
type: string
description: 'For CDs, bonds, and other time-based holdings.'
format: date-time
faceValue:
type: number
description: Face value at the time of data retrieved.
fiAssetClasses:
type: array
description: Percent breakdown by FI-specific asset class percentage breakdown
items:
type: object
properties:
assetClass:
type: string
description: FI-specific asset class
percent:
type: number
description: Percentage of asset class that falls under this asset
fiAttributes:
type: array
uniqueItems: true
minItems: 1
items:
$ref: '#/components/schemas/fiAttribute'
heldInAccount:
type: string
description: Sub-account
enum:
- CASH
- MARGIN
- SHORT
- OTHER
holdingId:
type: string
description: Long term persistent identity of the holding
holdingName:
type: string
description: Holding name or security name
holdingSubType:
type: string
enum:
- MONEYMARKET
- CASH
holdingType:
type: string
enum:
- STOCK
- BOND
- MUTUALFUND
- CD
- ANNUITY
- OPTION
- OTHER
inv401kSurce:
type: string
description: 'Source for money for this security. '
enum:
- PRETAX
- AFTERTAX
- MATCH
- PROFITSHARING
- ROLLOVER
- OTHERVEST
- OTHERNONVEST
marketValue:
type: number
description: Market value at the time of data retrieved
originalPurchaseDate:
type: string
description: Date of original purchase
format: date-time
positionType:
type: string
enum:
- LONG
- SHORT
purchasedPrice:
type: number
description: Price of holding at the time of purchase
rate:
type: number
description: 'For CDs, bonds, and other rate based holdings.'
securityId:
type: string
description: Unique identifier of security
securityIdType:
type: string
description: Security identifier type
enum:
- CUSIP
- ISIN
- SEDOL
- SICC
- VALOR
- WKN
symbol:
type: string
description: Ticker / Market symbol
taxLots:
type: array
uniqueItems: true
minItems: 1
description: Breakdown by tax lot.
items:
type: object
properties:
costBasis:
type: number
description: Total amount of money spent acquiring this lot including any fees or commission expenses incurred.
currentValue:
type: number
description: Lot market value
originalPurchaseDate:
type: string
format: date-time
description: Lot acquired date.
postionType:
type: string
enum:
- LONG
- SHORT
description: 'LONG, SHORT.'
purchasedPrice:
type: number
description: Original purchase price.
quantity:
type: number
description: Lot quantity.
units:
type: number
description: Number of shares (with decimals).
- oneOf:
- type: object
properties:
mutualFundSecurity:
$ref: '#/components/schemas/mutualFundSecurity'
- type: object
properties:
optionSecurity:
$ref: '#/components/schemas/optionSecurity'
- type: object
properties:
otherSecurity:
$ref: '#/components/schemas/otherSecurity'
- type: object
properties:
stockSecurity:
$ref: '#/components/schemas/stockSecurity'
- type: object
properties:
sweepSecurity:
$ref: '#/components/schemas/sweepSecurity'
- type: object
properties:
debtSecurity:
$ref: '#/components/schemas/debtSecurity'
x-stoplight:
id: nwbw2it7e6jd8
IndividualName:
title: Individual name
description: 'First name, middle initial, last name, suffix fields'
type: object
properties:
first:
description: First name
type: string
middle:
description: Middle initial
type: string
last:
description: Last name
type: string
suffix:
description: Generational or academic suffix
type: string
x-stoplight:
id: 6an5wvzs0n7x7
insuranceAccount:
title: InsuranceAccount
description: Insurance Account
allOf:
- $ref: '#/components/schemas/accountInfo'
- type: object
properties:
accountCategory:
type: string
enum:
- DEPOSIT_ACCOUNT
- INVESTMENT_ACCOUNT
- LOAN_ACCOUNT
- LOC_ACCOUNT
- INSURANCE_ACCOUNT
description: 'The account category of the insurance account. Possible enums: DEPOSIT_ACCOUNT, INVESTMENT_ACCOUNT, LOAN_ACCOUNT, LOC_ACCOUNT, INSURANCE_ACCOUNT'
x-stoplight:
id: 9e1snwxm6gzh6
insuranceBalance:
title: Insurance balances
description: Data elements included with balances specific to insurance accounts
allOf:
- $ref: '#/components/schemas/insuranceAccount'
- type: object
properties:
policyCoverageAmount:
description: Total amount of money the user is insured for.
type: number
policyEndDate:
type: string
format: date-time
description: The premium end date.
policyPremium:
description: The amount of the user's premium.
type: number
policyPremiumTerm:
type: string
enum:
- MONTHLY
- ANNUAL
description: he payment term for the premium. MONTHLY or ANNUAL.
policyStartDate:
type: string
format: date-time
description: The premium start date.
x-stoplight:
id: luurbe4w47h1n
insuranceTransaction:
description: Insurance transactions
allOf:
- $ref: '#/components/schemas/transaction'
- type: object
properties:
transactionType:
type: string
description: InsuranceTransaction Type
enum:
- PAYMENT
- FEE
- ADJUSTMENT
- INTEREST
x-stoplight:
id: j8c664yq4qfj6
investmentAccount:
title: InvestmentAccount
description: Investment Account
allOf:
- $ref: '#/components/schemas/accountInfo'
- type: object
properties:
allowedCheckWriting:
description: Check writing privileges
type: boolean
allowedOptionTrade:
description: Allowed to trade options
type: boolean
brokerId:
type: string
description: Unique identifier FI
calendarYearFor401K:
description: Date for this calendar year for 401K account
type: string
employerName:
type: string
description: Name of the employer in investment 401k Plan
margin:
description: Margin trading is allowed
type: boolean
planId:
type: string
description: Plan number for Investment 401k plan
x-stoplight:
id: x9zkaudlil8sy
investmentBalance:
title: Investment balances
description: Data elements included with balances specific to investment accounts
allOf:
- $ref: '#/components/schemas/investmentAccount'
- type: object
properties:
availableCashBalance:
description: Cash balance across all sub-accounts. Should include sweep funds.
type: number
balanceAsOf:
type: string
description: As-of date of balances
format: date-time
balanceList:
type: array
description: Balance List. Name value pair aggregate.
items:
$ref: '#/components/schemas/balanceList'
currentValue:
description: Total current value of all investments
type: number
dailyChange:
description: Daily change
type: number
marginBalance:
description: Margin balance
type: number
percentageChange:
description: Percentage change
type: number
rolloverAmount:
description: Rollover amount
type: number
shortBalance:
description: Short balance
type: number
x-stoplight:
id: 3h4768t3phahu
investmentLoan:
title: InvestmentLoan Entity
properties:
loanId:
type: string
description: Unique identifier for this loan
loanDescription:
type: string
description: Description
initialLoanBalance:
type: number
description: Initial loan balance amount
loanStartDate:
type: string
format: date-time
description: Start date of the loan
currentLoanBalance:
type: number
description: Current loan principal balance amount
dateAsOf:
type: string
format: date-time
description: Date and time of current loan balance
loanRate:
type: number
description: Loan annual interest rate for the loan
loanPaymentAmount:
type: number
description: Loan payment amount
loanPaymentFrequency:
type: string
enum:
- WEEKLY
- BIWEEKLY
- TWICEMONTHLY
- MONTHLY
- FOURWEEKS
- BIMONTHLY
- QUARTERLY
- SEMIANNUALLY
- ANNUALLY
- OTHER
loanPaymentInitial:
type: number
description: Initial number of loan payments
loanPaymentsRemaining:
type: integer
description: Remaining number of loan payments
loanMaturityDate:
type: string
format: date-time
description: Expected loan end date
loanInterestToDate:
type: number
description: Total interest paid to date on this loan
loanTotalProjectedInterest:
type: number
description: Total projected interest to be paid on this loan
loanNextPaymentDate:
type: string
format: date-time
description: The next payment date for the loan
description: Information about an investment loan.
x-stoplight:
id: 5nl7a2a48cs87
investments:
title: ''
type: object
allOf:
- type: object
properties:
accounts:
type: array
description: 'An array of accounts with entity types dependent on the account type (deposit, investment, loan, line of credit, annuity or insurance)'
items:
anyOf:
- properties:
investmentAccount:
$ref: '#/components/schemas/investmentDetails'
- properties:
depositAccount:
$ref: '#/components/schemas/depositBalance'
- properties:
loanAccount:
$ref: '#/components/schemas/loanBalance'
- properties:
locAccount:
$ref: '#/components/schemas/locBalance'
- properties:
insuranceAccount:
$ref: '#/components/schemas/insuranceBalance'
- properties:
annuityAccount:
$ref: '#/components/schemas/annuityBalance'
x-stoplight:
id: 02dp7o813l4b3
investmentDetails:
title: Investment account with all details
description: Data elements included with the investment product
allOf:
- $ref: '#/components/schemas/investmentBalance'
- type: object
properties:
holdings:
type: array
description: Array of holdings
items:
$ref: '#/components/schemas/holding'
openOrders:
type: array
description: Array of open orders
items:
$ref: '#/components/schemas/openOrder'
contribution:
type: array
description: Array of contribution objects. Describes how new contributions are distributed among the available securities
items:
$ref: '#/components/schemas/contribution'
vesting:
type: array
description: 'Array of vesting objects. Provides the past, present, and future vesting schedule and percentages'
items:
$ref: '#/components/schemas/vesting'
investmentLoans:
type: array
description: Array of investment loans
items:
$ref: '#/components/schemas/investmentLoan'
pensionSource:
type: array
description: Array of Pension Source
items:
$ref: '#/components/schemas/pensionSource'
equityGrants:
type: array
description: 'Provides equity grant information on Restricted Stock Units, Restricted Stock Awards, Stock Appreciation Right, Stock Options, Performance Awards, and Total Share Return Units'
items:
$ref: '#/components/schemas/equityGrant'
x-stoplight:
id: s1ygx8fc9728x
investmentTransaction:
description: Investment Transactions
allOf:
- $ref: '#/components/schemas/transaction'
- type: object
properties:
accruedInterest:
type: number
description: Accrued Interest.
commission:
type: number
description: Transaction commission.
confirmationNumber:
type: string
description: Confirmation number of the transaction.
faceValue:
type: number
description: Cash value for bonds.
fees:
type: number
description: Fees applied to the trade.
fractionalCash:
type: number
description: Cash for fractional units (used for stock splits).
gain:
type: number
description: For sales.
incomeType:
type: string
description: 'Type of investment income. CGLONG (capital gains-long term), CGSHORT (capital gains-short term), MISC.'
enum:
- CGLONG
- CGSHORT
- MISC
inv401kSource:
type: string
description: Source of money.
enum:
- PRETAX
- AFTERTAX
- MATCH
- PROFITSHARING
- ROLLOVER
- OTHERVEST
- OTHERNONVEST
load:
type: number
description: Load on the transaction.
loanId:
type: string
description: For 401k accounts only. This indicates the transaction was due to a loan or a loan repayment.
loanInterest:
type: number
description: How much loan pre-payment is interest.
loanPrincipal:
type: number
description: How much loan pre-payment is principal.
markup:
type: number
description: Portion of unit price that is attributed to the dealer markup.
newUnits:
type: number
description: Number of shares after split.
oldUnits:
type: number
description: Number of shares before split.
payrollDate:
type: string
description: The date for the 401k transaction was obtained in payroll.
penalty:
type: number
description: Indicates amount withheld due to a penalty.
positionType:
type: string
enum:
- LONG
- SHORT
price:
type: number
description: Unit purchase price.
priorYearContrib:
type: boolean
description: Indicates this buy was made using prior years contribution. TRUE or FALSE.
runningBalance:
type: number
description: Running balance of the position.
securityId:
type: string
description: Unique identifier of security.
securityIdType:
type: string
description: Security identifier type.
enum:
- BUSIP
- ISIN
- SEDOL
- SICC
- VALOR
- WKN
securityType:
type: string
enum:
- STOCK
- MUTUALFUND
- DEBT
- OPTION
- SWEEP
- OTHER
- BOND
shares:
type: number
description: Number of shares (with decimals). Negative numbers indicate securities are being removed from the account.
splitRatioDenominator:
type: number
description: Split ratio denominator.
splitRatioNumerator:
type: number
description: Split ratio numerator.
stateWithholding:
type: number
description: State tax withholding.
subAccountFund:
type: string
description: From which account money came in.
enum:
- CASH
- MARGIN
- SHORT
- OTHERS
subAccountSec:
type: string
description: Sub-account security type.
enum:
- CASH
- MARGIN
- SHORT
- OTHERS
symbol:
type: string
description: Ticker symbol.
taxes:
type: number
description: Taxes on the trade.
taxExempt:
type: boolean
description: Tax-exempt transaction TRUE or FALSE.
transactionReason:
type: string
description: 'Reason for this transaction; CALL (the debt was called), SELL (the debt was sold), MATURITY (the debt reached maturity)'
enum:
- CALL
- SELL
- MATURITY
transactionType:
type: string
description: InvestmentTransaction Type
enum:
- PURCHASED
- SOLD
- PURCHASEDTOCOVER
- ADJUSTMENT
- PURCHASETOOPEN
- PURCHASETOCLOSE
- SOLDTOOPEN
- SOLDTOCLOSE
- INTEREST
- MARGININTEREST
- REINVESTOFINCOME
- RETURNOFCAPITAL
- TRANSFER
- CONTRIBUTION
- FEE
- OPTIONEXERCISE
- OPTIONEXPIRATION
- DIVIDEND
- DIVIDENDREINVEST
- SPLIT
- CLOSURE
- INCOME
- EXPENSE
- CLOSUREOPT
- INVEXPENSE
- JRNLSEC
- JRNLFUND
- OTHER
- DIV
- SRVCHG
- DEP
- DEPOSIT
- ATM
- POS
- XFER
- CHECK
- PAYMENT
- CASH
- DIRECTDEP
- DIRECTDEBIT
- REPEATPMT
transferAction:
type: string
description: Transfer direction.
enum:
- IN
- OUT
unitPrice:
type: number
description: 'Price per commonly-quoted unit. Does not include markup/markdown, unitprice. Share price for stocks, mutual funds, and others. Percentage of par for bonds. Per share (not contract) for options.'
units:
type: number
description: 'For security-based actions other than stock splits, quantity. Shares for stocks, mutual funds, and others. Face value for bonds. Contracts for options.'
unitType:
type: string
enum:
- SHARES
- CURRENCY
withholding:
type: number
description: Federal tax withholding.
x-stoplight:
id: mztggq92iai2u
InvestmentSaleType:
title: Investment Sale Type
description: Type of investment sale
type: string
enum:
- CRYPTOCURRENCY
- EMPLOYEE_STOCK_PURCHASE_PLAN
- INCENTIVE_STOCK_OPTION
- NONQUALIFIED_STOCK_OPTIONS
- OTHER
- RESTRICTED_STOCK
- RESTRICTED_STOCK_UNITS
x-stoplight:
id: 9lwwa9147wicu
Iso3166CountryCode:
title: ISO 3166 Country Code
description: 'ISO 3166-1 alpha-2 codes as of April 5, 2023, from officially assigned Country Codes on [ISO Online Browsing Platform](https://www.iso.org/obp/ui/). Change log is at [ISO 3166 Maintenance Agency](https://www.iso.org/fr/committee/48750.html?t=3V3rukDb61p05Wd6ojyTRvE0S3Yg_fZgUjrLjHWcd9-mDmTKHOGjbX3nEJ3SqHar&view=documents#section-isodocuments-top)'
type: string
enum:
- AD
- AE
- AF
- AG
- AI
- AL
- AM
- AO
- AQ
- AR
- AS
- AT
- AU
- AW
- AX
- AZ
- BA
- BB
- BD
- BE
- BF
- BG
- BH
- BI
- BJ
- BL
- BM
- BN
- BO
- BQ
- BR
- BS
- BT
- BV
- BW
- BY
- BZ
- CA
- CC
- CD
- CF
- CG
- CH
- CI
- CK
- CL
- CM
- CN
- CO
- CR
- CU
- CV
- CW
- CX
- CY
- CZ
- DE
- DJ
- DK
- DM
- DO
- DZ
- EC
- EE
- EG
- EH
- ER
- ES
- ET
- FI
- FJ
- FK
- FM
- FO
- FR
- GA
- GB
- GD
- GE
- GF
- GG
- GH
- GI
- GL
- GM
- GN
- GP
- GQ
- GR
- GS
- GT
- GU
- GW
- GY
- HK
- HM
- HN
- HR
- HT
- HU
- ID
- IE
- IL
- IM
- IN
- IO
- IQ
- IR
- IS
- IT
- JE
- JM
- JO
- JP
- KE
- KG
- KH
- KI
- KM
- KN
- KP
- KR
- KW
- KY
- KZ
- LA
- LB
- LC
- LI
- LK
- LR
- LS
- LT
- LU
- LV
- LY
- MA
- MC
- MD
- ME
- MF
- MG
- MH
- MK
- ML
- MM
- MN
- MO
- MP
- MQ
- MR
- MS
- MT
- MU
- MV
- MW
- MX
- MY
- MZ
- NA
- NC
- NE
- NF
- NG
- NI
- NL
- 'NO'
- NP
- NR
- NU
- NZ
- OM
- PA
- PE
- PF
- PG
- PH
- PK
- PL
- PM
- PN
- PR
- PS
- PT
- PW
- PY
- QA
- RE
- RO
- RS
- RU
- RW
- SA
- SB
- SC
- SD
- SE
- SG
- SH
- SI
- SJ
- SK
- SL
- SM
- SN
- SO
- SR
- SS
- ST
- SV
- SX
- SY
- SZ
- TC
- TD
- TF
- TG
- TH
- TJ
- TK
- TL
- TM
- TN
- TO
- TR
- TT
- TV
- TW
- TZ
- UA
- UG
- UM
- US
- UY
- UZ
- VA
- VC
- VE
- VG
- VI
- VN
- VU
- WF
- WS
- YE
- YT
- ZA
- ZM
- ZW
x-stoplight:
id: 6hg8qnm28xd2h
lineItem:
title: LineItem
type: object
properties:
amount:
type: number
description: The amount of money attributable to this line item
checkNumber:
type: number
description: Check number
description:
type: string
description: The description of the line item
imageIds:
type: array
description: Array of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt
items:
type: string
links:
type: array
items:
$ref: '#/components/schemas/hateoasLink'
description: 'Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs'
memo:
type: string
description: Secondary item description
reference:
type: string
description: A reference number
x-stoplight:
id: xh1vewoeivs8b
loanAccount:
title: LoanAccount
description: Loan Account
allOf:
- $ref: '#/components/schemas/accountInfo'
- type: object
properties:
compoundingPeriod:
type: string
enum:
- DAILY
- WEEKLY
- BIWEEKLY
- SEMIMONTHLY
- MONTHLY
- SEMIANNUALLY
- ANNUALLY
loanTerm:
type: integer
description: Term of loan in months
maturityDate:
type: string
description: Maturity date
format: date-time
originatingDate:
type: string
description: Loan origination date
format: date-time
paymentFrequency:
type: string
enum:
- DAILY
- WEEKLY
- BIWEEKLY
- SEMIMONTHLY
- MONTHLY
- SEMIANNUALLY
- ANNUALLY
totalNumberOfPayments:
type: integer
description: Total number of payments
x-stoplight:
id: qaohlcrz8v9o9
loanBalance:
title: Loan balances
description: Data elements included with balances specific to loan accounts
allOf:
- $ref: '#/components/schemas/loanAccount'
- type: object
properties:
balanceAsOf:
type: string
description: As-of date of balances
format: date-time
escrowBalance:
description: Escrow balance of loan
type: number
interestPaidYearToDate:
description: Interest paid year to date
type: number
lastPaymentAmount:
description: Last payment amount
type: number
lastPaymentDate:
type: string
description: Last payment date
format: date-time
nextPaymentAmount:
description: Amount of next payment
type: number
nextPaymentDate:
type: string
description: Date of next payment
format: date-time
originalPrincipal:
description: Original principal of loan
type: number
payOffAmount:
description: Payoff amount
type: number
principalBalance:
description: Principal balance of loan
type: number
x-stoplight:
id: cgvj3vcfny4ls
loanTransaction:
title: Loan Transaction
allOf:
- $ref: '#/components/schemas/transaction'
- type: object
properties:
paymentDetails:
$ref: '#/components/schemas/paymentDetails'
transactionType:
type: string
description: LoanTransaction Type
enum:
- ADJUSTMENT
- FEE
- INTEREST
- PAYMENT
description: Loan Transaction
x-stoplight:
id: cxozfq4hy4m8e
locAccount:
title: LocAccount
description: Line of Credit Account
allOf:
- $ref: '#/components/schemas/accountInfo'
x-stoplight:
id: 25pprkyp6214g
LocalTaxWithholding:
title: Local Tax Withholding
description: Income in a locality and its tax withholding
type: object
properties:
taxWithheld:
description: Amount of local income tax withheld
type: number
localityName:
description: Locality name
type: string
income:
description: Income amount for local tax purposes
type: number
x-stoplight:
id: a2nfjemrm218z
locBalance:
title: Line of credit balances
description: Data elements included with balances specific to line of credit accounts
allOf:
- $ref: '#/components/schemas/locAccount'
- type: object
properties:
balanceAsOf:
type: string
description: As-of date of balances
format: date-time
advancesApr:
description: Advances APR
type: number
availableCash:
description: Available cash
type: number
availableCredit:
description: Available credit
type: number
cashAdvanceLimit:
description: Cash advance limit
type: number
creditLine:
description: Credit limit
type: number
currentBalance:
description: Current balance LOC
type: number
currentRewardsBalance:
description: Current rewards balance
type: number
financeCharges:
description: Finance charges
type: number
lastPaymentAmount:
description: Last payment amount
type: number
lastPaymentDate:
type: string
description: Last payment date
format: date-time
lastStmtBalance:
description: Last Statement Balance
type: number
lastStmtDate:
type: string
description: Last Statement Date
format: date-time
minimumPaymentAmount:
description: Minimum payment amount
type: number
nextPaymentAmount:
description: Amount of next payment
type: number
nextPaymentDate:
type: string
description: Due date of next payment
format: date-time
pastDueAmount:
description: Past Due Amount
type: number
pointsAccrued:
description: Points accrued
type: number
principalBalance:
description: Principal balance
type: number
pointsRedeemed:
description: Points redeemed
type: number
purchasesApr:
description: Purchases APR
type: number
x-stoplight:
id: dh1imzivkd3tv
locTransaction:
title: LocTransaction
description: A line of credit transaction of type
allOf:
- $ref: '#/components/schemas/transaction'
- type: object
description: Additional data elements for line of credit transactions
properties:
checkNumber:
type: integer
description: Check number
paymentDetails:
$ref: '#/components/schemas/paymentDetails'
transactionType:
type: string
description: LocTransaction Type
enum:
- CHECK
- WITHDRAWAL
- TRANSFER
- POSDEBIT
- ATMWITHDRAWAL
- BILLPAYMENT
- FEE
- DEPOSIT
- ADJUSTMENT
- INTEREST
- DIVIDEND
- DIRECTDEPOSIT
- ATMDEPOSIT
- POSCREDIT
x-stoplight:
id: e8j0vo80lya89
MonthAbbreviation:
title: Month Abbreviation
description: Used by MonthAmount
type: string
enum:
- JAN
- FEB
- MAR
- APR
- MAY
- JUN
- JUL
- AUG
- SEP
- OCT
- NOV
- DEC
x-stoplight:
id: u3xtorw8llfmd
MonthAmount:
title: Month and Amount
description: 'Month and amount pair used on IRS Form 1099-K, etc.'
type: object
properties:
month:
$ref: '#/components/schemas/MonthAbbreviation'
description: Month
amount:
description: Amount
type: number
x-stoplight:
id: gy3035b7b8gfo
mutualFundSecurity:
title: MutualFundSecurity Entity
description: Information about the mutual fund security specific to the type of security
type: object
properties:
mutualFundType:
type: string
description: Mutual fund type
enum:
- OPENEND
- CLOSEEND
- OTHER
unitsStreet:
type: number
description: 'Units in the FI''s street name, positive quantity'
unitsUser:
type: number
description: 'Units in user''s name directly, positive quantity'
reinvestDividends:
type: boolean
description: Reinvest dividends
reinvestCapitalGains:
type: boolean
description: Reinvest capital gains
yield:
type: number
description: Current yield reported as portion of the fund's assets
yieldAsOfDate:
type: string
format: date-time
description: As-of date for yield value
x-stoplight:
id: 0xjxnizuavgp3
NameAddress:
title: Name and Address
description: Individual or business name with address
type: object
allOf:
- $ref: '#/components/schemas/Address'
- type: object
properties:
name1:
type: string
description: Name line 1
name2:
type: string
description: Name line 2
x-stoplight:
id: c42fucu71dadw
NameAddressPhone:
title: 'Name, Address and Phone'
description: Contact phone number with name and address
type: object
allOf:
- $ref: '#/components/schemas/NameAddress'
- type: object
properties:
phone:
$ref: '#/components/schemas/TelephoneNumberPlusExtension'
description: Phone number
x-stoplight:
id: m073flfybf6kw
OfferOfHealthInsuranceCoverage:
title: Offer of Health Insurance Coverage
description: Health insurance coverage offer for part II of IRS Form 1095-C
type: object
properties:
coverageCode:
description: Offer of Coverage (enter required code)
type: string
requiredContribution:
description: Employee required contribution
type: number
section4980HCode:
description: Section 4980H Safe Harbor and Other Relief (enter code)
type: string
postalCode:
type: string
maxLength: 10
description: 'Box 17, ZIP Code'
month:
$ref: '#/components/schemas/CoverageMonth'
description: Month
x-stoplight:
id: zriop5u585zpy
openOrder:
title: OpenOrder Entity
type: object
description: Information on an open order.
properties:
orderId:
type: string
description: Long term persistent identity of the order. Id for this order transaction.
securityId:
type: string
description: Unique identifier of the security.
securityIdType:
type: string
description: Security identifier type
enum:
- CUSIP
- ISIN
- SEDOL
- SICC
- VALOR
- WKN
symbol:
type: string
description: Market symbol
description:
type: string
description: Description of order
units:
type: number
description: 'Number of units (shares, bonds, etc.)'
orderType:
type: string
enum:
- BUY
- SELL
- BUYTOCOVER
- BUYTOOPEN
- SELLTOCOVER
- SELLTOOPEN
- SELLSHORT
- SELLCLOSE
description: Type of order.
orderDate:
type: string
format: date-time
description: Order date
unitPrice:
type: number
description: Unit price
unitType:
type: string
enum:
- CURRENCY
- SHARES
description: Type of unit.
orderDuration:
description: 'This order is good for DAY, GOODTILLCANCEL, IMMEDIATE'
type: string
enum:
- DAY
- GOODTILLCANCEL
- IMMEDIATE
subAccount:
type: string
enum:
- CASH
- MARGIN
- SHORT
- OTHER
limitPrice:
type: number
description: Limit Price
stopPrice:
type: number
description: Stop price
inv401kSource:
type: string
enum:
- AFTERTAX
- MATCH
- OTHERNONVEST
- OTHERVEST
- PRETAX
- PROFITSHARING
- ROLLOVER
description: 'For 401(k) accounts, source of money for this order. Default if not present is OTHERNONVEST.'
x-stoplight:
id: dkvh619mty48n
optionSecurity:
title: OptionSecurity Entity
description: Information about the option security specific to the type of security
type: object
properties:
secured:
type: string
enum:
- COVERED
- NAKED
description: How the option is secured
optionType:
type: string
enum:
- CALL
- PUT
strikePrice:
type: number
description: Strike price / Unit price
expireDate:
type: string
format: date-time
description: Expiration date of option
sharesPerContract:
type: number
description: Shares per contract
x-stoplight:
id: jyut3crld3hku
otherSecurity:
title: OtherSecurity Entity
description: Information about the security specific to the type of security
type: object
properties:
typeDescription:
type: string
description: Description of Other Security
x-stoplight:
id: 5ok2r6n8w6698
paginatedArray:
type: object
properties:
links:
type: object
properties:
next:
type: object
properties:
href:
type: string
prev:
type: object
properties:
href:
type: string
x-examples:
example-1:
links:
next:
href: /fdx/v4/mikomo/accounts/g833202fb0866d0ad83472c429/transactions?endTime=2021-02-26T00%3A00%3A00Z&limit=5&offset=5&startTime=2019-02-26T00%3A00%3A00Z
prev:
href: /fdx/v4/mikomo/accounts/g833202fb0866d0ad83472c429/transactions?endTime=2021-02-26T00%3A00%3A00Z&limit=5&offset=0&startTime=2019-02-26T00%3A00%3A00Z
x-stoplight:
id: g7sl7kpppi0sw
paymentDetails:
title: PaymentDetails
type: object
description: Payment details for some transactions
properties:
escrowAmount:
type: number
description: The amount of payment applied to escrow
feesAmount:
type: number
description: The amount of payment applied to fees
insuranceAmount:
type: number
description: The amount of payment applied to life/health/accident insurance on the loan
interestAmount:
type: number
description: The amount of payment applied to interest
pmiAmount:
type: number
description: The amount of payment applied to PMI
principalAmount:
type: number
description: The amount of payment applied to principal
x-stoplight:
id: 7jsogy8bt14zz
pensionSource:
title: PensionSource Entity
properties:
displayName:
type: string
description: Name of the Source
amount:
type: number
description: Benefit Amount
paymentOption:
type: string
description: Form of payment
asOfDate:
type: string
format: date-time
description: Date benefit was calculated
frequency:
type: string
enum:
- ANNUALLY
- BIWEEKLY
- DAILY
- MONTHLY
- SEMIANNUALLY
- SEMIMONTHLY
- WEEKLY
startDate:
type: string
format: date-time
description: Assumed retirement date ‐ As of date amount is payable
description: Information about a pension source.
x-stoplight:
id: ny3vvzvql54qm
RentalIncomeStatement:
title: Rental Income Statement
description: Rental Income Statement for IRS Form 1040 Schedule E
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
propertyAddress:
description: 'Box 1a, Physical address of property (street, city, state, ZIP code)'
$ref: '#/components/schemas/Address'
rents:
type: number
description: 'Box 3, Rents received'
advertising:
type: number
description: 'Box 5, Advertising'
auto:
type: number
description: 'Box 6, Auto and travel'
cleaning:
type: number
description: 'Box 7, Cleaning and maintenance'
commissions:
type: number
description: 'Box 8, Commissions'
insurance:
type: number
description: 'Box 9, Insurance'
legal:
type: number
description: 'Box 10, Legal and other professional fees'
managementFees:
type: number
description: 'Box 11, Management fees'
mortgageInterest:
type: number
description: 'Box 12, Mortgage interest paid to banks, etc.'
otherInterest:
type: number
description: 'Box 13, Other interest'
repairs:
type: number
description: 'Box 14, Repairs'
supplies:
type: number
description: 'Box 15, Supplies'
taxes:
type: number
description: 'Box 16, Taxes'
utilities:
type: number
description: 'Box 17, Utilities'
depreciationExpense:
type: number
description: 'Box 18, Depreciation'
otherExpenses:
type: array
description: 'Box 19, Other expenses'
items:
$ref: '#/components/schemas/DescriptionAmount'
capitalExpenditures:
type: array
description: 'Capital expenditures, for use in calculating Depreciation'
items:
$ref: '#/components/schemas/DateAmount'
x-stoplight:
id: mh2jb8axh9140
ResultType:
title: Result Type
description: 'Flag to indicate if you want a lightweight array of metadata (AccountDescriptor or Tax or Operations) or full item details (Account or a Tax subclass or Availability details). If set to ''lightweight'', should only return the fields associated with the metadata entity.'
type: string
enum:
- details
- lightweight
default: lightweight
x-stoplight:
id: vnqepxax5x5hx
RoyaltyIncomeStatement:
title: Royalty Income Statement
description: Royalty Income Statement for IRS Form 1040 Schedule E
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
propertyAddress:
description: 'Box 1a, Physical address of property (street, city, state, ZIP code)'
$ref: '#/components/schemas/Address'
royalties:
type: number
description: 'Box 3, Royalties received'
advertising:
type: number
description: 'Box 5, Advertising'
auto:
type: number
description: 'Box 6, Auto and travel'
cleaning:
type: number
description: 'Box 7, Cleaning and maintenance'
commissions:
type: number
description: 'Box 8, Commissions'
insurance:
type: number
description: 'Box 9, Insurance'
legal:
type: number
description: 'Box 10, Legal and other professional fees'
managementFees:
type: number
description: 'Box 11, Management fees'
mortgageInterest:
type: number
description: 'Box 12, Mortgage interest paid to banks, etc.'
otherInterest:
type: number
description: 'Box 13, Other interest'
repairs:
type: number
description: 'Box 14, Repairs'
supplies:
type: number
description: 'Box 15, Supplies'
taxes:
type: number
description: 'Box 16, Taxes'
utilities:
type: number
description: 'Box 17, Utilities'
depletionExpense:
type: number
description: 'Box 18, Depletion'
otherExpenses:
type: array
description: 'Box 19, Other expenses'
items:
$ref: '#/components/schemas/DescriptionAmount'
capitalExpenditures:
type: array
description: 'Capital expenditures, for use in calculating Depreciation'
items:
$ref: '#/components/schemas/DateAmount'
x-stoplight:
id: 37ceeme9jkcq6
SaleProceedsType:
title: Sale Proceeds Type
description: Gross or net proceeds. Used by Form 1099-B
type: string
enum:
- GROSS
- NET
x-stoplight:
id: g2fdyva20qhwt
SaleTermType:
title: Sale Term Type
description: Long or short term. Used by Form 1099-B
type: string
enum:
- LONG
- SHORT
x-stoplight:
id: 4qftkjoj0t02e
SecurityDetail:
title: 'Security Detail, IRS Form 1099-B'
description: Tax information for a single security transaction
type: object
properties:
checkboxOnForm8949:
description: Applicable checkbox on Form 8949
type: string
securityName:
description: Security name
type: string
numberOfShares:
description: Number of shares
type: number
saleDescription:
description: 'Box 1a, Description of property'
type: string
dateAcquired:
$ref: '#/components/schemas/DateString'
description: 'Box 1b, Date acquired'
variousDatesAcquired:
type: boolean
description: 'Box 1b, Date acquired Various'
dateOfSale:
$ref: '#/components/schemas/DateString'
description: 'Box 1c, Date sold or disposed'
salesPrice:
description: 'Box 1d, Proceeds (not price per share)'
type: number
accruedMarketDiscount:
description: 'Box 1f, Accrued market discount'
type: number
adjustmentCodes:
description: Other adjustments (code and amount)
type: array
items:
$ref: '#/components/schemas/CodeAmount'
costBasis:
description: 'Box 1e, Cost or other basis'
type: number
correctedCostBasis:
description: 'Corrected cost basis. May be supplied in lieu of adjustmentCode code B. If both adjustmentCodes and correctedCostBasis are supplied, costBasis plus adjustmentCode B should equal correctedCostBasis'
type: number
washSaleLossDisallowed:
description: 'Box 1g, Wash sale loss disallowed'
type: number
longOrShort:
$ref: '#/components/schemas/SaleTermType'
description: 'Box 2, LONG or SHORT'
ordinary:
type: boolean
description: 'Box 2, Ordinary'
collectible:
type: boolean
description: 'Box 3, Collectibles'
qof:
type: boolean
description: 'Box 3, Qualified Opportunity Fund (QOF)'
federalTaxWithheld:
description: 'Box 4, Federal income tax withheld'
type: number
noncoveredSecurity:
type: boolean
description: 'Box 5, Noncovered security'
grossOrNet:
$ref: '#/components/schemas/SaleProceedsType'
description: 'Box 6, Reported to IRS: GROSS or NET'
lossNotAllowed:
type: boolean
description: 'Box 7, Loss not allowed based on proceeds'
basisReported:
type: boolean
description: 'Box 12, Basis reported to IRS'
stateAndLocal:
description: 'Boxes 14-16, State and Local tax withholding'
type: array
items:
$ref: '#/components/schemas/StateAndLocalTaxWithholding'
cusip:
description: CUSIP number
type: string
foreignAccountTaxCompliance:
type: boolean
description: Foreign account tax compliance
expiredOption:
$ref: '#/components/schemas/ExpiredOptionType'
description: 'To indicate gain or loss resulted from option expiration. If salesPrice (1d, proceeds) is zero, use PURCHASED. If costBasis (1e) is zero, use GRANTED'
investmentSaleType:
$ref: '#/components/schemas/InvestmentSaleType'
description: Type of investment sale
x-stoplight:
id: vbq08w8zijbq4
StateAndLocalTaxWithholding:
title: State and Local Tax Withholding
description: Income in a state and/or locality and its or their tax withholding
type: object
properties:
stateCode:
description: State two-digit code
$ref: '#/components/schemas/StateCode'
state:
description: Amount of state income tax withheld
$ref: '#/components/schemas/StateTaxWithholding'
local:
description: 'Amount of local income tax withheld, if any'
$ref: '#/components/schemas/LocalTaxWithholding'
x-stoplight:
id: pp4tyxpmbz9e8
StateCode:
title: State Code
description: |-
The codes for U.S. states, possessions and military overseas addresses. From [USPS Publication 28 - Postal Addressing Standards](https://pe.usps.com/text/pub28/28apb.htm) and [IRS Zip Code and State Abbreviations](https://www.irs.gov/pub/irs-utl/zip_code_and_state_abbreviations.pdf). Includes codes for 50 states and District of Columbia plus:
* AA - Armed Forces Americas (except Canada)
* AE - Armed Forces Europe, Africa, the Middle East, and Canada
* AP - Armed Forces Pacific
* AS - American Samoa
* FM - Federated States of Micronesia
* GU - Guam
* MH - Marshall Islands
* MP - Northern Mariana Islands
* PR - Puerto Rico
* PW - Palau
* VI - U.S. Virgin Islands
type: string
enum:
- AA
- AE
- AK
- AL
- AP
- AR
- AS
- AZ
- CA
- CO
- CT
- DC
- DE
- FL
- FM
- GA
- GU
- HI
- IA
- ID
- IL
- IN
- KS
- KY
- LA
- MA
- MD
- ME
- MH
- MI
- MN
- MO
- MP
- MS
- MT
- NC
- ND
- NE
- NH
- NJ
- NM
- NV
- NY
- OH
- OK
- OR
- PA
- PR
- PW
- RI
- SC
- SD
- TN
- TX
- UT
- VA
- VI
- VT
- WA
- WI
- WV
- WY
x-stoplight:
id: 8556rs0v9ajgq
StateTaxWithholding:
title: State Tax Withholding
description: Income in a state and its tax withholding
type: object
properties:
taxWithheld:
description: Amount of state income tax withheld
type: number
taxId:
description: Filer's state tax id
type: string
income:
description: Income amount for state tax purposes
type: number
x-stoplight:
id: lo3j3wupeyuzj
stockSecurity:
title: StockSecurity Entity
description: Information about the stock security specific to the type of security
type: object
properties:
unitsStreet:
type: number
description: 'Units in the FI''s street name, positive quantity'
unitsUser:
type: number
description: 'Units in user''s name directly, positive quantity'
reinvestDividends:
type: boolean
description: Reinvest dividends
stockType:
type: string
enum:
- BOND
- DEBT
- MUTUALFUND
- OPTION
- OTHER
- STOCK
- SWEEP
yield:
type: number
description: Current yield
yieldAsOfDate:
type: string
format: date-time
description: Yield as-of date
x-stoplight:
id: kzgfgd9y617ie
sweepSecurity:
title: SweepSecurity Entity
description: Information about the sweep security specific to the type of security
type: object
properties:
currentBalance:
type: number
description: Balance of funds in account
availableBalance:
type: number
description: Balance of funds available for use
balanceAsOf:
type: string
format: date-time
description: As-of date of balances
checks:
type: boolean
description: Whether or not checks can be written on the account
x-stoplight:
id: liscxme02agv8
taxlotsResponse:
type: object
properties:
accountId:
type: string
description: Corresponds to AccountId in Account
holding:
type: object
properties:
holdingId:
type: string
description: Long term persistent identity of the holding
securityId:
type: string
description: Unique identifier of the security.
securityIdType:
type: string
description: Security identifier type
enum:
- CUSIP
- ISIN
- SEDOL
- SICC
- VALOR
- WKN
taxLots:
type: array
uniqueItems: true
minItems: 1
description: Breakdown by tax lot.
items:
type: object
properties:
costBasis:
type: number
description: Total amount of money spent acquiring this lot including any fees or commission expenses incurred.
currentValue:
type: number
description: Lot market value
originalPurchaseDate:
type: string
format: date-time
description: Lot acquired date.
positionType:
type: string
enum:
- LONG
- SHORT
description: 'LONG, SHORT.'
purchasedPrice:
type: number
description: Original purchase price.
quantity:
type: number
description: Lot quantity.
x-stoplight:
id: 68f6modnycuwi
TaxData:
title: Tax Data
description: Tax data container for API requests and responses
type: object
properties:
businessIncomeStatement:
$ref: '#/components/schemas/BusinessIncomeStatement'
description: Business Income Statement for IRS Form 1040 Schedule C
cryptocurrencyTaxStatement:
$ref: '#/components/schemas/CryptocurrencyTaxStatement'
description: Cryptocurrency Tax Statement list
farmIncomeStatement:
$ref: '#/components/schemas/FarmIncomeStatement'
description: Farm Income Statement for IRS Form 1040 Schedule F
farmRentalIncomeStatement:
$ref: '#/components/schemas/FarmRentalIncomeStatement'
description: Farm Rental Income Statement for IRS Form 4835
rentalIncomeStatement:
$ref: '#/components/schemas/RentalIncomeStatement'
description: Rental Income Statement for IRS Form 1040 Schedule E
royaltyIncomeStatement:
$ref: '#/components/schemas/RoyaltyIncomeStatement'
description: Royalty Income Statement for IRS Form 1040 Schedule E
tax1041K1:
$ref: '#/components/schemas/Tax1041K1'
description: 'Beneficiary''s Share of Income, Deductions, Credits, etc.'
tax1042S:
$ref: '#/components/schemas/Tax1042S'
description: Foreign Person's U.S. Source Income Subject to Withholding
tax1065K1:
$ref: '#/components/schemas/Tax1065K1'
description: 'Partner''s Share of Income, Deductions, Credits, etc.'
tax1095A:
$ref: '#/components/schemas/Tax1095A'
description: Health Insurance Marketplace Statement
tax1095B:
$ref: '#/components/schemas/Tax1095B'
description: Health Coverage
tax1095C:
$ref: '#/components/schemas/Tax1095C'
description: Employer-Provided Health Insurance Offer and Coverage
tax1097Btc:
$ref: '#/components/schemas/Tax1097Btc'
description: Bond Tax Credit
tax1098:
$ref: '#/components/schemas/Tax1098'
description: Mortgage Interest Statement
tax1098C:
$ref: '#/components/schemas/Tax1098C'
description: 'Contributions of Motor Vehicles, Boats, and Airplanes'
tax1098E:
$ref: '#/components/schemas/Tax1098E'
description: Student Loan Interest Statement
tax1098Ma:
$ref: '#/components/schemas/Tax1098Ma'
description: Mortgage Assistance Payments
tax1098Q:
$ref: '#/components/schemas/Tax1098Q'
description: Qualifying Longevity Annuity Contract Information
tax1098T:
$ref: '#/components/schemas/Tax1098T'
description: Tuition Statement
tax1099A:
$ref: '#/components/schemas/Tax1099A'
description: Acquisition or Abandonment of Secured Property
tax1099B:
$ref: '#/components/schemas/Tax1099B'
description: Proceeds From Broker and Barter Exchange Transactions
tax1099C:
$ref: '#/components/schemas/Tax1099C'
description: Cancellation of Debt
tax1099Cap:
$ref: '#/components/schemas/Tax1099Cap'
description: Changes in Corporate Control and Capital Structure
tax1099ConsolidatedStatement:
$ref: '#/components/schemas/Tax1099ConsolidatedStatement'
description: Consolidated Statement for combined IRS Form 1099s
tax1099Div:
$ref: '#/components/schemas/Tax1099Div'
description: Dividends and Distributions
tax1099G:
$ref: '#/components/schemas/Tax1099G'
description: Certain Government Payments
tax1099H:
$ref: '#/components/schemas/Tax1099H'
description: Health Coverage Tax Credit (HCTC) Advance Payments
tax1099Int:
$ref: '#/components/schemas/Tax1099Int'
description: Interest Income
tax1099K:
$ref: '#/components/schemas/Tax1099K'
description: Merchant Card and Third-Party Network Payments
tax1099Ls:
$ref: '#/components/schemas/Tax1099Ls'
description: Reportable Life Insurance Sale
tax1099Ltc:
$ref: '#/components/schemas/Tax1099Ltc'
description: Long-Term Care and Accelerated Death Benefits
tax1099Misc:
$ref: '#/components/schemas/Tax1099Misc'
description: Miscellaneous Income
tax1099Nec:
$ref: '#/components/schemas/Tax1099Nec'
description: Nonemployee Compensation
tax1099Oid:
$ref: '#/components/schemas/Tax1099Oid'
description: Original Issue Discount
tax1099Patr:
$ref: '#/components/schemas/Tax1099Patr'
description: Taxable Distributions Received From Cooperatives
tax1099Q:
$ref: '#/components/schemas/Tax1099Q'
description: Payments From Qualified Education Programs
tax1099Qa:
$ref: '#/components/schemas/Tax1099Qa'
description: Distributions From ABLE Accounts
tax1099R:
$ref: '#/components/schemas/Tax1099R'
description: 'Distributions from Pensions, Annuities, Retirement or Profit-Sharing Plans, IRAs, Insurance Contracts, etc.'
tax1099S:
$ref: '#/components/schemas/Tax1099S'
description: Proceeds From Real Estate Transactions
tax1099Sa:
$ref: '#/components/schemas/Tax1099Sa'
description: 'Distributions From an HSA, Archer MSA, or Medicare Advantage MSA'
tax1099Sb:
$ref: '#/components/schemas/Tax1099Sb'
description: Seller's Investment in Life Insurance Contract
tax1120SK1:
$ref: '#/components/schemas/Tax1120SK1'
description: 'Shareholder''s Share of Income, Deductions, Credits, etc.'
tax2439:
$ref: '#/components/schemas/Tax2439'
description: Notice to Shareholder of Undistributed Long-Term Capital Gains
tax3921:
$ref: '#/components/schemas/Tax3921'
description: Exercise of an Incentive Stock Option Under Section 422(b)
tax3922:
$ref: '#/components/schemas/Tax3922'
description: Transfer of Stock Acquired Through an Employee Stock Purchase Plan under Section 423(c)
tax5227K1:
$ref: '#/components/schemas/Tax5227K1'
description: Split-Interest Trust Beneficiary's schedule K-1
tax5498:
$ref: '#/components/schemas/Tax5498'
description: IRA Contribution Information
tax5498Esa:
$ref: '#/components/schemas/Tax5498Esa'
description: Coverdell ESA Contribution Information
tax5498Qa:
$ref: '#/components/schemas/Tax5498Qa'
description: ABLE Account Contribution Information
tax5498Sa:
$ref: '#/components/schemas/Tax5498Sa'
description: 'HSA, Archer MSA, or Medicare Advantage MSA Information'
taxW2:
$ref: '#/components/schemas/TaxW2'
description: Wage and Tax Statement
taxW2C:
$ref: '#/components/schemas/TaxW2C'
description: 'IRS form W-2c, Corrected Wage and Tax Statement'
taxW2G:
$ref: '#/components/schemas/TaxW2G'
description: Certain Gambling Winnings
taxRefundDirectDeposit:
$ref: '#/components/schemas/TaxRefundDirectDeposit'
description: Tax refund direct deposit information
x-stoplight:
id: r8h8aritbnx5g
TaxDataType:
title: Type Data Type
description: 'Specify which data type is requested using TaxDataTypeQuery parameter, to receive ''JSON'' formatted tax data in `forms` property or PDF-formatted tax data encoded as Base64 in `pdf` property (''BASE64_PDF''). In TaxStatement response entity indicates which tax data property was returned'
type: string
enum:
- BASE64_PDF
- JSON
x-stoplight:
id: o13xh9lhc242k
TaxFormType:
title: Type Form Type
description: Tax form entity name e.g. "TaxW2"
type: string
enum:
- BusinessIncomeStatement
- CryptocurrencyTaxStatement
- FarmIncomeStatement
- FarmRentalIncomeStatement
- RentalIncomeStatement
- RoyaltyIncomeStatement
- Tax1041K1
- Tax1042S
- Tax1065K1
- Tax1095A
- Tax1095B
- Tax1095C
- Tax1097Btc
- Tax1098
- Tax1098C
- Tax1098E
- Tax1098Ma
- Tax1098Q
- Tax1098T
- Tax1099A
- Tax1099B
- Tax1099C
- Tax1099Cap
- Tax1099ConsolidatedStatement
- Tax1099Div
- Tax1099G
- Tax1099H
- Tax1099Int
- Tax1099K
- Tax1099Ls
- Tax1099Ltc
- Tax1099Misc
- Tax1099Nec
- Tax1099Oid
- Tax1099Patr
- Tax1099Q
- Tax1099Qa
- Tax1099R
- Tax1099S
- Tax1099Sa
- Tax1099Sb
- Tax1120SK1
- Tax2439
- Tax3921
- Tax3922
- Tax5227K1
- Tax5498
- Tax5498Esa
- Tax5498Qa
- Tax5498Sa
- TaxW2
- TaxW2C
- TaxW2G
x-stoplight:
id: stbdkpxaz1riv
transaction:
type: object
description: Transaction elements
properties:
accountId:
type: string
description: Corresponds to AccountId in Account
amount:
type: number
description: |-
The amount of money in the account currency.
If balanceType is `ASSET`:
1. If `debitCreditMemo` = `DEBIT`, sign is "+" or not present
2. If `CREDIT`, sign is "-"
If balanceType is `LIABILITY`:
1. If `debitCreditMemo` = `DEBIT`, sign is "-"
2. If `CREDIT`, sign is "+" or not present
category:
type: string
description: 'Transaction category, preferably MCC or SIC.'
debitCreditMemo:
type: string
description: Akoya will ensure that this is correctly populated with one of DEBIT or CREDIT and matches the sign of the status field.
enum:
- DEBIT
- CREDIT
description:
type: string
description: The description of the transaction
imageIds:
type: array
items:
type: string
description: Array of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt.
fiAttributes:
type: array
uniqueItems: true
minItems: 1
description: Array of FI-specific attributes
items:
$ref: '#/components/schemas/fiAttribute'
foreignAmount:
type: number
description: The amount of money in the foreign currency
foreignCurrency:
type: string
description: The ISO 4217 code of the foreign currency
lineItem:
type: array
description: Breakdown of the transaction details
items:
$ref: '#/components/schemas/lineItem'
links:
type: array
items:
$ref: '#/components/schemas/hateoasLink'
description: 'Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs'
memo:
type: string
description: Secondary transaction description
postedTimestamp:
type: string
description: The date and time that the transaction was posted to the account. If not provided then TransactionTimestamp can be used as PostedTimeStamp.
format: date-time
reference:
type: string
description: A tracking reference identifier
referenceTransactionId:
type: string
description: |-
Akoya ensures that this field is populated for all transactions which are reversals, otherwise it is null. Either way it is always present.
For reverse postings, the identity of the transaction being reversed. For the correction transaction, the identity of the reversing post. For credit card posting transactions, the identity of the authorization transaction.
status:
type: string
description: 'AUTHORIZATION, MEMO, PENDING, or POSTED'
enum:
- PENDING
- MEMO
- POSTED
- AUTHORIZATION
subCategory:
type: string
description: Transaction category detail
transactionId:
type: string
description: |-
Long term persistent identity of the transaction (unique to account).
Transaction IDs should:
1. be the same for pending and posted
2. be different for reversed transactions
3. `referenceTransactionId` should be present for reversed transactions'
transactionTimestamp:
type: string
description: |-
The date and time that the transaction was added to the server backend systems.
Akoya ensures that this field is populated for all transactions to which it applies, otherwise it is null. Either way it is always present.
format: date-time
x-stoplight:
id: 0na4sz8c2tisz
transactions:
title: Transactions Entity
description: Optionally paginated array of transactions
allOf:
- $ref: '#/components/schemas/paginatedArray'
- type: object
properties:
transactions:
description: 'An array of transactions with entity types dependent on the account type (deposit, investment, loan, or line of credit)'
type: array
items:
anyOf:
- properties:
depositTransaction:
$ref: '#/components/schemas/depositTransaction'
- properties:
loanTransaction:
$ref: '#/components/schemas/loanTransaction'
- properties:
locTransaction:
$ref: '#/components/schemas/locTransaction'
- properties:
investmentTransaction:
$ref: '#/components/schemas/investmentTransaction'
- properties:
insuranceTransaction:
$ref: '#/components/schemas/insuranceTransaction'
type: object
x-stoplight:
id: lrs6g637toizr
Tax:
title: Tax
description: Base entity for all IRS Tax forms
type: object
properties:
taxYear:
description: Year for which taxes are being paid
$ref: '#/components/schemas/TaxYear'
corrected:
type: boolean
description: True to indicate this is a corrected tax form
accountId:
type: string
description: Long-term persistent identity of the source account. Not the account number
taxFormId:
type: string
description: 'Long-term persistent id for this tax form. Depending upon the data provider, this may be the same id as the enclosing tax statement id, or this may be a different id, or this id may be omitted.'
taxFormDate:
$ref: '#/components/schemas/DateString'
description: Date of production or delivery of the tax form
additionalInformation:
description: Additional explanation text or content about this tax form
type: string
taxFormType:
$ref: '#/components/schemas/TaxFormType'
description: Enumerated name of the tax form entity e.g. "TaxW2"
issuer:
$ref: '#/components/schemas/TaxParty'
description: 'Issuer''s name, address, phone, and TIN. Issuer data need only be transmitted on enclosing TaxStatement, if it is the same on all its included tax forms.'
recipient:
$ref: '#/components/schemas/TaxParty'
description: 'Recipient''s name, address, phone, and TIN. Recipient data need only be transmitted on enclosing TaxStatement, if it is the same on all its included tax forms.'
attributes:
description: 'Additional attributes for this tax form when defined fields are not available. Some specific additional attributes already defined by providers: Fields required by [IRS FIRE](https://www.irs.gov/e-file-providers/filing-information-returns-electronically-fire): Name Control, Type of Identification Number (EIN, SSN, ITIN, ATIN). (ATIN is tax ID number for pending adoptions.) Tax form provider field for taxpayer notification: Recipient Email Address.'
type: array
items:
$ref: '#/components/schemas/TaxFormAttribute'
example:
- name: nameControl
value: WILC
- name: recipientIdType
value: EIN
code: '1'
- name: recipientIdType
value: SSN
code: '2'
- name: recipientIdType
value: ITIN
code: '2'
- name: recipientIdType
value: ATIN
code: '2'
error:
description: Present if an error was encountered while retrieving this form
$ref: '#/components/schemas/error'
links:
$ref: '#/components/schemas/HateoasLinks'
description: 'Links to retrieve this form as data or image, or to invoke other APIs'
x-stoplight:
id: 9xjejqlab3gao
Tax1041K1:
title: Form 1041 K-1
description: 'Beneficiary''s Share of Income, Deductions, Credits, etc., from Estate or Trust (boxes A-B as issuer) and Fiduciary (box C) to Beneficiary (boxes F-G as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
finalK1:
type: boolean
description: Final K-1
amendedK1:
type: boolean
description: Amended K-1
fiscalYearBegin:
$ref: '#/components/schemas/DateString'
description: Fiscal year begin date
fiscalYearEnd:
$ref: '#/components/schemas/DateString'
description: Fiscal year end date
form1041T:
type: boolean
description: 'Box D, Check if Form 1041-T was filed'
date1041T:
$ref: '#/components/schemas/DateString'
description: 'Box D, and enter the date it was filed'
final1041:
type: boolean
description: 'Box E, Check if this is the final Form 1041 for the estate or trust'
domestic:
type: boolean
description: 'Box H, Domestic beneficiary'
foreign:
type: boolean
description: 'Box H, Foreign beneficiary'
interestIncome:
description: 'Box 1, Interest income'
type: number
ordinaryDividends:
description: 'Box 2a, Ordinary dividends'
type: number
qualifiedDividends:
description: 'Box 2b, Qualified dividends'
type: number
netShortTermGain:
description: 'Box 3, Net short-term capital gain'
type: number
netLongTermGain:
description: 'Box 4a, Net long-term capital gain'
type: number
gain28Rate:
description: 'Box 4b, 28% rate gain'
type: number
unrecaptured1250Gain:
description: 'Box 4c, Unrecaptured section 1250 gain'
type: number
otherPortfolioIncome:
description: 'Box 5, Other portfolio and nonbusiness income'
type: number
ordinaryBusinessIncome:
description: 'Box 6, Ordinary business income'
type: number
netRentalRealEstateIncome:
description: 'Box 7, Net rental real estate income'
type: number
otherRentalIncome:
description: 'Box 8, Other rental income'
type: number
directlyApportionedDeductions:
description: 'Box 9, Directly apportioned deductions'
type: array
items:
$ref: '#/components/schemas/CodeAmount'
estateTaxDeduction:
description: 'Box 10, Estate tax deduction'
type: number
finalYearDeductions:
description: 'Box 11, Final year deductions'
type: array
items:
$ref: '#/components/schemas/CodeAmount'
fiduciary:
$ref: '#/components/schemas/TaxParty'
description: 'Box C, Fiduciary''s name and address'
amtAdjustments:
description: 'Box 12, Alternative minimum tax adjustment'
type: array
items:
$ref: '#/components/schemas/CodeAmount'
credits:
description: 'Box 13, Credits and credit recapture'
type: array
items:
$ref: '#/components/schemas/CodeAmount'
otherInfo:
description: 'Box 14, Other information'
type: array
items:
$ref: '#/components/schemas/CodeAmount'
x-stoplight:
id: 2rz9ixws14abn
Tax1042S:
title: Form 1042-S
description: 'Foreign Person''s U.S. Source Income Subject to Withholding, from WithholdingAgent (boxes 12a-i) to Recipient (boxes 13a-j, 13l as form1042Recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
formId:
type: string
description: Unique form identifier
amended:
type: boolean
description: Amended
amendmentNumber:
type: integer
description: Amendment number
format: int32
incomeTypeCode:
type: string
description: 'Box 1, Income code'
grossIncome:
type: number
description: 'Box 2, Gross income'
chapterIndicator:
type: string
description: 'Box 3, Chapter indicator'
ch3ExemptionCode:
type: string
description: 'Box 3a, Exemption code'
ch3TaxRate:
type: number
description: 'Box 3b, Tax rate'
format: double
ch4ExemptionCode:
type: string
description: 'Box 4a, Exemption code'
ch4TaxRate:
type: number
description: 'Box 4b, Tax rate'
format: double
withholdingAllowance:
type: number
description: 'Box 5, Withholding allowance'
netIncome:
type: number
description: 'Box 6, Net income'
federalTaxWithheld:
type: number
description: 'Box 7a, Federal tax withheld'
escrowProceduresApplied:
type: boolean
description: 'Box 7b, Check if federal tax withheld was not deposited with the IRS because escrow procedures were applied'
subsequentYear:
type: boolean
description: 'Box 7c, Check if withholding occurred in subsequent year with respect to a partnership interest'
otherAgentsTaxWithheld:
type: number
description: 'Box 8, Tax withheld by other agents'
recipientRepaidAmount:
type: number
description: 'Box 9, Overwithheld tax repaid to recipient pursuant to adjustment procedures'
totalTaxWithholdingCredit:
type: number
description: 'Box 10, Total withholding credit'
withholdingAgentTaxPaid:
type: number
description: 'Box 11, Tax paid by withholding agent (amounts not withheld)'
withholdingAgent:
description: 'Boxes 12a-i, Withholding agent'
$ref: '#/components/schemas/Form1042Agent'
form1042Recipient:
description: 'Boxes 13a-j, 13l, Recipient for Form 1042-S'
$ref: '#/components/schemas/Form1042Recipient'
accountNumber:
description: 'Box 13k, Recipient account number'
type: string
primary:
description: 'Boxes 14a-b, Primary Withholding Agent'
$ref: '#/components/schemas/Form1042Agent'
prorataBasisReporting:
description: 'Box 15, Check if pro-rata basis reporting'
type: boolean
intermediary:
description: 'Boxes 15a-i, Intermediary or flow thru entity'
$ref: '#/components/schemas/Form1042Agent'
payer:
description: 'Boxes 16a-e, Payer'
$ref: '#/components/schemas/Form1042Agent'
stateAndLocal:
description: 'Box 17, State and Local tax withholding'
$ref: '#/components/schemas/StateAndLocalTaxWithholding'
x-stoplight:
id: i1t75ssfxj6ak
Tax1065K1:
title: Form 1065 K-1
description: 'Partner''s Share of Income, Deductions, Credits, etc., from Partnership (boxes A, D as issuer) to Partner (boxes E-F as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
fiscalYearBegin:
$ref: '#/components/schemas/DateString'
description: Fiscal year begin date
fiscalYearEnd:
$ref: '#/components/schemas/DateString'
description: Fiscal year end data
finalK1:
type: boolean
description: Final K-1
amendedK1:
type: boolean
description: Amended K-1
irsCenter:
description: 'Box C, IRS Center where partnership filed return'
type: string
publiclyTraded:
type: boolean
description: 'Box D, Check if this is a publicly traded partnership (PTP)'
generalPartner:
type: boolean
description: 'Box G, General partner or LLC member-manager'
limitedPartner:
type: boolean
description: 'Box G, Limited partner or other LLC member'
domestic:
type: boolean
description: 'Box H1, Domestic partner'
foreign:
type: boolean
description: 'Box H1, Foreign partner'
disregardedEntity:
type: boolean
description: 'Box H2, Check if the partner is a disregarded entity (DE), and enter the partner''s TIN and Name'
disregardedEntityTin:
description: 'Box H2, Disregarded entity partner''s TIN'
type: string
disregardedEntityName:
description: 'Box H2, Disregarded entity partner''s Name'
type: string
entityType:
description: 'Box I1, What type of entity is this partner?'
type: string
retirementPlan:
type: boolean
description: 'Box I2, If this partner is a retirement plan (IRA/SEP/Keogh/etc.), check here'
profitShareBegin:
description: 'Box J, Partner''s share of profit - beginning'
type: number
format: double
profitShareEnd:
description: 'Box J, Partner''s share of profit - ending'
type: number
format: double
lossShareBegin:
description: 'Box J, Partner''s share of loss - beginning'
type: number
format: double
lossShareEnd:
description: 'Box J, Partner''s share of loss - ending'
type: number
format: double
capitalShareBegin:
description: 'Box J, Partner''s share of capital - beginning'
type: number
format: double
capitalShareEnd:
description: 'Box J, Partner''s share of capital - ending'
type: number
format: double
decreaseDueToSaleOrExchange:
type: boolean
deprecated: true
description: 'Box J, Check if decrease is due to sale or exchange of partnership interest. Deprecated and no longer used beginning tax year 2023. Use `decreaseDueToSale` and `decreaseDueToExchange` instead'
decreaseDueToSale:
type: boolean
description: 'Box J, Check if decrease is due to sale of partnership interest'
decreaseDueToExchange:
type: boolean
description: 'Box J, Check if decrease is due to exchange of partnership interest'
nonrecourseLiabilityShareBegin:
description: 'Box K1, Partner''s share of liabilities - beginning - nonrecourse'
type: number
nonrecourseLiabilityShareEnd:
description: 'Box K1, Partner''s share of liabilities - ending - nonrecourse'
type: number
qualifiedLiabilityShareBegin:
description: 'Box K1, Partner''s share of liabilities - beginning - qualified nonrecourse financing'
type: number
qualifiedLiabilityShareEnd:
description: 'Box K1, Partner''s share of liabilities - ending - qualified nonrecourse financing'
type: number
recourseLiabilityShareBegin:
description: 'Box K1, Partner''s share of liabilities - beginning - recourse'
type: number
recourseLiabilityShareEnd:
description: 'Box K1, Partner''s share of liabilities - ending - recourse'
type: number
includesLowerTierLiability:
type: boolean
description: 'Box K2, Check this box if item K1 includes liability amounts from lower tier partnerships'
liabilitySubjectToGuarantees:
type: boolean
description: 'Box K3, Check if any of the above liability is subject to guarantees or other payment obligations by the partner'
capitalAccountBegin:
description: 'Box L, Partner''s capital account analysis - Beginning capital account'
type: number
capitalAccountContributions:
description: 'Box L, Partner''s capital account analysis - Capital contributed during the year'
type: number
capitalAccountIncrease:
description: 'Box L, Partner''s capital account analysis - Current year net income (loss)'
type: number
capitalAccountOther:
description: 'Box L, Partner''s capital account analysis - Other increase (decrease)'
type: number
capitalAccountWithdrawals:
description: 'Box L, Partner''s capital account analysis - Withdrawals & distributions'
type: number
capitalAccountEnd:
description: 'Box L, Partner''s capital account analysis - Ending capital account'
type: number
builtInGain:
type: boolean
description: 'Box M, Did the partner contribute property with a built-in gain or loss? - Yes'
unrecognizedSection704Begin:
description: 'Box N, Partner''s Share of Net Unrecognized Section 704(c) Gain or (Loss) - beginning'
type: number
unrecognizedSection704End:
description: 'Box N, Partner''s Share of Net Unrecognized Section 704(c) Gain or (Loss) - ending'
type: number
ordinaryIncome:
description: 'Box 1, Ordinary business income (loss)'
type: number
netRentalRealEstateIncome:
description: 'Box 2, Net rental real estate income (loss)'
type: number
otherRentalIncome:
description: 'Box 3, Other net rental income (loss)'
type: number
guaranteedPaymentServices:
description: 'Box 4a, Guaranteed payments for services'
type: number
guaranteedPaymentCapital:
description: 'Box 4b, Guaranteed payments for capital'
type: number
guaranteedPayment:
description: 'Box 4c, Total guaranteed payments'
type: number
interestIncome:
description: 'Box 5, Interest income'
type: number
ordinaryDividends:
description: 'Box 6a, Ordinary dividends'
type: number
qualifiedDividends:
description: 'Box 6b, Qualified dividends'
type: number
dividendEquivalents:
description: 'Box 6c, Dividend equivalents'
type: number
royalties:
description: 'Box 7, Royalties'
type: number
netShortTermGain:
description: 'Box 8, Net short-term capital gain (loss)'
type: number
netLongTermGain:
description: 'Box 9a, Net long-term capital gain (loss)'
type: number
collectiblesGain:
description: 'Box 9b, Collectibles (28%) gain (loss)'
type: number
unrecaptured1250Gain:
description: 'Box 9c, Unrecaptured section 1250 gain'
type: number
net1231Gain:
description: 'Box 10, Net section 1231 gain (loss)'
type: number
otherIncome:
description: 'Box 11, Other income'
type: array
items:
$ref: '#/components/schemas/CodeAmount'
section179Deduction:
description: 'Box 12, Section 179 deduction'
type: number
otherDeductions:
description: 'Box 13, Other deductions'
type: array
items:
$ref: '#/components/schemas/CodeAmount'
selfEmployment:
description: 'Box 14, Self-employment earnings (loss)'
type: array
items:
$ref: '#/components/schemas/CodeAmount'
credits:
description: 'Box 15, Credits'
type: array
items:
$ref: '#/components/schemas/CodeAmount'
scheduleK3:
description: 'Box 16, Schedule K-3 is attached'
type: boolean
amtItems:
description: 'Box 17, Alternative minimum tax (AMT) items'
type: array
items:
$ref: '#/components/schemas/CodeAmount'
taxExemptIncome:
description: 'Box 18, Tax-exempt income and nondeductible expenses'
type: array
items:
$ref: '#/components/schemas/CodeAmount'
distributions:
description: 'Box 19, Distributions'
type: array
items:
$ref: '#/components/schemas/CodeAmount'
otherInfo:
description: 'Box 20, Other information'
type: array
items:
$ref: '#/components/schemas/CodeAmount'
foreignTaxPaid:
description: 'Box 21, Foreign taxes paid or accrued'
type: number
multipleAtRiskActivities:
description: 'Box 22, More than one activity for at-risk purposes'
type: boolean
multiplePassiveActivities:
description: 'Box 23, More than one activity for passive activity purposes'
type: boolean
x-stoplight:
id: dvxhvcmahxd8a
Tax1095A:
title: Form 1095-A
description: 'Health Insurance Marketplace Statement, to Recipient (boxes 4-5, 12-15)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
marketplaceId:
description: 'Box 1, Marketplace identifier'
type: string
marketplacePolicyNumber:
description: 'Box 2, Marketplace-assigned policy number'
type: string
policyIssuerName:
description: 'Box 3, Policy issuer''s name'
type: string
recipientDateOfBirth:
$ref: '#/components/schemas/DateString'
description: 'Box 6, Recipient''s date of birth'
spouseName:
description: 'Box 7, Recipient''s spouse''s name'
type: string
spouseTin:
description: 'Box 8, Recipient''s spouse''s SSN'
type: string
spouseDateOfBirth:
$ref: '#/components/schemas/DateString'
description: 'Box 9, Recipient''s spouse''s date of birth'
policyStartDate:
$ref: '#/components/schemas/DateString'
description: 'Box 10, Policy start date'
policyTerminationDate:
$ref: '#/components/schemas/DateString'
description: 'Box 11, Policy termination date'
coveredIndividuals:
description: 'Boxes 16+, Covered Individuals'
type: array
items:
$ref: '#/components/schemas/HealthInsuranceMarketplaceCoveredIndividual'
coverages:
description: 'Boxes 21-33, Coverage Information'
type: array
items:
$ref: '#/components/schemas/HealthInsuranceCoverage'
x-stoplight:
id: 6hxitidasscp3
Tax1095B:
title: Form 1095-B
description: 'Health Coverage, from Issuer (boxes 16-22) to Responsible Individual (boxes 1-2, 4-7 as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
responsibleDateOfBirth:
$ref: '#/components/schemas/DateString'
description: 'Box 3, Date of birth (if SSN or other TIN is not available)'
originOfHealthCoverageCode:
description: 'Box 8, Enter letter identifying Origin of the Health Coverage'
type: string
employer:
$ref: '#/components/schemas/TaxParty'
description: 'Boxes 10-15, Employer EIN, name and address'
coveredIndividuals:
description: 'Boxes 23+, Covered Individuals'
type: array
items:
$ref: '#/components/schemas/HealthInsuranceCoveredIndividual'
x-stoplight:
id: yhv5p7ygcdnlf
Tax1095C:
title: Form 1095-C
description: 'Employer-Provided Health Insurance Offer and Coverage, from Employer (boxes 7-13 as issuer) to Employee (boxes 1-6 as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
selfInsuredCoverage:
type: boolean
description: Self Insured Coverage
offersOfCoverage:
description: 'Boxes 14-16, Employee Offer of Coverage'
type: array
items:
$ref: '#/components/schemas/OfferOfHealthInsuranceCoverage'
employeeAge:
description: Employee's Age on January 1
type: integer
format: int32
planStartMonth:
description: Plan Start Month
format: int32
type: integer
coveredIndividuals:
description: 'Boxes 17+, Covered Individuals'
type: array
items:
$ref: '#/components/schemas/HealthInsuranceCoveredIndividual'
x-stoplight:
id: rbk7ba7ls5twi
Tax1097Btc:
title: Form 1097-BTC
description: 'Bond Tax Credit, from FORM 1097-BTC ISSUER (1st-2nd boxes) to RECIPIENT (3rd-6th boxes)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
filingForCredit:
type: boolean
description: 'Form 1097-BTC issuer is: Issuer of bond or its agent filing current year Form 1097-BTC for credit being reported'
asNominee:
type: boolean
description: 'Form 1097-BTC issuer is: An entity or a person that received or should have received a current year Form 1097-BTC and is distributing part or all of that credit to others'
total:
description: 'Box 1, Total'
type: number
bondCode:
description: 'Box 2a, Code'
type: string
uniqueId:
description: 'Box 2b, Unique Identifier'
type: string
bondType:
description: 'Box 3, Bond type'
type: string
amounts:
description: 'Box 5, Amounts by month'
type: array
items:
$ref: '#/components/schemas/MonthAmount'
comments:
description: 'Box 6, Comments'
type: string
x-stoplight:
id: fogkmymulzrcd
Tax1098:
title: Form 1098
description: 'Mortgage Interest Statement, from RECIPIENT/LENDER (1st-2nd boxes as issuer) to PAYER/BORROWER (3rd-6th boxes as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
mortgagedProperties:
description: 'Box 9, Number of properties securing the mortgage'
format: int32
type: integer
otherInformation:
description: 'Box 10, Other (property tax)'
type: string
accountNumber:
description: Account number
type: string
mortgageInterest:
description: 'Box 1, Mortgage interest received from borrower'
type: number
outstandingPrincipal:
description: 'Box 2, Outstanding mortgage principal'
type: number
originationDate:
$ref: '#/components/schemas/DateString'
description: 'Box 3, Mortgage origination date'
overpaidRefund:
description: 'Box 4, Refund of overpaid interest'
type: number
mortgageInsurance:
description: 'Box 5, Mortgage insurance premiums'
type: number
pointsPaid:
description: 'Box 6, Points paid on purchase of principal residence'
type: number
isPropertyAddressSameAsBorrowerAddress:
type: boolean
description: 'Box 7, Is address of property securing mortgage same as PAYER''S/BORROWER''S address'
acquisitionDate:
$ref: '#/components/schemas/DateString'
description: 'Box 11, Mortgage acquisition date'
propertyAddress:
$ref: '#/components/schemas/Address'
description: 'Box 8, Address of property securing mortgage'
propertyTax:
description: 'Box 10, Property tax'
type: number
propertyDescription:
description: 'Box 8, Description of property securing mortgage, if property securing mortgage has no address'
type: string
x-stoplight:
id: 66636ug1h2u03
Tax1098C:
title: Form 1098-C
description: 'Contributions of Motor Vehicles, Boats, and Airplanes, from DONEE (1st-2nd boxes as issuer) to DONOR (3rd-6th boxes as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
dateOfContribution:
$ref: '#/components/schemas/DateString'
description: 'Box 1, Date of contribution'
odometerMileage:
description: 'Box 2a, Odometer mileage'
format: int32
type: integer
carYear:
description: 'Box 2b, Year'
format: int32
type: integer
make:
description: 'Box 2c, Make'
type: string
model:
description: 'Box 2d, Model'
type: string
vin:
description: 'Box 3, Vehicle or other identification number'
type: string
armsLengthTransaction:
type: boolean
description: 'Box 4a, Donee certifies that vehicle was sold in arm''s length transaction to unrelated party'
dateOfSale:
$ref: '#/components/schemas/DateString'
description: 'Box 4b, Date of sale'
grossProceeds:
description: 'Box 4c, Gross proceeds from sale (see instructions)'
type: number
notTransferredBefore:
type: boolean
description: 'Box 5a, Donee certifies that vehicle will not be transferred for money, other property, or services before completion of material improvements or significant intervening use'
needyIndividual:
type: boolean
description: 'Box 5b, Donee certifies that vehicle is to be transferred to a needy individual for significantly below fair market value in furtherance of donee''s charitable purpose'
descriptionOfImprovements:
description: 'Box 5c, Donee certifies the following detailed description of material improvements or significant intervening use and duration of use'
type: string
goodsInExchange:
type: boolean
description: 'Box 6a, Did you provide goods or services in exchange for the vehicle? Yes'
valueOfExchange:
description: 'Box 6b, Value of goods and services provided in exchange for the vehicle'
type: number
intangibleReligious:
type: boolean
description: 'Box 6c, If this box is checked, donee certifies that the goods and services consisted solely of intangible religious benefits'
descriptionOfGoods:
description: 'Box 6c, Describe the goods and services, if any, that were provided'
type: string
maxDeductionApplies:
type: boolean
description: 'Box 7, Under the law, the donor may not claim a deduction of more than $500 for this vehicle if this box is checked'
x-stoplight:
id: 0n2cqb75u4p9s
Tax1098E:
title: Form 1098-E
description: 'Student Loan Interest Statement, from RECIPIENT/LENDER (1st-2nd boxes as issuer) to PAYER/BORROWER (3rd-4th boxes as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
accountNumber:
description: Account number
type: string
studentLoanInterest:
description: 'Box 1, Student loan interest received by lender'
type: number
box1ExcludesFees:
type: boolean
description: 'Box 2, If checked, box 1 does not include loan origination fee made before September 1, 2004'
x-stoplight:
id: vcxfmjs4fofhx
Tax1098Ma:
title: Form 1098-MA
description: 'Mortgage Assistance Payments, from FILER (1st-2nd boxes as issuer) to HOMEOWNER (3rd-6th boxes as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
accountNumber:
type: string
description: Account number
totalMortgagePayments:
type: number
description: 'Box 1, Total State HFA (Housing Finance Agency) and homeowner mortgage payments'
mortgageAssistancePayments:
type: number
description: 'Box 2, State HFA (Housing Finance Agency) mortgage assistance payments'
homeownerMortgagePayments:
type: number
description: 'Box 3, Homeowner mortgage payments'
x-stoplight:
id: b02ubz8n30ceb
Tax1098Q:
title: Form 1098-Q
description: 'Qualifying Longevity Annuity Contract Information, from ISSUER (1st box) to PARTICIPANT (3rd-5th boxes as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
accountNumber:
type: string
description: Account number
planNumber:
type: string
description: Plan number
planName:
type: string
description: Plan name
planSponsorId:
type: string
description: Plan sponsor's EIN
annuityAmount:
type: number
description: 'Box 1a, Annuity amount on start date'
startDate:
description: 'Box 1b, Annuity start date'
$ref: '#/components/schemas/DateString'
canBeAccelerated:
type: boolean
description: 'Box 2, Start date may be accelerated'
totalPremiums:
type: number
description: 'Box 3, Total premiums'
fairMarketValue:
type: number
description: 'Box 4, Fair market value of qualifying longevity annuity contract (FMV of QLAC)'
premiums:
type: array
description: 'Box 5, Total monthly premiums paid for the contract and date of the last payment in the month'
items:
$ref: '#/components/schemas/DateAmount'
x-stoplight:
id: bk86p3smoe49u
Tax1098T:
title: Form 1098-T
description: 'Tuition Statement, from FILER (1st-2nd boxes as issuer) to STUDENT (3rd-6th boxes as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
studentTinCertification:
type: boolean
description: 'By checking the box in STUDENT''S TIN, filer is making a true and accurate certification under penalty of perjury that they have complied with standards promulgated by the Secretary for obtaining such individual''s TIN'
accountNumber:
description: Account number
type: string
halfTime:
type: boolean
description: 'Box 8, Check if at least half-time student'
qualifiedTuitionFees:
description: 'Box 1, Payments received for qualified tuition and related expenses'
type: number
adjustmentPriorYear:
description: 'Box 4, Adjustments made for a prior year'
type: number
scholarship:
description: 'Box 5, Scholarships or grants'
type: number
adjustScholarship:
description: 'Box 6, Adjustments to scholarships or grants for a prior year'
type: number
includeJanMar:
type: boolean
description: 'Box 7, Check if the amount in box 1 or box 2 includes amounts for an academic period beginning January - March of next year'
graduate:
type: boolean
description: 'Box 9, Check if graduate student'
insuranceRefund:
description: 'Box 10, Insurance contract reimbursement / refund'
type: number
x-stoplight:
id: 3kb78zrmnmhuz
Tax1099A:
title: Form 1099-A
description: 'Acquisition or Abandonment of Secured Property, from LENDER (1st-2nd boxes as issuer) to BORROWER (3rd-4th boxes as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
accountNumber:
description: Account number
type: string
dateOfAcquisition:
$ref: '#/components/schemas/DateString'
description: 'Box 1, Date of lender''s acquisition or knowledge of abandonment'
principalBalance:
description: 'Box 2, Balance of principal outstanding'
type: number
fairMarketValue:
description: 'Box 4, Fair market value property'
type: number
personallyLiable:
type: boolean
description: 'Box 5, If checked, the borrower was personally liable for repayment of the debt'
propertyDescription:
description: 'Box 6, Description of property'
type: string
x-stoplight:
id: ctbojfpy3cpgu
Tax1099B:
title: Form 1099-B
description: 'Proceeds From Broker and Barter Exchange Transactions, from PAYER (1st-2nd boxes as issuer) to RECIPIENT (3rd-6th boxes)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
accountNumber:
description: Account number
type: string
stateAndLocal:
description: 'Boxes 14-16, State and Local tax withholding'
type: array
items:
$ref: '#/components/schemas/StateAndLocalTaxWithholding'
federalTaxWithheld:
description: 'Box 4, Federal income tax withheld'
type: number
profitOnClosedContracts:
description: 'Box 8, Profit or (loss) realized in current year on closed contracts'
type: number
unrealizedProfitOpenContractsBegin:
description: 'Box 9, Unrealized profit or loss on open contracts at end of last year'
type: number
unrealizedProfitOpenContractsEnd:
description: 'Box 10, Unrealized profit or loss on open contracts at end of current year'
type: number
aggregateProfitOnContracts:
description: 'Box 11, Aggregate profit or (loss) on contracts'
type: number
bartering:
description: 'Box 13, Bartering'
type: number
securityDetails:
description: 'Boxes 1-3, 5-7, 12, Security details'
type: array
items:
$ref: '#/components/schemas/SecurityDetail'
secondTinNotice:
type: boolean
description: Second TIN Notice
x-stoplight:
id: mjgxlbti9gh2r
Tax1099C:
title: Form 1099-C
description: 'Cancellation of Debt, from CREDITOR (1st-2nd boxes as issuer) to DEBTOR (3rd-4th boxes as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
accountNumber:
description: Account number
type: string
dateOfEvent:
$ref: '#/components/schemas/DateString'
description: 'Box 1, Date of identifiable event'
amountDischarged:
description: 'Box 2, Amount of debt discharged'
type: number
interestIncluded:
description: 'Box 3, Interest if included in box 2'
type: number
debtDescription:
description: 'Box 4, Debt description'
type: string
personallyLiable:
type: boolean
description: 'Box 5, If checked, the debtor was personally liable for repayment of the debt'
debtCode:
description: 'Box 6, Identifiable debt code'
type: string
fairMarketValue:
description: 'Box 7, Fair market value of property'
type: number
x-stoplight:
id: b0slgbzvdy25f
Tax1099Cap:
title: Form 1099-CAP
description: 'Changes in Corporate Control and Capital Structure, from CORPORATION (1st-2nd boxes as issuer) to SHAREHOLDER (3rd-4th boxes as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
accountNumber:
description: Account number
type: string
dateOfSale:
$ref: '#/components/schemas/DateString'
description: 'Box 1, Date of sale or exchange'
aggregateAmount:
description: 'Box 2, Aggregate amount received'
type: number
numberOfShares:
description: 'Box 3, Number of shares exchanged'
type: number
stockClasses:
description: 'Box 4, Classes of stock exchanged'
type: string
x-stoplight:
id: jy2r5osyd7lxd
Tax1099ConsolidatedStatement:
title: Form 1099 Consolidated Statement
description: Various tax-related items reported on consolidated brokerage or mutual fund statements not on the base 1099 forms. The component 1099 forms are delivered as their own Tax1099Xxx entities as usual
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
marginInterestPaid:
description: Interest paid on margin account
type: number
paymentInLieuPaid:
description: Payment in lieu of dividends paid
type: number
advisorFeesPaid:
description: Advisor fees paid
type: number
otherFeesPaid:
description: Other fees paid
type: number
corporateBondInterestPaid:
description: 'Accrued Interest Paid offset to form 1099-INT box 1, Corporate bond interest income'
type: number
usBondInterestPaid:
description: 'Accrued Interest Paid offset to form 1099-INT box 3, accrued U.S. Treasury Notes and Bonds interest income'
type: number
taxExemptInterestPaid:
description: 'Accrued Interest Paid offset to form 1099-INT box 8, tax exempt interest income from municipal bonds'
type: number
specifiedPabInterestPaid:
description: 'Accrued Interest Paid offset to form 1099-INT box 9, tax exempt interest income from Private Activity Bonds'
type: number
x-stoplight:
id: jtm1mgzwls1dg
Tax1099Div:
title: Form 1099-DIV
description: 'Dividends and Distributions, from PAYER (1st-2nd boxes as issuer) to RECIPIENT (3rd-6th boxes)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
accountNumber:
description: Account number
type: string
ordinaryDividends:
description: 'Box 1a, Total ordinary dividends'
type: number
qualifiedDividends:
description: 'Box 1b, Qualified dividends'
type: number
totalCapitalGain:
description: 'Box 2a, Total capital gain distributions'
type: number
unrecaptured1250Gain:
description: 'Box 2b, Unrecaptured Section 1250 gain'
type: number
section1202Gain:
description: 'Box 2c, Section 1202 gain'
type: number
collectiblesGain:
description: 'Box 2d, Collectibles (28%) gain'
type: number
section897Dividends:
description: 'Box 2e, Section 897 ordinary dividends'
type: number
section897CapitalGain:
description: 'Box 2f, Section 897 capital gain'
type: number
nonTaxableDistribution:
description: 'Box 3, Nondividend distributions'
type: number
federalTaxWithheld:
description: 'Box 4, Federal income tax withheld'
type: number
section199ADividends:
description: 'Box 5, Section 199A dividends'
type: number
investmentExpenses:
description: 'Box 6, Investment expenses'
type: number
foreignTaxPaid:
description: 'Box 7, Foreign tax paid'
type: number
foreignCountry:
description: 'Box 8, Foreign country or U.S. possession'
type: string
cashLiquidation:
description: 'Box 9, Cash liquidation distributions'
type: number
nonCashLiquidation:
description: 'Box 10, Noncash liquidation distributions'
type: number
foreignAccountTaxCompliance:
description: 'Box 11, FATCA filing requirement'
type: boolean
taxExemptInterestDividend:
description: 'Box 12, Exempt-interest dividends'
type: number
specifiedPabInterestDividend:
description: 'Box 13, Specified private activity bond interest dividends'
type: number
stateAndLocal:
description: 'Boxes 14-16, State and Local tax withholding'
type: array
items:
$ref: '#/components/schemas/StateAndLocalTaxWithholding'
foreignIncomes:
description: Foreign income information
type: array
items:
$ref: '#/components/schemas/DescriptionAmount'
stateTaxExemptIncomes:
description: Tax exempt income state information
type: array
items:
$ref: '#/components/schemas/DescriptionAmount'
secondTinNotice:
type: boolean
description: Second TIN Notice
x-stoplight:
id: 8srs9z671wypd
Tax1099G:
title: Form 1099-G
description: 'Certain Government Payments, from PAYER (1st-2nd boxes as issuer) to RECIPIENT (3rd-4th boxes)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
accountNumber:
description: Account number
type: string
unemploymentCompensation:
description: 'Box 1, Unemployment compensation'
type: number
taxRefund:
description: 'Box 2, State or local income tax refunds, credits, or offsets'
type: number
refundYear:
description: 'Box 3, Box 2 amount is for tax year'
format: int32
type: integer
federalTaxWithheld:
description: 'Box 4, Federal income tax withheld'
type: number
rtaaPayments:
description: 'Box 5, RTAA payments'
type: number
grants:
description: 'Box 6, Taxable grants'
type: number
agriculturePayments:
description: 'Box 7, Agriculture payments'
type: number
businessIncome:
type: boolean
description: 'Box 8, If checked, box 2 is trade or business income'
marketGain:
description: 'Box 9, Market gain'
type: number
stateAndLocal:
description: 'Boxes 10-11, State and Local tax withholding'
type: array
items:
$ref: '#/components/schemas/StateAndLocalTaxWithholding'
secondTinNotice:
type: boolean
description: Second TIN Notice
x-stoplight:
id: u5pvnlykix611
Tax1099H:
title: Form 1099-H
description: 'Health Coverage Tax Credit (HCTC) Advance Payments, from ISSUER/PROVIDER (1st-2nd boxes as issuer) to RECIPIENT (3rd-4th boxes)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
advancePayments:
description: 'Box 1, Amount of HCTC advance payments'
type: number
numberOfMonths:
description: 'Box 2, Number of months HCTC advance payments and reimbursement credits paid to you'
format: int32
type: integer
payments:
description: 'Boxes 3-14, Payments by month'
type: array
items:
$ref: '#/components/schemas/MonthAmount'
x-stoplight:
id: pg67a59sph4ea
Tax1099Int:
title: Form 1099-INT
description: 'Interest Income, from PAYER (1st-2nd boxes as issuer) to RECIPIENT (3rd-4th boxes)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
foreignAccountTaxCompliance:
type: boolean
description: FATCA filing requirement
accountNumber:
description: Account number
type: string
payerRtn:
description: Payer's RTN
type: string
interestIncome:
description: 'Box 1, Interest income'
type: number
earlyWithdrawalPenalty:
description: 'Box 2, Early withdrawal penalty'
type: number
usBondInterest:
description: 'Box 3, Interest on U.S. Savings Bonds and Treasury obligations'
type: number
federalTaxWithheld:
description: 'Box 4, Federal income tax withheld'
type: number
investmentExpenses:
description: 'Box 5, Investment expenses'
type: number
foreignTaxPaid:
description: 'Box 6, Foreign tax paid'
type: number
foreignCountry:
description: 'Box 7, Foreign country or U.S. possession'
type: string
taxExemptInterest:
description: 'Box 8, Tax-exempt interest'
type: number
specifiedPabInterest:
description: 'Box 9, Specified private activity bond interest'
type: number
marketDiscount:
description: 'Box 10, Market discount'
type: number
bondPremium:
description: 'Box 11, Bond premium'
type: number
usBondPremium:
description: 'Box 12, Bond premium on Treasury obligations'
type: number
taxExemptBondPremium:
description: 'Box 13, Bond premium on tax-exempt bond'
type: number
cusipNumber:
description: 'Box 14, Tax-exempt bond CUSIP no.'
type: string
stateAndLocal:
description: 'Boxes 15-17, State and Local tax withholding'
type: array
items:
$ref: '#/components/schemas/StateAndLocalTaxWithholding'
foreignIncomes:
description: Supplemental foreign income amount information (description is country)
type: array
items:
$ref: '#/components/schemas/DescriptionAmount'
stateTaxExemptIncome:
description: Supplemental tax-exempt income by state (description is state)
type: array
items:
$ref: '#/components/schemas/DescriptionAmount'
secondTinNotice:
type: boolean
description: Second TIN Notice
x-stoplight:
id: nagm36fj3x83p
Tax1099K:
title: Form 1099-K
description: 'Merchant Card and Third-Party Network Payments, from FILER (1st, 7th boxes as issuer) to PAYEE (4th, 8th boxes as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
paymentSettlementEntity:
type: boolean
description: Check to indicate if FILER is a Payment Settlement Entity (PSE)
electronicPaymentFacilitator:
type: boolean
description: Check to indicate if FILER is an Electronic Payment Facilitator (EPF) / Other third party
paymentCard:
type: boolean
description: 'Check to indicate transactions reported are: Payment card'
thirdPartyNetwork:
type: boolean
description: 'Check to indicate transactions reported are: Third party network'
pseName:
description: PSE's name
type: string
psePhone:
$ref: '#/components/schemas/TelephoneNumberPlusExtension'
description: PSE's phone number
accountNumber:
description: Account number
type: string
grossAmount:
description: 'Box 1a, Gross amount of payment card/third party network transactions'
type: number
cardNotPresent:
description: 'Box 1b, Card Not Present Transactions'
type: number
merchantCategoryCode:
description: 'Box 2, Merchant category code'
type: string
numberOfTransactions:
description: 'Box 3, Number of purchase transactions'
type: number
federalTaxWithheld:
description: 'Box 4, Federal income tax withheld'
type: number
monthAmounts:
description: 'Box 5, Monthly amounts'
type: array
items:
$ref: '#/components/schemas/MonthAmount'
stateAndLocal:
description: 'Boxes 6-8, State and Local tax withholding'
type: array
items:
$ref: '#/components/schemas/StateAndLocalTaxWithholding'
secondTinNotice:
type: boolean
description: Second TIN Notice
x-stoplight:
id: o5q2adtiyqsgd
Tax1099Ls:
title: Form 1099-LS
description: 'Reportable Life Insurance Sale, from ACQUIRER (1st-2nd boxes as issuer) to PAYMENT RECIPIENT (3rd-4th boxes)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
policyNumber:
type: string
description: Policy number
payment:
type: number
description: 'Box 1, Amount paid to payment recipient'
saleDate:
description: 'Box 2, Date of sale'
$ref: '#/components/schemas/DateString'
issuerName:
type: string
description: Issuer's name
contactNameAddress:
description: 'Acquirer''s information contact name, street address, city or town, state or province, country, ZIP or foreign postal code, and telephone no. (If different from ACQUIRER)'
$ref: '#/components/schemas/NameAddressPhone'
x-stoplight:
id: vdipgxwh5llfk
Tax1099Ltc:
title: Form 1099-LTC
description: 'Long-Term Care and Accelerated Death Benefits, from PAYER (1st-2nd boxes as issuer) to POLICY HOLDER (3rd-4th boxes as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
accountNumber:
description: Account number
type: string
ltcBenefits:
description: 'Box 1, Gross long-term care benefits paid'
type: number
deathBenefits:
description: 'Box 2, Accelerated death benefits paid'
type: number
perDiem:
type: boolean
description: 'Box 3, Per diem'
reimbursedAmount:
type: boolean
description: 'Box 3, Reimbursed amount'
insuredId:
description: INSURED'S taxpayer identification no.
type: string
insuredNameAddress:
$ref: '#/components/schemas/NameAddress'
description: Insured name and address
qualifiedContract:
type: boolean
description: 'Box 4, Qualified contract'
chronicallyIll:
type: boolean
description: 'Box 5, Chronically ill'
terminallyIll:
type: boolean
description: 'Box 5, Terminally ill'
dateCertified:
$ref: '#/components/schemas/DateString'
description: Date certified
x-stoplight:
id: 7wn0u16iudzel
Tax1099Misc:
title: Form 1099-MISC
description: 'Miscellaneous Income, from PAYER (1st-2nd boxes as issuer) to RECIPIENT (3rd-4th boxes)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
accountNumber:
description: Account number
type: string
rents:
description: 'Box 1, Rents'
type: number
royalties:
description: 'Box 2, Royalties'
type: number
otherIncome:
description: 'Box 3, Other income'
type: number
federalTaxWithheld:
description: 'Box 4, Federal income tax withheld'
type: number
fishingBoatProceeds:
description: 'Box 5, Fishing boat proceeds'
type: number
medicalHealthPayment:
description: 'Box 6, Medical and health care payments'
type: number
payerDirectSales:
type: boolean
description: 'Box 7, Payer made direct sales of $5,000 or more of consumer products to a buyer (recipient) for resale'
substitutePayments:
description: 'Box 8, Substitute payments in lieu of dividends or interest'
type: number
cropInsurance:
description: 'Box 9, Crop insurance proceeds'
type: number
secondTinNotice:
type: boolean
description: Second TIN Notice
grossAttorney:
description: 'Box 10, Gross proceeds paid to an attorney'
type: number
fishPurchased:
description: 'Box 11, Fish purchased for resale'
type: number
section409ADeferrals:
description: 'Box 12, Section 409A deferrals'
type: number
foreignAccountTaxCompliance:
description: 'Box 13, FATCA filing requirement'
type: boolean
excessGolden:
description: 'Box 14, Excess golden parachute payments'
type: number
nonQualifiedDeferredCompensation:
description: 'Box 15, Nonqualified Deferred Compensation'
type: number
stateAndLocal:
description: 'Boxes 16-18, State and Local tax withholding'
type: array
items:
$ref: '#/components/schemas/StateAndLocalTaxWithholding'
x-stoplight:
id: u7ap1qjsbjp11
Tax1099Nec:
title: Form 1099-NEC
description: 'Non-Employee Compensation, from PAYER (1st-2nd boxes as issuer) to RECIPIENT (3rd-4th boxes)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
accountNumber:
description: Account number
type: string
secondTinNotice:
type: boolean
description: Second TIN Notice
nonEmployeeCompensation:
description: 'Box 1, Nonemployee compensation'
type: number
payerDirectSales:
type: boolean
description: 'Box 2, Payer made direct sales of $5,000 or more of consumer products to a buyer (recipient) for resale'
federalTaxWithheld:
description: 'Box 4, Federal income tax withheld'
type: number
stateAndLocal:
description: 'Boxes 5-7, State and Local tax withholding'
type: array
items:
$ref: '#/components/schemas/StateAndLocalTaxWithholding'
x-stoplight:
id: vy0ohf1jx187j
Tax1099Oid:
title: Form 1099-OID
description: 'Original Issue Discount, from PAYER (1st-2nd boxes as issuer) to RECIPIENT (3rd-4th boxes)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
foreignAccountTaxCompliance:
type: boolean
description: FATCA filing requirement
accountNumber:
description: Account number
type: string
originalIssueDiscount:
description: 'Box 1, Original issue discount'
type: number
otherPeriodicInterest:
description: 'Box 2, Other periodic interest'
type: number
earlyWithdrawalPenalty:
description: 'Box 3, Early withdrawal penalty'
type: number
federalTaxWithheld:
description: 'Box 4, Federal income tax withheld'
type: number
marketDiscount:
description: 'Box 5, Market discount'
type: number
acquisitionPremium:
description: 'Box 6, Acquisition premium'
type: number
oidDescription:
description: 'Box 7, Description'
type: string
discountOnTreasuryObligations:
description: 'Box 8, Original issue discount on U.S. Treasury obligations'
type: number
investmentExpenses:
description: 'Box 9, Investment expenses'
type: number
bondPremium:
description: 'Box 10, Bond premium'
type: number
taxExemptOid:
description: 'Box 11, Tax-exempt OID'
type: number
stateAndLocal:
description: 'Boxes 12-14, State and Local tax withheld'
type: array
items:
$ref: '#/components/schemas/StateAndLocalTaxWithholding'
stateExemptOid:
description: 'Supplemental: State name and tax-exempt OID by state'
type: array
items:
$ref: '#/components/schemas/DescriptionAmount'
secondTinNotice:
type: boolean
description: Second TIN Notice
x-stoplight:
id: 832p8l0a4hn0n
Tax1099Patr:
title: Form 1099-PATR
description: 'Taxable Distributions Received From Cooperatives, from PAYER (1st-2nd boxes as issuer) to RECIPIENT (3rd-4th boxes)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
accountNumber:
description: Account number
type: string
patronageDividends:
description: 'Box 1, Patronage dividends'
type: number
nonpatronageDistributions:
description: 'Box 2, Nonpatronage distributions'
type: number
perUnitRetainAllocations:
description: 'Box 3, Per-unit retain allocations'
type: number
federalTaxWithheld:
description: 'Box 4, Federal income tax withheld'
type: number
redemption:
description: 'Box 5, Redemption of nonqualified notices and retain allocations'
type: number
section199Deduction:
description: 'Box 6, Section 199A(g) deduction'
type: number
qualifiedPayments:
description: 'Box 7, Qualified payments'
type: number
section199QualifiedItems:
description: 'Box 8, Section 199A(a) qualified items'
type: number
section199SstbItems:
description: 'Box 9, Section 199A(a) SSTB (Specified Service Trade or Business) items'
type: number
investmentCredit:
description: 'Box 10, Investment credit'
type: number
workOpportunityCredit:
description: 'Box 11, Work opportunity credit'
type: number
otherCreditsAndDeductions:
description: 'Box 12, Other credits and deductions'
type: number
specifiedCoop:
description: 'Box 13, Specified Cooperative'
type: boolean
stateAndLocal:
description: 'State and Local tax withholding, from IRS''s IRIS schema'
$ref: '#/components/schemas/StateAndLocalTaxWithholding'
secondTinNotice:
type: boolean
description: Second TIN Notice
x-stoplight:
id: eppllf1lo5rat
Tax1099Q:
title: Form 1099-Q
description: 'Payments From Qualified Education Programs, from PAYER/TRUSTEE (1st-2nd boxes as issuer) to RECIPIENT (3rd-4th boxes)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
accountNumber:
description: Account number
type: string
grossDistribution:
description: 'Box 1, Gross distribution'
type: number
earnings:
description: 'Box 2, Earnings'
type: number
basis:
description: 'Box 3, Basis'
type: number
trusteeToTrustee:
type: boolean
description: 'Box 4, Trustee-to-trustee transfer'
tuitionPlanPrivate:
type: boolean
description: 'Box 5a, Qualified tuition plan - Private'
tuitionPlanPublic:
type: boolean
description: 'Box 5b, Qualified tuition plan - Public'
coverdellEsa:
type: boolean
description: 'Box 5c, Coverdell ESA'
recipientIsNotBeneficiary:
type: boolean
description: 'Box 6, If this box is checked, the recipient is not the designated beneficiary'
fairMarketValue:
description: 'If fair market value (FMV) is included, see Pub. 970, Tax Benefits for Education, for how to figure earnings'
type: number
x-stoplight:
id: v80j7qbdtnadk
Tax1099Qa:
title: Form 1099-QA
description: 'Distributions From ABLE Accounts, from PAYER (1st-2nd boxes as issuer) to RECIPIENT (3rd-4th boxes)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
accountNumber:
type: string
description: Account number
grossDistribution:
type: number
description: 'Box 1, Gross distribution'
earnings:
type: number
description: 'Box 2, Earnings'
basis:
type: number
description: 'Box 3, Basis'
programTransfer:
type: boolean
description: 'Box 4, Program-to-program transfer'
terminated:
type: boolean
description: 'Box 5, Check if ABLE account terminated in current year'
notBeneficiary:
type: boolean
description: 'Box 6, Check if the recipient is not the designated beneficiary'
x-stoplight:
id: ca1cz90f55e38
Tax1099R:
title: Form 1099-R
description: 'Distributions from Pensions, Annuities, Retirement or Profit-Sharing Plans, IRAs, Insurance Contracts, etc., from PAYER (1st-2nd boxes as issuer) to RECIPIENT (3rd-4th boxes)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
allocableToIRR:
description: 'Box 10, Amount allocable to IRR within 5 years'
type: number
firstYearOfRoth:
description: 'Box 11, First year of designated Roth contributions. A four-digit year. (Like `TaxYear` definition, but lower minimum since first year of Roth IRAs was 1997)'
type: integer
format: int32
minimum: 1997
maximum: 2050
example: 2020
recipientAccountNumber:
description: Account number
type: string
grossDistribution:
description: 'Box 1, Gross distribution'
type: number
taxableAmount:
description: 'Box 2a, Taxable amount'
type: number
taxableAmountNotDetermined:
type: boolean
description: 'Box 2b, Taxable amount not determined'
totalDistribution:
type: boolean
description: 'Box 2c, Total distribution'
capitalGain:
description: 'Box 3, Capital gain'
type: number
federalTaxWithheld:
description: 'Box 4, Federal income tax withheld'
type: number
employeeContributions:
description: 'Box 5, Employee contributions'
type: number
netUnrealizedAppreciation:
description: 'Box 6, Net unrealized appreciation'
type: number
distributionCodes:
description: 'Box 7, Distribution codes'
type: array
items:
type: string
iraSepSimple:
type: boolean
description: 'Box 7b, IRA/SEP/SIMPLE'
otherAmount:
description: 'Box 8, Other'
type: number
otherPercent:
description: 'Box 8, Other percent'
type: number
format: double
yourPercentOfTotal:
description: 'Box 9a, Your percent of total distribution'
type: number
format: double
totalEmployeeContributions:
description: 'Box 9b, Total employee contributions'
type: number
foreignAccountTaxCompliance:
description: 'Box 12, FATCA filing requirement'
type: boolean
dateOfPayment:
description: 'Box 13, Date of payment'
$ref: '#/components/schemas/DateString'
stateAndLocal:
description: 'Boxes 14-19, State and Local tax withholding'
type: array
items:
$ref: '#/components/schemas/StateAndLocalTaxWithholding'
x-stoplight:
id: p877e1bsu3eb8
Tax1099S:
title: Form 1099-S
description: 'Proceeds From Real Estate Transactions, from FILER (1st-2nd boxes as issuer) to TRANSFEROR (3rd-4th boxes as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
accountNumber:
description: Account or escrow number
type: string
dateOfClosing:
$ref: '#/components/schemas/DateString'
description: 'Box 1, Date of closing'
grossProceeds:
description: 'Box 2, Gross proceeds'
type: number
addressOrLegalDescription:
description: 'Box 3, Address or legal description'
type: string
receivedOtherConsideration:
type: boolean
description: 'Box 4, Transferor received or will receive property or services as part of the consideration (if checked)'
foreignPerson:
type: boolean
description: 'Box 5, If checked, transferor is a foreign person (nonresident alien, foreign partnership, foreign estate, or foreign trust)'
realEstateTax:
description: 'Box 6, Buyer''s part of real estate tax'
type: number
x-stoplight:
id: cj3l0inilgn9n
Tax1099Sa:
title: Form 1099-SA
description: 'Distributions From an HSA, Archer MSA, or Medicare Advantage MSA, from PAYER (1st-2nd boxes as issuer) to RECIPIENT (3rd-4th boxes)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
accountNumber:
description: Account number
type: string
grossDistribution:
description: 'Box 1, Gross distribution'
type: number
earnings:
description: 'Box 2, Earnings on excess contributions'
type: number
distributionCode:
description: 'Box 3, Distribution code'
type: string
fairMarketValue:
description: 'Box 4, FMV on date of death'
type: number
hsa:
type: boolean
description: 'Box 5a, HSA'
archerAccount:
type: boolean
description: 'Box 5b, Archer MSA'
medicalSavingsAccount:
type: boolean
description: 'Box 5c, Medicare Advantage (MA) MSA'
x-stoplight:
id: 81k13hibcxzij
Tax1099Sb:
title: Form 1099-SB
description: 'Seller''s Investment in Life Insurance Contract, from ISSUER (1st-2nd boxes) to SELLER (3rd-4th boxes as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
policyNumber:
type: string
description: Policy number
contractInvestment:
type: number
description: 'Box 1, Investment in contract'
surrenderAmount:
type: number
description: 'Box 2, Surrender amount'
contactNameAddress:
description: 'Issuer''s information contact name, street address, city or town, state or province, country, ZIP or foreign postal code, and telephone no. (if different from ISSUER)'
$ref: '#/components/schemas/NameAddressPhone'
x-stoplight:
id: 1nb8m17zkfjjy
Tax1120SK1:
title: Form 1120-S K-1
description: 'Shareholder''s Share of Income, Deductions, Credits, etc., from Corporation (boxes A-B as issuer) to Shareholder (boxes E-F as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
finalK1:
type: boolean
description: Final K-1
amendedK1:
type: boolean
description: Amended K-1
fiscalYearBegin:
$ref: '#/components/schemas/DateString'
description: Fiscal year begin date
fiscalYearEnd:
$ref: '#/components/schemas/DateString'
description: Fiscal year end date
irsCenter:
description: 'Box C, IRS Center where corporation filed return'
type: string
corporationBeginningShares:
description: 'Box D, Corporation''s total number of shares, Beginning of tax year'
type: number
corporationEndingShares:
description: 'Box D, Corporation''s total number of shares, End of tax year'
type: number
percentOwnership:
description: 'Box G, Current year allocation percentage'
type: number
format: double
beginningShares:
description: 'Box H, Shareholder''s number of shares, Beginning of tax year'
type: number
endingShares:
description: 'Box H, Shareholder''s number of shares, End of tax year'
type: number
beginningLoans:
description: 'Box I, Loans from shareholder, Beginning of tax year'
type: number
endingLoans:
description: 'Box I, Loans from shareholder, Ending of tax year'
type: number
ordinaryIncome:
description: 'Box 1, Ordinary business income (loss)'
type: number
netRentalRealEstateIncome:
description: 'Box 2, Net rental real estate income (loss)'
type: number
otherRentalIncome:
description: 'Box 3, Other net rental income (loss)'
type: number
interestIncome:
description: 'Box 4, Interest income'
type: number
ordinaryDividends:
description: 'Box 5a, Ordinary dividends'
type: number
qualifiedDividends:
description: 'Box 5b, Qualified dividends'
type: number
royalties:
description: 'Box 6, Royalties'
type: number
netShortTermGain:
description: 'Box 7, Net short-term capital gain (loss)'
type: number
netLongTermGain:
description: 'Box 8a, Net long-term capital gain (loss)'
type: number
collectiblesGain:
description: 'Box 8b, Collectibles (28%) gain (loss)'
type: number
unrecaptured1250Gain:
description: 'Box 8c, Unrecaptured section 1250 gain'
type: number
net1231Gain:
description: 'Box 9, Net section 1231 gain (loss)'
type: number
otherIncome:
description: 'Box 10, Other income (loss)'
type: array
items:
$ref: '#/components/schemas/CodeAmount'
section179Deduction:
description: 'Box 11, Section 179 deduction'
type: number
otherDeductions:
description: 'Box 12, Other deductions'
type: array
items:
$ref: '#/components/schemas/CodeAmount'
credits:
description: 'Box 13, Credits'
type: array
items:
$ref: '#/components/schemas/CodeAmount'
scheduleK3:
description: 'Box 14, Schedule K-3 is attached'
type: boolean
amtItems:
description: 'Box 15, Alternative minimum tax (AMT) items'
type: array
items:
$ref: '#/components/schemas/CodeAmount'
basisItems:
description: 'Box 16, Items affecting shareholder basis'
type: array
items:
$ref: '#/components/schemas/CodeAmount'
otherInfo:
description: 'Box 17, Other information'
type: array
items:
$ref: '#/components/schemas/CodeAmount'
multipleAtRiskActivities:
description: 'Box 18, More than one activity for at-risk purposes'
type: boolean
multiplePassiveActivities:
description: 'Box 19, More than one activity for passive activity purposes'
type: boolean
x-stoplight:
id: g9k654rxpitgm
Tax2439:
title: Form 2439
description: 'Notice to Shareholder of Undistributed Long-Term Capital Gains, from RIC or REIT (1st-2nd boxes as issuer) to Shareholder (3rd-4th boxes as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
fiscalYearBegin:
$ref: '#/components/schemas/DateString'
description: Fiscal year begin date
fiscalYearEnd:
$ref: '#/components/schemas/DateString'
description: Fiscal year end date
undistributedLongTermCapitalGains:
description: 'Box 1a, Total undistributed long-term capital gains'
type: number
unrecaptured1250Gain:
description: 'Box 1b, Unrecaptured section 1250 gain'
type: number
section1202Gain:
description: 'Box 1c, Section 1202 gain'
type: number
collectiblesGain:
description: 'Box 1d, Collectibles (28%) gain'
type: number
taxPaid:
description: 'Box 2, Tax paid by the RIC or REIT on the box 1a gains'
type: number
x-stoplight:
id: ihpo2edz73rf4
Tax3921:
title: Form 3921
description: 'Exercise of an Incentive Stock Option Under Section 422(b), from TRANSFEROR (1st-2nd boxes as issuer) to EMPLOYEE (3rd-4th boxes as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
accountNumber:
type: string
description: Account number
optionGrantDate:
description: 'Box 1, Date option granted'
$ref: '#/components/schemas/DateString'
optionExerciseDate:
description: 'Box 2, Date option exercised'
$ref: '#/components/schemas/DateString'
exercisePrice:
type: number
description: 'Box 3, Exercise price per share'
exerciseMarketValue:
type: number
description: 'Box 4, Fair market value per share on exercise date'
numberOfShares:
type: number
description: 'Box 5, Number of shares transferred'
corporation:
description: 'Box 6, If other than TRANSFEROR, name, address and tin of corporation whose stock is being transferred'
$ref: '#/components/schemas/TaxParty'
x-stoplight:
id: 77xa0mdkm4jce
Tax3922:
title: Form 3922
description: 'Transfer of Stock Acquired Through an Employee Stock Purchase Plan under Section 423(c), from CORPORATION (1st-2nd boxes as issuer) to EMPLOYEE (3rd-4th boxes as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
accountNumber:
type: string
description: Account number
optionGrantDate:
description: 'Box 1, Date option granted'
$ref: '#/components/schemas/DateString'
optionExerciseDate:
description: 'Box 2, Date option exercised'
$ref: '#/components/schemas/DateString'
grantMarketValue:
type: number
description: 'Box 3, Fair market value per share on grant date'
exerciseMarketValue:
type: number
description: 'Box 4, Fair market value per share on exercise date'
exercisePrice:
type: number
description: 'Box 5, Exercise price paid per share'
numberOfShares:
type: number
description: 'Box 6, Number of shares transferred'
titleTransferDate:
description: 'Box 7, Date legal title transferred'
$ref: '#/components/schemas/DateString'
grantDateExercisePrice:
type: number
description: 'Box 8, Exercise price per share determined as if the option was exercised on the option granted date'
x-stoplight:
id: h2s7xks9qwu1l
Tax5227K1:
title: Form 5227-K1
description: 'Split-Interest Trust Beneficiary''s schedule K-1, uses Tax1041K1 entity'
type: object
allOf:
- $ref: '#/components/schemas/Tax1041K1'
x-stoplight:
id: oqgnfmqeyzjpq
Tax5498:
title: Form 5498
description: 'IRA Contribution Information, from TRUSTEE/ISSUER (1st-2nd boxes as issuer) to PARTICIPANT (3rd-4th boxes as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
accountNumber:
description: Account number
type: string
iraContributions:
description: 'Box 1, IRA contributions'
type: number
rolloverContributions:
description: 'Box 2, Rollover contributions'
type: number
rothIraConversion:
description: 'Box 3, Roth IRA conversion amount'
type: number
recharacterizedContributions:
description: 'Box 4, Recharacterized contributions'
type: number
fairMarketValue:
description: 'Box 5, Fair market value of account'
type: number
lifeInsuranceCost:
description: 'Box 6, Life insurance cost included in box 1'
type: number
ira:
type: boolean
description: 'Box 7a, IRA'
sep:
type: boolean
description: 'Box 7b, SEP'
simple:
type: boolean
description: 'Box 7c, SIMPLE'
rothIra:
type: boolean
description: 'Box 7d, Roth IRA'
sepContributions:
description: 'Box 8, SEP contributions'
type: number
simpleContributions:
description: 'Box 9, SIMPLE contributions'
type: number
rothIraContributions:
description: 'Box 10, Roth IRA contributions'
type: number
rmdNextYear:
type: boolean
description: 'Box 11, If checked, required minimum distribution for next year'
rmdDate:
$ref: '#/components/schemas/DateString'
description: 'Box 12a, RMD date'
rmdAmount:
description: 'Box 12b, RMD amount'
type: number
postponedContribution:
description: 'Box 13a, Postponed contribution'
type: number
postponedYear:
description: 'Box 13b, Year'
format: int32
type: integer
postponedCode:
description: 'Box 13c, Code'
type: string
repayments:
description: 'Box 14a, Repayments'
type: number
repayCode:
description: 'Box 14b, Code'
type: string
fmvSpecifiedAssets:
description: 'Box 15a, FMV of certain specified assets'
type: number
specifiedCodes:
description: 'Box 15b, Code(s)'
type: string
x-stoplight:
id: o1ckihi1ux97h
Tax5498Esa:
title: Form 5498-ESA
description: 'Coverdell ESA Contribution Information, from TRUSTEE/ISSUER (1st-2nd boxes as issuer) to BENEFICIARY (3rd-4th boxes as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
accountNumber:
description: Account number
type: string
coverdellEsaContributions:
description: 'Box 1, Coverdell ESA contributions'
type: number
rolloverContributions:
description: 'Box 2, Rollover contributions'
type: number
x-stoplight:
id: gx2hq5jjlijch
Tax5498Qa:
title: Form 5498-QA
description: 'ABLE Account Contribution Information, from ISSUER (1st-2nd boxes) to BENEFICIARY (3rd-4th boxes as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
accountNumber:
type: string
description: Account number
ableContributions:
type: number
description: 'Box 1, ABLE contributions'
rollovers:
type: number
description: 'Box 2, ABLE to ABLE Rollovers'
cumulativeContributions:
type: number
description: 'Box 3, Cumulative contributions'
fairMarketValue:
type: number
description: 'Box 4, Fair market value'
openedInTaxYear:
type: boolean
description: 'Box 5, Check if account opened in current tax year'
basisOfDisabilityCode:
type: string
description: 'Box 6, Basis of eligibility'
typeOfDisabilityCode:
type: string
description: 'Box 7, Code'
x-stoplight:
id: qod7gp5m1dmvb
Tax5498Sa:
title: Form 5498-SA
description: 'HSA, Archer MSA, or Medicare Advantage (MA) MSA Information, from TRUSTEE (1st-2nd boxes as issuer) to PARTICIPANT (3rd-4th boxes as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
accountNumber:
description: Account number
type: string
msaContributions:
description: 'Box 1, Employee or self-employed person''s Archer MSA contributions made in current and following years for current year'
type: number
totalContributions:
description: 'Box 2, Total contributions made in current year'
type: number
totalPostYearEnd:
description: 'Box 3, Total HSA or Archer MSA contributions made in following year for current year'
type: number
rolloverContributions:
description: 'Box 4, Rollover contributions'
type: number
fairMarketValue:
description: 'Box 5, Fair market value of HSA, Archer MSA, or Medicare Advantage (MA) MSA'
type: number
hsa:
type: boolean
description: 'Box 6a, HSA'
archer:
type: boolean
description: 'Box 6b, Archer MSA'
maMsa:
type: boolean
description: 'Box 6c, Medicare Advantage (MA) MSA'
x-stoplight:
id: zzws8cqh2xhy8
TaxFormAttribute:
title: Tax Form Attribute
description: An additional tax form attribute for use when a defined field is not available
type: object
allOf:
- $ref: '#/components/schemas/fiAttribute'
- type: object
properties:
boxNumber:
type: string
description: 'Box number on a tax form, if any'
code:
type: string
description: 'Tax form code for the given box number, if any'
x-stoplight:
id: 6gp2162mxcgsi
TaxParty:
title: Tax Party
description: 'Legal entity for issuer or recipient, used across all tax forms'
type: object
properties:
tin:
description: Issuer or recipient Tax Identification Number. Usually EIN for issuer and SSN for recipient
type: string
partyType:
$ref: '#/components/schemas/TaxPartyType'
description: 'Type of issuer or recipient legal entity, as "BUSINESS" or "INDIVIDUAL". Commonly BUSINESS for issuer and INDIVIDUAL for recipient'
individualName:
$ref: '#/components/schemas/IndividualName'
description: Individual issuer or recipient name
businessName:
$ref: '#/components/schemas/BusinessName'
description: Business issuer or recipient name
address:
$ref: '#/components/schemas/Address'
description: Issuer or recipient address
phone:
$ref: '#/components/schemas/TelephoneNumberPlusExtension'
description: Issuer or recipient telephone number
email:
description: 'Issuer or recipient email address. (Additional information, not part of IRS forms)'
type: string
x-stoplight:
id: 425ozvw1tpig8
TaxPartyType:
title: Tax Party Type
description: Whether the tax legal entity is a business or an individual
type: string
enum:
- BUSINESS
- INDIVIDUAL
x-stoplight:
id: m1t5o9gaqew77
TaxRefundDirectDeposit:
title: Tax Refund Direct Deposit
description: IRS Form 8888 Direct Deposit Information
type: object
properties:
institutionName:
description: Name of institution
type: string
rtn:
description: Routing transit number
type: string
accountNumber:
description: Account number
type: string
accountNickName:
description: Account nickname
type: string
x-stoplight:
id: fc4mf5ko7xcbb
TaxStatement:
title: Tax Statement
description: Tax statement containing one or more tax forms
type: object
properties:
taxYear:
description: Year for which taxes are being paid
$ref: '#/components/schemas/TaxYear'
taxStatementId:
description: 'Long-term persistent id for the tax statement. Depending upon the data provider, this may be the same id as the id on the enclosed tax form(s), or this may be a different id'
type: string
issuer:
description: 'Issuer''s name, address, phone, and TIN. Issuer data need only be transmittted on TaxStatement, ''JSON'' data type responses if it is the same on all included tax forms'
$ref: '#/components/schemas/TaxParty'
recipient:
description: 'Recipient''s name, address, phone, and TIN. Recipient data need only be transmittted on TaxStatement, ''JSON'' data type responses if it is the same on all included tax forms'
$ref: '#/components/schemas/TaxParty'
taxDataType:
description: Whether this `application/json` tax form response contains data in `forms` property (as 'JSON' format) or `pdf` property (as 'BASE64_PDF' format)
$ref: '#/components/schemas/TaxDataType'
forms:
description: 'The list of data contents for all included tax forms, response should include one of `forms` or `pdf`'
type: array
items:
$ref: '#/components/schemas/TaxData'
pdf:
description: 'PDF version of the tax statement containing all form pages, binary encoded as Base64, response should include one of `pdf` or `forms`'
type: string
format: base64
attributes:
description: Additional tax statement attributes that the provider wishes to include
type: array
items:
$ref: '#/components/schemas/fiAttribute'
x-stoplight:
id: zobevhcnnrt9x
TaxStatementList:
title: Tax Statement List
description: Tax statement list containing one or more tax statements
type: object
properties:
statements:
type: array
description: The list of tax statements
items:
$ref: '#/components/schemas/TaxStatement'
x-stoplight:
id: di0phktf4u8yt
TaxW2:
title: Form W-2
description: 'Wage and Tax Statement, from Employer (boxes b-c as issuer) to Employee (boxes a, e-f as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
controlNumber:
description: Control number
type: string
wages:
description: 'Box 1, Wages, tips, other compensation'
type: number
federalTaxWithheld:
description: 'Box 2, Federal income tax withheld'
type: number
socialSecurityWages:
description: 'Box 3, Social security wages'
type: number
socialSecurityTaxWithheld:
description: 'Box 4, Social security tax withheld'
type: number
medicareWages:
description: 'Box 5, Medicare wages and tips'
type: number
medicareTaxWithheld:
description: 'Box 6, Medicare tax withheld'
type: number
socialSecurityTips:
description: 'Box 7, Social security tips'
type: number
allocatedTips:
description: 'Box 8, Allocated tips'
type: number
dependentCareBenefit:
description: 'Box 10, Dependent care benefits'
type: number
nonQualifiedPlan:
description: 'Box 11, Nonqualified plans'
type: number
codes:
description: 'Box 12, Codes and amounts'
type: array
items:
$ref: '#/components/schemas/CodeAmount'
statutory:
type: boolean
description: 'Box 13, Statutory employee'
retirementPlan:
type: boolean
description: 'Box 13, Retirement plan'
thirdPartySickPay:
type: boolean
description: 'Box 13, Third-party sick pay'
esppQualified:
description: Employee Stock Purchase Plan Qualified Disposition amount
type: number
esppNonQualified:
description: Employee Stock Purchase Plan Nonqualified Disposition amount
type: number
other:
description: 'Box 14, Other descriptions and amounts'
type: array
items:
$ref: '#/components/schemas/DescriptionAmount'
stateAndLocal:
description: 'Boxes 15-20, State and Local tax withholding'
type: array
items:
$ref: '#/components/schemas/StateAndLocalTaxWithholding'
x-stoplight:
id: pwxpq9epjbn93
TaxW2C:
title: Form W-2c
description: 'IRS form W-2c, Corrected Wage and Tax Statement, from Employer (boxes a-b as issuer) to Employee (boxes d, h-i as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
correctedTinOrName:
description: 'Box e, Corrected SSN and/or name'
type: boolean
previousEmployeeTin:
description: 'Box f, Employee''s previously reported SSN'
type: string
previousEmployeeName:
description: 'Box g, Employee''s previously reported name'
$ref: '#/components/schemas/IndividualName'
originalW2:
description: Boxes 1-20 of Previously reported Wage and Tax Statement
$ref: '#/components/schemas/TaxW2'
correctedW2:
description: Boxes 1-20 of Correct information Wage and Tax Statement
$ref: '#/components/schemas/TaxW2'
x-stoplight:
id: fnt7mrjv5m26u
TaxW2G:
title: Form W-2G
description: 'Certain Gambling Winnings, from PAYER (1st-3rd boxes as issuer) to WINNER (boxes 4th-6th and 9 as recipient)'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
properties:
winnings:
description: 'Box 1, Reportable winnings'
type: number
dateWon:
$ref: '#/components/schemas/DateString'
description: 'Box 2, Date won'
typeOfWager:
description: 'Box 3, Type of wager'
type: string
federalTaxWithheld:
description: 'Box 4, Federal income tax withheld'
type: number
transaction:
description: 'Box 5, Transaction'
type: string
race:
description: 'Box 6, Race'
type: string
identicalWinnings:
description: 'Box 7, Winnings from identical wagers'
type: number
cashier:
description: 'Box 8, Cashier'
type: string
window:
description: 'Box 10, Window'
type: string
firstId:
description: 'Box 11, First I.D.'
type: string
secondId:
description: 'Box 12, Second I.D.'
type: string
stateAndLocal:
description: 'Boxes 13-18, State and Local tax withholding, use income fields for state (box 14) and local (box 16) winnings amounts'
type: array
items:
$ref: '#/components/schemas/StateAndLocalTaxWithholding'
x-stoplight:
id: dgr77l0627lt7
TaxYear:
title: Tax Year Type
description: The four-digit year for which a tax form applies. FDX Tax data API was completed with v3.0 in fall of 2018
type: integer
format: int32
minimum: 2018
maximum: 2050
example: 2023
x-stoplight:
id: 3npdjkgkgtdzu
TelephoneNumber:
title: Telephone Number
description: Standard for international phone numbers
type: object
properties:
type:
$ref: '#/components/schemas/TelephoneNumberType'
description: 'Type of phone number: HOME, BUSINESS, CELL, FAX'
country:
type: string
maxLength: 3
description: Country calling codes defined by ITU-T recommendations E.123 and E.164
number:
type: string
maxLength: 15
pattern: \d+
description: Telephone subscriber number defined by ITU-T recommendation E.164
x-stoplight:
id: 9pc4k4pw6x8x0
TelephoneNumberPlusExtension:
title: Telephone Number Plus Extension
description: A telephone number that can contain optional text for an arbitrary length telephone extension number
type: object
allOf:
- $ref: '#/components/schemas/TelephoneNumber'
- type: object
properties:
extension:
description: An arbitrary length telephone number extension
type: string
x-stoplight:
id: hom0x6a01yhni
TelephoneNumberType:
title: Telephone Number Type
description: Purpose or type of telephone number
type: string
enum:
- BUSINESS
- CELL
- FAX
- HOME
x-stoplight:
id: izca3l9pp7ey4
vesting:
title: Vesting Entity
properties:
vestingDate:
type: string
format: date-time
description: Vesting date
symbol:
type: string
description: Security symbol
strikePrice:
type: number
description: Strike price
vestingPercentage:
type: number
description: Vesting percentage
otherVestAmount:
type: number
description: Other vest amount
otherVestPercentage:
type: number
description: Other vest percentage
vestedBalance:
type: number
description: Vested balance
unVestedBalance:
type: number
description: Unvested balance
vestedQuantity:
type: number
description: Vested qualtity
unVestedQuantity:
type: number
description: Unvested quantity
type: object
description: 'Provides the past, present, and future vesting schedule and percentages.'
x-stoplight:
id: 56z8d995wsgg8
accountContact:
title: Account Contact entity
description: Contact information for the account
type: object
properties:
holders:
type: array
items:
$ref: '#/components/schemas/accountHolder'
description: Owners of the account
emails:
type: array
items:
type: string
description: Email addresses associated with the account
# addresses:
# type: array
#items:
# $ref: '#/components/schemas/deliveryAddress'
# description: Physical mail addresses associated with the account
# telephones:
# type: array
# items:
# $ref: '#/components/schemas/telephoneNumber'
# description: Telephone numbers associated with the account
x-stoplight:
id: qxgcfsam6u3j5
accountHolder:
title: Account Holder entity
description: Extends `Customer` and adds a `relationship` field to define the customer's relationship with an account
type: object
allOf:
- $ref: '#/components/schemas/customer'
- type: object
properties:
relationship:
$ref: '#/components/schemas/accountHolderRelationship'
description: Customer's relationship to the account
x-stoplight:
id: im27l8u5l1ocr
accountHolderRelationship:
title: Account Holder Relationship
description: Types of relationships between accounts and holders. Suggested values
type: string
enum:
- AUTHORIZED_USER
- BUSINESS
- FOR_BENEFIT_OF
- FOR_BENEFIT_OF_PRIMARY
- FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED
- FOR_BENEFIT_OF_SECONDARY
- FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED
- FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED
- POWER_OF_ATTORNEY
- PRIMARY_JOINT_TENANTS
- PRIMARY
- PRIMARY_BORROWER
- PRIMARY_JOINT
- SECONDARY
- SECONDARY_JOINT_TENANTS
- SECONDARY_BORROWER
- SECONDARY_JOINT
- SOLE_OWNER
- TRUSTEE
- UNIFORM_TRANSFER_TO_MINOR
x-stoplight:
id: wc63jpi67i7kz
businessCustomer:
title: Business Customer entity
description: Customers that are commercial in nature are affiliated with a business entity
type: object
properties:
name:
type: string
description: Name of business customer
registeredAgents:
type: array
description: A list of registered agents who act on behalf of the business customer
items:
$ref: '#/components/schemas/customerName'
registeredId:
type: string
description: The registered tax identification number (TIN) or other identifier of business customer
industryCode:
description: Industry code and type
type: object
properties:
type:
type: string
code:
type: string
domicile:
description: The country and region of the business customer's location
type: object
properties:
region:
type: string
country:
type: string
x-stoplight:
id: 67rfb1nkv4da6
customerName:
title: customerName
type: object
properties:
first:
type: string
description: First or given name. This data element may contain first & last name if not separated.
middle:
type: string
last:
type: string
prefix:
description: 'Name prefix, e.g. Mr.'
type: string
suffix:
description: Generational or academic suffix
type: string
company:
type: string
description: Company name
x-stoplight:
id: 2e0tax11rgb2y
currentCustomer:
title: Current customer
description: Currently authenticated end-user
type: object
properties:
customer:
$ref: '#/components/schemas/customer'
description: current customer
x-stoplight:
id: kontn3osawv18
deliveryAddress:
allOf:
- type: object
# $ref: '#/components/schemas/address'
- type: object
properties:
type:
type: string
description: 'Type of address location. One of BUSINESS, HOME, MAILING'
x-stoplight:
id: c7ztbk9ve9mr7
statements:
title: An array of statements
description: A paginated array of account statements
type: object
allOf:
- $ref: '#/components/schemas/paginatedArray'
- type: object
# properties:
# statements:
# type: array
# description: 'An array of Statement, each with its HATEOAS link to retrieve the account statement'
# items:
#$ref: '#/components/schemas/statement'
x-stoplight:
id: xncpiwftlx1o6
parameters:
accountIdPath:
name: accountId
in: path
description: Account Identifier
required: true
schema:
type: string
default: ':accountId'
endTimeQuery:
name: endTime
in: query
description: 'ISO 8601 date format in UTC time zone. If blank, the default value (current date) is used. If a value is specified, startTime is required.'
schema:
type: string
format: date-time
example: '2021-03-30T04:00:00Z'
startTimeQuery:
name: startTime
in: query
description: 'ISO 8601 date format in UTC time zone. If blank, the default value (current date - 15 calendar days) is used. If a value is specified, endTime is required.'
schema:
type: string
example: '2020-03-30T04:00:00Z'
format: date-time
statementIdPath:
name: statementId
in: path
description: Statement Identifier
required: true
schema:
type: string
default: statementId
versionPath:
name: version
in: path
description: 'Akoya major version number. Do not use minor version numbers. For instance, use v2 and not v2.2'
required: true
schema:
type: string
default: v2
providerIdPath:
name: providerId
in: path
description: Id of provider
schema:
type: string
default: mikomo
required: true
limitQuery:
name: limit
in: query
description: The maximum number of items to be returned in the response. The default is 50.
schema:
type: integer
default: 50
offsetQuery:
name: offset
in: query
description: The number of items to skip before the first in the response. The default is 0.
schema:
type: string
default: '0'
endDateQuery:
name: endTime
in: query
description: End date for use in retrieval of statements (ISO 8601)
schema:
type: string
format: date
example: '2021-03-30'
startDateQuery:
name: startTime
in: query
description: Start date for use in retrieval of statements (ISO 8601)
schema:
type: string
example: '2020-03-30'
format: date
x-internal: true
x-readme:
explorer-enabled: true
proxy-enabled: true
Change log
| Date | Update |
|---|---|
| 2024-Apr-11 | Added v2.4.0 |
| 2024-Dec-10 | Added v2.3.0 |
| 2024-Sept-11 | Original. |
Need help?
Check out our Developer Community, or visit the Support Center in the Data Recipient Hub.
Looking for provider nuance documentation?
All provider nuance documentation is available in the Data providers section in the Data Recipient Hub.
Still stuck?
For all production issues, submit a support ticket through the Data Recipient Hub. Our support team is standing by 24/7. Questions and non-production issues will be answered during business hours.
Updated 4 days ago