Skip to main content
Version: 1.7.3


This utility allows you to get the RecordIds of the previously submitted returns. Which can be used in other endpoints like status, list, update etc.

In the request use a particular SubmissionId to retrive RecordIds of that submission or give BusinessId with TaxYear to get RecordIds againt that business for that TaxYear. Also, use the Form type filter to filter RecordIds for that particular form type.

GET Utility/GetRecordIds 
Run in Postman

Request Params

SubmissionIdGuidUnique identifier of a submission.
BusinessIdGuidUnique identifier of a business.
TaxYearstringList the RecordIds based on the given tax year.
FormTypestringList the RecordIds based on the Type of Form requested for the business.

Request Params


Response Body

BusinessIdGuidUnique identifier of a business.
PayerRefstringA Unique identifier of the payer.
TaxYearstringTax year for which the record IDs are requested.
Recordsobject[]It will show the detailed information about the RecordIds.
    SubmissionIdGuidA Unique identifier created by TaxBandits for each submission.
    FormTypestringType of form for which the RecordIds are listed.
    RecordIdsobject[]Type of form for which the RecordIds are listed.
        RecordIdGuidA Unique identifier of a record.
        RecipientIdGuidA unique ID generated by TaxBandits for a Recipient.
        EmployeeIdGuidA Unique ID generated by Taxbandits for the employee.
        PayeeRefstringA Unique identifier of the recipient. Set by the client.
Errorsobject[]Shows detailed error information.
    IdstringReturns the validation error Id.
    NamestringName of the validation error.
    MessagestringDescription of the validation error.

Response JSON

"BusinessId": "b48037d1-7459-4fec-bae0-48f7ad07b82c",
"PayerRef": "B123",
"TaxYear": "2021",
"Records": [
"SubmissionId": "7862f7cf-0b2e-48cb-a94f-cfbdf94ce757",
"FormType": "Form1099NEC",
"RecordIds": [
"RecordId": "766e3f80-34b6-4b57-987e-5883008dc5a3",
"RecipientId": "1f5bc7ba-e6fc-4082-823c-897d87206537",
"EmployeeId": null,
"PayeeRef": null
"Errors": null