Skip to main content
Version: 1.7.3

Creation of Tax Form

Explore the event sequence below that leads to the creation of a tax form.

Once you send a request to the API, its authenticity is verified through a series of validation checks before the actual creation of the form begins.

  • Send Request to Create Tax Form: Send your API request with the return information using the CREATE API Endpoint to create a tax form.

    The creation of the tax form involves the following steps:

    • Authentication: The JWT in the API request header will be validated for authenticity before it is processed further.
    • Validation: Once the authentication is successful, our system will check for the JWT, field validations, and IRS business rules validations. If these fields pass the validation checks, the form will be processed further, if not, the errors will be updated through Response JSON.
    • Processing: Records that pass the business validation will be processed further, and their respective statuses will be communicated in Response JSON through a collection of Success Records.
    • Form Creation: The API will create forms for records that clear the business validation. For each CREATE API Request, you will get a SubmissionId in the Response. For 1099/W-2/1095, you will get multiple RecordIds for each of the returns. You should store these IDs for further processing of the returns and retrieve statuses of them.
  • Update Form: Use this endpoint to update/change any information in a return that is already created in your account. You will have to provide the SubmissionId/RecordId to reference a particular return. If you want to add a return to an existing SubmissionId, you can mention the SubmissionId in the Update request and leave the RecordId as null.

  • Transmit Form: When the return is ready for transmission, an API request has to be called using the TRANSMIT API endpoint so that the e-filing process is initiated. Please note that the prepaid credits will be deducted from your account only when a return is transmitted.

  • Handling Errors in Response: In order to help you understand the error codes, the unique error codes are made available in Response JSON.

  • Returns Statuses using Webhooks: The API uses Webhooks to communicate the filing status to you. The Webhook URL has to be configured in the Sandbox account.

  • Download PDF using Webhooks: An API request has to be sent to the GETPDF API Endpoint to download the PDF form. In turn, the request is processed offline, PDFs are generated and saved in a secure path. You will be communicated on the secure location path through Webhooks.

  • Retrieve PDF URLs in Response: You can also use the RequestPdfURLs endpoint to retrieve the PDF URLs for single or multiple recipients in the response itself. The PDF URL will be returned in the response only if it is already generated by us. You must use the SubmissionId or RecordIds to request the PDF URLs.