# Derived by the API Evangelist enrichment pipeline from the webhook definitions in the
# first-party Fern API Definition shipped in @withabound/node-sdk@6.0.68.
# method: derived source: https://registry.npmjs.org/@withabound/node-sdk/-/node-sdk-6.0.68.tgz
asyncapi: 3.0.0
info:
title: Abound API v4 - Webhooks
version: '4'
description: 'The Abound webhook event surface: 44 HMAC-signed events covering Users, TIN Verifications,
Mailings, Form 1099-INT/K/MISC/NEC and Forms W-9, W-8BEN and W-8BEN-E.
Derived from the first-party Fern API Definition shipped in @withabound/node-sdk@6.0.68. Abound is
retired and no longer delivers events.'
defaultContentType: application/json
servers:
subscriber:
host: your-application.example.com
protocol: https
description: Abound POSTs each event to the HTTPS endpoint you register. Verify the Abound-Signature
HMAC header before trusting the payload.
channels:
MAILING_CREATED:
address: /{subscriberUrl}
title: MAILING_CREATED
description: Receive a notification when a Mailing is created
messages:
messageMailingCreated:
$ref: '#/components/messages/messageMailingCreated'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
MAILING_DELETED:
address: /{subscriberUrl}
title: MAILING_DELETED
description: Receive a notification when a Mailing is deleted
messages:
messageMailingDeleted:
$ref: '#/components/messages/messageMailingDeleted'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
MAILING_DELIVERED:
address: /{subscriberUrl}
title: MAILING_DELIVERED
description: Receive a notification when a Mailing status changes to `DELIVERED`
messages:
messageMailingDelivered:
$ref: '#/components/messages/messageMailingDelivered'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
MAILING_IN_TRANSIT:
address: /{subscriberUrl}
title: MAILING_IN_TRANSIT
description: Receive a notification when a Mailing status changes to `IN_TRANSIT`
messages:
messageMailingInTransit:
$ref: '#/components/messages/messageMailingInTransit'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
MAILING_PROCESSING_FOR_DELIVERY:
address: /{subscriberUrl}
title: MAILING_PROCESSING_FOR_DELIVERY
description: Receive a notification when a Mailing status changes to `PROCESSING_FOR_DELIVERY`
messages:
messageMailingProcessingForDelivery:
$ref: '#/components/messages/messageMailingProcessingForDelivery'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
MAILING_RETURNED_TO_SENDER:
address: /{subscriberUrl}
title: MAILING_RETURNED_TO_SENDER
description: Receive a notification when a Mailing status changes to `RETURNED_TO_SENDER`
messages:
messageMailingReturnedToSender:
$ref: '#/components/messages/messageMailingReturnedToSender'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
MAILING_UPDATED:
address: /{subscriberUrl}
title: MAILING_UPDATED
description: Receive a notification when a Mailing is updated
messages:
messageMailingUpdated:
$ref: '#/components/messages/messageMailingUpdated'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_INT_ACCEPTED:
address: /{subscriberUrl}
title: TEN99_INT_ACCEPTED
description: Receive a notification when a Form 1099-INT status changes to `ACCEPTED`
messages:
messageTen99IntAccepted:
$ref: '#/components/messages/messageTen99IntAccepted'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_INT_CORRECTED:
address: /{subscriberUrl}
title: TEN99_INT_CORRECTED
description: Receive a notification when a Form 1099-INT is corrected.
messages:
messageTen99IntCorrected:
$ref: '#/components/messages/messageTen99IntCorrected'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_INT_CREATED:
address: /{subscriberUrl}
title: TEN99_INT_CREATED
description: Receive a notification when a Form 1099-INT is created
messages:
messageTen99IntCreated:
$ref: '#/components/messages/messageTen99IntCreated'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_INT_DELETED:
address: /{subscriberUrl}
title: TEN99_INT_DELETED
description: Receive a notification when a Form 1099-INT is deleted
messages:
messageTen99IntDeleted:
$ref: '#/components/messages/messageTen99IntDeleted'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_INT_FILED:
address: /{subscriberUrl}
title: TEN99_INT_FILED
description: Receive a notification when a Form 1099-INT is filed
messages:
messageTen99IntFiled:
$ref: '#/components/messages/messageTen99IntFiled'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_INT_REJECTED:
address: /{subscriberUrl}
title: TEN99_INT_REJECTED
description: Receive a notification when a Form 1099-INT is rejected
messages:
messageTen99IntRejected:
$ref: '#/components/messages/messageTen99IntRejected'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_INT_VOIDED:
address: /{subscriberUrl}
title: TEN99_INT_VOIDED
description: Receive a notification when a Form 1099-INT is voided
messages:
messageTen99IntVoided:
$ref: '#/components/messages/messageTen99IntVoided'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_K_ACCEPTED:
address: /{subscriberUrl}
title: TEN99_K_ACCEPTED
description: Receive a notification when a Form 1099-K status changes to `ACCEPTED`
messages:
messageTen99KAccepted:
$ref: '#/components/messages/messageTen99KAccepted'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_K_CORRECTED:
address: /{subscriberUrl}
title: TEN99_K_CORRECTED
description: Receive a notification when a Form 1099-K is corrected.
messages:
messageTen99KCorrected:
$ref: '#/components/messages/messageTen99KCorrected'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_K_CREATED:
address: /{subscriberUrl}
title: TEN99_K_CREATED
description: Receive a notification when a Form 1099-K is created
messages:
messageTen99KCreated:
$ref: '#/components/messages/messageTen99KCreated'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_K_DELETED:
address: /{subscriberUrl}
title: TEN99_K_DELETED
description: Receive a notification when a Form 1099-K is deleted
messages:
messageTen99KDeleted:
$ref: '#/components/messages/messageTen99KDeleted'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_K_FILED:
address: /{subscriberUrl}
title: TEN99_K_FILED
description: Receive a notification when a Form 1099-K is filed
messages:
messageTen99KFiled:
$ref: '#/components/messages/messageTen99KFiled'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_K_REJECTED:
address: /{subscriberUrl}
title: TEN99_K_REJECTED
description: Receive a notification when a Form 1099-K is rejected
messages:
messageTen99KRejected:
$ref: '#/components/messages/messageTen99KRejected'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_K_VOIDED:
address: /{subscriberUrl}
title: TEN99_K_VOIDED
description: Receive a notification when a Form 1099-K is voided
messages:
messageTen99KVoided:
$ref: '#/components/messages/messageTen99KVoided'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_MISC_ACCEPTED:
address: /{subscriberUrl}
title: TEN99_MISC_ACCEPTED
description: Receive a notification when a Form 1099-MISC status changes to `ACCEPTED`
messages:
messageTen99MiscAccepted:
$ref: '#/components/messages/messageTen99MiscAccepted'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_MISC_CORRECTED:
address: /{subscriberUrl}
title: TEN99_MISC_CORRECTED
description: Receive a notification when a Form 1099-MISC is corrected.
messages:
messageTen99MiscCorrected:
$ref: '#/components/messages/messageTen99MiscCorrected'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_MISC_CREATED:
address: /{subscriberUrl}
title: TEN99_MISC_CREATED
description: Receive a notification when a Form 1099-MISC is created
messages:
messageTen99MiscCreated:
$ref: '#/components/messages/messageTen99MiscCreated'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_MISC_DELETED:
address: /{subscriberUrl}
title: TEN99_MISC_DELETED
description: Receive a notification when a Form 1099-MISC is deleted
messages:
messageTen99MiscDeleted:
$ref: '#/components/messages/messageTen99MiscDeleted'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_MISC_FILED:
address: /{subscriberUrl}
title: TEN99_MISC_FILED
description: Receive a notification when a Form 1099-MISC is filed
messages:
messageTen99MiscFiled:
$ref: '#/components/messages/messageTen99MiscFiled'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_MISC_REJECTED:
address: /{subscriberUrl}
title: TEN99_MISC_REJECTED
description: Receive a notification when a Form 1099-MISC is rejected
messages:
messageTen99MiscRejected:
$ref: '#/components/messages/messageTen99MiscRejected'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_MISC_VOIDED:
address: /{subscriberUrl}
title: TEN99_MISC_VOIDED
description: Receive a notification when a Form 1099-MISC is voided
messages:
messageTen99MiscVoided:
$ref: '#/components/messages/messageTen99MiscVoided'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_NEC_ACCEPTED:
address: /{subscriberUrl}
title: TEN99_NEC_ACCEPTED
description: Receive a notification when a Form 1099-NEC status changes to `ACCEPTED`
messages:
messageTen99NecAccepted:
$ref: '#/components/messages/messageTen99NecAccepted'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_NEC_CORRECTED:
address: /{subscriberUrl}
title: TEN99_NEC_CORRECTED
description: Receive a notification when a Form 1099-NEC is corrected.
messages:
messageTen99NecCorrected:
$ref: '#/components/messages/messageTen99NecCorrected'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_NEC_CREATED:
address: /{subscriberUrl}
title: TEN99_NEC_CREATED
description: Receive a notification when a Form 1099-NEC is created
messages:
messageTen99NecCreated:
$ref: '#/components/messages/messageTen99NecCreated'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_NEC_DELETED:
address: /{subscriberUrl}
title: TEN99_NEC_DELETED
description: Receive a notification when a Form 1099-NEC is deleted
messages:
messageTen99NecDeleted:
$ref: '#/components/messages/messageTen99NecDeleted'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_NEC_FILED:
address: /{subscriberUrl}
title: TEN99_NEC_FILED
description: Receive a notification when a Form 1099-NEC is filed
messages:
messageTen99NecFiled:
$ref: '#/components/messages/messageTen99NecFiled'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_NEC_REJECTED:
address: /{subscriberUrl}
title: TEN99_NEC_REJECTED
description: Receive a notification when a Form 1099-NEC is rejected
messages:
messageTen99NecRejected:
$ref: '#/components/messages/messageTen99NecRejected'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TEN99_NEC_VOIDED:
address: /{subscriberUrl}
title: TEN99_NEC_VOIDED
description: Receive a notification when a Form 1099-NEC is voided
messages:
messageTen99NecVoided:
$ref: '#/components/messages/messageTen99NecVoided'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TIN_VERIFICATION_CREATED:
address: /{subscriberUrl}
title: TIN_VERIFICATION_CREATED
description: Receive a notification when a TIN Verification is created
messages:
messageTinVerificationCreated:
$ref: '#/components/messages/messageTinVerificationCreated'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TIN_VERIFICATION_MATCH:
address: /{subscriberUrl}
title: TIN_VERIFICATION_MATCH
description: Receive a notification when a TIN Verification status changes to `MATCH`
messages:
messageTinVerificationMatch:
$ref: '#/components/messages/messageTinVerificationMatch'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TIN_VERIFICATION_MISMATCH:
address: /{subscriberUrl}
title: TIN_VERIFICATION_MISMATCH
description: Receive a notification when a TIN Verification status changes to `MISMATCH`
messages:
messageTinVerificationMismatch:
$ref: '#/components/messages/messageTinVerificationMismatch'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
TIN_VERIFICATION_PENDING:
address: /{subscriberUrl}
title: TIN_VERIFICATION_PENDING
description: Receive a notification when a TIN Verification status changes to `PENDING`
messages:
messageTinVerificationPending:
$ref: '#/components/messages/messageTinVerificationPending'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
USER_CREATED:
address: /{subscriberUrl}
title: USER_CREATED
description: Receive a notification when a User is created
messages:
messageUserCreated:
$ref: '#/components/messages/messageUserCreated'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
USER_UPDATED:
address: /{subscriberUrl}
title: USER_UPDATED
description: Receive a notification when a User is updated
messages:
messageUserUpdated:
$ref: '#/components/messages/messageUserUpdated'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
W_8BEN_CREATED:
address: /{subscriberUrl}
title: W_8BEN_CREATED
description: Receive a notification when a Form W-8BEN is created
messages:
messageW8benCreated:
$ref: '#/components/messages/messageW8benCreated'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
W_8BEN_E_CREATED:
address: /{subscriberUrl}
title: W_8BEN_E_CREATED
description: Receive a notification when a Form W-8BEN-E is created
messages:
messageW8benECreated:
$ref: '#/components/messages/messageW8benECreated'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
W_9_CREATED:
address: /{subscriberUrl}
title: W_9_CREATED
description: Receive a notification when a Form W-9 is created
messages:
messageW9Created:
$ref: '#/components/messages/messageW9Created'
parameters:
subscriberUrl:
description: The HTTPS endpoint you registered with Abound to receive webhooks.
operations:
receiveMailingCreated:
action: receive
channel:
$ref: '#/channels/MAILING_CREATED'
summary: MAILING_CREATED
bindings:
http:
method: POST
receiveMailingDeleted:
action: receive
channel:
$ref: '#/channels/MAILING_DELETED'
summary: MAILING_DELETED
bindings:
http:
method: POST
receiveMailingDelivered:
action: receive
channel:
$ref: '#/channels/MAILING_DELIVERED'
summary: MAILING_DELIVERED
bindings:
http:
method: POST
receiveMailingInTransit:
action: receive
channel:
$ref: '#/channels/MAILING_IN_TRANSIT'
summary: MAILING_IN_TRANSIT
bindings:
http:
method: POST
receiveMailingProcessingForDelivery:
action: receive
channel:
$ref: '#/channels/MAILING_PROCESSING_FOR_DELIVERY'
summary: MAILING_PROCESSING_FOR_DELIVERY
bindings:
http:
method: POST
receiveMailingReturnedToSender:
action: receive
channel:
$ref: '#/channels/MAILING_RETURNED_TO_SENDER'
summary: MAILING_RETURNED_TO_SENDER
bindings:
http:
method: POST
receiveMailingUpdated:
action: receive
channel:
$ref: '#/channels/MAILING_UPDATED'
summary: MAILING_UPDATED
bindings:
http:
method: POST
receiveTen99IntAccepted:
action: receive
channel:
$ref: '#/channels/TEN99_INT_ACCEPTED'
summary: TEN99_INT_ACCEPTED
bindings:
http:
method: POST
receiveTen99IntCorrected:
action: receive
channel:
$ref: '#/channels/TEN99_INT_CORRECTED'
summary: TEN99_INT_CORRECTED
bindings:
http:
method: POST
receiveTen99IntCreated:
action: receive
channel:
$ref: '#/channels/TEN99_INT_CREATED'
summary: TEN99_INT_CREATED
bindings:
http:
method: POST
receiveTen99IntDeleted:
action: receive
channel:
$ref: '#/channels/TEN99_INT_DELETED'
summary: TEN99_INT_DELETED
bindings:
http:
method: POST
receiveTen99IntFiled:
action: receive
channel:
$ref: '#/channels/TEN99_INT_FILED'
summary: TEN99_INT_FILED
bindings:
http:
method: POST
receiveTen99IntRejected:
action: receive
channel:
$ref: '#/channels/TEN99_INT_REJECTED'
summary: TEN99_INT_REJECTED
bindings:
http:
method: POST
receiveTen99IntVoided:
action: receive
channel:
$ref: '#/channels/TEN99_INT_VOIDED'
summary: TEN99_INT_VOIDED
bindings:
http:
method: POST
receiveTen99KAccepted:
action: receive
channel:
$ref: '#/channels/TEN99_K_ACCEPTED'
summary: TEN99_K_ACCEPTED
bindings:
http:
method: POST
receiveTen99KCorrected:
action: receive
channel:
$ref: '#/channels/TEN99_K_CORRECTED'
summary: TEN99_K_CORRECTED
bindings:
http:
method: POST
receiveTen99KCreated:
action: receive
channel:
$ref: '#/channels/TEN99_K_CREATED'
summary: TEN99_K_CREATED
bindings:
http:
method: POST
receiveTen99KDeleted:
action: receive
channel:
$ref: '#/channels/TEN99_K_DELETED'
summary: TEN99_K_DELETED
bindings:
http:
method: POST
receiveTen99KFiled:
action: receive
channel:
$ref: '#/channels/TEN99_K_FILED'
summary: TEN99_K_FILED
bindings:
http:
method: POST
receiveTen99KRejected:
action: receive
channel:
$ref: '#/channels/TEN99_K_REJECTED'
summary: TEN99_K_REJECTED
bindings:
http:
method: POST
receiveTen99KVoided:
action: receive
channel:
$ref: '#/channels/TEN99_K_VOIDED'
summary: TEN99_K_VOIDED
bindings:
http:
method: POST
receiveTen99MiscAccepted:
action: receive
channel:
$ref: '#/channels/TEN99_MISC_ACCEPTED'
summary: TEN99_MISC_ACCEPTED
bindings:
http:
method: POST
receiveTen99MiscCorrected:
action: receive
channel:
$ref: '#/channels/TEN99_MISC_CORRECTED'
summary: TEN99_MISC_CORRECTED
bindings:
http:
method: POST
receiveTen99MiscCreated:
action: receive
channel:
$ref: '#/channels/TEN99_MISC_CREATED'
summary: TEN99_MISC_CREATED
bindings:
http:
method: POST
receiveTen99MiscDeleted:
action: receive
channel:
$ref: '#/channels/TEN99_MISC_DELETED'
summary: TEN99_MISC_DELETED
bindings:
http:
method: POST
receiveTen99MiscFiled:
action: receive
channel:
$ref: '#/channels/TEN99_MISC_FILED'
summary: TEN99_MISC_FILED
bindings:
http:
method: POST
receiveTen99MiscRejected:
action: receive
channel:
$ref: '#/channels/TEN99_MISC_REJECTED'
summary: TEN99_MISC_REJECTED
bindings:
http:
method: POST
receiveTen99MiscVoided:
action: receive
channel:
$ref: '#/channels/TEN99_MISC_VOIDED'
summary: TEN99_MISC_VOIDED
bindings:
http:
method: POST
receiveTen99NecAccepted:
action: receive
channel:
$ref: '#/channels/TEN99_NEC_ACCEPTED'
summary: TEN99_NEC_ACCEPTED
bindings:
http:
method: POST
receiveTen99NecCorrected:
action: receive
channel:
$ref: '#/channels/TEN99_NEC_CORRECTED'
summary: TEN99_NEC_CORRECTED
bindings:
http:
method: POST
receiveTen99NecCreated:
action: receive
channel:
$ref: '#/channels/TEN99_NEC_CREATED'
summary: TEN99_NEC_CREATED
bindings:
http:
method: POST
receiveTen99NecDeleted:
action: receive
channel:
$ref: '#/channels/TEN99_NEC_DELETED'
summary: TEN99_NEC_DELETED
bindings:
http:
method: POST
receiveTen99NecFiled:
action: receive
channel:
$ref: '#/channels/TEN99_NEC_FILED'
summary: TEN99_NEC_FILED
bindings:
http:
method: POST
receiveTen99NecRejected:
action: receive
channel:
$ref: '#/channels/TEN99_NEC_REJECTED'
summary: TEN99_NEC_REJECTED
bindings:
http:
method: POST
receiveTen99NecVoided:
action: receive
channel:
$ref: '#/channels/TEN99_NEC_VOIDED'
summary: TEN99_NEC_VOIDED
bindings:
http:
method: POST
receiveTinVerificationCreated:
action: receive
channel:
$ref: '#/channels/TIN_VERIFICATION_CREATED'
summary: TIN_VERIFICATION_CREATED
bindings:
http:
method: POST
receiveTinVerificationMatch:
action: receive
channel:
$ref: '#/channels/TIN_VERIFICATION_MATCH'
summary: TIN_VERIFICATION_MATCH
bindings:
http:
method: POST
receiveTinVerificationMismatch:
action: receive
channel:
$ref: '#/channels/TIN_VERIFICATION_MISMATCH'
summary: TIN_VERIFICATION_MISMATCH
bindings:
http:
method: POST
receiveTinVerificationPending:
action: receive
channel:
$ref: '#/channels/TIN_VERIFICATION_PENDING'
summary: TIN_VERIFICATION_PENDING
bindings:
http:
method: POST
receiveUserCreated:
action: receive
channel:
$ref: '#/channels/USER_CREATED'
summary: USER_CREATED
bindings:
http:
method: POST
receiveUserUpdated:
action: receive
channel:
$ref: '#/channels/USER_UPDATED'
summary: USER_UPDATED
bindings:
http:
method: POST
receiveW8benCreated:
action: receive
channel:
$ref: '#/channels/W_8BEN_CREATED'
summary: W_8BEN_CREATED
bindings:
http:
method: POST
receiveW8benECreated:
action: receive
channel:
$ref: '#/channels/W_8BEN_E_CREATED'
summary: W_8BEN_E_CREATED
bindings:
http:
method: POST
receiveW9Created:
action: receive
channel:
$ref: '#/channels/W_9_CREATED'
summary: W_9_CREATED
bindings:
http:
method: POST
components:
messages:
messageMailingCreated:
name: MAILING_CREATED
title: MAILING_CREATED
summary: Receive a notification when a Mailing is created
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/MailingCreatedWebhookPayload'
messageMailingDeleted:
name: MAILING_DELETED
title: MAILING_DELETED
summary: Receive a notification when a Mailing is deleted
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/MailingDeletedWebhookPayload'
messageMailingDelivered:
name: MAILING_DELIVERED
title: MAILING_DELIVERED
summary: Receive a notification when a Mailing status changes to `DELIVERED`
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/MailingDeliveredWebhookPayload'
messageMailingInTransit:
name: MAILING_IN_TRANSIT
title: MAILING_IN_TRANSIT
summary: Receive a notification when a Mailing status changes to `IN_TRANSIT`
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/MailingInTransitWebhookPayload'
messageMailingProcessingForDelivery:
name: MAILING_PROCESSING_FOR_DELIVERY
title: MAILING_PROCESSING_FOR_DELIVERY
summary: Receive a notification when a Mailing status changes to `PROCESSING_FOR_DELIVERY`
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/MailingProcessingForDeliveryWebhookPayload'
messageMailingReturnedToSender:
name: MAILING_RETURNED_TO_SENDER
title: MAILING_RETURNED_TO_SENDER
summary: Receive a notification when a Mailing status changes to `RETURNED_TO_SENDER`
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/MailingReturnedToSenderWebhookPayload'
messageMailingUpdated:
name: MAILING_UPDATED
title: MAILING_UPDATED
summary: Receive a notification when a Mailing is updated
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/MailingUpdatedWebhookPayload'
messageTen99IntAccepted:
name: TEN99_INT_ACCEPTED
title: TEN99_INT_ACCEPTED
summary: Receive a notification when a Form 1099-INT status changes to `ACCEPTED`
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099IntAcceptedWebhookPayload'
messageTen99IntCorrected:
name: TEN99_INT_CORRECTED
title: TEN99_INT_CORRECTED
summary: Receive a notification when a Form 1099-INT is corrected.
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099IntCorrectedWebhookPayload'
messageTen99IntCreated:
name: TEN99_INT_CREATED
title: TEN99_INT_CREATED
summary: Receive a notification when a Form 1099-INT is created
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099IntCreatedWebhookPayload'
messageTen99IntDeleted:
name: TEN99_INT_DELETED
title: TEN99_INT_DELETED
summary: Receive a notification when a Form 1099-INT is deleted
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099IntDeletedWebhookPayload'
messageTen99IntFiled:
name: TEN99_INT_FILED
title: TEN99_INT_FILED
summary: Receive a notification when a Form 1099-INT is filed
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099IntFiledWebhookPayload'
messageTen99IntRejected:
name: TEN99_INT_REJECTED
title: TEN99_INT_REJECTED
summary: Receive a notification when a Form 1099-INT is rejected
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099IntRejectedWebhookPayload'
messageTen99IntVoided:
name: TEN99_INT_VOIDED
title: TEN99_INT_VOIDED
summary: Receive a notification when a Form 1099-INT is voided
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099IntVoidedWebhookPayload'
messageTen99KAccepted:
name: TEN99_K_ACCEPTED
title: TEN99_K_ACCEPTED
summary: Receive a notification when a Form 1099-K status changes to `ACCEPTED`
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099KAcceptedWebhookPayload'
messageTen99KCorrected:
name: TEN99_K_CORRECTED
title: TEN99_K_CORRECTED
summary: Receive a notification when a Form 1099-K is corrected.
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099KCorrectedWebhookPayload'
messageTen99KCreated:
name: TEN99_K_CREATED
title: TEN99_K_CREATED
summary: Receive a notification when a Form 1099-K is created
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099KCreatedWebhookPayload'
messageTen99KDeleted:
name: TEN99_K_DELETED
title: TEN99_K_DELETED
summary: Receive a notification when a Form 1099-K is deleted
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099KDeletedWebhookPayload'
messageTen99KFiled:
name: TEN99_K_FILED
title: TEN99_K_FILED
summary: Receive a notification when a Form 1099-K is filed
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099KFiledWebhookPayload'
messageTen99KRejected:
name: TEN99_K_REJECTED
title: TEN99_K_REJECTED
summary: Receive a notification when a Form 1099-K is rejected
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099KRejectedWebhookPayload'
messageTen99KVoided:
name: TEN99_K_VOIDED
title: TEN99_K_VOIDED
summary: Receive a notification when a Form 1099-K is voided
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099KVoidedWebhookPayload'
messageTen99MiscAccepted:
name: TEN99_MISC_ACCEPTED
title: TEN99_MISC_ACCEPTED
summary: Receive a notification when a Form 1099-MISC status changes to `ACCEPTED`
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099MiscAcceptedWebhookPayload'
messageTen99MiscCorrected:
name: TEN99_MISC_CORRECTED
title: TEN99_MISC_CORRECTED
summary: Receive a notification when a Form 1099-MISC is corrected.
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099MiscCorrectedWebhookPayload'
messageTen99MiscCreated:
name: TEN99_MISC_CREATED
title: TEN99_MISC_CREATED
summary: Receive a notification when a Form 1099-MISC is created
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099MiscCreatedWebhookPayload'
messageTen99MiscDeleted:
name: TEN99_MISC_DELETED
title: TEN99_MISC_DELETED
summary: Receive a notification when a Form 1099-MISC is deleted
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099MiscDeletedWebhookPayload'
messageTen99MiscFiled:
name: TEN99_MISC_FILED
title: TEN99_MISC_FILED
summary: Receive a notification when a Form 1099-MISC is filed
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099MiscFiledWebhookPayload'
messageTen99MiscRejected:
name: TEN99_MISC_REJECTED
title: TEN99_MISC_REJECTED
summary: Receive a notification when a Form 1099-MISC is rejected
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099MiscRejectedWebhookPayload'
messageTen99MiscVoided:
name: TEN99_MISC_VOIDED
title: TEN99_MISC_VOIDED
summary: Receive a notification when a Form 1099-MISC is voided
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099MiscVoidedWebhookPayload'
messageTen99NecAccepted:
name: TEN99_NEC_ACCEPTED
title: TEN99_NEC_ACCEPTED
summary: Receive a notification when a Form 1099-NEC status changes to `ACCEPTED`
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099NecAcceptedWebhookPayload'
messageTen99NecCorrected:
name: TEN99_NEC_CORRECTED
title: TEN99_NEC_CORRECTED
summary: Receive a notification when a Form 1099-NEC is corrected.
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099NecCorrectedWebhookPayload'
messageTen99NecCreated:
name: TEN99_NEC_CREATED
title: TEN99_NEC_CREATED
summary: Receive a notification when a Form 1099-NEC is created
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099NecCreatedWebhookPayload'
messageTen99NecDeleted:
name: TEN99_NEC_DELETED
title: TEN99_NEC_DELETED
summary: Receive a notification when a Form 1099-NEC is deleted
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099NecDeletedWebhookPayload'
messageTen99NecFiled:
name: TEN99_NEC_FILED
title: TEN99_NEC_FILED
summary: Receive a notification when a Form 1099-NEC is filed
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099NecFiledWebhookPayload'
messageTen99NecRejected:
name: TEN99_NEC_REJECTED
title: TEN99_NEC_REJECTED
summary: Receive a notification when a Form 1099-NEC is rejected
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099NecRejectedWebhookPayload'
messageTen99NecVoided:
name: TEN99_NEC_VOIDED
title: TEN99_NEC_VOIDED
summary: Receive a notification when a Form 1099-NEC is voided
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/Form1099NecVoidedWebhookPayload'
messageTinVerificationCreated:
name: TIN_VERIFICATION_CREATED
title: TIN_VERIFICATION_CREATED
summary: Receive a notification when a TIN Verification is created
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/TINVerificationCreatedWebhookPayload'
messageTinVerificationMatch:
name: TIN_VERIFICATION_MATCH
title: TIN_VERIFICATION_MATCH
summary: Receive a notification when a TIN Verification status changes to `MATCH`
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/TINVerificationMatchWebhookPayload'
messageTinVerificationMismatch:
name: TIN_VERIFICATION_MISMATCH
title: TIN_VERIFICATION_MISMATCH
summary: Receive a notification when a TIN Verification status changes to `MISMATCH`
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/TINVerificationMismatchWebhookPayload'
messageTinVerificationPending:
name: TIN_VERIFICATION_PENDING
title: TIN_VERIFICATION_PENDING
summary: Receive a notification when a TIN Verification status changes to `PENDING`
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/TINVerificationPendingWebhookPayload'
messageUserCreated:
name: USER_CREATED
title: USER_CREATED
summary: Receive a notification when a User is created
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/UserCreatedWebhookPayload'
messageUserUpdated:
name: USER_UPDATED
title: USER_UPDATED
summary: Receive a notification when a User is updated
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/UserUpdatedWebhookPayload'
messageW8benCreated:
name: W_8BEN_CREATED
title: W_8BEN_CREATED
summary: Receive a notification when a Form W-8BEN is created
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/FormW8BenCreatedWebhookPayload'
messageW8benECreated:
name: W_8BEN_E_CREATED
title: W_8BEN_E_CREATED
summary: Receive a notification when a Form W-8BEN-E is created
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/FormW8BenECreatedWebhookPayload'
messageW9Created:
name: W_9_CREATED
title: W_9_CREATED
summary: Receive a notification when a Form W-9 is created
contentType: application/json
headers:
type: object
properties:
Abound-Signature:
type: string
description: An HMAC signature of the payload
payload:
schemaFormat: application/vnd.oai.openapi;version=3.1.0
schema:
$ref: '#/components/schemas/FormW9CreatedWebhookPayload'
schemas:
AboundSignatureHeader:
type: string
description: An HMAC signature of the payload
AccessTokenSchema:
type: object
properties:
accessToken:
type: string
description: The access token to authenticate your Drop-In UI Components.
createdAt:
type: string
format: date-time
description: The creation date and time of the access token in `ISO 8601` format.
expiresAt:
type: string
format: date-time
description: The expiration date and time of the access token in `ISO 8601` format.
customizations:
$ref: '#/components/schemas/CustomizationsSchema'
userId:
type: string
description: The unique identifier of the user associated with this access token.
required:
- accessToken
- createdAt
- expiresAt
examples:
- accessToken: accessToken_sampleeyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE2OTY5ODczNTcsImV4cCI6MTY5Njk4NzY1NywiYXVkIjoiYXBwSWRfc2FtcGxlcU5oVmNkWVFZVSIsImlzcyI6Imh0dHBzOi8vc2FuZGJveC1hcGkud2l0aGFib3VuZC5jb20vdjQiLCJzdWIiOiJ1c2VySWRfc2FtcGxlWEdNRm5oT3BlUiJ9.-NrPVQvsnM8vJouyuP5yeFGlYb1xGgR-gS3v87p5BQk
createdAt: '2024-01-01T00:00:00.000Z'
expiresAt: '2024-01-01T00:15:00.000Z'
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
CustomizationsSchema:
type: object
properties:
payeeTaxProfile:
allOf:
- $ref: '#/components/schemas/PayeeTaxProfileSchema'
description: The Payee Tax Profile component customizations.
description: The component customizations for this access token.
DefaultErrorSchema:
type: object
properties:
message:
type: string
description: The error message associated with the response status code.
required:
- message
DefaultsSchema:
type: object
properties:
firstName:
type: string
description: The payee's legal first name.
lastName:
type: string
description: The payee's legal last name.
businessName:
type: string
description: The payee's business name.
dateOfBirth:
type: string
format: date
description: The date, in `YYYY-MM-DD` format, the payee was born on.
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 (`CA` for California, `ME` for Maine).
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
email:
type: string
description: The payee's email address. Abound assume's you have taken the proper steps to verify
the ownership of this email address.
DocumentId:
type: string
description: The unique identifier for an existing document.
EDeliveryConsentSchema:
type: object
properties:
id:
type: string
description: The unique identifier for this electronic delivery consent.
createdAt:
type: string
format: date-time
description: The creation date and time of the electronic delivery consent in `ISO 8601` format.
status:
allOf:
- $ref: '#/components/schemas/EDeliveryConsentStatusEnum'
description: The status of the electronic delivery consent.
email:
type: string
description: The email address associated with the electronic delivery consent. Abound assume's
you have taken the proper steps to verify the ownership of this email address.
tinFingerprint:
allOf:
- $ref: '#/components/schemas/TinFingerprint'
description: The TIN fingerprint for this electronic delivery consent.
required:
- createdAt
- email
- id
- status
- tinFingerprint
EDeliveryConsentStatusEnum:
type: string
enum:
- ASSENTED
- WITHDRAWN
ElectronicSignatureOfPayeeSchema:
type: object
properties:
signature:
type: string
description: The signature of the payee.
printedName:
type: string
description: The printed name of the payee.
signedAt:
type: string
format: date-time
description: The date and time in `ISO 8601` format of the signature.
ipAddress:
type: string
description: The IP address of the payee when signing this document.
required:
- ipAddress
- printedName
- signature
- signedAt
description: The electronic signature of the payee.
Email:
type: string
description: Filters the list of users based on the `email` field.
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
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
FilingYear:
type: integer
description: The filing year associated with this document.
ForeignAddressSchema:
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.
state:
type: string
description: The province associated with the street address.
postalCode:
type: string
description: The foreign postal code associated with the street address.
country:
type: string
description: The country adhering to `ISO 3166-2` standards.
minLength: 2
maxLength: 2
required:
- address
- country
ForeignId:
type: string
description: The customer-specific unique identifier associated to an Abound record. Allows developers
to forego making their own tables every time they integrate and/or add an application.
ForeignTinFingerprint:
type: string
description: The unique token that points to a foreign TIN.
Form1099AccountNumber:
type: string
maxLength: 20
description: The account number or other unique number assigned to distinguish an account. Abound
will auto-generate this for you if left omitted.
Form1099BaseCorrectRequestSchema:
type: object
properties:
userId:
$ref: '#/components/schemas/UserId'
payee:
$ref: '#/components/schemas/PayeeRequestSchema'
required:
- payee
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
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.
• `CREATED`: The document has
passed data validation and the PDFs have been generated.
• `FILED`: The payee''s
TIN has been verified and the 1099 has been filed with the appropriate tax authorities.
•
`ACCEPTED`: The document has been acknowledged and accepted by the appropriate tax authorities.
•
`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
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`.
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
Form1099IntAcceptedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_INT_ACCEPTED
required:
- event
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
Form1099IntCorrectedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_INT_CORRECTED
required:
- event
Form1099IntCreatedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_INT_CREATED
required:
- event
Form1099IntDeletedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_INT_DELETED
required:
- event
Form1099IntFiledWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_INT_FILED
required:
- event
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.
Form1099IntFormFieldsSchema:
allOf:
- $ref: '#/components/schemas/Form1099FormFieldsBaseSchema'
- $ref: '#/components/schemas/Form1099IntFormFieldsRequestSchema'
Form1099IntRejectedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_INT_REJECTED
required:
- event
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
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
Form1099IntVoidedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_INT_VOIDED
required:
- event
Form1099KAcceptedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_K_ACCEPTED
required:
- event
Form1099KCorrectRequestSchema:
allOf:
- $ref: '#/components/schemas/Form1099BaseCorrectRequestSchema'
- type: object
properties:
formFields:
$ref: '#/components/schemas/Form1099KFormFieldsRequestSchema'
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:
accountNumber: A0MCFOfvWWL7AVtwrhiU
aggregateGrossAmount: 25655553
aggregateGrossAmountCardNotPresent: 25655553
federalIncomeTaxWithheld: 0
merchantCategoryCode: '4582'
numberOfPaymentTransactions: 767
pseName: Payment Entity
payerClassification: PSE
transactionsReportedClassification: PAYMENT_CARD
psePhoneNumber: '+15555555555'
grossAmountsByMonth:
april: 2332323
august: 2332323
december: 2332323
february: 2332323
january: 0
july: 2332323
june: 2332323
march: 2332323
may: 2332323
november: 2332323
october: 2332323
september: 2332323
stateTaxInfo:
- filingState: CA
Form1099KCorrectedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_K_CORRECTED
required:
- event
Form1099KCreatedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_K_CREATED
required:
- event
Form1099KDeletedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_K_DELETED
required:
- event
Form1099KFiledWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_K_FILED
required:
- event
Form1099KFormFieldsRequestSchema:
type: object
properties:
payerClassification:
$ref: '#/components/schemas/Form1099KPayerClassificationEnum'
transactionsReportedClassification:
$ref: '#/components/schemas/Form1099KTransactionsReportedClassificationSchema'
pseName:
type: string
description: The payment settlement entity name. Required if `payerClassification` is `PSE`.
psePhoneNumber:
type: string
description: The payment settlement entity phone number. Required if `payerClassification` is
`PSE`.
pattern: ^\+?\d{10,15}$
accountNumber:
$ref: '#/components/schemas/Form1099AccountNumber'
aggregateGrossAmount:
type: integer
description: Aggregate gross amount of payment card/third party network transactions made to
you through the PSE during the calendar year. Value must be in cents.
minimum: 0
aggregateGrossAmountCardNotPresent:
type: integer
description: The aggregate gross amount of all reportable payment transactions made to you through
the PSE during the calendar year where the card was not present at the time of the transaction
or the card number was keyed into the terminal. Typically, this relates to online sales, phone
sales, or catalogue sales. If `transactionsReportedClassification` is `thirdPartyNetwork`,
or if these are third party network transactions, card not present transactions will not be
reported. Value must be in cents.
minimum: 0
merchantCategoryCode:
type: string
description: Payment brands use merchant category codes (MCCs) to classify merchants and businesses
by the type of goods or services provided. It is a four (4) digit code. This may be left blank.
minLength: 4
maxLength: 4
pattern: ^\d{4}$
numberOfPaymentTransactions:
type: integer
description: The number of payment transactions (not including refund transactions) processed
through the payment card/third party network.
minimum: 0
federalIncomeTaxWithheld:
type: integer
description: The federal income tax withheld. Generally, a payer must backup withhold if you
did not furnish your TIN or you did not furnish the correct TIN to the payer. Value must be
in cents. Abound does not currently support `federalIncomeTaxWithheld` reporting on the 1099-K,
please contact us for more information.
minimum: 0
maximum: 0
grossAmountsByMonth:
$ref: '#/components/schemas/Form1099KGrossAmountsByMonthSchema'
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-K, please contact us for more information.
required:
- aggregateGrossAmount
- grossAmountsByMonth
- numberOfPaymentTransactions
- payerClassification
- stateTaxInfo
- transactionsReportedClassification
description: The 1099-K form fields.
Form1099KFormFieldsSchema:
allOf:
- $ref: '#/components/schemas/Form1099FormFieldsBaseSchema'
- $ref: '#/components/schemas/Form1099KFormFieldsRequestSchema'
Form1099KGrossAmountsByMonthSchema:
type: object
properties:
january:
type: integer
description: The gross amount of payment card/third party network transactions made to you in
January. Value must be in cents.
minimum: 0
february:
type: integer
description: The gross amount of payment card/third party network transactions made to you in
February. Value must be in cents.
minimum: 0
march:
type: integer
description: The gross amount of payment card/third party network transactions made to you in
March. Value must be in cents.
minimum: 0
april:
type: integer
description: The gross amount of payment card/third party network transactions made to you in
April. Value must be in cents.
minimum: 0
may:
type: integer
description: The gross amount of payment card/third party network transactions made to you in
May. Value must be in cents.
minimum: 0
june:
type: integer
description: The gross amount of payment card/third party network transactions made to you in
June. Value must be in cents.
minimum: 0
july:
type: integer
description: The gross amount of payment card/third party network transactions made to you in
July. Value must be in cents.
minimum: 0
august:
type: integer
description: The gross amount of payment card/third party network transactions made to you in
August. Value must be in cents.
minimum: 0
september:
type: integer
description: The gross amount of payment card/third party network transactions made to you in
September. Value must be in cents.
minimum: 0
october:
type: integer
description: The gross amount of payment card/third party network transactions made to you in
October. Value must be in cents.
minimum: 0
november:
type: integer
description: The gross amount of payment card/third party network transactions made to you in
November. Value must be in cents.
minimum: 0
december:
type: integer
description: The gross amount of payment card/third party network transactions made to you in
December. Value must be in cents.
minimum: 0
description: An object that contains the gross amount of transactions for each month. At least one
month must have a value above zero. Values must be in cents.
Form1099KPayerClassificationEnum:
type: string
enum:
- PSE
- EPF_OTHER
description: The type of payer. Payment settlement entity (PSE) or Electronic Payment Facilitator
(EPF)/Other third party.
Form1099KRejectedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_K_REJECTED
required:
- event
Form1099KRequestSchema:
allOf:
- $ref: '#/components/schemas/Form1099BaseRequestSchema'
- type: object
properties:
formFields:
$ref: '#/components/schemas/Form1099KFormFieldsRequestSchema'
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:
accountNumber: A0MCFOfvWWL7AVtwrhiU
aggregateGrossAmount: 27987876
aggregateGrossAmountCardNotPresent: 2332323
federalIncomeTaxWithheld: 0
merchantCategoryCode: '4582'
numberOfPaymentTransactions: 767
pseName: Payment Entity
payerClassification: PSE
transactionsReportedClassification: PAYMENT_CARD
psePhoneNumber: '+15555555555'
grossAmountsByMonth:
april: 2332323
august: 2332323
december: 2332323
february: 2332323
january: 2332323
july: 2332323
june: 2332323
march: 2332323
may: 2332323
november: 2332323
october: 2332323
september: 2332323
stateTaxInfo:
- filingState: CA
stateTaxWithheld: 0
Form1099KSchema:
allOf:
- $ref: '#/components/schemas/Form1099BaseSchema'
- type: object
properties:
formFields:
$ref: '#/components/schemas/Form1099KFormFieldsSchema'
required:
- formFields
examples:
- id: documentId_sampletTtqNfulW8
formFields:
isCorrected: false
isVoid: false
accountNumber: A0MCFOfvWWL7AVtwrhiU
aggregateGrossAmount: 27987876
aggregateGrossAmountCardNotPresent: 2332323
federalIncomeTaxWithheld: 0
merchantCategoryCode: '4582'
numberOfPaymentTransactions: 767
pseName: Payment Entity
payerClassification: PSE
transactionsReportedClassification: PAYMENT_CARD
psePhoneNumber: '+15555555555'
grossAmountsByMonth:
april: 2332323
august: 2332323
december: 2332323
february: 2332323
january: 2332323
july: 2332323
june: 2332323
march: 2332323
may: 2332323
november: 2332323
october: 2332323
september: 2332323
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-K-COPY-C.pdf
payeeUrl: https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-1099-K-COPY-B.pdf
- id: documentId_sampletTtqNfulW8
formFields:
isCorrected: false
isVoid: false
accountNumber: A0MCFOfvWWL7AVtwrhiU
aggregateGrossAmount: 27987876
aggregateGrossAmountCardNotPresent: 2332323
federalIncomeTaxWithheld: 0
merchantCategoryCode: '4582'
numberOfPaymentTransactions: 767
pseName: Payment Entity
payerClassification: PSE
transactionsReportedClassification: PAYMENT_CARD
psePhoneNumber: '+15555555555'
grossAmountsByMonth:
april: 2332323
august: 2332323
december: 2332323
february: 2332323
january: 2332323
july: 2332323
june: 2332323
march: 2332323
may: 2332323
november: 2332323
october: 2332323
september: 2332323
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-K-COPY-C.pdf
payeeUrl: https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-1099-K-COPY-B.pdf
- id: documentId_samplenOHhUUVnh6
correctedFromId: documentId_sampletTtqNfulW8
formFields:
isCorrected: true
isVoid: false
accountNumber: A0MCFOfvWWL7AVtwrhiU
aggregateGrossAmount: 25655553
aggregateGrossAmountCardNotPresent: 25655553
federalIncomeTaxWithheld: 0
merchantCategoryCode: '4582'
numberOfPaymentTransactions: 767
pseName: Payment Entity
payerClassification: PSE
transactionsReportedClassification: PAYMENT_CARD
psePhoneNumber: '+15555555555'
grossAmountsByMonth:
april: 2332323
august: 2332323
december: 2332323
february: 2332323
january: 0
july: 2332323
june: 2332323
march: 2332323
may: 2332323
november: 2332323
october: 2332323
september: 2332323
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-K-CORRECTED-COPY-C.pdf
payeeUrl: https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-1099-K-CORRECTED-COPY-B.pdf
- id: documentId_sampleb6HQLsVuM9
voidedFromId: documentId_sampletTtqNfulW8
formFields:
isCorrected: false
isVoid: true
accountNumber: A0MCFOfvWWL7AVtwrhiU
aggregateGrossAmount: 27987876
aggregateGrossAmountCardNotPresent: 2332323
federalIncomeTaxWithheld: 0
merchantCategoryCode: '4582'
numberOfPaymentTransactions: 767
pseName: Payment Entity
payerClassification: PSE
transactionsReportedClassification: PAYMENT_CARD
psePhoneNumber: '+15555555555'
grossAmountsByMonth:
april: 2332323
august: 2332323
december: 2332323
february: 2332323
january: 2332323
july: 2332323
june: 2332323
march: 2332323
may: 2332323
november: 2332323
october: 2332323
september: 2332323
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-K-VOID-COPY-C.pdf
payeeUrl: https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-1099-K-VOID-COPY-B.pdf
Form1099KTransactionsReportedClassificationSchema:
type: string
enum:
- PAYMENT_CARD
- THIRD_PARTY_NETWORK
description: The type of transactions reported.
Form1099KVoidedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_K_VOIDED
required:
- event
Form1099MiscAcceptedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_MISC_ACCEPTED
required:
- event
Form1099MiscCorrectRequestSchema:
allOf:
- $ref: '#/components/schemas/Form1099BaseCorrectRequestSchema'
- type: object
properties:
formFields:
$ref: '#/components/schemas/Form1099MiscFormFieldsRequestSchema'
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:
cropInsuranceProceeds: 97109
excessGoldenParachutePayments: 97109
federalIncomeTaxWithheld: 0
fishPurchasedForResale: 97109
fishingBoatProceeds: 97109
grossProceedsPaidToAnAttorney: 97109
hasDirectSalesOver5000: false
hasFatcaFilingRequirement: true
medicalAndHealthCarePayments: 97109
nonqualifiedDeferredCompensation: 97109
substitutePaymentsInLieuOfDividendsOrInterest: 97109
otherIncome: 97109
rents: 10000
royalties: 97109
section409ADeferrals: 97109
accountNumber: A00AskD1ZTO4YB8oBHav
stateTaxInfo:
- filingState: CA
stateIncome: 258434
Form1099MiscCorrectedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_MISC_CORRECTED
required:
- event
Form1099MiscCreatedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_MISC_CREATED
required:
- event
Form1099MiscDeletedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_MISC_DELETED
required:
- event
Form1099MiscFiledWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_MISC_FILED
required:
- event
Form1099MiscFormFieldsRequestSchema:
type: object
properties:
hasFatcaFilingRequirement:
type: boolean
description: If the FATCA filing requirement box is checked, the payer is reporting on this
Form 1099 to satisfy its account reporting requirement under chapter 4 of the Internal Revenue
Code. You may also have a filing requirement. See the Instructions for Form 8938.
accountNumber:
type: string
description: May show an account or other unique number the payer assigned to distinguish your
account. This field is also required if `fatca` is `true`. Abound will auto-generated this
field if not provided.
maxLength: 20
rents:
type: integer
description: Report rents from real estate on Schedule E (Form 1040). However, report rents
on Schedule C (Form 1040) if you provided significant services to the tenant, sold real estate
as a business, or rented personal property as a business. Value must be in cents.
royalties:
type: integer
description: Report royalties from oil, gas, or mineral properties; copyrights; and patents
on Schedule E (Form 1040). However, report payments for a working interest as explained in
the Schedule E (Form 1040) instructions. For royalties on timber, coal, and iron ore, see
Pub. 544. Value must be in cents.
otherIncome:
type: integer
description: Generally, report this amount on the “Other income” line of Schedule 1 (Form 1040)
and identify the payment. The amount shown may be payments received as the beneficiary of
a deceased employee, prizes, awards, taxable damages, Indian gaming profits, or other taxable
income. See Pub. 525. If it is trade or business income, report this amount on Schedule C
or F (Form 1040). Value must be in cents.
federalIncomeTaxWithheld:
type: integer
description: Shows backup withholding or withholding on Indian gaming profits.Generally, a payer
must backup withhold if you did not furnish your TIN. See Form W-9 and Pub. 505 for more information.
Report this amount on your income tax return as tax withheld. Abound does not currently support
`federalIncomeTaxWithheld` reporting on the 1099-MISC, please contact us for more information.
fishingBoatProceeds:
type: integer
description: Shows the amount paid to you as a fishing boat crew member by the operator, who
considers you to be self-employed. Self-employed individuals must report this amount on Schedule
C (Form 1040). See Pub. 334. Value must be in cents.
medicalAndHealthCarePayments:
type: integer
description: For individuals, report on Schedule C (Form 1040). Value must be in cents. Value
must be in cents.
hasDirectSalesOver5000:
type: boolean
description: If checked, consumer products totaling $5,000 or more were sold to you for resale,
on a buy-sell, a deposit-commission, or other basis. Generally, report any income from your
sale of these products on Schedule C (Form 1040).
substitutePaymentsInLieuOfDividendsOrInterest:
type: integer
description: Shows substitute payments in lieu of dividends or tax-exempt interest received
by your broker on your behalf as a result of a loan of your securities. Report on the “Other
income” line of Schedule 1 (Form 1040). Value must be in cents.
cropInsuranceProceeds:
type: integer
description: Report this amount on Schedule F (Form 1040). Value must be in cents.
grossProceedsPaidToAnAttorney:
type: integer
description: Shows gross proceeds paid to an attorney in connection with legal services. Report
only the taxable part as income on your return. Value must be in cents.
fishPurchasedForResale:
type: integer
description: Shows the amount of cash you received for the sale of fish if you are in the trade
or business of catching fish. Value must be in cents.
section409ADeferrals:
type: integer
description: May show current year deferrals as a nonemployee under a nonqualified deferred
compensation (NQDC) plan that is subject to the requirements of section 409A plus any earnings
on current and prior year deferrals. Value must be in cents.
excessGoldenParachutePayments:
type: integer
description: Shows your total compensation of excess golden parachute payments subject to a
20% excise tax. See your tax return instructions for where to report. Value must be in cents.
nonqualifiedDeferredCompensation:
type: integer
description: Shows income as a nonemployee under an NQDC plan that does not meet the requirements
of section 409A. Any amount included in box 12 that is currently taxable is also included
in this box. Report this amount as income on your tax return. This income is also subject
to a substantial additional tax to be reported on Form 1040, 1040-SR, or 1040-NR. See the
instructions for your tax return. Value must be in cents.
stateTaxInfo:
type: array
items:
$ref: '#/components/schemas/Form1099StateTaxInfoWithStateIncomeSchema'
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-MISC, please contact us for more information.
required:
- stateTaxInfo
description: The 1099-MISC form fields.
Form1099MiscFormFieldsSchema:
allOf:
- $ref: '#/components/schemas/Form1099FormFieldsBaseSchema'
- $ref: '#/components/schemas/Form1099MiscFormFieldsRequestSchema'
Form1099MiscRejectedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_MISC_REJECTED
required:
- event
Form1099MiscRequestSchema:
allOf:
- $ref: '#/components/schemas/Form1099BaseRequestSchema'
- type: object
properties:
formFields:
$ref: '#/components/schemas/Form1099MiscFormFieldsRequestSchema'
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:
cropInsuranceProceeds: 97109
excessGoldenParachutePayments: 97109
federalIncomeTaxWithheld: 0
fishPurchasedForResale: 97109
fishingBoatProceeds: 97109
grossProceedsPaidToAnAttorney: 97109
hasDirectSalesOver5000: false
hasFatcaFilingRequirement: true
medicalAndHealthCarePayments: 97109
nonqualifiedDeferredCompensation: 97109
substitutePaymentsInLieuOfDividendsOrInterest: 97109
otherIncome: 97109
rents: 97109
royalties: 97109
section409ADeferrals: 97109
accountNumber: A00AskD1ZTO4YB8oBHav
stateTaxInfo:
- filingState: CA
stateIncome: 345543
stateTaxWithheld: 0
Form1099MiscSchema:
allOf:
- $ref: '#/components/schemas/Form1099BaseSchema'
- type: object
properties:
formFields:
$ref: '#/components/schemas/Form1099MiscFormFieldsSchema'
required:
- formFields
examples:
- id: documentId_sampleGNPOKNmIgF
formFields:
isCorrected: false
isVoid: false
cropInsuranceProceeds: 97109
excessGoldenParachutePayments: 97109
federalIncomeTaxWithheld: 0
fishPurchasedForResale: 97109
fishingBoatProceeds: 97109
grossProceedsPaidToAnAttorney: 97109
hasDirectSalesOver5000: false
hasFatcaFilingRequirement: true
medicalAndHealthCarePayments: 97109
nonqualifiedDeferredCompensation: 97109
substitutePaymentsInLieuOfDividendsOrInterest: 97109
otherIncome: 97109
rents: 97109
royalties: 97109
section409ADeferrals: 97109
accountNumber: A00AskD1ZTO4YB8oBHav
stateTaxInfo:
- filingState: CA
stateIncome: 345543
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-MISC-COPY-C.pdf
payeeUrl: https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-1099-MISC-COPY-B.pdf
- id: documentId_sampleGNPOKNmIgF
formFields:
isCorrected: false
isVoid: false
cropInsuranceProceeds: 97109
excessGoldenParachutePayments: 97109
federalIncomeTaxWithheld: 0
fishPurchasedForResale: 97109
fishingBoatProceeds: 97109
grossProceedsPaidToAnAttorney: 97109
hasDirectSalesOver5000: false
hasFatcaFilingRequirement: true
medicalAndHealthCarePayments: 97109
nonqualifiedDeferredCompensation: 97109
substitutePaymentsInLieuOfDividendsOrInterest: 97109
otherIncome: 97109
rents: 97109
royalties: 97109
section409ADeferrals: 97109
accountNumber: A00AskD1ZTO4YB8oBHav
stateTaxInfo:
- filingState: CA
stateIncome: 345543
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-MISC-COPY-C.pdf
payeeUrl: https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-1099-MISC-COPY-B.pdf
- id: documentId_sampleaTA4jltVVx
correctedFromId: documentId_sampleGNPOKNmIgF
formFields:
isCorrected: true
isVoid: false
cropInsuranceProceeds: 97109
excessGoldenParachutePayments: 97109
federalIncomeTaxWithheld: 0
fishPurchasedForResale: 97109
fishingBoatProceeds: 97109
grossProceedsPaidToAnAttorney: 97109
hasDirectSalesOver5000: false
hasFatcaFilingRequirement: true
medicalAndHealthCarePayments: 97109
nonqualifiedDeferredCompensation: 97109
substitutePaymentsInLieuOfDividendsOrInterest: 97109
otherIncome: 97109
rents: 10000
royalties: 97109
section409ADeferrals: 97109
accountNumber: A00AskD1ZTO4YB8oBHav
stateTaxInfo:
- filingState: CA
stateIncome: 258434
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-MISC-CORRECTED-COPY-C.pdf
payeeUrl: https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-1099-MISC-CORRECTED-COPY-B.pdf
- id: documentId_sampleStGnVcbd57
voidedFromId: documentId_sampleGNPOKNmIgF
formFields:
isCorrected: false
isVoid: true
cropInsuranceProceeds: 97109
excessGoldenParachutePayments: 97109
federalIncomeTaxWithheld: 0
fishPurchasedForResale: 97109
fishingBoatProceeds: 97109
grossProceedsPaidToAnAttorney: 97109
hasDirectSalesOver5000: false
hasFatcaFilingRequirement: true
medicalAndHealthCarePayments: 97109
nonqualifiedDeferredCompensation: 97109
substitutePaymentsInLieuOfDividendsOrInterest: 97109
otherIncome: 97109
rents: 97109
royalties: 97109
section409ADeferrals: 97109
accountNumber: A00AskD1ZTO4YB8oBHav
stateTaxInfo:
- filingState: CA
stateIncome: 345543
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-MISC-VOID-COPY-C.pdf
payeeUrl: https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-1099-MISC-VOID-COPY-B.pdf
Form1099MiscVoidedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_MISC_VOIDED
required:
- event
Form1099NecAcceptedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_NEC_ACCEPTED
required:
- event
Form1099NecCorrectRequestSchema:
allOf:
- $ref: '#/components/schemas/Form1099BaseCorrectRequestSchema'
- type: object
properties:
formFields:
$ref: '#/components/schemas/Form1099NecFormFieldsRequestSchema'
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:
nonemployeeCompensation: 10000
accountNumber: A0NEqtav7n0sBGoq88w0
stateTaxInfo:
- filingState: CA
stateIncome: 10000
Form1099NecCorrectedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_NEC_CORRECTED
required:
- event
Form1099NecCreatedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_NEC_CREATED
required:
- event
Form1099NecDeletedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_NEC_DELETED
required:
- event
Form1099NecFiledWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_NEC_FILED
required:
- event
Form1099NecFormFieldsRequestSchema:
type: object
properties:
accountNumber:
type: string
description: If the payer assigns the contractor a unique number for its records, enter the
account number in this box. If not, leave the box blank.
maxLength: 20
nonemployeeCompensation:
type: integer
description: The total amount remitted by payer to recipient during the year. Value must be
in cents.
minimum: 0
hasDirectSalesOver5000:
type: boolean
description: If `true`, consumer products totaling $5,000 or more were sold to recipient for
resale, on a buy-sell, a deposit-commission, or other basis.
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-NEC, please contact us for more information.
minimum: 0
maximum: 0
stateTaxInfo:
type: array
items:
$ref: '#/components/schemas/Form1099StateTaxInfoWithStateIncomeSchema'
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-NEC, please contact us for more information.
required:
- stateTaxInfo
description: The 1099-NEC form fields.
Form1099NecFormFieldsSchema:
allOf:
- $ref: '#/components/schemas/Form1099FormFieldsBaseSchema'
- $ref: '#/components/schemas/Form1099NecFormFieldsRequestSchema'
Form1099NecRejectedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_NEC_REJECTED
required:
- event
Form1099NecRequestSchema:
allOf:
- $ref: '#/components/schemas/Form1099BaseRequestSchema'
- type: object
properties:
formFields:
$ref: '#/components/schemas/Form1099NecFormFieldsRequestSchema'
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:
nonemployeeCompensation: 23423
hasDirectSalesOver5000: false
federalIncomeTaxWithheld: 0
accountNumber: A0NEqtav7n0sBGoq88w0
stateTaxInfo:
- filingState: CA
stateIncome: 23423
stateTaxWithheld: 0
Form1099NecSchema:
allOf:
- $ref: '#/components/schemas/Form1099BaseSchema'
- type: object
properties:
formFields:
$ref: '#/components/schemas/Form1099NecFormFieldsSchema'
required:
- formFields
examples:
- id: documentId_samplegU0eR8oc8a
formFields:
isCorrected: false
isVoid: false
nonemployeeCompensation: 23423
hasDirectSalesOver5000: false
federalIncomeTaxWithheld: 0
accountNumber: A0NEqtav7n0sBGoq88w0
stateTaxInfo:
- filingState: CA
stateIncome: 23423
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-NEC-COPY-C.pdf
payeeUrl: https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-1099-NEC-COPY-B.pdf
- id: documentId_samplegU0eR8oc8a
formFields:
isCorrected: false
isVoid: false
nonemployeeCompensation: 23423
hasDirectSalesOver5000: false
federalIncomeTaxWithheld: 0
accountNumber: A0NEqtav7n0sBGoq88w0
stateTaxInfo:
- filingState: CA
stateIncome: 23423
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-NEC-COPY-C.pdf
payeeUrl: https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-1099-NEC-COPY-B.pdf
- id: documentId_sampletdeUbrEgYw
correctedFromId: documentId_samplegU0eR8oc8a
formFields:
isCorrected: true
isVoid: false
nonemployeeCompensation: 10000
hasDirectSalesOver5000: false
federalIncomeTaxWithheld: 0
accountNumber: A0NEqtav7n0sBGoq88w0
stateTaxInfo:
- filingState: CA
stateIncome: 10000
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-NEC-CORRECTED-COPY-C.pdf
payeeUrl: https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-1099-NEC-CORRECTED-COPY-B.pdf
- id: documentId_sampleSaOkfbLdUb
voidedFromId: documentId_samplegU0eR8oc8a
formFields:
isCorrected: false
isVoid: true
nonemployeeCompensation: 23423
hasDirectSalesOver5000: false
federalIncomeTaxWithheld: 0
accountNumber: A0NEqtav7n0sBGoq88w0
stateTaxInfo:
- filingState: CA
stateIncome: 23423
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-NEC-VOID-COPY-C.pdf
payeeUrl: https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-1099-NEC-VOID-COPY-B.pdf
Form1099NecVoidedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TEN99_NEC_VOIDED
required:
- event
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
Form1099StateTaxInfoWithStateIncomeSchema:
allOf:
- $ref: '#/components/schemas/Form1099StateTaxInfoSchema'
- type: object
properties:
stateIncome:
type: integer
description: The state income. Value must be in cents.
minimum: 0
required:
- stateIncome
Form1099StatusEnum:
type: string
enum:
- CREATED
- FILED
- ACCEPTED
- REJECTED
FormW8BenCreatedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: W_8BEN_CREATED
required:
- event
FormW8BenECreatedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: W_8BEN_E_CREATED
required:
- event
FormW9CreatedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: W_9_CREATED
required:
- event
IdempotencyKey:
type: string
description: The unique key used to identify a request that has already been processed.
MailingCreatedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: MAILING_CREATED
required:
- event
MailingDeletedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: MAILING_DELETED
required:
- event
MailingDeliveredWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: MAILING_DELIVERED
required:
- event
MailingId:
type: string
description: The unique identifier for an existing mailing.
MailingInTransitWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: MAILING_IN_TRANSIT
required:
- event
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`.
MailingProcessingForDeliveryWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: MAILING_PROCESSING_FOR_DELIVERY
required:
- event
MailingRequestFromSchema:
allOf:
- $ref: '#/components/schemas/MailingNameSchema'
- $ref: '#/components/schemas/AddressSchema'
description: The mailing address of the sender.
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
MailingRequestToSchema:
allOf:
- $ref: '#/components/schemas/MailingNameSchema'
- $ref: '#/components/schemas/AddressSchema'
description: The mailing address of the recipient.
MailingReturnedToSenderWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: MAILING_RETURNED_TO_SENDER
required:
- event
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
MailingStatusEnum:
type: string
enum:
- CREATED
- PROCESSING_FOR_DELIVERY
- IN_TRANSIT
- DELIVERED
- RETURNED_TO_SENDER
MailingUpdatedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: MAILING_UPDATED
required:
- event
OkSchema:
type: object
additionalProperties: {}
Page:
type: integer
description: The specific page of results you're requesting. Responses are limited to a maximum
of 100 records.
PayeeForeignTinFingerprint:
type: string
description: Filters the list of documents based on the `payee.foreignTinFingerprint` 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.
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.
PayeeTaxProfileSchema:
type: object
properties:
shouldPreloadFromUserId:
type: boolean
description: Determines if Abound should preload the Payee Tax Profile by `userId` lookup. Default
is `true`.
shouldCollectElectronicDeliveryConsent:
type: boolean
description: Determines if the electronic delivery consent question should be asked in the Payee
Tax Profile component. Default is `true`.
supportedTaxForms:
type: array
items:
$ref: '#/components/schemas/SupportedTaxFormsEnum'
description: 'A list of the forms your organizaton intends to support and collect during a Payee
Tax Profile submission. Default is all forms: `["FORM_W_9", "FORM_W_8BEN", "FORM_W_8BEN_E"]`.'
defaults:
allOf:
- $ref: '#/components/schemas/DefaultsSchema'
description: Used to preload the Payee Tax Profile with default values. These defaults will
be ignored if data is preloaded by `userId`.
requestingPayer:
allOf:
- $ref: '#/components/schemas/PayerRequestSchema'
description: If supplied, a Payee Tax Profile submission that creates a Form W-9 will attach
this information as the `Payer`.
PayeeTinFingerprint:
type: string
description: Filters the list of documents based on the `payee.tinFingerprint` field.
PayeeWithOptionalTinTypeRequestSchema:
allOf:
- $ref: '#/components/schemas/PayeeRequestSchema'
- type: object
properties:
tinType:
$ref: '#/components/schemas/TinTypeEnum'
description: The payee of the document.
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.
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.
PayerTinFingerprint:
type: string
description: Filters the list of documents based on the `payer.tinFingerprint` field.
SupportedTaxFormsEnum:
type: string
enum:
- FORM_W_9
- FORM_W_8BEN
- FORM_W_8BEN_E
TINVerificationCreatedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TIN_VERIFICATION_CREATED
required:
- event
TINVerificationMatchWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TIN_VERIFICATION_MATCH
required:
- event
TINVerificationMismatchWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TIN_VERIFICATION_MISMATCH
required:
- event
TINVerificationPendingWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: TIN_VERIFICATION_PENDING
required:
- event
TaxTreatyAboundCodeEnum:
type: string
enum:
- AU_17_INDEPENDENT_PERSONAL_SERVICES
- AU_18_DEPENDENT_PERSONAL_SERVICES
- AU_42_PUBLIC_ENTERTAINMENT
- CA_17_INDEPENDENT_PERSONAL_SERVICES
- CA_18_DEPENDENT_PERSONAL_SERVICES
- CA_42_PUBLIC_ENTERTAINMENT
- CN_17_INDEPENDENT_PERSONAL_SERVICES
- CN_18_DEPENDENT_PERSONAL_SERVICES
- CN_42_PUBLIC_ENTERTAINMENT
- GB_17_INDEPENDENT_PERSONAL_SERVICES
- GB_18_DEPENDENT_PERSONAL_SERVICES
- GB_42_PUBLIC_ENTERTAINMENT
- IL_16_SCHOLARSHIP_AND_FELLOWSHIP_GRANT
- IL_17_INDEPENDENT_PERSONAL_SERVICES
- IL_18_DEPENDENT_PERSONAL_SERVICES
- IL_42_PUBLIC_ENTERTAINMENT
- IN_17_INDEPENDENT_PERSONAL_SERVICES
- IN_18_DEPENDENT_PERSONAL_SERVICES
- IN_42_PUBLIC_ENTERTAINMENT
- MX_17_INDEPENDENT_PERSONAL_SERVICES
- MX_18_DEPENDENT_PERSONAL_SERVICES
- MX_42_PUBLIC_ENTERTAINMENT
description: The tax treaty code the payee is claiming.
TaxTreatyBenefitsSchema:
type: object
properties:
residentCountry:
type: string
description: The foreign country, adhering to `ISO 3166-2` standards, the payee is claiming
treaty benefits as a resident with which the United States has an income tax treaty for payments
subject to withholding under chapter 3 or under section 1446(a) or (f).
minLength: 2
maxLength: 2
claimedProvision:
type: string
description: The article and paragraph of the tax treaty that cite the provisions the payee
is claiming. Max 20 characters.
maxLength: 20
rateOfWithholding:
type: number
description: The decimal percentage rate of withholding the tax treaty allows by default. Rates
are subject to validation and approval by the Payer.
incomeCode:
allOf:
- $ref: '#/components/schemas/TaxTreatyIncomeCodeEnum'
description: The code of the income associated with the claimed rate of withholding.
incomeType:
type: string
const: SERVICES
description: The type of income associated with the claimed rate of withholding.
additionalConditions:
type: string
description: The additional conditions the payee is claiming under the cited tax treaty.
required:
- claimedProvision
- incomeCode
- incomeType
- rateOfWithholding
- residentCountry
description: The tax treaty benefits the payee is claiming.
TaxTreatyCountry:
type: string
description: Filters the list of tax treaties based on the specified foreign `country`, adhering
to `ISO 3166-2` standards.
TaxTreatyIncomeCodeEnum:
type: string
enum:
- '16'
- '17'
- '18'
- '42'
TaxTreatySchema:
type: object
properties:
taxTreatyCode:
allOf:
- $ref: '#/components/schemas/TaxTreatyAboundCodeEnum'
description: Abound's shorthand code for a particular US tax treaty.
residentCountry:
type: string
description: The foreign country, adhering to `ISO 3166-2` standards, associated with the tax
treaty.
rateOfWithholding:
type: number
description: The decimal percentage rate of withholding the tax treaty allows by default. Rates
are subject to validation and approval by the Payer.
description:
type: string
description: The income description associated with the tax treaty.
required:
- description
- rateOfWithholding
- residentCountry
- taxTreatyCode
examples:
- taxTreatyCode: GB_17_INDEPENDENT_PERSONAL_SERVICES
residentCountry: GB
rateOfWithholding: 0
description: Independent personal services performed in the US
TinFingerprint:
type: string
description: Your unique token that points to a TIN.
TinFingerprintQueryParam:
type: string
description: Filters the list of TIN Verifications based on the `tinFingerprint` field.
TinTypeEnum:
type: string
enum:
- INDIVIDUAL
- BUSINESS
description: The type of the TIN. `INDIVIDUAL` refers to SSNs, ITINs, or ATINs. While `BUSINESS`
refers to EINs.
TinVerificationId:
type: string
description: The unique identifier for the TIN Verification.
TinVerificationRequestSchema:
type: object
properties:
name:
type: string
description: The legal name (first + last) or business name.
tin:
type: string
description: The tax identification number, commonly referred to as a TIN. No hyphens. Numerical
digits only.
minLength: 9
maxLength: 9
userId:
$ref: '#/components/schemas/UserId'
required:
- name
- tin
examples:
- name: Ada Lovelace
tin: '000000000'
TinVerificationSchema:
allOf:
- $ref: '#/components/schemas/TinVerificationRequestSchema'
- type: object
properties:
id:
type: string
description: The unique identifier for this TIN Verification.
createdAt:
type: string
format: date-time
description: The creation date and time of the TIN Verification in `ISO 8601` format.
status:
$ref: '#/components/schemas/TinVerificationStatusEnum'
tinType:
$ref: '#/components/schemas/TinTypeEnum'
tinFingerprint:
type: string
description: The fingerprint for this TIN Verification.
required:
- createdAt
- id
- status
- tinFingerprint
examples:
- name: Ada Lovelace
id: tinVerificationId_sample41SD71AV8f
createdAt: '2024-01-01T00:00:00.000Z'
status: MATCH
tin: '*******00'
tinFingerprint: tinFingerprint_samplehy2BWO6JJG
tinType: INDIVIDUAL
TinVerificationStatusEnum:
type: string
enum:
- MATCH
- MISMATCH
- PENDING
description: The status of the TIN Verification.
TinVerificationStatusQueryParam:
type: string
description: Filters the list of TIN Verifications based on the `status` field.
UserCreatedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: USER_CREATED
required:
- event
UserId:
type: string
description: The unique identifier for a single end-user of your application.
UserRequestSchema:
type: object
properties:
email:
type: string
description: The user's email address. Abound assume's you have taken the proper steps to verify
the ownership of this email address.
deprecated: true
foreignId:
type: string
description: The customer-specific unique identifier associated with this user.
metadata:
type: object
additionalProperties:
type: string
description: Use metadata for storing additional user data. For filtering, please use `foreignId`.
examples:
- foreignId: my-foreign-id
UserSchema:
allOf:
- $ref: '#/components/schemas/UserRequestSchema'
- type: object
properties:
id:
type: string
description: The unique identifier for this user.
createdAt:
type: string
format: date-time
description: The creation date and time of the user in `ISO 8601` format.
required:
- createdAt
- id
examples:
- id: userId_sampleXGMFnhOpeR
createdAt: '2024-01-01T00:00:00.000Z'
foreignId: my-foreign-id
UserUpdatedWebhookPayload:
allOf:
- $ref: '#/components/schemas/WebhookPayloadBaseSchema'
- type: object
properties:
event:
type: string
const: USER_UPDATED
required:
- event
W8BenBeneficialOwnerRequestSchema:
type: object
properties:
name:
type: string
description: The payee's legal name (first + last).
citizenshipCountry:
type: string
description: The payee's country of citizenship adhering to `ISO 3166-2` standards.
minLength: 2
maxLength: 2
tin:
type: string
description: The payee's US 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
foreignTin:
type: string
description: The payee's foreign tax identifying number, commonly referred to as a FTIN. No
hyphens. Alphanumeric digits only. Alternatively, you may pass the corresponding `foreignTinFingerprint`.
dateOfBirth:
type: string
description: The date, in `YYYY-MM-DD` format, the payee was born on.
pattern: ^\d{4}-\d{2}-\d{2}$
permanentResidenceAddress:
allOf:
- $ref: '#/components/schemas/ForeignAddressSchema'
description: Permanent residence address (street, apt. or suite no., or rural route). Do not
use a P.O. box or in-care-of address.
mailingAddress:
allOf:
- $ref: '#/components/schemas/AddressSchema'
description: The mailing address. Only include if different from the permanent residence address.
required:
- citizenshipCountry
- dateOfBirth
- name
- permanentResidenceAddress
description: The payee (beneficial owner) completing the document.
W8BenBeneficialOwnerSchema:
allOf:
- $ref: '#/components/schemas/W8BenBeneficialOwnerRequestSchema'
- type: object
properties:
tinFingerprint:
$ref: '#/components/schemas/TinFingerprint'
tinType:
$ref: '#/components/schemas/TinTypeEnum'
tinVerificationId:
$ref: '#/components/schemas/TinVerificationId'
tinVerificationStatus:
$ref: '#/components/schemas/TinVerificationStatusEnum'
foreignTinFingerprint:
$ref: '#/components/schemas/ForeignTinFingerprint'
W8BenEBeneficialOwnerRequestSchema:
type: object
properties:
name:
type: string
description: The payee's legal name (first + last).
incorporationCountry:
type: string
description: The payee's country of incorporation adhering to `ISO 3166-2` standards.
minLength: 2
maxLength: 2
tin:
type: string
description: The payee's US 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
foreignTin:
type: string
description: The payee's foreign tax identifying number, commonly referred to as a FTIN. No
hyphens. Alphanumeric digits only. Alternatively, you may pass the corresponding `foreignTinFingerprint`.
permanentResidenceAddress:
allOf:
- $ref: '#/components/schemas/ForeignAddressSchema'
description: Permanent residence address (street, apt. or suite no., or rural route). Do not
use a P.O. box or in-care-of address.
mailingAddress:
allOf:
- $ref: '#/components/schemas/AddressSchema'
description: The mailing address. Only include if different from the permanent residence address.
required:
- incorporationCountry
- name
- permanentResidenceAddress
description: The payee (beneficial owner) completing the document.
W8BenEBeneficialOwnerSchema:
allOf:
- $ref: '#/components/schemas/W8BenEBeneficialOwnerRequestSchema'
- type: object
properties:
tinFingerprint:
$ref: '#/components/schemas/TinFingerprint'
tinType:
$ref: '#/components/schemas/TinTypeEnum'
tinVerificationId:
$ref: '#/components/schemas/TinVerificationId'
tinVerificationStatus:
$ref: '#/components/schemas/TinVerificationStatusEnum'
foreignTinFingerprint:
$ref: '#/components/schemas/ForeignTinFingerprint'
W8BenEFormFieldsRequestSchema:
type: object
properties:
taxClassification:
$ref: '#/components/schemas/W8BenETaxClassificationEnum'
isForeignTinNotRequired:
type: boolean
description: Pass true if a foreign TIN is not legally required. Otherwise false.
taxTreatyCode:
allOf:
- $ref: '#/components/schemas/TaxTreatyAboundCodeEnum'
description: Abound's shorthand code for the particular US tax treaty the payee is claiming.
referenceNumbers:
type: array
items:
type: string
description: The reference numbers to list on this W-8BEN-E. Two reference numbers are allowed.
Max 20 characters each.
isCertified:
type: boolean
description: Pass true if the payee has certified the W-8BEN-E. Otherwise false.
electronicSignature:
allOf:
- $ref: '#/components/schemas/ElectronicSignatureOfPayeeSchema'
description: The electronic signature of the payee.
required:
- isCertified
- taxClassification
W8BenEFormFieldsSchema:
type: object
properties:
taxClassification:
$ref: '#/components/schemas/W8BenETaxClassificationEnum'
isForeignTinNotRequired:
type: boolean
description: Pass true if a foreign TIN is not legally required. Otherwise false.
taxTreatyBenefits:
allOf:
- $ref: '#/components/schemas/TaxTreatyBenefitsSchema'
description: The tax treaty benefits the payee is claiming.
referenceNumbers:
type: array
items:
type: string
description: The reference numbers to list on this W-8BEN-E. Two reference numbers are allowed.
Max 20 characters each.
isCertified:
type: boolean
description: Pass true if the payee has certified the W-8BEN-E. Otherwise false.
electronicSignature:
allOf:
- $ref: '#/components/schemas/ElectronicSignatureOfPayeeSchema'
description: The electronic signature of the payee.
required:
- isCertified
- taxClassification
W8BenERequestSchema:
type: object
properties:
payee:
$ref: '#/components/schemas/W8BenEBeneficialOwnerRequestSchema'
formFields:
$ref: '#/components/schemas/W8BenEFormFieldsRequestSchema'
userId:
$ref: '#/components/schemas/UserId'
required:
- formFields
- payee
examples:
- payee:
name: Hooli
incorporationCountry: GB
tin: '111111111'
foreignTin: DQ123456C
permanentResidenceAddress:
address: 43 Hilly Fields
address2: Suite 32
city: Lewisham
state: London
postalCode: SE13 7JN
country: GB
mailingAddress:
address: 256 Byron Street
address2: Suite 32
city: Palo Alto
postalCode: '94306'
state: CA
country: US
formFields:
taxClassification: CORPORATION
isForeignTinNotRequired: false
taxTreatyCode: GB_17_INDEPENDENT_PERSONAL_SERVICES
referenceNumbers:
- '123456789'
isCertified: true
electronicSignature:
signature: Hooli Representative
printedName: Hooli Representative
signedAt: '2024-01-01T00:00:00.000Z'
ipAddress: 127.0.0.1
W8BenESchema:
type: object
properties:
id:
type: string
description: The unique identifier for the W-8BEN-E document.
createdAt:
type: string
format: date-time
description: The date and time in `ISO 8601` format when the W-8BEN-E document was created.
expiresAt:
type: string
format: date-time
description: The date and time in `ISO 8601` format when the W-8BEN-E is expired and requires
re-collection.
url:
type: string
description: The URL to the W-8BEN-E document.
payee:
$ref: '#/components/schemas/W8BenEBeneficialOwnerSchema'
formFields:
$ref: '#/components/schemas/W8BenEFormFieldsSchema'
userId:
$ref: '#/components/schemas/UserId'
required:
- createdAt
- expiresAt
- formFields
- id
- payee
- url
examples:
- id: documentId_sampleGyuBXlfAwo
createdAt: '2024-01-01T00:00:00.000Z'
expiresAt: '2029-01-01T00:00:00.000Z'
url: https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-W-8BEN-E.pdf
payee:
name: Hooli
incorporationCountry: GB
tin: '*******11'
permanentResidenceAddress:
address: 43 Hilly Fields
address2: Suite 32
city: Lewisham
state: London
postalCode: SE13 7JN
country: GB
mailingAddress:
address: 256 Byron Street
address2: Suite 32
city: Palo Alto
postalCode: '94306'
state: CA
country: US
tinType: BUSINESS
tinFingerprint: tinFingerprint_sample847jI1LwxF
tinVerificationId: tinVerificationId_sample1b0E6efa89
tinVerificationStatus: MATCH
foreignTin: '*******6C'
foreignTinFingerprint: tinFingerprint_sampleanXo4V9nL9
formFields:
taxClassification: CORPORATION
isForeignTinNotRequired: false
taxTreatyBenefits:
residentCountry: GB
claimedProvision: '7'
rateOfWithholding: 0
incomeCode: '17'
incomeType: SERVICES
additionalConditions: Independent personal services performed in the US
referenceNumbers:
- '123456789'
isCertified: true
electronicSignature:
signature: Hooli Representative
printedName: Hooli Representative
signedAt: '2024-01-01T00:00:00.000Z'
ipAddress: 127.0.0.1
W8BenETaxClassificationEnum:
type: string
enum:
- CENTRAL_BANK_OF_ISSUE
- COMPLEX_TRUST
- CORPORATION
- DISREGARDED_ENTITY
- ESTATE
- FOREIGN_GOVERNMENT_CONTROLLED_ENTITY
- FOREIGN_GOVERNMENT_INTEGRAL_PART
- GRANTOR_TRUST
- INTERNATIONAL_ORGANIZATION
- PARTNERSHIP
- PRIVATE_FOUNDATION
- SIMPLE_TRUST
- TAX_EXEMPT_ORGANIZATION
description: The tax classification of the payee.
W8BenFormFieldsRequestSchema:
type: object
properties:
isForeignTinNotRequired:
type: boolean
description: Pass true if a foreign TIN is not legally required. Otherwise false.
taxTreatyCode:
allOf:
- $ref: '#/components/schemas/TaxTreatyAboundCodeEnum'
description: Abound's shorthand code for the particular US tax treaty the payee is claiming.
referenceNumbers:
type: array
items:
type: string
description: The reference numbers to list on this W-8BEN. Two reference numbers are allowed.
Max 20 characters each.
isCertified:
type: boolean
description: Pass true if the payee has certified the W-8BEN. Otherwise false.
electronicSignature:
allOf:
- $ref: '#/components/schemas/ElectronicSignatureOfPayeeSchema'
description: The electronic signature of the payee.
required:
- isCertified
W8BenFormFieldsSchema:
type: object
properties:
taxClassification:
type: string
const: INDIVIDUAL
description: The tax classification of the payee.
isForeignTinNotRequired:
type: boolean
description: Pass true if a foreign TIN is not legally required. Otherwise false.
taxTreatyBenefits:
allOf:
- $ref: '#/components/schemas/TaxTreatyBenefitsSchema'
description: The tax treaty benefits the payee is claiming.
referenceNumbers:
type: array
items:
type: string
description: The reference numbers to list on this W-8BEN. Two reference numbers are allowed.
Max 20 characters each.
isCertified:
type: boolean
description: Pass true if the payee has certified the W-8BEN. Otherwise false.
electronicSignature:
allOf:
- $ref: '#/components/schemas/ElectronicSignatureOfPayeeSchema'
description: The electronic signature of the payee.
required:
- isCertified
- taxClassification
W8BenRequestSchema:
type: object
properties:
payee:
$ref: '#/components/schemas/W8BenBeneficialOwnerRequestSchema'
formFields:
$ref: '#/components/schemas/W8BenFormFieldsRequestSchema'
userId:
$ref: '#/components/schemas/UserId'
required:
- formFields
- payee
examples:
- payee:
name: Ada Lovelace
citizenshipCountry: GB
tin: '000000000'
foreignTin: DQ123456C
dateOfBirth: '1982-12-10'
permanentResidenceAddress:
address: 43 Hilly Fields
address2: Suite 32
city: Lewisham
state: London
postalCode: SE13 7JN
country: GB
mailingAddress:
address: 256 Byron Street
address2: Suite 32
city: Palo Alto
postalCode: '94306'
state: CA
country: US
formFields:
isForeignTinNotRequired: false
taxTreatyCode: GB_17_INDEPENDENT_PERSONAL_SERVICES
referenceNumbers:
- '123456789'
isCertified: true
electronicSignature:
signature: Ada Lovelace
printedName: Ada Lovelace
signedAt: '2024-01-01T00:00:00.000Z'
ipAddress: 127.0.0.1
W8BenSchema:
type: object
properties:
id:
type: string
description: The unique identifier for the W-8BEN document.
createdAt:
type: string
format: date-time
description: The date and time in `ISO 8601` format when the W-8BEN document was created.
expiresAt:
type: string
format: date-time
description: The date and time in `ISO 8601` format when the W-8BEN is expired and requires
re-collection.
url:
type: string
description: The URL to the W-8BEN document.
payee:
$ref: '#/components/schemas/W8BenBeneficialOwnerSchema'
formFields:
$ref: '#/components/schemas/W8BenFormFieldsSchema'
userId:
$ref: '#/components/schemas/UserId'
required:
- createdAt
- expiresAt
- formFields
- id
- payee
- url
examples:
- id: documentId_samplexEM8PRV7sh
createdAt: '2024-01-01T00:00:00.000Z'
expiresAt: '2029-01-01T00:00:00.000Z'
url: https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-W-8BEN.pdf
payee:
name: Ada Lovelace
citizenshipCountry: GB
dateOfBirth: '1982-12-10'
permanentResidenceAddress:
address: 43 Hilly Fields
address2: Suite 32
city: Lewisham
state: London
postalCode: SE13 7JN
country: GB
mailingAddress:
address: 256 Byron Street
address2: Suite 32
city: Palo Alto
postalCode: '94306'
state: CA
country: US
tin: '*******00'
tinType: INDIVIDUAL
tinFingerprint: tinFingerprint_samplehy2BWO6JJG
tinVerificationId: tinVerificationId_sample41SD71AV8f
tinVerificationStatus: MATCH
foreignTin: '*******6C'
foreignTinFingerprint: tinFingerprint_sampleanXo4V9nL9
formFields:
taxClassification: INDIVIDUAL
isForeignTinNotRequired: false
taxTreatyBenefits:
residentCountry: GB
claimedProvision: '7'
rateOfWithholding: 0
incomeCode: '17'
incomeType: SERVICES
additionalConditions: Independent personal services performed in the US
referenceNumbers:
- '123456789'
isCertified: true
electronicSignature:
signature: Ada Lovelace
printedName: Ada Lovelace
signedAt: '2024-01-01T00:00:00.000Z'
ipAddress: 127.0.0.1
W9ExemptFatcaCodeSchema:
type: string
enum:
- A
- B
- C
- D
- E
- F
- G
- H
- I
- J
- K
- L
- M
- NOT_APPLICABLE
description: The code to identify a payee that is exempt from reporting under FATCA.
W9ExemptPayeeCodeSchema:
type: string
enum:
- '1'
- '2'
- '3'
- '4'
- '5'
- '6'
- '7'
- '8'
- '9'
- '10'
- '11'
- '12'
- '13'
description: The code to identify a payee that is exempt from backup withholding.
W9FormFieldsSchema:
type: object
properties:
taxClassification:
allOf:
- $ref: '#/components/schemas/W9TaxClassificationSchema'
description: The U.S. federal tax classification of the person.
otherTaxClassification:
type: string
description: The tax classification of the payee if `taxClassification` is `OTHER`.
hasIndirectForeignOwnership:
type: boolean
description: If your `taxClassification` is `PARTNERSHIP`, `TRUST`, `ESTATE`, or `LLC_PARTNERSHIP`,
and you are providing this form to a partnership, trust, or estate in which you have an ownership
interest, pass `true` if you have any foreign partners, owners, or beneficiaries.
exemptPayeeCode:
allOf:
- $ref: '#/components/schemas/W9ExemptPayeeCodeSchema'
description: The code to identify a payee that is exempt from backup withholding.
exemptFatcaCode:
allOf:
- $ref: '#/components/schemas/W9ExemptFatcaCodeSchema'
description: The code to identify a payee that is exempt from reporting under FATCA.
accountNumbers:
type: array
items:
type: string
description: The account numbers to list on this W-9.
isSubjectToBackupWithholding:
type: boolean
description: If the payee is subject to backup withholding, pass `true`.
certifiedAt:
type: string
format: date-time
description: The certification date and time in `ISO 8601` format. This field is deprecated.
Please use `electronicSignature` instead.
deprecated: true
electronicSignature:
allOf:
- $ref: '#/components/schemas/ElectronicSignatureOfPayeeSchema'
description: The electronic signature of the payee.
required:
- taxClassification
W9RequestSchema:
type: object
properties:
payee:
$ref: '#/components/schemas/PayeeWithOptionalTinTypeRequestSchema'
payer:
$ref: '#/components/schemas/PayerRequestSchema'
formFields:
$ref: '#/components/schemas/W9FormFieldsSchema'
userId:
$ref: '#/components/schemas/UserId'
required:
- formFields
- payee
examples:
- payee:
name: Ada Lovelace
address: 1401 N Shoreline Blvd
address2: Suite 1
city: Mountain View
country: US
postalCode: '94043'
state: CA
tin: '000000000'
tinType: INDIVIDUAL
formFields:
taxClassification: INDIVIDUAL
isSubjectToBackupWithholding: false
electronicSignature:
signature: Ada Lovelace
printedName: Ada Lovelace
signedAt: '2024-01-01T00:00:00.000Z'
ipAddress: 127.0.0.1
W9Schema:
type: object
properties:
id:
type: string
description: The unique identifier for the W-9 document.
createdAt:
type: string
format: date-time
description: The date and time in `ISO 8601` format when the W-9 document was created.
url:
type: string
description: The URL to the W-9 document.
payee:
$ref: '#/components/schemas/PayeeSchema'
payer:
$ref: '#/components/schemas/PayerSchema'
formFields:
$ref: '#/components/schemas/W9FormFieldsSchema'
userId:
$ref: '#/components/schemas/UserId'
required:
- createdAt
- formFields
- id
- payee
- url
examples:
- id: documentId_sampleVppNzzIbQT
createdAt: '2024-01-01T00:00:00.000Z'
url: https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-W-9.pdf
payee:
name: Ada Lovelace
address: 1401 N Shoreline Blvd
address2: Suite 1
city: Mountain View
country: US
postalCode: '94043'
state: CA
tin: '*******00'
tinType: INDIVIDUAL
tinFingerprint: tinFingerprint_samplehy2BWO6JJG
tinVerificationId: tinVerificationId_sample41SD71AV8f
tinVerificationStatus: MATCH
formFields:
accountNumbers:
- '1234567890'
- '1234567891'
taxClassification: INDIVIDUAL
isSubjectToBackupWithholding: false
electronicSignature:
signature: Ada Lovelace
printedName: Ada Lovelace
signedAt: '2024-01-01T00:00:00.000Z'
ipAddress: 127.0.0.1
W9TaxClassificationSchema:
type: string
enum:
- INDIVIDUAL
- SOLE_PROPRIETOR
- C_CORPORATION
- S_CORPORATION
- PARTNERSHIP
- TRUST
- ESTATE
- LLC_PARTNERSHIP
- LLC_C_CORPORATION
- LLC_S_CORPORATION
- OTHER
description: The U.S. federal tax classification of the person.
WebhookPayloadBaseSchema:
type: object
properties:
id:
type: string
description: The id of the webhook attempt
webhookId:
type: string
description: The id of the webhook event
timestamp:
type: string
format: date-time
description: The date and time in `ISO 8601` format when the webhook attempt was triggered
resourceId:
type: string
description: The id of the resource that triggered the webhook
resourceUrl:
type: string
description: The URL of the resource that triggered the webhook
required:
- id
- resourceId
- resourceUrl
- timestamp
- webhookId