Akoya APIs 3.0.0
Paste the following code into your favorite text editor and save it as a YAML file:
Documentation
Paste the following code into your favorite text editor and save it as a YAML file:
openapi: 3.1.0
x-stoplight:
id: 1cklkzlsezaz5
info:
title: Akoya APIs v3.0.0
version: 3.0.0
description: |-
Updated 08/05/2026
Akoya product APIs for data access. Default servers are set for the Akoya sandbox environment.
Akoya APIs include the following updates:
- v3.0.0
- Added new mandatory headers
contact:
name: API Support
url: 'http://www.akoya.com'
email: questions@akoya.com
license:
name: Akoya Terms of Use
url: 'https://recipient.ddp.akoya.com/terms-of-use'
summary: ''
x-server-configuration:
default-environment: Sandbox
default-server: default
environments:
- name: Sandbox
servers:
- name: default
url: 'https://sandbox-products.ddp.akoya.com'
- name: Production
servers:
- name: default
url: 'https://products.ddp.akoya.com'
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 (beta)
description: Tax (beta)
- name: Transactions
description: Transactions
security:
- bearerAuth: []
servers:
- url: 'https://sandbox-products.ddp.akoya.com'
description: Sandbox Server
- url: 'https://products.ddp.akoya.com'
description: Production Server
paths:
'/accounts-info/{version}/{providerId}':
get:
summary: Account Information
x-stoplight:
id: r3nouwmzvm8qr
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. For example:\n\n`https://sandbox-products.ddp.akoya.com/accounts-info/v3/mikomo?mode=standard`\n"
responses:
'200':
$ref: '#/components/responses/accountInfo200'
'206':
$ref: '#/components/responses/accountInfo206'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'408':
$ref: '#/components/responses/408'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
parameters:
- $ref: '#/components/parameters/x-akoya-interaction-type'
- $ref: '#/components/parameters/x-akoya-last-access'
- $ref: '#/components/parameters/x-akoya-intent-type'
- $ref: '#/components/parameters/mode'
- $ref: '#/components/parameters/accountIds'
parameters:
- $ref: '#/components/parameters/versionPath'
- $ref: '#/components/parameters/providerIdPath'
'/balances/{version}/{providerId}':
get:
summary: Balances
x-stoplight:
id: jlwljrwidwc8b
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. For example:\n\n`https://sandbox-products.ddp.akoya.com/balances/v3/mikomo?mode=standard`"
responses:
'200':
$ref: '#/components/responses/balances200'
'206':
$ref: '#/components/responses/balances206'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'408':
$ref: '#/components/responses/408'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
parameters:
- $ref: '#/components/parameters/x-akoya-interaction-type'
- $ref: '#/components/parameters/x-akoya-last-access'
- $ref: '#/components/parameters/x-akoya-intent-type'
- $ref: '#/components/parameters/mode'
- $ref: '#/components/parameters/accountIds'
parameters:
- $ref: '#/components/parameters/versionPath'
- $ref: '#/components/parameters/providerIdPath'
'/customers/{version}/{providerId}/current':
get:
operationId: customer-info
x-stoplight:
id: xycjg4wfhrkcp
tags:
- Customers
description: "This product supports use cases such as payment enablement, account opening, and identity verification. Responses return information about the authorized consumer, the consumer 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>\n\nUse the `mode` query param to receive FDX-aligned, standardized data values. For example:\n\n`https://sandbox-products.ddp.akoya.com/customers/v3/mikomo/current?mode=standard`"
summary: Customer Info
parameters:
- $ref: '#/components/parameters/versionPath'
- $ref: '#/components/parameters/providerIdPath'
- $ref: '#/components/parameters/x-akoya-interaction-type'
- $ref: '#/components/parameters/x-akoya-last-access'
- $ref: '#/components/parameters/x-akoya-intent-type'
- $ref: '#/components/parameters/mode'
responses:
'200':
$ref: '#/components/responses/customerInfo200'
'405':
$ref: '#/components/responses/405'
'408':
$ref: '#/components/responses/408'
parameters:
- $ref: '#/components/parameters/versionPath'
- $ref: '#/components/parameters/providerIdPath'
'/contacts/{version}/{providerId}/{accountId}':
get:
operationId: get-account-holder
x-stoplight:
id: iadlaos1x5p80
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 consumer 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-akoya-v2-4-0) 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\nUse the `mode` query param to receive FDX-aligned, standardized data values. For example:\n\n`https://sandbox-products.ddp.akoya.com/contacts/v3/mikomo/g833202fb0866d0ad83472c429?mode=standard`\n"
summary: Account Holder Information
parameters:
- $ref: '#/components/parameters/accountIdPath'
- $ref: '#/components/parameters/versionPath'
- $ref: '#/components/parameters/providerIdPath'
- $ref: '#/components/parameters/mode'
- $ref: '#/components/parameters/x-akoya-interaction-type'
- $ref: '#/components/parameters/x-akoya-last-access'
- $ref: '#/components/parameters/x-akoya-intent-type'
responses:
'200':
$ref: '#/components/responses/accountHolder200'
'404':
$ref: '#/components/responses/accountHolder404'
'405':
$ref: '#/components/responses/405'
'408':
$ref: '#/components/responses/408'
parameters:
- $ref: '#/components/parameters/versionPath'
- $ref: '#/components/parameters/providerIdPath'
- $ref: '#/components/parameters/accountIdPath'
'/accounts/{version}/{providerId}':
get:
summary: Accounts
x-stoplight:
id: dz9mmuqz5s0w3
tags:
- Investments
operationId: get-accounts
description: "Get detailed account information that includes Akoya products Account Info and Balances for all account types (annuity, 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. For example:\n\n`https://sandbox-products.ddp.akoya.com/accounts/v3/mikomo?mode=standard`"
responses:
'200':
$ref: '#/components/responses/accounts200'
'206':
$ref: '#/components/responses/accounts206'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'408':
$ref: '#/components/responses/408'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
parameters:
- $ref: '#/components/parameters/x-akoya-interaction-type'
- $ref: '#/components/parameters/x-akoya-last-access'
- $ref: '#/components/parameters/x-akoya-intent-type'
- $ref: '#/components/parameters/mode'
- $ref: '#/components/parameters/accountIds'
- $ref: '#/components/parameters/offsetQuery'
- $ref: '#/components/parameters/limitQuery'
parameters:
- $ref: '#/components/parameters/versionPath'
- $ref: '#/components/parameters/providerIdPath'
'/taxlots/{version}/{providerId}/{accountId}/{holdingId}':
get:
summary: Taxlots
x-stoplight:
id: 2b0en2jluh1ro
tags:
- Investments
operationId: get-taxlots
description: "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."
responses:
'200':
$ref: '#/components/responses/taxlots200'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'408':
$ref: '#/components/responses/408'
parameters:
- $ref: '#/components/parameters/x-akoya-interaction-type'
- $ref: '#/components/parameters/x-akoya-last-access'
- $ref: '#/components/parameters/x-akoya-intent-type'
- $ref: '#/components/parameters/offsetQuery'
- $ref: '#/components/parameters/limitQuery'
parameters:
- $ref: '#/components/parameters/versionPath'
- $ref: '#/components/parameters/providerIdPath'
- $ref: '#/components/parameters/accountIdPath'
- $ref: '#/components/parameters/holdingIdPath'
'/payments/{version}/{providerId}/{accountId}/payment-networks':
get:
tags:
- Payments
x-stoplight:
id: b3j9dl6myrzh8
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'
- $ref: '#/components/parameters/x-akoya-interaction-type'
- $ref: '#/components/parameters/x-akoya-last-access'
- $ref: '#/components/parameters/x-akoya-intent-type'
responses:
'200':
$ref: '#/components/responses/payments200'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/payments404'
'405':
$ref: '#/components/responses/405'
'408':
$ref: '#/components/responses/408'
parameters:
- $ref: '#/components/parameters/versionPath'
- $ref: '#/components/parameters/providerIdPath'
- $ref: '#/components/parameters/accountIdPath'
'/statements/{version}/{providerId}/{accountId}':
get:
summary: Statement List
x-stoplight:
id: gglxr2n5v5bje
tags:
- Statements
operationId: get-statement-list
description: |-
Retrieve a list of available statements for the consumer'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 consumer's account id and statement details such as statement id, date, description, and status. The results also include links to GET the statement image.
responses:
'200':
$ref: '#/components/responses/statementList200'
'400':
$ref: '#/components/responses/statementList400'
'404':
$ref: '#/components/responses/statementList404'
'405':
$ref: '#/components/responses/405'
'408':
$ref: '#/components/responses/408'
'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'
- $ref: '#/components/parameters/x-akoya-interaction-type'
- $ref: '#/components/parameters/x-akoya-last-access'
- $ref: '#/components/parameters/x-akoya-intent-type'
parameters:
- $ref: '#/components/parameters/accountIdPath'
- $ref: '#/components/parameters/versionPath'
- $ref: '#/components/parameters/providerIdPath'
'/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
x-stoplight:
id: jfm0rxg56gntg
tags:
- Statements
operationId: get-statements
description: |-
Retrieve a specific account statement file. Use [HTTP Accept request-header](https://www.rfc-editor.org/rfc/rfc9110.html#section-12.5.1) to specify desired content types.
### 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/v3/mikomo/513815781465/P9CvLPKDaFRMbNDkhu1 --header "accept: application/pdf" --header "authorization: Bearer {idtoken}" --output example.pdf
```
parameters:
- $ref: '#/components/parameters/x-akoya-interaction-type'
- $ref: '#/components/parameters/x-akoya-last-access'
- $ref: '#/components/parameters/x-akoya-intent-type'
responses:
'200':
$ref: '#/components/responses/statements200'
'302':
$ref: '#/components/responses/302'
'400':
$ref: '#/components/responses/statement400'
'404':
$ref: '#/components/responses/statement404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'408':
$ref: '#/components/responses/408'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
'/tax-forms/{version}/{providerId}':
get:
operationId: taxFormsSearch
x-stoplight:
id: uc1mh36zsbvbo
tags:
- Tax (beta)
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.\r\n\r\n> \U0001F6D1\r\n> \r\n> Not all providers support Tax. See [this article](https://recipient.ddp.akoya.com/support/article/kA0Uw00000026VxKAI) in the Data Recipient Hub."
parameters:
- $ref: '#/components/parameters/versionPath'
- $ref: '#/components/parameters/providerIdPath'
- $ref: '#/components/parameters/x-akoya-interaction-id'
- $ref: '#/components/parameters/x-akoya-interaction-type'
- $ref: '#/components/parameters/x-akoya-last-access'
- $ref: '#/components/parameters/x-akoya-intent-type'
- $ref: '#/components/parameters/accept-tax'
- $ref: '#/components/parameters/taxYear'
- $ref: '#/components/parameters/taxForms'
- $ref: '#/components/parameters/accountId'
responses:
'200':
$ref: '#/components/responses/searchTaxForms200'
'206':
$ref: '#/components/responses/searchTaxForms206'
'400':
$ref: '#/components/responses/searchTaxForms400'
'404':
$ref: '#/components/responses/searchTaxForms404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'408':
$ref: '#/components/responses/408'
'409':
$ref: '#/components/responses/searchTaxForms409'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
parameters:
- $ref: '#/components/parameters/versionPath'
- $ref: '#/components/parameters/providerIdPath'
'/tax-forms/{version}/{providerId}/{taxFormId}':
get:
operationId: getTaxForm
x-stoplight:
id: t6qqkdwrtgg6f
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.rfc-editor.org/rfc/rfc9110.html#section-12.5.1) to specify desired content types. See `AcceptHeader` definition for typical values.\r\n\r\n> \U0001F6D1\r\n> \r\n> Not all providers support Tax. See [this article](https://recipient.ddp.akoya.com/support/article/kA0Uw00000026VxKAI) in the Data Recipient Hub."
tags:
- Tax (beta)
parameters:
- $ref: '#/components/parameters/versionPath'
- $ref: '#/components/parameters/providerIdPath'
- $ref: '#/components/parameters/taxFormId'
- $ref: '#/components/parameters/x-akoya-interaction-id'
- $ref: '#/components/parameters/x-akoya-interaction-type'
- $ref: '#/components/parameters/x-akoya-last-access'
- $ref: '#/components/parameters/x-akoya-intent-type'
- $ref: '#/components/parameters/taxDataType'
- $ref: '#/components/parameters/accept-tax'
responses:
'200':
$ref: '#/components/responses/retrieveTaxForm200'
'206':
$ref: '#/components/responses/retrieveTaxForm206'
'400':
$ref: '#/components/responses/retrieveTaxForm400'
'404':
$ref: '#/components/responses/retrieveTaxForm404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'408':
$ref: '#/components/responses/408'
'409':
$ref: '#/components/responses/retrieveTaxForm409'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
parameters:
- $ref: '#/components/parameters/versionPath'
- $ref: '#/components/parameters/providerIdPath'
- $ref: '#/components/parameters/taxFormId'
'/transactions/{version}/{providerId}/{accountId}':
get:
summary: Transactions
x-stoplight:
id: 4v4deohxmf0ff
tags:
- Transactions
operationId: get-transactions
description: "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/guides/pagination)\n\nUse the `mode` query param to receive FDX-aligned, standardized data values. For example:\n\n`https://sandbox-products.ddp.akoya.com/transactions/v3/mikomo/g833202fb0866d0ad83472c429?mode=standard`"
responses:
'200':
$ref: '#/components/responses/transactions200'
'400':
$ref: '#/components/responses/transactions400'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'408':
$ref: '#/components/responses/408'
'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'
- $ref: '#/components/parameters/x-akoya-interaction-type'
- $ref: '#/components/parameters/x-akoya-last-access'
- $ref: '#/components/parameters/x-akoya-intent-type'
- $ref: '#/components/parameters/mode'
- $ref: '#/components/parameters/content-type'
parameters:
- $ref: '#/components/parameters/versionPath'
- $ref: '#/components/parameters/providerIdPath'
- $ref: '#/components/parameters/accountIdPath'
components:
headers:
accept:
description: 'Indicates which content types, expressed as MIME types, the sender is able to understand'
schema:
type: string
x-akoya-interaction-id:
description: Akoya-supplied interaction id used for logging and error tracking
schema:
type: string
example: unique-request-id-001
responses:
'302':
description: Statement is available at specified location. URL is returned via the `Location` HTTP header
content:
text/plain:
schema:
type: string
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
'400':
description: Invalid Input
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Invalid Input:
value:
code: 401
message: Invalid input
debugMessage: Invalid Input.
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
'401':
description: Customer not authorized.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Customer Not Authorized:
value:
code: 602
message: Customer not authorized
debugMessage: Customer not authorized.
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
'403':
description: Incorrect providerId or no subscription to provider.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Subscription not found:
value:
code: 403
message: Subscription not found.
debugMessage: Subscription not found.
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
'404':
description: 701 - Tax Lots not found. The `holdingId` may be wrong.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Tax Lots Not Found:
value:
code: 701
message: Account not found
debugMessage: Account not found.
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
'405':
description: Method Not Allowed
content:
text/plain:
schema:
$ref: '#/components/schemas/stringError'
examples:
Method Not Found:
value: Method Not Found
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
'406':
description: Content Type not Supported
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
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.
'408':
description: Request timed out (round trip call took >10 seconds).
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Request Timeout:
value:
code: 408
message: Request Timeout.
debugMessage: Request Timeout.
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
'429':
description: 1207 - Too many requests
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Too Many Requests:
value:
code: 1207
message: Too many requests
debugMessage: Too many requests.
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
'500':
description: Catch-all exception where request was not processed due to an internal outage/issue.
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
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:
$ref: '#/components/headers/x-akoya-interaction-id'
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:
$ref: '#/components/headers/x-akoya-interaction-id'
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.
accountInfo200:
description: OK
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
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
accountInfo206:
description: Partial Content. Success searching for accounts. Some errors are being returned.
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
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
balances200:
description: OK
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
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
balances206:
description: Partial Content. Success searching for accounts. Some errors are being returned.
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
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
customerInfo200:
description: OK
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
content:
application/json:
schema:
$ref: '#/components/schemas/currentCustomer'
examples:
Successful Response:
value:
customer:
customerId: string
name:
first: string
middle: string
last: string
addresses:
- line1: string
city: string
state: string
postalCode: string
telephones:
- number: string
country: string
type: string
email:
- string
accounts:
- string
accountHolder200:
description: OK
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
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
country: string
type: string
email:
- string
accounts:
- account-id-1
- account-id-2
relationship: AUTHORIZED_USER
emails:
- string
addresses:
- line1: string
line2: string
line3: string
city: string
state: string
region: string
postalCode: string
country: US
type: HOME
telephones:
- number: '8675309'
country: US
type: HOME
accountHolder404:
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Account Not Found:
value:
code: 701
message: Account not found.
accounts200:
description: OK
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
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
accounts206:
description: Partial Content. Success searching for accounts. Some errors are being returned.
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
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
taxlots200:
description: OK
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
content:
application/json:
schema:
$ref: '#/components/schemas/taxlotsResponse'
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: CUSIP
taxLots:
- originalPurchaseDate: '2022-04-24T14:15:22Z'
quantity: 0
purchasedPrice: 0
costBasis: 0
currentValue: 0
positionType: LONG
payments200:
description: OK
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
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: []
payments404:
description: 701 - Account not found. The `accountId` may be wrong.
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Account Not Found:
value:
code: 701
message: Account not found
debugMessage: Account not found.
statements200:
description: OK - An image of an account statement
headers:
Accept:
$ref: '#/components/headers/accept'
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
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
statement400:
description: Statement is processing and is not yet available.
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
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.
statement404:
description: Account exists but contains no statements.
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
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.
statementList200:
description: OK
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
content:
application/json:
schema:
$ref: '#/components/schemas/statements'
statementList400:
description: Start or end date value is not in the ISO 8601 format.
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
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.
statementList404:
description: 404 - Not found
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
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.
searchTaxForms200:
description: Array of all the tax document data and tax form images available for the customer matching search criteria
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
properties:
statements:
type: array
items:
type: object
properties:
taxYear:
type: integer
taxDataType:
type: string
forms:
type: array
items:
type: object
properties:
tax1099Div:
type: object
properties:
taxFormId:
type: string
additionalInformation:
type: string
taxFormType:
type: string
accountNumber:
type: string
ordinaryDividends:
type: integer
qualifiedDividends:
type: integer
totalCapitalGain:
type: integer
unrecaptured1250Gain:
type: integer
collectiblesGain:
type: integer
section897Dividends:
type: integer
section897CapitalGain:
type: integer
nonTaxableDistribution:
type: integer
federalTaxWithheld:
type: integer
section199ADividends:
type: integer
investmentExpenses:
type: integer
foreignTaxPaid:
type: integer
cashLiquidation:
type: integer
nonCashLiquidation:
type: integer
taxExemptInterestDividend:
type: integer
specifiedPabInterestDividend:
type: integer
stateAndLocal:
type: array
items:
type: object
properties:
state:
type: object
properties:
taxWithheld:
type: integer
tax1099R:
type: object
properties:
taxFormId:
type: string
additionalInformation:
type: string
taxFormType:
type: string
recipientAccountNumber:
type: string
grossDistribution:
type: integer
taxableAmount:
type: integer
taxableAmountNotDetermined:
type: boolean
totalDistribution:
type: boolean
federalTaxWithheld:
type: integer
iraSepSimple:
type: boolean
stateAndLocal:
type: array
items:
type: object
properties:
state:
type: object
properties:
taxWithheld:
type: integer
x-examples:
Example 1:
statements:
- taxYear: 2024
taxDataType: JSON
forms:
- tax1099Div:
taxFormId: XXXX25-2024-1099Div
additionalInformation: FDX v6.1
taxFormType: Tax1099Div
accountNumber: '4000019295'
ordinaryDividends: 0
qualifiedDividends: 0
totalCapitalGain: 0
unrecaptured1250Gain: 0
collectiblesGain: 0
section897Dividends: 0
section897CapitalGain: 0
nonTaxableDistribution: 0
federalTaxWithheld: 0
section199ADividends: 0
investmentExpenses: 0
foreignTaxPaid: 0
cashLiquidation: 0
nonCashLiquidation: 0
taxExemptInterestDividend: 0
specifiedPabInterestDividend: 0
stateAndLocal:
- state:
taxWithheld: 0
- tax1099R:
taxFormId: XXXX25-2024-1099R
additionalInformation: FDX v6.1
taxFormType: Tax1099R
recipientAccountNumber: '4000019295'
grossDistribution: 0
taxableAmount: 0
taxableAmountNotDetermined: false
totalDistribution: false
federalTaxWithheld: 0
iraSepSimple: false
stateAndLocal:
- state:
taxWithheld: 0
example:
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
examples:
200 Response:
value:
statements:
- taxYear: 2024
taxDataType: JSON
forms:
- tax1099Div:
taxFormId: XXXX25-2024-1099Div
additionalInformation: FDX v6.1
taxFormType: Tax1099Div
accountNumber: '6060017293'
ordinaryDividends: 0
qualifiedDividends: 0
totalCapitalGain: 0
unrecaptured1250Gain: 0
collectiblesGain: 0
section897Dividends: 0
section897CapitalGain: 0
nonTaxableDistribution: 0
federalTaxWithheld: 0
section199ADividends: 0
investmentExpenses: 0
foreignTaxPaid: 0
cashLiquidation: 0
nonCashLiquidation: 0
taxExemptInterestDividend: 0
specifiedPabInterestDividend: 0
stateAndLocal:
- state:
taxWithheld: 0
- tax1099R:
taxFormId: XXXX25-2024-1099R
additionalInformation: FDX v6.1
taxFormType: Tax1099R
recipientAccountNumber: '4000019295'
grossDistribution: 0
taxableAmount: 0
taxableAmountNotDetermined: false
totalDistribution: false
federalTaxWithheld: 0
iraSepSimple: false
stateAndLocal:
- state:
taxWithheld: 0
searchTaxForms206:
description: Partial Content
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
$ref: '#/components/schemas/TaxStatementList'
example:
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
searchTaxForms400:
description: Bad Request
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Invalid Input:
value:
code: 400
message: Invalid input
debugMessage: Invalid input.
searchTaxForms404:
description: Not Found
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Customer Not Found:
value:
code: 404
message: Customer not found
debugMessage: Customer not found.
searchTaxForms409:
description: Conflict
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
$ref: '#/components/schemas/error'
retrieveTaxForm200:
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:
$ref: '#/components/headers/x-akoya-interaction-id'
Content-Type:
schema:
type: string
example: application/json
content:
application/pdf:
schema:
type: object
properties:
taxYear:
type: integer
recipient:
type: object
properties:
partyType:
type: string
individualName:
type: object
properties: {}
address:
type: object
properties:
country:
type: string
phone:
type: object
properties:
country:
type: string
number:
type: string
taxDataType:
type: string
forms:
type: array
items:
type: object
properties:
tax1099R:
type: object
properties:
taxFormId:
type: string
additionalInformation:
type: string
taxFormType:
type: string
recipientAccountNumber:
type: string
grossDistribution:
type: integer
taxableAmount:
type: integer
taxableAmountNotDetermined:
type: boolean
totalDistribution:
type: boolean
federalTaxWithheld:
type: integer
iraSepSimple:
type: boolean
stateAndLocal:
type: array
items:
type: object
properties:
state:
type: object
properties:
taxWithheld:
type: integer
x-examples:
Example 1:
taxYear: 2024
recipient:
partyType: INDIVIDUAL
individualName: {}
address:
country: USA
phone:
country: '+1'
number: '8004214225'
taxDataType: JSON
forms:
- tax1099R:
taxFormId: XXXX25-2024-1099R
additionalInformation: FDX v6.1
taxFormType: Tax1099R
recipientAccountNumber: '4000019295'
grossDistribution: 0
taxableAmount: 0
taxableAmountNotDetermined: false
totalDistribution: false
federalTaxWithheld: 0
iraSepSimple: false
stateAndLocal:
- state:
taxWithheld: 0
examples:
200 Response:
value:
taxYear: 2024
recipient:
partyType: INDIVIDUAL
individualName: {}
address:
country: USA
phone:
country: '+1'
number: '8004214225'
taxDataType: JSON
forms:
- tax1099R:
taxFormId: XXXX25-2024-1099R
additionalInformation: FDX v6.1
taxFormType: Tax1099R
recipientAccountNumber: '4000019295'
grossDistribution: 0
taxableAmount: 0
taxableAmountNotDetermined: false
totalDistribution: false
federalTaxWithheld: 0
iraSepSimple: false
stateAndLocal:
- state:
taxWithheld: 0
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
retrieveTaxForm206:
description: 'Partial Content success retrieving a customer tax document, some errors are being returned'
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
title: PartialSuccessTaxStatement
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'
allOf:
- $ref: '#/components/schemas/TaxStatement'
retrieveTaxForm400:
description: Account ID is required for searching or validating authorization
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
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.
retrieveTaxForm404:
description: Tax Form for provided Tax Form ID was not found
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
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.
retrieveTaxForm409:
description: Tax forms are not currently available for this account or this year
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
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.
transactions200:
description: OK
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
content:
application/json:
x-pagination:
- type: link
result: $response.body#/transactions
next: $response.body#/links/next/href
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
transactions400:
description: Bad Request
headers:
x-akoya-interaction-id:
$ref: '#/components/headers/x-akoya-interaction-id'
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.
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:
Accept:
title: Accept
x-stoplight:
id: b01z9fui9gl02
type: string
default: application/pdf
enum:
- application/pdf
- image/gif
- image/jpeg
- image/tiff
- image/png
description: 'Other values include image/gif, image/tiff, etc'
acceptMediaType:
title: AcceptMediaType
x-stoplight:
id: rvybyjkflmmwy
type: array
items:
title: MediaType
type: string
enum:
- application/json
- application/pdf
example:
- application/json
description: |
MIME type expected in the response. Common values are:
- 'application/json'
- 'application/pdf'
accountId:
title: accountId
x-stoplight:
id: xxs0p2cw8d896
description: Unique account identifier (not the account number)
type: string
accountInfo:
title: Account information
x-stoplight:
id: aloq3smz7bbqq
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:
$ref: '#/components/schemas/fiAttributes'
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:
title: AccountInfoStatus
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:
title: 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:
title: 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
account-info:
title: Akoya Account Info product
x-stoplight:
id: hvj32ei7r9354
description: An optionally paginated array of accounts
type: object
properties:
accounts:
type: array
title: AccountsInfo
description: 'An array of accounts with entity types dependent on the account type (deposit, investment, loan, line of credit, annuity or insurance)'
items:
title: AccountInfoItem
anyOf:
- title: DepositAccountInfo
properties:
depositAccount:
$ref: '#/components/schemas/depositAccount'
- title: LoanAccountInfo
properties:
loanAccount:
$ref: '#/components/schemas/loanAccount'
- title: LocAccountInfo
properties:
locAccount:
$ref: '#/components/schemas/locAccount'
- title: InvestmentAccountInfo
properties:
investmentAccount:
$ref: '#/components/schemas/investmentAccount'
- title: InsuranceAccountInfo
properties:
insuranceAccount:
$ref: '#/components/schemas/insuranceAccount'
- title: AnnuityAccountInfo
properties:
annuityAccount:
$ref: '#/components/schemas/annuityAccount'
accountPaymentNetworkList:
title: Array of account payment networks
x-stoplight:
id: mufo8hx4c4m7z
description: An optionally paginated array of payment networks supported by the account
type: object
properties:
paymentNetworks:
type: array
title: PaymentNetworks
items:
$ref: '#/components/schemas/accountPaymentNetwork'
description: Array of payment networks
accountPaymentNetwork:
title: Payment Network Supported by Account
x-stoplight:
id: hrplhc7xr20ai
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
Address:
title: Address
x-stoplight:
id: 2zhfctmp085l6
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
amtItems:
description: 'Box 15, Alternative minimum tax (AMT) items'
x-stoplight:
id: cdhnuptfbzpx1
type: array
items:
$ref: '#/components/schemas/CodeAmount'
balances:
type: object
x-stoplight:
id: wpvgkhxbb2s3g
title: Balances
properties:
accounts:
title: 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:
title: BalanceAccounts
anyOf:
- title: DepositBalance
properties:
depositAccount:
$ref: '#/components/schemas/depositBalance'
- title: LoanBalance
properties:
loanAccount:
$ref: '#/components/schemas/loanBalance'
- title: LocBalance
properties:
locAccount:
$ref: '#/components/schemas/locBalance'
- title: InvestmentBalance
properties:
investmentAccount:
$ref: '#/components/schemas/investmentBalance'
- title: InsuranceBalance
properties:
insuranceAccount:
$ref: '#/components/schemas/insuranceBalance'
- title: AnnuityBalance
properties:
annuityAccount:
$ref: '#/components/schemas/annuityBalance'
balanceList:
title: Investment Balance List
x-stoplight:
id: v4inwc1p6xofy
type: object
properties:
balanceName:
type: string
description: Name of the balance.
balanceDescription:
type: string
description: Description of balance.
balanceType:
type: string
title: InvestmentBalanceType
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'
BusinessName:
title: Business name
x-stoplight:
id: emvibv907gey3
description: Business issuer or recipient name
type: object
properties:
name1:
description: Name line 1
type: string
name2:
description: Name line 2
type: string
BusinessIncomeStatement:
title: BusinessIncomeStatement
x-stoplight:
id: 9tnb72qaeih42
description: Business Income Statement for IRS Form 1040 Schedule C
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: BusinessIncomeStatementDetails
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:
$ref: '#/components/schemas/otherIncome'
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:
title: BusinessIncomeStatementOtherExpenses
description: 'Box 27, Other expenses'
allOf:
- $ref: '#/components/schemas/otherExpenses'
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
title: OtherCosts
description: 'Box 39, Other costs'
items:
$ref: '#/components/schemas/DescriptionAmount'
endingInventory:
type: number
description: 'Box 41, Inventory at end of year'
capitalExpenditures:
$ref: '#/components/schemas/capitalExpenditures'
annuityAccount:
title: AnnuityAccount
x-stoplight:
id: 3qphwvzqy59ew
description: Annuity Account
allOf:
- $ref: '#/components/schemas/accountInfo'
- type: object
title: AnnuityAccountDetails
properties:
annuityProductType:
enum:
- CURRENCY
- SHARES
title: AnnunityProductType
type: string
annuityValueBasis:
enum:
- FIXED
- VARIABLE
title: AnnunityValueBasis
type: string
paymentFrequency:
title: AnnuityAccountPaymentFrequency
type: string
enum:
- ANNUALLY
- QUARTERLY
- MONTHLY
- WEEKLY
annuityBalance:
title: AnnuityBalances
x-stoplight:
id: r4gi9ugbfjnmu
description: Data elements included with balances specific to annuity accounts
allOf:
- $ref: '#/components/schemas/annuityAccount'
- type: object
title: AnnuityBalanceDetails
properties:
annualIncrease:
description: Percent or dollar amount of annual payment increase
type: number
annualIncreaseType:
title: 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:
title: 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
capitalExpenditures:
type: array
x-stoplight:
id: 7tyco5y3lfluy
description: 'Capital expenditures, for use in calculating Depreciation'
items:
$ref: '#/components/schemas/DateAmount'
CodeAmount:
title: Code and Amount
x-stoplight:
id: ghtaa0mg59ez7
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
contribution:
title: Contribution Entity
x-stoplight:
id: thj6ef9mbkeyb
type: object
description: Describes how new contributions are distributed among the available securities.
properties:
securityId:
type: string
description: Unique identifier of security
securityIdType:
$ref: '#/components/schemas/securityIdType'
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
Content-Type:
name: Content-Type
x-stoplight:
id: qybf48j54m2pk
description: application/JSON
type: string
coveredIndividuals:
description: 'Boxes 16+, Covered Individuals'
x-stoplight:
id: 82c52q7bs3ajk
type: array
items:
$ref: '#/components/schemas/HealthInsuranceMarketplaceCoveredIndividual'
CoverageMonth:
title: Coverage Month
x-stoplight:
id: cm47b8glk7rh6
description: Month of coverage
type: string
enum:
- ANNUAL
- JANUARY
- FEBRUARY
- MARCH
- APRIL
- MAY
- JUNE
- JULY
- AUGUST
- SEPTEMBER
- OCTOBER
- NOVEMBER
- DECEMBER
credits:
description: 'Box 15, Credits'
x-stoplight:
id: 5rpfe01ohckqm
type: array
items:
$ref: '#/components/schemas/CodeAmount'
CryptocurrencyGainOrLoss:
title: Gain or loss from cryptocurrency transaction
x-stoplight:
id: ubswi05ra24el
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/longOrShort'
CryptocurrencyTaxStatement:
title: Cryptocurrency Tax Statement list
x-stoplight:
id: znqudvulfe9au
description: Cryptocurrency Tax Statement list
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: CryptocurrencyTaxStatementDetails
properties:
gainsAndLosses:
type: array
title: GainsAndLosses
description: The list of cryptocurrency gains and losses
items:
$ref: '#/components/schemas/CryptocurrencyGainOrLoss'
currency:
title: Currency Entity
x-stoplight:
id: iec9cvt4t35wg
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.
customer:
description: Represents a customer (end-user)
x-stoplight:
id: pxe558q501uf4
title: Customer
type: object
properties:
customerId:
type: string
description: Long-term persistent identity of the end-user. This identity must be unique to the owning institution
name:
title: 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
addresses:
title: Addresses
type: array
uniqueItems: true
minItems: 1
description: An array of the end-user's physical mail addresses
items:
type: object
title: AddressInfo
properties:
line1:
title: Address line 1
type: string
description: May contain full address if not separated
city:
title: City
type: string
state:
title: State
type: string
postalCode:
title: Postal code
type: string
telephones:
title: Telephones
type:
- array
- 'null'
description: Optional array of telephone numbers
items:
type: object
title: TelephoneInfo
properties:
number:
type: string
description: The telephone number
country:
type: string
description: The country
type:
type: string
description: The telephone type
email:
title: Email
type: array
description: An array of the end-user's electronic mail addresses
items:
type: string
accounts:
title: AccountsList
type:
- array
- 'null'
description: Optional list of accounts associated with the customer
items:
type: string
DateString:
title: Date String
x-stoplight:
id: s8a9zheo8nwmz
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'
debtSecurity:
title: DebtSecurity Entity
x-stoplight:
id: xm39y49h114c7
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
title: DebtType
description: Debt type
enum:
- ASSET
- COUPON
debtClass:
type: string
title: DebtClass
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
title: CouponMatureFrequency
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
title: CallType
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
depositAccount:
title: DepositAccount
x-stoplight:
id: 4ba6u2zlomr1j
description: Deposit Account
allOf:
- $ref: '#/components/schemas/accountInfo'
- type: object
title: DepositAccountDetails
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
depositBalance:
title: Deposit balances
x-stoplight:
id: b3qnurtkv5zyv
description: Data elements included with balances specific to deposit accounts
allOf:
- $ref: '#/components/schemas/depositAccount'
- type: object
title: DepositBalanceDetails
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
depositTransaction:
description: Deposit transaction
x-stoplight:
id: platiz0sqvwb6
allOf:
- $ref: '#/components/schemas/transaction'
- type: object
title: DepositTransactionDetails
properties:
payee:
type: string
description: Payee name
checkNumber:
type: integer
description: Check Number
transactionType:
type: string
title: DepositTransactionType
description: DepositTransaction Type
enum:
- CHECK
- WITHDRAWAL
- TRANSFER
- POSDEBIT
- ATMWITHDRAWAL
- BILLPAYMENT
- FEE
- DEPOSIT
- ADJUSTMENT
- INTEREST
- DIVIDEND
- DIRECTDEPOSIT
- ATMDEPOSIT
- POSCREDIT
DateAmount:
title: Date and Amount
x-stoplight:
id: xsibrk9avrhjx
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'
DescriptionAmount:
title: Description and Amount
x-stoplight:
id: u0ryqtrzytn60
description: 'Description and amount pair used on IRS W-2, etc.'
type: object
properties:
description:
description: Description
type: string
amount:
description: Amount
type: number
equityGrant:
title: EquityGrant
x-stoplight:
id: jhbavca58xvys
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:
title: Vestings
type: array
description: 'An array of equityGrant vestings. Provides the past, present, and future vesting schedule and percentages.'
items:
type: object
title: Vesting
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
error:
title: Error
x-stoplight:
id: g113ectd0m9j9
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.
ExpiredOptionType:
title: Expired Option Type
x-stoplight:
id: hqvnp4y30k75o
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'
type: string
enum:
- GRANTED
- PURCHASED
FarmIncomeStatement:
title: Farm Income Statement
x-stoplight:
id: g6gt80gqtuiro
description: Farm Income Statement for IRS Form 1040 Schedule F
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: FarmIncomeStatementDetails
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:
title: FarmIncomeStatementOtherIncome
description: 'Box 8, Other income'
allOf:
- $ref: '#/components/schemas/otherIncome'
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:
$ref: '#/components/schemas/otherExpenses'
capitalExpenditures:
$ref: '#/components/schemas/capitalExpenditures'
FarmRentalIncomeStatement:
title: Farm Rental Income Statement
x-stoplight:
id: b7xjt8a3rzy7d
description: Farm Rental Income Statement for IRS Form 4835
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: FarmRentalIncomeStatementDetails
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:
title: FarmRentalIncomeStatementOtherIncome
description: 'Box 6, Other income'
allOf:
- $ref: '#/components/schemas/otherIncome'
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:
title: FarmRentalIncomeStatementOtherExpenses
description: 'Box 30, Other expenses'
allOf:
- $ref: '#/components/schemas/otherExpenses'
capitalExpenditures:
$ref: '#/components/schemas/capitalExpenditures'
fiAttribute:
title: FiAttribute Entity
x-stoplight:
id: 7q7w8bfig02w3
description: Data provider-specific attribute
properties:
name:
type: string
description: Name of attribute
value:
type: string
description: Value of attribute
type: object
fiAttributes:
type: array
x-stoplight:
id: reigud5l7y4pq
uniqueItems: true
minItems: 1
items:
$ref: '#/components/schemas/fiAttribute'
foreignIncomes:
description: Supplemental foreign income amount information (description is country)
x-stoplight:
id: 0c36gi4ntxlzb
type: array
items:
$ref: '#/components/schemas/DescriptionAmount'
Form1042Agent:
title: Form 1042-S Agent
x-stoplight:
id: w8zgbp2clluk2
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
title: Form1042AgentDetails
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
Form1042Recipient:
title: Form 1042-S Recipient
x-stoplight:
id: uq6q295hrrtcy
description: 'Boxes 13a-j, 13l, Recipient for Form 1042-S'
type: object
allOf:
- $ref: '#/components/schemas/Form1042Agent'
- type: object
title: Form1042RecipientDetails
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'
hateoasLink:
title: HATEOAS Link
x-stoplight:
id: 4hlniau3jjiaa
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
title: HttpMethod
enum:
- GET
- POST
- PATCH
- DELETE
- PUT
description: HTTP Method to use for the request
types:
type: array
title: ContentTypes
description: Content-types that can be used in the Accept header.
items:
type: string
title: ContentType
enum:
- application/pdf
- image/gif
- image/jpeg
- image/tiff
- image/png
- application/json
example: application/json
required:
- href
HateoasLinks:
title: HATEOAS Links array
x-stoplight:
id: w67ui9hsf1hal
description: Links relative to this containing entity
type: array
items:
$ref: '#/components/schemas/hateoasLink'
HealthInsuranceCoverage:
title: Health Insurance Coverage
x-stoplight:
id: lrj3iw6pls3rt
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
HealthInsuranceCoveredIndividual:
title: Health Insurance Covered Individual
x-stoplight:
id: hq4b3x0ck7h4e
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
title: CoveredMonths
type: array
items:
$ref: '#/components/schemas/MonthAbbreviation'
HealthInsuranceMarketplaceCoveredIndividual:
title: Health Insurance Marketplace Covered Individual
x-stoplight:
id: j90bvs0j5jwjm
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
hrefLink:
type: object
x-stoplight:
id: op2mumnvgxyci
properties:
href:
type: string
holding:
title: An investment holding
x-stoplight:
id: y1ukfvpnrkyk0
allOf:
- type: object
title: HoldingDetails
properties:
assetClasses:
type: array
title: AssetClasses
uniqueItems: true
minItems: 1
description: Percent breakdown by asset class.
items:
type: object
title: AssetClassItem
properties:
assetClass:
type: string
title: AssetClass
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
title: FiAssetClasses
description: Percent breakdown by FI-specific asset class percentage breakdown
items:
type: object
title: FiAssetClassItem
properties:
assetClass:
type: string
description: FI-specific asset class
percent:
type: number
description: Percentage of asset class that falls under this asset
fiAttributes:
$ref: '#/components/schemas/fiAttributes'
heldInAccount:
type: string
title: HeldInAccount
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
title: HoldingSubType
enum:
- MONEYMARKET
- CASH
holdingType:
title: HoldingType
type: string
enum:
- STOCK
- BOND
- MUTUALFUND
- CD
- ANNUITY
- OPTION
- OTHER
inv401kSurce:
title: 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:
$ref: '#/components/schemas/positionType'
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:
$ref: '#/components/schemas/securityIdType'
symbol:
type: string
description: Ticker / Market symbol
taxLots:
$ref: '#/components/schemas/taxLots'
units:
type: number
description: Number of shares (with decimals).
- title: HoldingSecurity
oneOf:
- type: object
title: MutualFundSecurityDetails
properties:
mutualFundSecurity:
$ref: '#/components/schemas/mutualFundSecurity'
- type: object
title: OptionSecurityDetails
properties:
optionSecurity:
$ref: '#/components/schemas/optionSecurity'
- type: object
title: OtherSecurityDetails
properties:
otherSecurity:
$ref: '#/components/schemas/otherSecurity'
- type: object
title: StockSecurityDetails
properties:
stockSecurity:
$ref: '#/components/schemas/stockSecurity'
- type: object
title: SweepSecurityDetails
properties:
sweepSecurity:
$ref: '#/components/schemas/sweepSecurity'
- type: object
title: DebtSecurityDetails
properties:
debtSecurity:
$ref: '#/components/schemas/debtSecurity'
imageIds:
type: array
x-stoplight:
id: 4l3oqzv43fw8e
items:
type: string
description: Array of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt.
IndividualName:
title: Individual name
x-stoplight:
id: moyt7l8yam45i
description: Name of responsible individual
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
insuranceAccount:
title: InsuranceAccount
x-stoplight:
id: n0cnr1nciuubk
description: Insurance Account
allOf:
- $ref: '#/components/schemas/accountInfo'
- type: object
title: InsuranceAccountDetails
properties:
accountCategory:
title: 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'
insuranceBalance:
title: Insurance balances
x-stoplight:
id: ch4yek613fooy
description: Data elements included with balances specific to insurance accounts
allOf:
- $ref: '#/components/schemas/insuranceAccount'
- type: object
title: InsuranceBalanceDetails
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:
title: 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.
insuranceTransaction:
description: Insurance transactions
x-stoplight:
id: xfnlh1bedrrk7
allOf:
- $ref: '#/components/schemas/transaction'
- type: object
title: InsuranceTransactionDetails
properties:
transactionType:
title: InsuranceTransactionType
type: string
description: InsuranceTransaction Type
enum:
- PAYMENT
- FEE
- ADJUSTMENT
- INTEREST
intentType:
title: intentType
x-stoplight:
id: nvjkhiagw9ydm
type: string
enum:
- payments
- nonpayments
interactionId:
title: InteractionId
type: string
x-stoplight:
id: mrqd90faaoulb
interactionType:
title: InteractionType
x-stoplight:
id: 920j37jdq1lxc
type: string
enum:
- USER
- BATCH
investmentAccount:
title: InvestmentAccount
x-stoplight:
id: w96ll2fdzhklz
description: Investment Account
allOf:
- $ref: '#/components/schemas/accountInfo'
- type: object
title: InvestmentAccountDetails
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
investmentBalance:
title: Investment balances
x-stoplight:
id: ot50e9ht6r8xi
description: Data elements included with balances specific to investment accounts
allOf:
- $ref: '#/components/schemas/investmentAccount'
- type: object
title: InvestmentBalanceDetails
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
title: BalanceLists
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
investmentLoan:
title: InvestmentLoan Entity
x-stoplight:
id: 79p1y0vg6y2hp
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:
title: 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.
investments:
type: object
x-stoplight:
id: xl647eicaqzil
title: InvestmentsDetails
properties:
accounts:
type: array
title: InvestmentAccounts
description: 'An array of accounts with entity types dependent on the account type (deposit, investment, loan, line of credit, annuity or insurance)'
items:
title: InvestmentAccountItem
anyOf:
- title: InvestmentBalanceInfo
properties:
investmentAccount:
$ref: '#/components/schemas/investmentDetails'
- title: DepositBalanceInfo
properties:
depositAccount:
$ref: '#/components/schemas/depositBalance'
- title: LoanBalanceInfo
properties:
loanAccount:
$ref: '#/components/schemas/loanBalance'
- title: LocBalanceInfo
properties:
locAccount:
$ref: '#/components/schemas/locBalance'
- title: InsuranceBalanceInfo
properties:
insuranceAccount:
$ref: '#/components/schemas/insuranceBalance'
- title: AnnuityBalanceInfo
properties:
annuityAccount:
$ref: '#/components/schemas/annuityBalance'
investmentDetails:
title: Investment account with all details
x-stoplight:
id: 6edcd5fbfu3f5
description: Data elements included with the investment product
allOf:
- $ref: '#/components/schemas/investmentBalance'
- type: object
title: InvestmentDetailsProperties
properties:
holdings:
type: array
title: Holdings
description: Array of holdings
items:
$ref: '#/components/schemas/holding'
openOrders:
type: array
title: OpenOrders
description: Array of open orders
items:
$ref: '#/components/schemas/openOrder'
contribution:
type: array
title: Contributions
description: Array of contribution objects. Describes how new contributions are distributed among the available securities
items:
$ref: '#/components/schemas/contribution'
vesting:
type: array
title: VestingObjects
description: 'Array of vesting objects. Provides the past, present, and future vesting schedule and percentages'
items:
$ref: '#/components/schemas/vesting'
investmentLoans:
type: array
title: InvestmentLoans
description: Array of investment loans
items:
$ref: '#/components/schemas/investmentLoan'
pensionSource:
type: array
title: PensionSources
description: Array of Pension Source
items:
$ref: '#/components/schemas/pensionSource'
equityGrants:
type: array
title: EquityGrants
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'
investmentTransaction:
description: Investment Transactions
x-stoplight:
id: 10g1egadtk6cn
allOf:
- $ref: '#/components/schemas/transaction'
- type: object
title: InvestmentTransactionDetails
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:
title: IncomeType
type: string
description: 'Type of investment income. CGLONG (capital gains-long term), CGSHORT (capital gains-short term), MISC.'
enum:
- CGLONG
- CGSHORT
- MISC
inv401kSource:
$ref: '#/components/schemas/inv401kSource'
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:
$ref: '#/components/schemas/positionType'
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:
title: InvestmentTransactionSecurityIdType
type: string
description: Security identifier type.
enum:
- BUSIP
- ISIN
- SEDOL
- SICC
- VALOR
- WKN
securityType:
title: 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:
title: SubAccountFund
type: string
description: From which account money came in.
enum:
- CASH
- MARGIN
- SHORT
- OTHERS
subAccountSec:
type: string
title: SubAccountSecurityType
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
title: TransactionReason
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
title: InvestmentTransactionType
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
title: TransferAction
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:
$ref: '#/components/schemas/unitType'
withholding:
type: number
description: Federal tax withholding.
InvestmentSaleType:
title: Investment Sale Type
x-stoplight:
id: 5dp16kltmbbmv
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
inv401kSource:
type: string
x-stoplight:
id: at6j1snk2tugf
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.'
Iso3166CountryCode:
title: ISO 3166 Country Code
x-stoplight:
id: cs3afbqibi4ow
description: Country code
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
lastAccess:
title: lastAccess
x-stoplight:
id: xf40uikx2ly0z
type: string
lineItem:
title: LineItem
x-stoplight:
id: iv5qda7qyava5
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:
$ref: '#/components/schemas/imageIds'
links:
type: array
title: HateoasLinks
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
loanAccount:
title: LoanAccount
x-stoplight:
id: pq0cnj5ghbxr7
description: Loan Account
allOf:
- $ref: '#/components/schemas/accountInfo'
- type: object
title: LoanAccountDetails
properties:
compoundingPeriod:
type: string
title: CompoundingPeriod
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
title: LoanAccountPaymentFrequency
enum:
- DAILY
- WEEKLY
- BIWEEKLY
- SEMIMONTHLY
- MONTHLY
- SEMIANNUALLY
- ANNUALLY
totalNumberOfPayments:
type: integer
description: Total number of payments
loanBalance:
title: Loan balances
x-stoplight:
id: q3bmaxmocq4g4
description: Data elements included with balances specific to loan accounts
allOf:
- $ref: '#/components/schemas/loanAccount'
- type: object
title: LoanBalanceDetails
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
loanTransaction:
title: Loan Transaction
x-stoplight:
id: ifa5om1ib8o80
allOf:
- $ref: '#/components/schemas/transaction'
- type: object
title: LoanTransactionDetails
properties:
paymentDetails:
$ref: '#/components/schemas/paymentDetails'
transactionType:
type: string
title: LoanTransactionType
description: LoanTransaction Type
enum:
- ADJUSTMENT
- FEE
- INTEREST
- PAYMENT
description: Loan Transaction
locAccount:
title: LocAccount
x-stoplight:
id: 8vge4t5c63ze5
description: Line of Credit Account
allOf:
- $ref: '#/components/schemas/accountInfo'
LocalTaxWithholding:
title: Local Tax Withholding
x-stoplight:
id: iwyu7oli0x0k3
description: 'Amount of local income tax withheld, if any'
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
locBalance:
title: Line of credit balances
x-stoplight:
id: 8jtg9ud5ehj7r
description: Data elements included with balances specific to line of credit accounts
allOf:
- $ref: '#/components/schemas/locAccount'
- type: object
title: LocBalanceDetails
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
locTransaction:
title: LocTransaction
x-stoplight:
id: ure07yksi81wy
description: A line of credit transaction of type
allOf:
- $ref: '#/components/schemas/transaction'
- type: object
title: LocTransactionDetails
description: Additional data elements for line of credit transactions
properties:
checkNumber:
type: integer
description: Check number
paymentDetails:
$ref: '#/components/schemas/paymentDetails'
transactionType:
type: string
title: LocTransactionType
description: LocTransaction Type
enum:
- CHECK
- WITHDRAWAL
- TRANSFER
- POSDEBIT
- ATMWITHDRAWAL
- BILLPAYMENT
- FEE
- DEPOSIT
- ADJUSTMENT
- INTEREST
- DIVIDEND
- DIRECTDEPOSIT
- ATMDEPOSIT
- POSCREDIT
longOrShort:
title: LongOrShort
x-stoplight:
id: nym924704y26r
allOf:
- $ref: '#/components/schemas/SaleTermType'
description: LONG or SHORT (1099-B box 2)
Mode:
title: Mode
x-stoplight:
id: l2d4s988yaxet
type: string
enum:
- raw
- standard
example: raw
description: |
Indicates format of returned data.
'raw' = provider-specific;
'standard' = FDX-aligned values (BETA)
MonthAbbreviation:
title: Month Abbreviation
x-stoplight:
id: p4m8l5hz0pkzl
description: Month
type: string
enum:
- JAN
- FEB
- MAR
- APR
- MAY
- JUN
- JUL
- AUG
- SEP
- OCT
- NOV
- DEC
MonthAmount:
title: Month and Amount
x-stoplight:
id: 6et4gqa6ylt35
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
mutualFundSecurity:
title: MutualFundSecurity Entity
x-stoplight:
id: ea2700vck421y
description: Information about the mutual fund security specific to the type of security
type: object
properties:
mutualFundType:
type: string
title: MutualFundType
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
NameAddress:
title: Name and Address
x-stoplight:
id: vnm2o1y6k431d
description: Individual or business name with address
type: object
allOf:
- $ref: '#/components/schemas/Address'
- type: object
title: NameAddressDetails
properties:
name1:
type: string
description: Name line 1
name2:
type: string
description: Name line 2
NameAddressPhone:
title: 'Name, Address and Phone'
x-stoplight:
id: 1u0p6pcdysbds
description: Contact phone number with name and address
type: object
allOf:
- $ref: '#/components/schemas/NameAddress'
- type: object
title: NameAddressPhoneDetails
properties:
phone:
$ref: '#/components/schemas/TelephoneNumberPlusExtension'
OfferOfHealthInsuranceCoverage:
title: Offer of Health Insurance Coverage
x-stoplight:
id: s36ii4ev2uewv
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:
title: HealthInsuranceCoverageMonth
allOf:
- $ref: '#/components/schemas/CoverageMonth'
description: Month
openOrder:
title: OpenOrder Entity
x-stoplight:
id: pvcms20bx8xfa
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:
$ref: '#/components/schemas/securityIdType'
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
title: OrderType
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:
$ref: '#/components/schemas/unitType'
orderDuration:
description: 'This order is good for DAY, GOODTILLCANCEL, IMMEDIATE'
title: OrderDuration
type: string
enum:
- DAY
- GOODTILLCANCEL
- IMMEDIATE
subAccount:
title: SubAccount
type: string
enum:
- CASH
- MARGIN
- SHORT
- OTHER
limitPrice:
type: number
description: Limit Price
stopPrice:
type: number
description: Stop price
inv401kSource:
$ref: '#/components/schemas/inv401kSource'
optionSecurity:
title: OptionSecurity Entity
x-stoplight:
id: mdwpnj81puvg4
description: Information about the option security specific to the type of security
type: object
properties:
secured:
title: Secured
type: string
enum:
- COVERED
- NAKED
description: How the option is secured
optionType:
title: 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
otherDeductions:
description: 'Box 12, Other deductions'
x-stoplight:
id: ma1mazblm7lsh
type: array
items:
$ref: '#/components/schemas/CodeAmount'
otherExpenses:
type: array
x-stoplight:
id: hbg8i8w40fgzl
description: 'Box 32, Other expenses'
items:
$ref: '#/components/schemas/DescriptionAmount'
otherIncome:
type: array
x-stoplight:
id: 4vumh8t16nfa8
description: 'Box 8, Other income'
items:
$ref: '#/components/schemas/DescriptionAmount'
otherInfo:
description: 'Box 14, Other information'
x-stoplight:
id: 06dlrd5j4lx91
type: array
items:
$ref: '#/components/schemas/CodeAmount'
otherSecurity:
title: OtherSecurity Entity
x-stoplight:
id: j84x6ye8ieslf
description: Information about the security specific to the type of security
type: object
properties:
typeDescription:
type: string
description: Description of Other Security
paginatedArray:
title: PaginatedArray
x-stoplight:
id: 4dbz3ioecf9yl
type: object
properties:
links:
title: Links
type: object
properties:
next:
$ref: '#/components/schemas/hrefLink'
prev:
$ref: '#/components/schemas/hrefLink'
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
positionType:
type: string
x-stoplight:
id: m0rekfcm2mylh
enum:
- LONG
- SHORT
description: 'LONG, SHORT.'
paymentDetails:
title: PaymentDetails
x-stoplight:
id: ctlpq4ootli4k
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
pensionSource:
title: PensionSource Entity
x-stoplight:
id: e7io70ktynw0m
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:
title: 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.
propertyAddress:
title: PropertyAddress
x-stoplight:
id: b9ug1thcxujyn
allOf:
- $ref: '#/components/schemas/Address'
description: 'Box 1a, Physical address of property (street, city, state, ZIP code)'
RentalIncomeStatement:
title: Rental Income Statement
x-stoplight:
id: 8nleeslggot5q
description: Rental Income Statement for IRS Form 1040 Schedule E
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: RentalIncomeStatementDetails
properties:
propertyAddress:
$ref: '#/components/schemas/propertyAddress'
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:
title: RentalIncomeStatementOtherExpenses
description: 'Box 19, Other expenses'
allOf:
- $ref: '#/components/schemas/otherExpenses'
capitalExpenditures:
$ref: '#/components/schemas/capitalExpenditures'
ResultType:
title: Result Type
x-stoplight:
id: 8xfseffxknfhl
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
example: lightweight
RoyaltyIncomeStatement:
title: Royalty Income Statement
x-stoplight:
id: 3w1g5qs74120k
description: Royalty Income Statement for IRS Form 1040 Schedule E
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: RoyaltyIncomeStatementDetails
properties:
propertyAddress:
$ref: '#/components/schemas/propertyAddress'
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:
title: RoyaltyIncomeStatementOtherExpenses
description: 'Box 19, Other expenses'
allOf:
- $ref: '#/components/schemas/otherExpenses'
capitalExpenditures:
$ref: '#/components/schemas/capitalExpenditures'
SaleProceedsType:
title: Sale Proceeds Type
x-stoplight:
id: jx67n86et1muu
description: Gross or net proceeds. Used by Form 1099-B
type: string
enum:
- GROSS
- NET
SaleTermType:
title: Sale Term Type
x-stoplight:
id: c6g5woeb6b2ds
description: Long or short term. Used by Form 1099-B
type: string
enum:
- LONG
- SHORT
SecurityDetail:
title: 'Security Detail, IRS Form 1099-B'
x-stoplight:
id: x7o85q72l85l3
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
title: AdjustmentCodes
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/longOrShort'
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:
title: GrossOrNet
allOf:
- $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:
$ref: '#/components/schemas/stateAndLocal'
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
securityIdType:
type: string
x-stoplight:
id: li8zshfrhls3p
description: Security identifier type
enum:
- CUSIP
- ISIN
- SEDOL
- SICC
- VALOR
- WKN
StateAndLocalTaxWithholding:
title: State and Local Tax Withholding
x-stoplight:
id: aduz9wmemv1oq
description: Income in a state and/or locality and its or their tax withholding
type: object
properties:
stateCode:
title: StateCodeTwoDigit
description: State two-digit code
allOf:
- $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'
StateCode:
title: State Code
x-stoplight:
id: vzmvwplhj7mlk
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
stateAndLocal:
description: 'Boxes 14-16, State and Local tax withholding'
x-stoplight:
id: uol840p7cnnha
type: array
items:
$ref: '#/components/schemas/StateAndLocalTaxWithholding'
StateTaxWithholding:
title: State Tax Withholding
x-stoplight:
id: 7ewy04vqtzbn3
description: Amount of state income tax withheld
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
stockSecurity:
title: StockSecurity Entity
x-stoplight:
id: f9eg9bt76q15d
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:
title: 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
sweepSecurity:
title: SweepSecurity Entity
x-stoplight:
id: 2eaq8dj5b7h55
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
stringError:
title: String Error
x-stoplight:
id: iovxnya1w1jou
description: A string error entity
type: string
taxlotsResponse:
title: TaxlotsResponse
x-stoplight:
id: 9dkhz78ykuqcj
type: object
properties:
accountId:
type: string
description: Corresponds to AccountId in Account
holding:
title: Holding
type: object
properties:
holdingId:
title: HoldingId
type: string
description: Long term persistent identity of the holding
securityId:
title: SecurityId
type: string
description: Unique identifier of the security.
securityIdType:
$ref: '#/components/schemas/securityIdType'
taxLots:
$ref: '#/components/schemas/taxLots'
TaxData:
title: Tax Data
x-stoplight:
id: t4a92lufni4h4
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'
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: Non-Employee 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 (MA) 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:
title: TaxRefundDirectDepositInfo
allOf:
- $ref: '#/components/schemas/TaxRefundDirectDeposit'
description: Tax refund direct deposit information
TaxDataType:
title: Type Data Type
x-stoplight:
id: s6cxnrorxxoh9
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
taxFormId:
title: taxFormId
x-stoplight:
id: ppm7yvs4txd2e
description: Unique identifier of the tax form to request.
type: string
required: true
taxForms:
title: taxForms
description: One or more tax form type enums for the specific documents being requested. Comma separated.
type: array
items:
$ref: '#/components/schemas/TaxFormType'
example:
- Tax1099Div
- Tax1099Int
x-stoplight:
id: lxkeuu112jmdy
TaxFormType:
title: Type Form Type
x-stoplight:
id: ucs93om0yl2ce
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
taxYear:
title: taxYear
x-stoplight:
id: phtcfgs6coglj
type: string
description: Tax year in which to search for tax forms.
transaction:
title: Transaction
x-stoplight:
id: hzgl2vuo1iqb9
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:
title: 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:
$ref: '#/components/schemas/imageIds'
fiAttributes:
title: transactionFiAttributes
description: Array of FI-specific attributes
allOf:
- $ref: '#/components/schemas/fiAttributes'
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
title: LineItems
description: Breakdown of the transaction details
items:
$ref: '#/components/schemas/lineItem'
links:
title: fiAttriburesHateoasLinks
description: 'Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs'
allOf:
- $ref: '#/components/schemas/HateoasLinks'
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:
title: TransationStatus
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
transactions:
title: Transactions Entity
x-stoplight:
id: kgrnnnqhrqrg6
description: Optionally paginated array of transactions
allOf:
- $ref: '#/components/schemas/paginatedArray'
- type: object
title: TransactionsDetails
properties:
transactions:
description: 'An array of transactions with entity types dependent on the account type (deposit, investment, loan, or line of credit)'
type: array
title: Transactions
items:
title: TransactionItem
anyOf:
- title: DepositTransactionInfo
properties:
depositTransaction:
$ref: '#/components/schemas/depositTransaction'
- title: LoanTransactionInfo
properties:
loanTransaction:
$ref: '#/components/schemas/loanTransaction'
- title: LocTransactionInfo
properties:
locTransaction:
$ref: '#/components/schemas/locTransaction'
- title: InvestmentTransactionInfo
properties:
investmentTransaction:
$ref: '#/components/schemas/investmentTransaction'
- title: InsuranceTransactionInfo
properties:
insuranceTransaction:
$ref: '#/components/schemas/insuranceTransaction'
type: object
Tax:
title: Tax
x-stoplight:
id: hptkvni2d4mpp
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:
title: TaxFormEntityType
allOf:
- $ref: '#/components/schemas/TaxFormType'
description: Enumerated name of the tax form entity e.g. "TaxW2"
issuer:
title: IssuerInfo
allOf:
- $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:
title: RecipientInfo
allOf:
- $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
title: TaxFormAttributes
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:
title: TaxError
allOf:
- $ref: '#/components/schemas/error'
description: Present if an error was encountered while retrieving this form
links:
$ref: '#/components/schemas/HateoasLinks'
description: 'Links to retrieve this form as data or image, or to invoke other APIs'
Tax1041K1:
title: Form 1041 K-1
x-stoplight:
id: v7a41v4yh3ozu
description: 'Beneficiary''s Share of Income, Deductions, Credits, etc.'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1041K1Details
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
title: DirectlyApportionedDeductions
items:
$ref: '#/components/schemas/CodeAmount'
estateTaxDeduction:
description: 'Box 10, Estate tax deduction'
type: number
finalYearDeductions:
description: 'Box 11, Final year deductions'
type: array
title: FinalYearDeductions
items:
$ref: '#/components/schemas/CodeAmount'
fiduciary:
title: FiduciaryData
allOf:
- $ref: '#/components/schemas/TaxParty'
description: 'Box C, Fiduciary''s name and address'
amtAdjustments:
description: 'Box 12, Alternative minimum tax adjustment'
type: array
title: AmtAdjustments
items:
$ref: '#/components/schemas/CodeAmount'
credits:
title: Credits
description: 'Box 13, Credits and credit recapture'
allOf:
- $ref: '#/components/schemas/credits'
otherInfo:
$ref: '#/components/schemas/otherInfo'
Tax1042S:
title: Form 1042-S
x-stoplight:
id: vzg914om8ptic
description: Foreign Person's U.S. Source Income Subject to Withholding
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1042SDetails
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:
title: WithholdingAgent
description: 'Boxes 12a-i, Withholding agent'
allOf:
- $ref: '#/components/schemas/Form1042Agent'
form1042Recipient:
$ref: '#/components/schemas/Form1042Recipient'
accountNumber:
description: 'Box 13k, Recipient account number'
type: string
primary:
title: PrimaryWithholdingAgent
description: 'Boxes 14a-b, Primary Withholding Agent'
allOf:
- $ref: '#/components/schemas/Form1042Agent'
prorataBasisReporting:
description: 'Box 15, Check if pro-rata basis reporting'
type: boolean
intermediary:
title: Intermediary
description: 'Boxes 15a-i, Intermediary or flow thru entity'
allOf:
- $ref: '#/components/schemas/Form1042Agent'
payer:
title: Payer
description: 'Boxes 16a-e, Payer'
allOf:
- $ref: '#/components/schemas/Form1042Agent'
stateAndLocal:
title: Tax1042sStateAndLocalTaxWithholding
description: 'Box 17, State and Local tax withholding'
allOf:
- $ref: '#/components/schemas/StateAndLocalTaxWithholding'
Tax1065K1:
title: Form 1065 K-1
x-stoplight:
id: n31n2hhccx6bt
description: 'Partner''s Share of Income, Deductions, Credits, etc.'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1065K1Details
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
title: OtherIncome
items:
$ref: '#/components/schemas/CodeAmount'
section179Deduction:
description: 'Box 12, Section 179 deduction'
type: number
otherDeductions:
title: Tax1065K1OtherDeductions
description: 'Box 13, Other deductions'
allOf:
- $ref: '#/components/schemas/otherDeductions'
selfEmployment:
description: 'Box 14, Self-employment earnings (loss)'
type: array
title: SelfEmployment
items:
$ref: '#/components/schemas/CodeAmount'
credits:
$ref: '#/components/schemas/credits'
scheduleK3:
description: 'Box 16, Schedule K-3 is attached'
type: boolean
amtItems:
title: Tax1065K1AmtItems
description: 'Box 17, Alternative minimum tax (AMT) items'
allOf:
- $ref: '#/components/schemas/amtItems'
taxExemptIncome:
description: 'Box 18, Tax-exempt income and nondeductible expenses'
type: array
title: TaxExemptIncome
items:
$ref: '#/components/schemas/CodeAmount'
distributions:
description: 'Box 19, Distributions'
type: array
title: Distributions
items:
$ref: '#/components/schemas/CodeAmount'
otherInfo:
title: OtherInfo
description: 'Box 20, Other information'
allOf:
- $ref: '#/components/schemas/otherInfo'
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
Tax1095A:
title: Form 1095-A
x-stoplight:
id: lamz261pfa28p
description: Health Insurance Marketplace Statement
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1095ADetails
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:
$ref: '#/components/schemas/coveredIndividuals'
coverages:
description: 'Boxes 21-33, Coverage Information'
type: array
title: Coverages
items:
$ref: '#/components/schemas/HealthInsuranceCoverage'
Tax1095B:
title: Form 1095-B
x-stoplight:
id: 8iwpfafv4xr0q
description: Health Coverage
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1095BDetails
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:
title: EmployerData
allOf:
- $ref: '#/components/schemas/TaxParty'
description: 'Boxes 10-15, Employer EIN, name and address'
coveredIndividuals:
description: 'Boxes 23+, Covered Individuals'
type: array
title: CoveredIndividuals
items:
$ref: '#/components/schemas/HealthInsuranceCoveredIndividual'
Tax1095C:
title: Form 1095-C
x-stoplight:
id: u0zdc4a3ib5o3
description: Employer-Provided Health Insurance Offer and Coverage
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1095CDetails
properties:
selfInsuredCoverage:
type: boolean
description: Self Insured Coverage
offersOfCoverage:
description: 'Boxes 14-16, Employee Offer of Coverage'
type: array
title: OffersOfCoverage
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:
title: Tax1095CCoveredIndividuals
description: 'Boxes 17+, Covered Individuals'
allOf:
- $ref: '#/components/schemas/coveredIndividuals'
Tax1097Btc:
title: Form 1097-BTC
x-stoplight:
id: q2kxuh0zrxsrj
description: Bond Tax Credit
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1097BtcDetails
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
title: Amounts
items:
$ref: '#/components/schemas/MonthAmount'
comments:
description: 'Box 6, Comments'
type: string
Tax1098:
title: Form 1098
x-stoplight:
id: 2lg7o42yixjz7
description: Mortgage Interest Statement
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1098Details
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:
title: MortgagePropertyAddress
allOf:
- $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
Tax1098C:
title: Form 1098-C
x-stoplight:
id: dcux4yy6zk03k
description: 'Contributions of Motor Vehicles, Boats, and Airplanes'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1098CDetails
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'
Tax1098E:
title: Form 1098-E
x-stoplight:
id: ybidl2bnojhdv
description: Student Loan Interest Statement
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1098EDetails
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'
Tax1098Ma:
title: Form 1098-MA
x-stoplight:
id: lldeaeziyrxkk
description: Mortgage Assistance Payments
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1098MADetails
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'
Tax1098Q:
title: Form 1098-Q
x-stoplight:
id: otzutbcj5zrhc
description: Qualifying Longevity Annuity Contract Information
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1098QDetails
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:
title: 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'
Tax1098T:
title: Form 1098-T
x-stoplight:
id: a402u8wzp33z4
description: Tuition Statement
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1098TDetails
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
Tax1099A:
title: Form 1099-A
x-stoplight:
id: 38mrumyge3nsu
description: Acquisition or Abandonment of Secured Property
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1099ADetails
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
Tax1099B:
title: Form 1099-B
x-stoplight:
id: 9ctb4pntnwsft
description: Proceeds From Broker and Barter Exchange Transactions
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1099BDetails
properties:
accountNumber:
description: Account number
type: string
stateAndLocal:
title: Tax1099BStateAndLocal
description: 'Boxes 14-16, State and Local tax withholding'
allOf:
- $ref: '#/components/schemas/stateAndLocal'
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
title: SecurityDetails
items:
$ref: '#/components/schemas/SecurityDetail'
secondTinNotice:
type: boolean
description: Second TIN Notice
Tax1099C:
title: Form 1099-C
x-stoplight:
id: drtjsqqptwo0d
description: Cancellation of Debt
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1099CDetails
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
Tax1099Cap:
title: Form 1099-CAP
x-stoplight:
id: qpgywz41ww907
description: Changes in Corporate Control and Capital Structure
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1099CapDetails
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
Tax1099ConsolidatedStatement:
title: Form 1099 Consolidated Statement
x-stoplight:
id: ukz93g17a6wx2
description: Consolidated Statement for combined IRS Form 1099s
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1099ConsolidatedStatementDetails
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
Tax1099Div:
title: Form 1099-DIV
x-stoplight:
id: 1hc921x79k1j4
description: Dividends and Distributions
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1099DivDetails
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:
title: Tax1099DivStateAndLocal
description: 'Boxes 14-16, State and Local tax withholding'
allOf:
- $ref: '#/components/schemas/stateAndLocal'
foreignIncomes:
title: Tax1099DivForeignIncomes
allOf:
- $ref: '#/components/schemas/foreignIncomes'
description: Foreign income information
stateTaxExemptIncomes:
description: Tax exempt income state information
type: array
title: StateTaxExemptIncomes
items:
$ref: '#/components/schemas/DescriptionAmount'
secondTinNotice:
type: boolean
description: Second TIN Notice
Tax1099G:
title: Form 1099-G
x-stoplight:
id: hhpxnah0hiehw
description: Certain Government Payments
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1099GDetails
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:
title: Tax1099GStateAndLocal
description: 'Boxes 10-11, State and Local tax withholding'
allOf:
- $ref: '#/components/schemas/stateAndLocal'
secondTinNotice:
type: boolean
description: Second TIN Notice
Tax1099H:
title: Form 1099-H
x-stoplight:
id: 5k79tvyghqs0b
description: Health Coverage Tax Credit (HCTC) Advance Payments
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1099HDetails
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
title: Payments
items:
$ref: '#/components/schemas/MonthAmount'
Tax1099Int:
title: Form 1099-INT
x-stoplight:
id: hl1ep05cnwf2p
description: Interest Income
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1099IntDetails
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:
title: Tax1099IntStateAndLocal
description: 'Boxes 15-17, State and Local tax withholding'
allOf:
- $ref: '#/components/schemas/stateAndLocal'
foreignIncomes:
$ref: '#/components/schemas/foreignIncomes'
stateTaxExemptIncome:
description: Supplemental tax-exempt income by state (description is state)
type: array
title: StateTaxExemptIncome
items:
$ref: '#/components/schemas/DescriptionAmount'
secondTinNotice:
type: boolean
description: Second TIN Notice
Tax1099K:
title: Form 1099-K
x-stoplight:
id: 3gn26byj97803
description: Merchant Card and Third-Party Network Payments
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1099KDetails
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:
title: PSEPhone
allOf:
- $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
title: MonthAmounts
items:
$ref: '#/components/schemas/MonthAmount'
stateAndLocal:
title: Tax1099KStateAndLocal
description: 'Boxes 6-8, State and Local tax withholding'
allOf:
- $ref: '#/components/schemas/stateAndLocal'
secondTinNotice:
type: boolean
description: Second TIN Notice
Tax1099Ls:
title: Form 1099-LS
x-stoplight:
id: ivspow14nnbkj
description: Reportable Life Insurance Sale
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1099LsDetails
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:
title: AcquirerNameAddressInfo
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)'
allOf:
- $ref: '#/components/schemas/NameAddressPhone'
Tax1099Ltc:
title: Form 1099-LTC
x-stoplight:
id: 46olq1y3f38xn
description: Long-Term Care and Accelerated Death Benefits
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1099LtcDetails
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:
title: InsuredNameAndAddress
allOf:
- $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
Tax1099Misc:
title: Form 1099-MISC
x-stoplight:
id: 0y7ksv3vmyg8v
description: Miscellaneous Income
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1099MiscDetails
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:
title: Tax1099MiscStateAndLocal
description: 'Boxes 16-18, State and Local tax withholding'
allOf:
- $ref: '#/components/schemas/stateAndLocal'
Tax1099Nec:
title: Form 1099-NEC
x-stoplight:
id: 0bttr2g8i8asf
description: Non-Employee Compensation
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1099NecDetails
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:
title: Tax1099NecStateAndLocal
description: 'Boxes 5-7, State and Local tax withholding'
allOf:
- $ref: '#/components/schemas/stateAndLocal'
Tax1099Oid:
title: Form 1099-OID
x-stoplight:
id: m382j0epdj5an
description: Original Issue Discount
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1099OidDetails
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:
title: Form1099OidStateAndLocal
description: 'Boxes 12-14, State and Local tax withheld'
allOf:
- $ref: '#/components/schemas/stateAndLocal'
stateExemptOid:
description: 'Supplemental: State name and tax-exempt OID by state'
type: array
title: StateExemptOid
items:
$ref: '#/components/schemas/DescriptionAmount'
secondTinNotice:
type: boolean
description: Second TIN Notice
Tax1099Patr:
title: Form 1099-PATR
x-stoplight:
id: 95544t733g7at
description: Taxable Distributions Received From Cooperatives
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1099PatrDetails
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:
title: IRISStateAndLocalTaxWithholding
description: 'State and Local tax withholding, from IRS''s IRIS schema'
allOf:
- $ref: '#/components/schemas/StateAndLocalTaxWithholding'
secondTinNotice:
type: boolean
description: Second TIN Notice
Tax1099Q:
title: Form 1099-Q
x-stoplight:
id: wwl1rztudb3v3
description: Payments From Qualified Education Programs
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1099QDetails
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
Tax1099Qa:
title: Form 1099-QA
x-stoplight:
id: p7qm6axhk5gys
description: Distributions From ABLE Accounts
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1099QaDetails
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'
Tax1099R:
title: Form 1099-R
x-stoplight:
id: wrkyl8unrh9on
description: 'Distributions from Pensions, Annuities, Retirement or Profit-Sharing Plans, IRAs, Insurance Contracts, etc.'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1099RDetails
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
title: DistributionCodes
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:
title: Form1099RStateAndLocal
description: 'Boxes 14-19, State and Local tax withholding'
allOf:
- $ref: '#/components/schemas/stateAndLocal'
Tax1099S:
title: Form 1099-S
x-stoplight:
id: fxy9qet27s9ny
description: Proceeds From Real Estate Transactions
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1099SDetails
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
Tax1099Sa:
title: Form 1099-SA
x-stoplight:
id: 3hkxev8scjr94
description: 'Distributions From an HSA, Archer MSA, or Medicare Advantage MSA'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1099SaDetails
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'
Tax1099Sb:
title: Form 1099-SB
x-stoplight:
id: y2yl55gfi11wc
description: Seller's Investment in Life Insurance Contract
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1099SbDetails
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:
title: IssuerNameAddressInfo
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)'
allOf:
- $ref: '#/components/schemas/NameAddressPhone'
Tax1120SK1:
title: Form 1120-S K-1
x-stoplight:
id: mwhueysasi60a
description: 'Shareholder''s Share of Income, Deductions, Credits, etc.'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax1120SK1Details
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)'
title: Tax1120SK1OtherIncome
allOf:
- $ref: '#/components/schemas/otherIncome'
section179Deduction:
description: 'Box 11, Section 179 deduction'
type: number
otherDeductions:
$ref: '#/components/schemas/otherDeductions'
credits:
description: 'Box 13, Credits'
title: Tax1120SK1Credits
allOf:
- $ref: '#/components/schemas/credits'
scheduleK3:
description: 'Box 14, Schedule K-3 is attached'
type: boolean
amtItems:
$ref: '#/components/schemas/amtItems'
basisItems:
description: 'Box 16, Items affecting shareholder basis'
type: array
title: BasisItems
items:
$ref: '#/components/schemas/CodeAmount'
otherInfo:
title: Tax1120SK1OtherInfo
description: 'Box 17, Other information'
allOf:
- $ref: '#/components/schemas/otherInfo'
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
Tax2439:
title: Form 2439
x-stoplight:
id: zxvt6si8mpntc
description: Notice to Shareholder of Undistributed Long-Term Capital Gains
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax2439Details
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
Tax3921:
title: Form 3921
x-stoplight:
id: erzeak2n0sgxx
description: Exercise of an Incentive Stock Option Under Section 422(b)
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax3921Details
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:
title: CorporationData
description: 'Box 6, If other than TRANSFEROR, name, address and tin of corporation whose stock is being transferred'
allOf:
- $ref: '#/components/schemas/TaxParty'
Tax3922:
title: Form 3922
x-stoplight:
id: 692mwt1boei1a
description: Transfer of Stock Acquired Through an Employee Stock Purchase Plan under Section 423(c)
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax3922Details
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'
Tax5227K1:
title: Form 5227-K1
x-stoplight:
id: bldeb3hpq1glj
description: 'Split-Interest Trust Beneficiary''s schedule K-1, uses Tax1041K1 entity'
type: object
allOf:
- $ref: '#/components/schemas/Tax1041K1'
Tax5498:
title: Form 5498
x-stoplight:
id: lry9f6kgwczqi
description: IRA Contribution Information
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax5498Details
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
Tax5498Esa:
title: Form 5498-ESA
x-stoplight:
id: ycmnpak2t1afr
description: Coverdell ESA Contribution Information
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax5498EsaDetails
properties:
accountNumber:
description: Account number
type: string
coverdellEsaContributions:
description: 'Box 1, Coverdell ESA contributions'
type: number
rolloverContributions:
description: 'Box 2, Rollover contributions'
type: number
Tax5498Qa:
title: Form 5498-QA
x-stoplight:
id: nyfx2n1j8ou98
description: ABLE Account Contribution Information
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax5498QaDetails
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'
Tax5498Sa:
title: Form 5498-SA
x-stoplight:
id: qnir41zh4v887
description: 'HSA, Archer MSA, or Medicare Advantage (MA) MSA Information'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: Tax5498SaDetails
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'
TaxFormAttribute:
title: Tax Form Attribute
x-stoplight:
id: s8ndhz79kj96r
description: An additional tax form attribute for use when a defined field is not available
type: object
allOf:
- $ref: '#/components/schemas/fiAttribute'
- type: object
title: TaxFormAttributeDetails
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'
taxLots:
type: array
x-stoplight:
id: ppgc2tnjl9gh3
uniqueItems: true
minItems: 1
description: Breakdown by tax lot.
items:
title: Items
type: object
properties:
costBasis:
title: CostBasis
type: number
description: Total amount of money spent acquiring this lot including any fees or commission expenses incurred.
currentValue:
title: CurrentValue
type: number
description: Lot market value
originalPurchaseDate:
title: OriginalPurchaseDate
type: string
format: date-time
description: Lot acquired date.
positionType:
$ref: '#/components/schemas/positionType'
purchasedPrice:
title: PurchasedPrice
type: number
description: Original purchase price.
quantity:
title: Quantity
type: number
description: Lot quantity.
TaxParty:
title: Tax Party
x-stoplight:
id: 1ths5bqgadd9p
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:
title: RecipientOrIssuerName
allOf:
- $ref: '#/components/schemas/IndividualName'
description: Individual issuer or recipient name
businessName:
$ref: '#/components/schemas/BusinessName'
address:
title: RecipientAddress
allOf:
- $ref: '#/components/schemas/Address'
description: Issuer or recipient address
phone:
title: RecipientOrIssuerPhone
allOf:
- $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
TaxPartyType:
title: Tax Party Type
x-stoplight:
id: mdyv8jxvtzhna
description: 'Type of issuer or recipient legal entity, as "BUSINESS" or "INDIVIDUAL". Commonly BUSINESS for issuer and INDIVIDUAL for recipient'
type: string
enum:
- BUSINESS
- INDIVIDUAL
TaxRefundDirectDeposit:
title: Tax Refund Direct Deposit
x-stoplight:
id: xa8d68hhskam6
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
TaxStatement:
title: Tax Statement
x-stoplight:
id: 5fvaua2qjs2v2
description: The TaxStatement json for a single tax document containing one or more tax reporting forms for the customer
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:
title: IssuerData
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'
allOf:
- $ref: '#/components/schemas/TaxParty'
recipient:
title: RecipientData
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'
allOf:
- $ref: '#/components/schemas/TaxParty'
taxDataType:
title: TaxStatementDataType
description: Whether this `application/json` tax form response contains data in `forms` property (as 'JSON' format) or `pdf` property (as 'BASE64_PDF' format)
allOf:
- $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
title: Forms
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
allOf:
- $ref: '#/components/schemas/fiAttributes'
title: TaxStatementAttributes
TaxStatementList:
title: Tax Statement List
x-stoplight:
id: z2g7sr82fm7tr
description: Tax statement list containing one or more tax statements
type: object
properties:
statements:
type: array
title: Statements
description: The list of tax statements
items:
$ref: '#/components/schemas/TaxStatement'
TaxW2:
title: Form W-2
x-stoplight:
id: 5nro03kz8kuk3
description: Wage and Tax Statement
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: TaxW2Details
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
title: Codes
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
title: Other
items:
$ref: '#/components/schemas/DescriptionAmount'
stateAndLocal:
description: 'Boxes 15-20, State and Local tax withholding'
title: TaxW2StateAndLocal
allOf:
- $ref: '#/components/schemas/stateAndLocal'
TaxW2C:
title: Form W-2c
x-stoplight:
id: p93tm4geqm81x
description: 'IRS form W-2c, Corrected Wage and Tax Statement'
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: TaxW2CDetails
properties:
correctedTinOrName:
description: 'Box e, Corrected SSN and/or name'
type: boolean
previousEmployeeTin:
description: 'Box f, Employee''s previously reported SSN'
type: string
previousEmployeeName:
title: PreviousEmployeeName
description: 'Box g, Employee''s previously reported name'
allOf:
- $ref: '#/components/schemas/IndividualName'
originalW2:
title: OriginalW2
description: Boxes 1-20 of Previously reported Wage and Tax Statement
allOf:
- $ref: '#/components/schemas/TaxW2'
correctedW2:
title: CorrectedW2
description: Boxes 1-20 of Correct information Wage and Tax Statement
allOf:
- $ref: '#/components/schemas/TaxW2'
TaxW2G:
title: Form W-2G
x-stoplight:
id: xopajabr0kdl6
description: Certain Gambling Winnings
type: object
allOf:
- $ref: '#/components/schemas/Tax'
- type: object
title: TaxW2GDetails
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:
title: TaxW2GStateAndLocal
description: 'Boxes 13-18, State and Local tax withholding, use income fields for state (box 14) and local (box 16) winnings amounts'
allOf:
- $ref: '#/components/schemas/stateAndLocal'
TaxYear:
title: Tax Year Type
x-stoplight:
id: va320dt5k2k3q
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
TelephoneNumber:
title: Telephone Number
x-stoplight:
id: hzo24e1tsyjqw
description: Standard for international phone numbers
type: object
properties:
type:
$ref: '#/components/schemas/TelephoneNumberType'
country:
title: CountryCallingCode
allOf:
- $ref: '#/components/schemas/Iso3166CountryCode'
- example: US
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
TelephoneNumberPlusExtension:
title: Telephone Number Plus Extension
x-stoplight:
id: v2vdac5wm0ktd
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
title: TelephoneNumberPlusExtensionDetails
properties:
extension:
description: An arbitrary length telephone number extension
type: string
TelephoneNumberType:
title: Telephone Number Type
x-stoplight:
id: iaqzozdrwcunn
description: 'Type of phone number: HOME, BUSINESS, CELL, FAX'
type: string
enum:
- BUSINESS
- CELL
- FAX
- HOME
- PRIMARY
- SECONDARY
unitType:
type: string
x-stoplight:
id: gcmxdg5r3f8g8
enum:
- CURRENCY
- SHARES
description: Type of unit.
vesting:
title: Vesting Entity
x-stoplight:
id: jrtk595rumut8
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.'
Version:
type: string
x-stoplight:
id: 7nqfdv3sgt0gu
enum:
- v2
default: v2
accountContact:
title: Account Contact entity
x-stoplight:
id: nau80x6cm85xk
description: Contact information for the account
type: object
properties:
holders:
type: array
title: Holders
items:
$ref: '#/components/schemas/accountHolder'
description: Owners of the account
emails:
type: array
title: Emails
items:
type: string
description: Email addresses associated with the account
addresses:
type: array
title: DeliveryAddresses
items:
$ref: '#/components/schemas/deliveryAddress'
telephones:
type: array
title: TelephoneNumbers
description: Telephone numbers associated with the account.
items:
$ref: '#/components/schemas/TelephoneNumber'
accountHolder:
title: Account Holder entity
x-stoplight:
id: fc92isux6q4h2
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
title: AccountHolderDetails
properties:
relationship:
title: AccountHolderEntityRelationship
type: string
enum:
- PRIMARY
- JOINT
- AUTHORIZED_USER
description: Customer's relationship to the account
accountHolderRelationship:
title: Account Holder Relationship
x-stoplight:
id: jkrj6afnracuc
description: Customer's relationship to the account
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
businessCustomer:
title: Business Customer entity
x-stoplight:
id: 581bqc00xktu9
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
title: RegisteredAgents
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
title: IndustryCode
type: object
properties:
type:
type: string
code:
type: string
domicile:
title: Domicile
description: The country and region of the business customer's location
type: object
properties:
region:
type: string
country:
type: string
customerName:
title: CustomerName
x-stoplight:
id: ldaa69rth3g4i
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
currentCustomer:
title: Current customer
x-stoplight:
id: a61jbkerzl6rw
type: object
properties:
customer:
$ref: '#/components/schemas/customer'
deliveryAddress:
description: Physical mail address associated with the account
x-stoplight:
id: w6qxv7mcl7s2l
allOf:
- type: object
$ref: '#/components/schemas/Address'
- type: object
title: DeliveryAddressDetails
properties:
type:
type: string
enum:
- BUSINESS
- HOME
- MAILING
- PRIMARY
- SECONDARY
- LEGAL
description: Type of address location.
statements:
type: array
items:
allOf:
- $ref: '#/components/schemas/paginatedArray'
- type: object
properties:
statements:
type: array
items:
$ref: '#/components/schemas/statement'
statement:
type: object
description: An account statement with links to retrieve the statement document.
required:
- accountId
- statementId
- statementDate
- status
- links
properties:
accountId:
type: string
description: The unique identifier of the account associated with the statement.
statementId:
type: string
description: The unique identifier of the statement.
statementDate:
type: string
format: date-time
description: The statement date in ISO 8601 format.
description:
type: string
description: A human-readable description of the statement.
status:
type: string
description: The availability status of the statement.
example: AVAILABLE
links:
type: array
description: Links to retrieve the statement content in supported formats.
items:
$ref: '#/components/schemas/statementLink'
statementLink:
type: object
required:
- href
- action
- types
properties:
href:
type: string
format: uri
description: The URL to retrieve the statement.
action:
type: string
description: The HTTP method to use with the link.
example: GET
types:
type: array
description: Supported media types for the statement retrieval.
items:
type: string
example:
- application/pdf
- image/jpeg
- image/png
parameters:
accept:
name: accept
in: header
description: 'Other values include image/gif, image/tiff, etc'
schema:
$ref: '#/components/schemas/Accept'
type: string
accept-tax:
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:
$ref: '#/components/schemas/acceptMediaType'
examples:
Only JSON data:
value:
- application/json
Multiple types accepted:
value:
- application/json
accountId:
name: accountId
in: query
description: Unique account identifier (not the account number)
schema:
$ref: '#/components/schemas/accountId'
accountIds:
name: accountIds
in: query
description: Comma-separated list of accountIds
schema:
type: string
accountIdPath:
name: accountId
in: path
description: Account Identifier
required: true
schema:
type: string
default: ':accountId'
content-type:
name: content-type
in: header
description: Application/JSON
schema:
$ref: '#/components/schemas/Content-Type'
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:
title: EndTimeQuery
type: string
format: date-time
example: '2021-03-30T04:00:00Z'
holdingIdPath:
name: holdingId
in: path
description: Consumer's holdingId under investments
required: true
schema:
type: string
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:
title: StartTimeQuery
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 v3 and not v3.1'
required: true
schema:
type: string
default: v3
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:
title: LimitQuery
type: string
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:
title: OffsetQuery
type: string
default: '0'
endDateQuery:
name: endTime
in: query
description: End date for use in retrieval of statements (ISO 8601)
schema:
type: string
example: '2021-03-30T04:00:00Z'
format: date-time
mode:
name: mode
in: query
description: 'Default is raw. Use standard for FDX-aligned, standardized data values.'
schema:
$ref: '#/components/schemas/Mode'
type: string
startDateQuery:
name: startTime
in: query
description: Start date for use in retrieval of statements (ISO 8601)
schema:
type: string
example: '2020-03-30T04:00:00Z'
format: date-time
taxDataType:
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
taxFormId:
name: taxFormId
in: path
description: Unique identifier of the tax form to request.
schema:
$ref: '#/components/schemas/taxFormId'
required: true
taxForms:
name: taxForms
in: query
style: form
explode: false
description: One or more tax form type enums for the specific documents being requested. Comma separated.
schema:
$ref: '#/components/schemas/taxForms'
example:
- Tax1099Div
- Tax1099Int
taxYear:
name: taxYear
in: query
description: Tax year in which to search for tax forms.
schema:
$ref: '#/components/schemas/taxYear'
type: string
example: '2024'
x-akoya-interaction-id:
name: x-akoya-interaction-id
in: header
description: Unique identifier to associate with this request. No specific format required.
schema:
$ref: '#/components/schemas/interactionId'
type: string
example: unique-request-id-001
x-akoya-interaction-type:
name: x-akoya-interaction-type
in: header
description: 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:
$ref: '#/components/schemas/interactionType'
type: string
required: true
x-akoya-last-access:
name: x-akoya-last-access
in: header
description: "The date and time stamp for the last active use by the user. Follow the ISO8601 date format in the UTC time zone. For example: `2025-11-24T00:00:00Z`"
schema:
$ref: '#/components/schemas/lastAccess'
type: string
required: true
x-akoya-intent-type:
name: x-akoya-intent-type
in: header
description: Acceptable values are `payments` or `nonpayments.`
schema:
$ref: '#/components/schemas/intentType'
type: string
required: true
x-internal: true
x-readme:
explorer-enabled: true
proxy-enabled: true