openapi: 3.1.0
info:
  title: Abound API - v4 1099-INT API
  version: '4'
  description: 'Abound was a US tax-compliance API for platforms and marketplaces: W-9 / W-8BEN / W-8BEN-E collection, real-time TIN verification against the IRS, and generation, filing, correction, voiding and physical mailing of Form 1099-NEC, 1099-MISC, 1099-K and 1099-INT with federal and state tax authorities.


    NOTE: This document is a mechanical conversion of the first-party Fern API Definition that Abound shipped inside its official npm package @withabound/node-sdk (v6.0.68). Abound was acquired and the service has been retired: the withabound.com DNS zone is fully de-delegated and the API hosts no longer resolve. This spec is preserved as a historical record of the API surface.'
  x-status: retired
servers:
- url: https://production-api.withabound.com
  description: Production (retired - host no longer resolves)
- url: https://sandbox-api.withabound.com
  description: Sandbox (retired - host no longer resolves)
security:
- bearerAuth: []
tags:
- name: 1099-INT
paths:
  /v4/documents/1099-int:
    get:
      operationId: form1099IntList
      tags:
      - 1099-INT
      summary: List all 1099-INT documents
      description: Returns a list of 1099-INT documents.
      parameters:
      - name: page
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Page'
      - name: filingYear
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/FilingYear'
      - name: payeeTinFingerprint
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/PayeeTinFingerprint'
      - name: payerTinFingerprint
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/PayerTinFingerprint'
      - name: status
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Form1099StatusEnum'
      - name: userId
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/UserId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Form1099IntSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequestSchema'
              example:
                errors:
                - field: metadata.key
                  message: Expected metadata.key to be of type string, but received number
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorSchema'
              example:
                message: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorSchema'
              example:
                message: Not Found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorSchema'
              example:
                message: Internal Server Error
    post:
      operationId: form1099IntCreate
      tags:
      - 1099-INT
      summary: Create a 1099-INT
      description: Creates a 1099-INT document and subsequently kicks off a TIN Verification, if the name and TIN combo has not been used before.
      parameters:
      - name: Idempotency-Key
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Form1099IntRequestSchema'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Form1099IntSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequestSchema'
              example:
                errors:
                - field: metadata.key
                  message: Expected metadata.key to be of type string, but received number
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorSchema'
              example:
                message: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorSchema'
              example:
                message: Not Found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorSchema'
              example:
                message: Internal Server Error
  /v4/documents/1099-int/{documentId}:
    get:
      operationId: form1099IntRetrieve
      tags:
      - 1099-INT
      summary: Retrieve a 1099-INT
      description: Retrieves the details of an existing 1099-INT document.
      parameters:
      - name: documentId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/DocumentId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Form1099IntSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequestSchema'
              example:
                errors:
                - field: metadata.key
                  message: Expected metadata.key to be of type string, but received number
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorSchema'
              example:
                message: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorSchema'
              example:
                message: Not Found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorSchema'
              example:
                message: Internal Server Error
    delete:
      operationId: form1099IntDelete
      tags:
      - 1099-INT
      summary: Delete a 1099-INT
      description: Deletes a 1099-INT document. Once an action (`/file`, `/correct`, `/void`) has been executed on a 1099-INT, it cannot be deleted.
      parameters:
      - name: documentId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/DocumentId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OkSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequestSchema'
              example:
                errors:
                - field: metadata.key
                  message: Expected metadata.key to be of type string, but received number
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorSchema'
              example:
                message: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorSchema'
              example:
                message: Not Found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorSchema'
              example:
                message: Internal Server Error
  /v4/documents/1099-int/{documentId}/correct:
    post:
      operationId: form1099IntCorrect
      tags:
      - 1099-INT
      summary: Correct a 1099-INT
      description: Files a new corrected 1099-INT and relates it to the original document. A 1099-INT can be corrected only after it has reached the `FILED` status. Automatically handles both one-transaction and two-transaction corrections.
      parameters:
      - name: documentId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/DocumentId'
      - name: Idempotency-Key
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Form1099IntCorrectRequestSchema'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Form1099IntSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequestSchema'
              example:
                errors:
                - field: metadata.key
                  message: Expected metadata.key to be of type string, but received number
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorSchema'
              example:
                message: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorSchema'
              example:
                message: Not Found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorSchema'
              example:
                message: Internal Server Error
  /v4/documents/1099-int/{documentId}/file:
    post:
      operationId: form1099IntFile
      tags:
      - 1099-INT
      summary: File a 1099-INT
      description: Files a 1099-INT document.
      parameters:
      - name: documentId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/DocumentId'
      - name: Idempotency-Key
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/IdempotencyKey'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Form1099IntSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequestSchema'
              example:
                errors:
                - field: metadata.key
                  message: Expected metadata.key to be of type string, but received number
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorSchema'
              example:
                message: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorSchema'
              example:
                message: Not Found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorSchema'
              example:
                message: Internal Server Error
  /v4/documents/1099-int/{documentId}/mail:
    post:
      operationId: form1099IntMail
      tags:
      - 1099-INT
      summary: Mail a 1099-INT
      description: Mails a 1099-INT document.
      parameters:
      - name: documentId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/DocumentId'
      - name: Idempotency-Key
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MailingRequestSchema'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailingSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequestSchema'
              example:
                errors:
                - field: metadata.key
                  message: Expected metadata.key to be of type string, but received number
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorSchema'
              example:
                message: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorSchema'
              example:
                message: Not Found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorSchema'
              example:
                message: Internal Server Error
  /v4/documents/1099-int/{documentId}/void:
    post:
      operationId: form1099IntVoid
      tags:
      - 1099-INT
      summary: Void a 1099-INT
      description: Files a new voided 1099-INT and relates it to the original document. A 1099-INT can be voided only after it has reached the `FILED` status.
      parameters:
      - name: documentId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/DocumentId'
      - name: Idempotency-Key
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/IdempotencyKey'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Form1099IntSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequestSchema'
              example:
                errors:
                - field: metadata.key
                  message: Expected metadata.key to be of type string, but received number
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorSchema'
              example:
                message: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorSchema'
              example:
                message: Not Found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorSchema'
              example:
                message: Internal Server Error
components:
  schemas:
    Form1099FilingStateEnum:
      type: string
      enum:
      - AK
      - AL
      - AR
      - AZ
      - CA
      - CO
      - CT
      - DC
      - DE
      - FL
      - GA
      - HI
      - IA
      - ID
      - IL
      - IN
      - KY
      - KS
      - LA
      - MA
      - MD
      - ME
      - MI
      - MN
      - MO
      - MS
      - MT
      - N/A
      - NC
      - ND
      - NE
      - NH
      - NJ
      - NM
      - NV
      - NY
      - OH
      - OK
      - OR
      - PA
      - RI
      - SC
      - SD
      - TN
      - TX
      - UT
      - VA
      - VT
      - WA
      - WI
      - WV
      - WY
      description: The filing state code. The abbreviation of the state (`CA` for California). If a state filing is not desired, use `N/A`.
    Form1099IntCorrectRequestSchema:
      allOf:
      - $ref: '#/components/schemas/Form1099BaseCorrectRequestSchema'
      - type: object
        properties:
          formFields:
            $ref: '#/components/schemas/Form1099IntFormFieldsRequestSchema'
        required:
        - formFields
      examples:
      - payee:
          name: Ada Lovelace
          tin: '000000000'
          address: 1401 N Shoreline Blvd
          address2: Suite 1
          city: Mountain View
          state: CA
          postalCode: '94043'
          country: US
        formFields:
          bondPremium: 19423
          bondPremiumTaxExemptBond: 19423
          bondPremiumTreasury: 19423
          earlyWithdrawalPenalty: 23223
          foreignTaxPaid: 19423
          foreignTaxPaidCountry: FR
          hasFatcaFilingRequirement: true
          interestIncome: 10000
          investmentExpenses: 19423
          marketDiscount: 19423
          payersRoutingNumber: '054000030'
          specifiedPrivateActivityBondInterest: 19423
          taxExemptInterest: 19423
          usSavingsBondsInterest: 19423
          federalIncomeTaxWithheld: 0
          accountNumber: A006SVmcrieFAbm3gsaV
          stateTaxInfo:
          - filingState: CA
    OkSchema:
      type: object
      additionalProperties: {}
    Form1099IntSchema:
      allOf:
      - $ref: '#/components/schemas/Form1099BaseSchema'
      - type: object
        properties:
          formFields:
            $ref: '#/components/schemas/Form1099IntFormFieldsSchema'
        required:
        - formFields
      examples:
      - id: documentId_samplepWpJ9Snlzb
        formFields:
          isCorrected: false
          isVoid: false
          bondPremium: 19423
          bondPremiumTaxExemptBond: 19423
          bondPremiumTreasury: 19423
          earlyWithdrawalPenalty: 23223
          foreignTaxPaid: 19423
          foreignTaxPaidCountry: FR
          hasFatcaFilingRequirement: true
          interestIncome: 83232
          investmentExpenses: 19423
          marketDiscount: 19423
          payersRoutingNumber: '054000030'
          specifiedPrivateActivityBondInterest: 19423
          taxExemptInterest: 19423
          usSavingsBondsInterest: 19423
          federalIncomeTaxWithheld: 0
          accountNumber: A006SVmcrieFAbm3gsaV
          stateTaxInfo:
          - filingState: CA
            stateTaxWithheld: 0
        filingYear: 2024
        createdAt: '2024-01-01T00:00:00.000Z'
        status: CREATED
        payer:
          name: Hooli
          address: 256 Byron Street
          address2: Suite 32
          city: Palo Alto
          state: CA
          postalCode: '94306'
          country: US
          phoneNumber: '+16501014096'
          tin: '*******11'
          tinType: BUSINESS
          tinFingerprint: tinFingerprint_sample847jI1LwxF
          tinVerificationId: tinVerificationId_sample1b0E6efa89
          tinVerificationStatus: MATCH
        payee:
          name: Ada Lovelace
          address: 1401 N Shoreline Blvd
          address2: Suite 1
          city: Mountain View
          state: CA
          postalCode: '94043'
          country: US
          tin: '*******00'
          tinType: INDIVIDUAL
          tinFingerprint: tinFingerprint_samplehy2BWO6JJG
          tinVerificationId: tinVerificationId_sample41SD71AV8f
          tinVerificationStatus: MATCH
        payerUrl: https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-1099-INT-COPY-C.pdf
        payeeUrl: https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-1099-INT-COPY-B.pdf
      - id: documentId_samplepWpJ9Snlzb
        formFields:
          isCorrected: false
          isVoid: false
          bondPremium: 19423
          bondPremiumTaxExemptBond: 19423
          bondPremiumTreasury: 19423
          earlyWithdrawalPenalty: 23223
          foreignTaxPaid: 19423
          foreignTaxPaidCountry: FR
          hasFatcaFilingRequirement: true
          interestIncome: 83232
          investmentExpenses: 19423
          marketDiscount: 19423
          payersRoutingNumber: '054000030'
          specifiedPrivateActivityBondInterest: 19423
          taxExemptInterest: 19423
          usSavingsBondsInterest: 19423
          federalIncomeTaxWithheld: 0
          accountNumber: A006SVmcrieFAbm3gsaV
          stateTaxInfo:
          - filingState: CA
            stateTaxWithheld: 0
        filingYear: 2024
        createdAt: '2024-01-01T00:00:00.000Z'
        status: FILED
        payer:
          name: Hooli
          address: 256 Byron Street
          address2: Suite 32
          city: Palo Alto
          state: CA
          postalCode: '94306'
          country: US
          phoneNumber: '+16501014096'
          tin: '*******11'
          tinType: BUSINESS
          tinFingerprint: tinFingerprint_sample847jI1LwxF
          tinVerificationId: tinVerificationId_sample1b0E6efa89
          tinVerificationStatus: MATCH
        payee:
          name: Ada Lovelace
          address: 1401 N Shoreline Blvd
          address2: Suite 1
          city: Mountain View
          state: CA
          postalCode: '94043'
          country: US
          tin: '*******00'
          tinType: INDIVIDUAL
          tinFingerprint: tinFingerprint_samplehy2BWO6JJG
          tinVerificationId: tinVerificationId_sample41SD71AV8f
          tinVerificationStatus: MATCH
        payerUrl: https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-1099-INT-COPY-C.pdf
        payeeUrl: https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-1099-INT-COPY-B.pdf
      - id: documentId_samplexc6Aw2Qr9R
        correctedFromId: documentId_samplepWpJ9Snlzb
        formFields:
          isCorrected: true
          isVoid: false
          bondPremium: 19423
          bondPremiumTaxExemptBond: 19423
          bondPremiumTreasury: 19423
          earlyWithdrawalPenalty: 23223
          foreignTaxPaid: 19423
          foreignTaxPaidCountry: FR
          hasFatcaFilingRequirement: true
          interestIncome: 10000
          investmentExpenses: 19423
          marketDiscount: 19423
          payersRoutingNumber: '054000030'
          specifiedPrivateActivityBondInterest: 19423
          taxExemptInterest: 19423
          usSavingsBondsInterest: 19423
          federalIncomeTaxWithheld: 0
          accountNumber: A006SVmcrieFAbm3gsaV
          stateTaxInfo:
          - filingState: CA
            stateTaxWithheld: 0
        filingYear: 2024
        createdAt: '2024-01-01T00:00:00.000Z'
        status: FILED
        payer:
          name: Hooli
          address: 256 Byron Street
          address2: Suite 32
          city: Palo Alto
          state: CA
          postalCode: '94306'
          country: US
          phoneNumber: '+16501014096'
          tin: '*******11'
          tinType: BUSINESS
          tinFingerprint: tinFingerprint_sample847jI1LwxF
          tinVerificationId: tinVerificationId_sample1b0E6efa89
          tinVerificationStatus: MATCH
        payee:
          name: Ada Lovelace
          address: 1401 N Shoreline Blvd
          address2: Suite 1
          city: Mountain View
          state: CA
          postalCode: '94043'
          country: US
          tin: '*******00'
          tinType: INDIVIDUAL
          tinFingerprint: tinFingerprint_samplehy2BWO6JJG
          tinVerificationId: tinVerificationId_sample41SD71AV8f
          tinVerificationStatus: MATCH
        payerUrl: https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-1099-INT-CORRECTED-COPY-C.pdf
        payeeUrl: https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-1099-INT-CORRECTED-COPY-B.pdf
      - id: documentId_sampleVwRnewIBMu
        voidedFromId: documentId_samplepWpJ9Snlzb
        formFields:
          isCorrected: false
          isVoid: true
          bondPremium: 19423
          bondPremiumTaxExemptBond: 19423
          bondPremiumTreasury: 19423
          earlyWithdrawalPenalty: 23223
          foreignTaxPaid: 19423
          foreignTaxPaidCountry: FR
          hasFatcaFilingRequirement: true
          interestIncome: 83232
          investmentExpenses: 19423
          marketDiscount: 19423
          payersRoutingNumber: '054000030'
          specifiedPrivateActivityBondInterest: 19423
          taxExemptInterest: 19423
          usSavingsBondsInterest: 19423
          federalIncomeTaxWithheld: 0
          accountNumber: A006SVmcrieFAbm3gsaV
          stateTaxInfo:
          - filingState: CA
            stateTaxWithheld: 0
        filingYear: 2024
        createdAt: '2024-01-01T00:00:00.000Z'
        status: FILED
        payer:
          name: Hooli
          address: 256 Byron Street
          address2: Suite 32
          city: Palo Alto
          state: CA
          postalCode: '94306'
          country: US
          phoneNumber: '+16501014096'
          tin: '*******11'
          tinType: BUSINESS
          tinFingerprint: tinFingerprint_sample847jI1LwxF
          tinVerificationId: tinVerificationId_sample1b0E6efa89
          tinVerificationStatus: MATCH
        payee:
          name: Ada Lovelace
          address: 1401 N Shoreline Blvd
          address2: Suite 1
          city: Mountain View
          state: CA
          postalCode: '94043'
          country: US
          tin: '*******00'
          tinType: INDIVIDUAL
          tinFingerprint: tinFingerprint_samplehy2BWO6JJG
          tinVerificationId: tinVerificationId_sample41SD71AV8f
          tinVerificationStatus: MATCH
        payerUrl: https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-1099-INT-VOID-COPY-C.pdf
        payeeUrl: https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-1099-INT-VOID-COPY-B.pdf
    IdempotencyKey:
      type: string
      description: The unique key used to identify a request that has already been processed.
    PayerRequestSchema:
      allOf:
      - $ref: '#/components/schemas/AddressSchema'
      - type: object
        properties:
          name:
            type: string
            description: The payer's legal name (first + last) or business name.
          name2:
            type: string
            description: The payer's trade name, DBA name, or disregarded entity name, if different from `name`.
          tin:
            type: string
            description: The payer's tax identification number, commonly referred to as a TIN. No hyphens. Numerical digits only. Alternatively, you may pass the corresponding `tinFingerprint`.
            minLength: 9
            maxLength: 9
          phoneNumber:
            type: string
            description: The payer's phone number.
            pattern: ^\+?\d{10,15}$
        required:
        - name
        - phoneNumber
        - tin
      description: The payer of the document.
    MailingRequestToSchema:
      allOf:
      - $ref: '#/components/schemas/MailingNameSchema'
      - $ref: '#/components/schemas/AddressSchema'
      description: The mailing address of the recipient.
    Page:
      type: integer
      description: The specific page of results you're requesting. Responses are limited to a maximum of 100 records.
    FilingYear:
      type: integer
      description: The filing year associated with this document.
    TinTypeEnum:
      type: string
      enum:
      - INDIVIDUAL
      - BUSINESS
      description: The type of the TIN. `INDIVIDUAL` refers to SSNs, ITINs, or ATINs. While `BUSINESS` refers to EINs.
    MailingStatusEnum:
      type: string
      enum:
      - CREATED
      - PROCESSING_FOR_DELIVERY
      - IN_TRANSIT
      - DELIVERED
      - RETURNED_TO_SENDER
    Form1099BaseCorrectRequestSchema:
      type: object
      properties:
        userId:
          $ref: '#/components/schemas/UserId'
        payee:
          $ref: '#/components/schemas/PayeeRequestSchema'
      required:
      - payee
    TinFingerprint:
      type: string
      description: Your unique token that points to a TIN.
    PayerSchema:
      allOf:
      - $ref: '#/components/schemas/PayerRequestSchema'
      - type: object
        properties:
          tinFingerprint:
            $ref: '#/components/schemas/TinFingerprint'
          tinType:
            $ref: '#/components/schemas/TinTypeEnum'
          tinVerificationId:
            $ref: '#/components/schemas/TinVerificationId'
          tinVerificationStatus:
            $ref: '#/components/schemas/TinVerificationStatusEnum'
        required:
        - tinFingerprint
        - tinVerificationId
        - tinVerificationStatus
      description: The payer of the document.
    ErrorBadRequestSchema:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorBadRequestSchemaErrorsItem'
          description: The error message(s) associated with the response status code.
      required:
      - errors
    UserId:
      type: string
      description: The unique identifier for a single end-user of your application.
    MailingNameSchema:
      type: object
      properties:
        name:
          type: string
          description: The individual's name (first + last) or business name.
        name2:
          type: string
          description: The business name, trade name, DBA name, or disregarded entity name, if different from `name`.
    Form1099BaseRequestSchema:
      type: object
      properties:
        filingYear:
          $ref: '#/components/schemas/FilingYear'
        userId:
          $ref: '#/components/schemas/UserId'
        payer:
          $ref: '#/components/schemas/PayerRequestSchema'
        payee:
          $ref: '#/components/schemas/PayeeRequestSchema'
      required:
      - filingYear
      - payee
      - payer
    Form1099FormFieldsBaseSchema:
      type: object
      properties:
        isVoid:
          type: boolean
          description: If `true`, the void checkbox will be marked on the 1099 document.
        isCorrected:
          type: boolean
          description: If `true`, the corrected checkbox will be marked on the 1099 document.
      required:
      - isCorrected
      - isVoid
    TinVerificationStatusEnum:
      type: string
      enum:
      - MATCH
      - MISMATCH
      - PENDING
      description: The status of the TIN Verification.
    MailingRequestFromSchema:
      allOf:
      - $ref: '#/components/schemas/MailingNameSchema'
      - $ref: '#/components/schemas/AddressSchema'
      description: The mailing address of the sender.
    Form1099IntFormFieldsSchema:
      allOf:
      - $ref: '#/components/schemas/Form1099FormFieldsBaseSchema'
      - $ref: '#/components/schemas/Form1099IntFormFieldsRequestSchema'
    PayeeSchema:
      allOf:
      - $ref: '#/components/schemas/PayeeRequestSchema'
      - type: object
        properties:
          tinFingerprint:
            $ref: '#/components/schemas/TinFingerprint'
          tinType:
            $ref: '#/components/schemas/TinTypeEnum'
          tinVerificationId:
            $ref: '#/components/schemas/TinVerificationId'
          tinVerificationStatus:
            $ref: '#/components/schemas/TinVerificationStatusEnum'
        required:
        - tinFingerprint
        - tinVerificationId
        - tinVerificationStatus
      description: The payee of the document.
    Form1099StatusEnum:
      type: string
      enum:
      - CREATED
      - FILED
      - ACCEPTED
      - REJECTED
    Form1099BaseSchema:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/DocumentId'
        createdAt:
          type: string
          format: date-time
          description: The `ISO 8601` timestamp when the document was created.
        filingYear:
          $ref: '#/components/schemas/FilingYear'
        status:
          allOf:
          - $ref: '#/components/schemas/Form1099StatusEnum'
          description: 'The status of the 1099 document.<br/>&nbsp;&nbsp;• `CREATED`: The document has passed data validation and the PDFs have been generated.<br/>&nbsp;&nbsp;• `FILED`: The payee''s TIN has been verified and the 1099 has been filed with the appropriate tax authorities.<br/>&nbsp;&nbsp;• `ACCEPTED`: The document has been acknowledged and accepted by the appropriate tax authorities.<br/>&nbsp;&nbsp;• `REJECTED`: The document has a TIN verification `MISMATCH` or has been rejected by one or more tax authories.'
        payerUrl:
          type: string
          description: The URL to the payer's 1099 document. Both the Payer's and Payee's TINs are not masked in this document.
        payeeUrl:
          type: string
          description: The URL to the payee's 1099 document. The Payee's TIN is masked in this document. The Payer's TIN is not masked.
        payer:
          $ref: '#/components/schemas/PayerSchema'
        payee:
          $ref: '#/components/schemas/PayeeSchema'
        correctedById:
          type: string
          description: The `documentId` of the corrected 1099 document.
        correctedFromId:
          type: string
          description: The `documentId` of the original 1099 document.
        voidedById:
          type: string
          description: The `documentId` of the voided 1099 document.
        voidedFromId:
          type: string
          description: The `documentId` of the original 1099 document.
        userId:
          $ref: '#/components/schemas/UserId'
      required:
      - createdAt
      - filingYear
      - id
      - payee
      - payeeUrl
      - payer
      - payerUrl
      - status
    AddressSchema:
      type: object
      properties:
        address:
          type: string
          description: The legal address.
        address2:
          type: string
          description: The second part of the legal address, such as an apartment or suite number.
        city:
          type: string
          description: The city associated with the street address. Required if `country` is `US`.
        state:
          type: string
          description: The two-letter character code for this state or US territory (`CA` for California, `ME` for Maine, `PR` for Puerto Rico). Required if `country` is `US`. If foreign, use the province.
        postalCode:
          type: string
          description: The postal code associated with the street address. Required to be a 5-digit numerical value if `country` is `US`. If foreign, use the foreign postal code.
        country:
          type: string
          description: The country adhering to `ISO 3166-2` standards.
          minLength: 2
          maxLength: 2
      required:
      - address
      - country
    DocumentId:
      type: string
      description: The unique identifier for an existing document.
    Form1099IntRequestSchema:
      allOf:
      - $ref: '#/components/schemas/Form1099BaseRequestSchema'
      - type: object
        properties:
          formFields:
            $ref: '#/components/schemas/Form1099IntFormFieldsRequestSchema'
        required:
        - formFields
      examples:
      - filingYear: 2024
        payer:
          name: Hooli
          tin: '111111111'
          address: 256 Byron Street
          address2: Suite 32
          city: Palo Alto
          state: CA
          postalCode: '94306'
          country: US
          phoneNumber: '+16501014096'
        payee:
          name: Ada Lovelace
          tin: '000000000'
          address: 1401 N Shoreline Blvd
          address2: Suite 1
          city: Mountain View
          state: CA
          postalCode: '94043'
          country: US
        formFields:
          bondPremium: 19423
          bondPremiumTaxExemptBond: 19423
          bondPremiumTreasury: 19423
          earlyWithdrawalPenalty: 23223
          foreignTaxPaid: 19423
          foreignTaxPaidCountry: FR
          hasFatcaFilingRequirement: true
          interestIncome: 83232
          investmentExpenses: 19423
          marketDiscount: 19423
          payersRoutingNumber: '054000030'
          specifiedPrivateActivityBondInterest: 19423
          taxExemptInterest: 19423
          usSavingsBondsInterest: 19423
          federalIncomeTaxWithheld: 0
          accountNumber: A006SVmcrieFAbm3gsaV
          stateTaxInfo:
          - filingState: CA
            stateTaxWithheld: 0
    PayeeTinFingerprint:
      type: string
      description: Filters the list of documents based on the `payee.tinFingerprint` field.
    PayerTinFingerprint:
      type: string
      description: Filters the list of documents based on the `payer.tinFingerprint` field.
    PayeeRequestSchema:
      allOf:
      - $ref: '#/components/schemas/AddressSchema'
      - type: object
        properties:
          name:
            type: string
            description: The payee's legal name (first + last) or business name.
          name2:
            type: string
            description: The payee's trade name, DBA name, or disregarded entity name, if different from `name`.
          tin:
            type: string
            description: The payee's tax identification number, commonly referred to as a TIN. No hyphens. Numerical digits only. Alternatively, you may pass the corresponding `tinFingerprint`.
            minLength: 9
            maxLength: 9
        required:
        - name
        - tin
      description: The payee of the document.
    TinVerificationId:
      type: string
      description: The unique identifier for the TIN Verification.
    MailingSchema:
      allOf:
      - $ref: '#/components/schemas/MailingRequestSchema'
      - type: object
        properties:
          id:
            type: string
            description: The unique identifier for this mailing.
          createdAt:
            type: string
            format: date-time
            description: The creation date and time of the mailing in `ISO 8601` format.
          url:
            type: string
            description: The URL to the mailed document.
          status:
            allOf:
            - $ref: '#/components/schemas/MailingStatusEnum'
            description: The status of the mailing.
          userId:
            $ref: '#/components/schemas/UserId'
          mailedFromId:
            type: string
            description: The `documentId` of the mailed document.
        required:
        - createdAt
        - id
        - mailedFromId
        - status
        - url
      examples:
      - id: mailingId_sampleFV9b73IvAD
        createdAt: '2024-01-01T00:00:00.000Z'
        url: https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-1099-COPY-B.pdf
        status: CREATED
        to:
          address: 1401 N Shoreline Blvd
          address2: Suite 1
          city: Mountain View
          state: CA
          postalCode: '94043'
          country: US
          name: Ada Lovelace
        from:
          address: 256 Byron Street
          address2: Suite 32
          city: Palo Alto
          state: CA
          postalCode: '94306'
          country: US
          name: Hooli
        mailedFromId: documentId_sampletTtqNfulW8
    DefaultErrorSchema:
      type: object
      properties:
        message:
          type: string
          description: The error message associated with the response status code.
      required:
      - message
    Form1099StateTaxInfoSchema:
      type: object
      properties:
        filingState:
          $ref: '#/components/schemas/Form1099FilingStateEnum'
        payeeStateId:
          type: string
          description: The payee's state identification number.
          deprecated: true
        payerStateId:
          type: string
          description: The payer's state identification number.
          deprecated: true
        stateTaxWithheld:
          type: integer
          description: The state tax withheld. Value must be in cents. Abound does not currently support `stateTaxWithheld` reporting, please contact us for more information.
          minimum: 0
          maximum: 0
      required:
      - filingState
    Form1099IntFormFieldsRequestSchema:
      type: object
      properties:
        hasFatcaFilingRequirement:
          type: boolean
          description: Satisfying a requirement to report with respect to a U.S. account for chapter 4 purposes.
        accountNumber:
          type: string
          description: The IRS “encourages” a payer to designate an account number for all Form 1099-INT filed. This field is required if payer has multiple accounts for a recipient for whom it is filing more than one Form 1099-INT. This field is also required if `fatca` is `true`. Abound will auto-generated this field if not provided.
          maxLength: 20
        payersRoutingNumber:
          type: string
          description: A routing and transit number (RTN) is a unique nine-digit number used to identify a bank for purposes of directing financial flows. This is essentially bank's bank account - their account with the Federal Reserve.
          maxLength: 20
        interestIncome:
          type: integer
          description: The taxable interest paid to you during the calendar year by the payer. This does not include interest for `usSavingsBondsInterest`. May also show the total amount of the credits from clean renewable energy bonds, new clean renewable energy bonds, qualified energy conservation bonds, qualified zone academy bonds, qualified school construction bonds, and build America bonds that must be included in your interest income. Value must be in cents.
          minimum: 0
        earlyWithdrawalPenalty:
          type: integer
          description: The interest or principal forfeited because of early withdrawal of time savings. You may deduct this amount to figure your adjusted gross income on your income tax return. Value must be in cents.
          minimum: 0
        usSavingsBondsInterest:
          type: integer
          description: Shows interest on U.S. Savings Bonds, Treasury bills, Treasury bonds, and Treasury notes. This may or may not all be taxable. This interest is exempt from state and local income taxes. This interest is not included in `interestIncome`. Value must be in cents.
          minimum: 0
        federalIncomeTaxWithheld:
          type: integer
          description: The federal income tax withheld. A payer must backup withhold on certain payments if recipient did not provide a TIN to the payer. Value must be in cents. Abound does not currently support `federalIncomeTaxWithheld` reporting on the 1099-INT, please contact us for more information.
          minimum: 0
          maximum: 0
        investmentExpenses:
          type: integer
          description: 'Any amount is your share of investment expenses of a singleclass REMIC. This amount is included in `interestIncome`. *Note: This amount is not deductible.* Value must be in cents.'
          minimum: 0
        foreignTaxPaid:
          type: integer
          description: The foreign tax paid. Value must be in cents.
          minimum: 0
        foreignTaxPaidCountry:
          type: string
          description: The country or U.S. possession to which the foreign tax was paid.
          minLength: 2
          maxLength: 2
        taxExemptInterest:
          type: integer
          description: The tax-exempt interest paid to you during the calendar year by the payer. This amount may be subject to backup withholding. See `federalIncomeTaxWithheld` above. Value must be in cents.
          minimum: 0
        specifiedPrivateActivityBondInterest:
          type: integer
          description: The tax-exempt interest subject to the alternative minimum tax. This amount is included in `taxExemptInterest`. Value must be in cents.
          minimum: 0
        marketDiscount:
          type: integer
          description: For a taxable or tax-exempt covered security, if you made an election under section 1278(b) to include market discount in income as it accrues and you notified your payer of the election in writing in accordance with Regulations section 1.6045-1(n)(5), shows the market discount that accrued on the debt instrument during the year while held by you, unless it was reported on Form 1099-OID. Value must be in cents.
          minimum: 0
        bondPremium:
          type: integer
          description: For a taxable covered security (other than a U.S. Treasury obligation), shows the amount of premium amortization allocable to the interest payment(s), unless you notified the payer in writing in accordance with Regulations section 1.6045-1(n)(5) that you did not want to amortize bond premium under section 171. Value must be in cents.
          minimum: 0
        bondPremiumTreasury:
          type: integer
          description: For a U.S. Treasury obligation that is a covered security, shows the amount of premium amortization allocable to the interest payment(s), unless you notified the payer in writing in accordance with Regulations section 1.6045-1(n)(5) that you did not want to amortize bond premium under section 171. Value must be in cents.
          minimum: 0
        bondPremiumTaxExemptBond:
          type: integer
          description: For a tax-exempt covered security, shows the amount of premium amortization allocable to the interest payment(s). Value must be in cents.
          minimum: 0
        stateTaxInfo:
          type: array
          items:
            $ref: '#/components/schemas/Form1099StateTaxInfoSchema'
          description: An array that contains up to two state tax information objects. Abound currently only supports one state tax information object in this array. Abound does not currently support state-level tax withholding reporting on the 1099-INT, please contact us for more information.
      required:
      - stateTaxInfo
      description: The 1099-INT form fields.
    MailingRequestSchema:
      type: object
      properties:
        to:
          $ref: '#/components/schemas/MailingRequestToSchema'
        from:
          $ref: '#/components/schemas/MailingRequestFromSchema'
      required:
      - from
      - to
      examples:
      - to:
          address: 1401 N Shoreline Blvd
          address2: Suite 1
          city: Mountain View
          state: CA
          postalCode: '94043'
          country: US
          name: Ada Lovelace
        from:
          address: 256 Byron Street
          address2: Suite 32
          city: Palo Alto
          state: CA
          postalCode: '94306'
          country: US
          name: Hooli
    ErrorBadRequestSchemaErrorsItem:
      type: object
      properties:
        field:
          type: string
          description: The field that caused the error.
        message:
          type: string
          description: The error message associated with the field.
      required:
      - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token. The token is the concatenation of your Abound appId and appSecret separated by a period, e.g. `appId_xxx.appSecret_yyy`.