Version: 1.7.3

GetbyRecordIds

This endpoint can be used to get the information from the 1098 Form created against the particular record. You will be able to pull the data from multiple records created under different submissions.

The response will include the Business information, Recipient details, and 1098 Form data.

POST Form1098/GetbyRecordIds

Request Body

Field	Type	Description
RecordIds	object[]	Contains the object of RecordId
RecordId	Guid	The unique identifier of the record. Provide the RecordId for which you need to obtain the information

Request Json

{
   "RecordIds": [
       {
           "RECORDID": "488b1c7e-d244-4d6a-8491-65ae2209a99f"
       }
   ]
}

Response Body

Field	Type	Description
StatusCode	number	Returns the HTTP status codes like 200,300 etc.
StatusName	string	Name of the status code
StatusMessage	string	Detailed status message
Form1098Records	object	Contains information about Form 1098 returns.
SubmissionManifest	object	SubmissionManifest provides brief information about a particular submission on the whole. It contains information like Submission ID Tax Year IsPostal IsFederalFiling IsOnlineAccess IsScheduleFiling & ScheduleFiling service details
SubmissionId	Guid	Unique identifier created by TaxBandits for each submission. Not required when you are creating a return.
TaxYear	string	Tax year of Form 1098 to be filed. Allowed values: "2023"
IsFederalFiling	Boolean	Federal Filing for the return will be enabled when the value is True. Form 1098 will be sent directly to the IRS.
IsPostal	Boolean	Postal Order will be created when the value is set as True. Once the return is Transmitted, Form 1098 Recipient copies will be postal mailed to the recipient's address via USPS. Note: Postal Orders for Foreign Address will not be created.
IsOnlineAccess	Boolean	Online Access will be enabled when the value is set as True. Once the return is Transmitted, an email with the link to the secure TaxBandits portal will be sent to the Recipient. The recipient can provide consent and download Form 1098 Recipient copies from the portal.
IsScheduleFiling	Boolean	When true, schedule filing services will be provided for Form 1098 returns under this submission.
ScheduleFiling	object	Contains preferred date to submit the returns to the IRS. Required only when "IsScheduleFiling" is True.
EfileDate	string	Date of Schedule Filing. Enter the date in the format: MM/DD/YYYY or MM-DD-YYYY Example: 10/20/2023 or 10-20-2023
ReturnHeader	object	Contains information about the Business details.
Business	object	Object to identify the Business Details.
BusinessId	Guid	Returns the unique Business ID for the Business. It can be used in future to refer the same business.
PayerRef	string	Unique identifier of the payer. Size Range: ..50
BusinessNm	string	Name of the business Size Range: ..75
FirstNm	string	First Name of the Individual Size Range: ..20
MiddleNm	string	Middle Name of the Individual Size Range: ..20
LastNm	string	Last Name of the Individual Size Range: ..20
Suffix	string	Suffix of the Individual Allowed values "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
TradeNm	string	Optional Name under which the business operates Size Range: ..75
IsEIN	Boolean	When true, identifies the business with an EIN.
EINorSSN	string	Returns the Employer Identification Number of Business Size Range: 9
Email	string	Optional Email address of the Business Size Range: ..100
ContactNm	string	Optional Name of the person who can be contacted by the IRS Size Range: ..27
Phone	string	Optional Phone number of the business Size Range: 10
PhoneExtn	string	Optional Extension of the business phone number Size Range: ..5
Fax	string	Optional Fax number of the Business Size Range: 10
BusinessType	string	Optional Type of business. Optional for w-2/1098 and mandatory for 94X series Size Range: ..4 Allowed values "ESTE", "PART", "CORP", "EORG", "SPRO"
SigningAuthority	object	Optional Details of the person who is authorized to sign the return
Name	string	Optional Name of the signing authority Size Range: ..35
Phone	string	Optional Phone number of the signing authority Size Range: 10
BusinessMemberType	string	Optional Business title of the signing authority Size Range: 5..29 Allowed values "CORPORATESECRETARY", "SECRETARYTREASURER", "PARTNER", "GENERALPARTNER", "LIMITEDPARTNER", "LLCMEMBER", "MANAGINGMEMBER", "MANAGER", "TAXMATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEXECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CHAIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROFRELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OWNER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER"
KindOfEmployer	string	Optional Identifies the kind of employer. Mandatory for W-2 and optional for 1098 Allowed values "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY"
KindOfPayer	string	Optional Identifies the kind of payer. This field is mandatory in W-2 and optional in 1098 Allowed values "REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1"
IsBusinessTerminated	Boolean	When true, identifies the business as terminated.
IsForeign	Boolean	When true, identifies the business address with a foreign address.
USAddress	object	If IsForeign is false, pass US address of the business
Address1	string	Employer/Payer's US address (street address or post office box of that locality) Size Range: ..46
Address2	string	Optional Employer/Payer's suite or apartment Size Range: ..46
City	string	Employer/Payer's city Size Range: ..50
State	string	Employer/Payer's state code. Refer Static values. Size Range: 2 Allowed values "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
ZipCd	string	Employer/Payer's zip code.
ForeignAddress	object	If IsForeign is true, pass foreign address of the business
Address1	string	Employer/Payer's foreign address (street address or post office box of that locality) Size Range: ..50
Address2	string	Optional Employer/Payer's suite or apartment Size Range: ..50
City	string	Employer/Payer's city Size Range: ..50
ProvinceOrStateNm	string	Employer/Payer's province or state name Size Range: ..50
Country	string	Employer/Payer's country Size Range: 2 Allowed values "AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"
PostalCd	string	Employer/Payer's postal code Size Range: ..16
ReturnData	object[]	Contains information about the recipient details and Form 1098 details.
RecordId	string	Unique identifier of a record. Not required when you are creating a return.
SequenceId	string	An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. Size Range: 50
Recipient	object	Object to identify the recipient details.
RecipientId	Guid	An unique ID generated by TaxBandits after the return is created and will be returned in the Response. You can use this id for your future reference to update.
TINType	string	Specify the TIN type of the recipient. Allowed values "SSN", "EIN", "ITIN", "ATIN", "NA"
TIN	string	Enter the nine-digit taxpayer identification number of the Recipient (SSN, ITIN, ATIN, or EIN). Size Range: 9
FirstPayeeNm	string	Enter the name of the recipient (preferably last name first for an Individual). If more space is required for the name, use the Second Payee Name Field. Size Range: 40
SecondPayeeNm	string	Optional If there are multiple recipients (for example, partners, joint owners, or spouses), use this field for those names not associated with the TIN or if not enough space was provided in the First Payee Name, continue the name in this field. Size Range: 40
FirstNm	string	First Name of the Individual Size Range: ..20
MiddleNm	string	Middle Name of the Individual Size Range: ..20
LastNm	string	Last Name of the Individual Size Range: ..20
Suffix	string	Suffix of the Individual Allowed values "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
IsForeign	Boolean	When true, identifies the recipient address with a foreign address.
USAddress	object	If IsForeign is false, pass US address of the recipient
Address1	string	Recipient's US address (street address or post office box of that locality) Size Range: ..46
Address2	string	Optional Recipient's suite or apartment Size Range: ..46
City	string	Recipient's city Size Range: ..50
State	string	Recipient's state code. Refer Static values. Size Range: 2 Allowed values "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
ZipCd	string	Recipient's zip code. Size Range: 5..10
ForeignAddress	object	If IsForeign is true, pass foreign address of the recipient
Address1	string	Recipient's foreign address (street address or post office box of that locality) Size Range: ..50
Address2	string	Optional Recipient's suite or apartment Size Range: ..50
City	string	Recipient's city. Size Range: ..50
ProvinceOrStateNm	string	Recipient's Province or State Name. Size Range: ..50
Country	string	Recipient's country code. Refer Static values. Size Range: 2 Allowed values "AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"
PostalCd	string	Recipient's Postal Code Size Range: ..16
Email	string	Optional Recipient's email address. Size Range: 0..100
Fax	string	Optional Recipient's Fax number. Size Range: 10
Phone	string	Optional Recipient's Phone Number. Size Range: 10
Form1098Data	object	Recipient's Form 1098 information.
B1IntRec	number	Gets the Mortgage Interest Received from recipient Size Range: 0-9999999999.99
B2OutPrin	number	Gets the Outstanding Mortgage Principal Size Range: 0-9999999999.99
B3OrgDate	string	Gets the Date of the origination of the mortgage Enter the date in the format: MM/DD/YYYY or MM-DD-YYYY Example: 10/20/2023 or 10-20-2023
B4RfdPd	number	Optional Gets the Total refund or credit of a prior year(s) overpayment of interest Size Range: 0-9999999999.99
B5MIP	number	OptionalGets the Total Mortgage Insurance Premiums paid by the recipient Size Range: 0-9999999999.99
B6PtsPd	number	OptionalGets the Points paid on the purchase of the recipient's principal residence Size Range: 0-9999999999.99
B7PropAddSameAsRec	Boolean	When true, identifies that the address of the property securing the mortgage is the same as the recipient's mailing address
B8DescrProp	string	Gets the Description of Property Securing Mortgage Size Range: ..39
B9NumOfProp	number	Optional Gets the Total number of properties secured by the particular mortgage Size Range: 0-9999
B10Other	string	Optional Gets any other item lender wish to report to the recipient, such as real estate taxes, insurance paid from escrow etc. Size Range: ..39
B11AcqDate	string	Optional Gets the date of acquisition Enter the date in the format: MM/DD/YYYY or MM-DD-YYYY Example: 10/20/2023 or 10-20-2023
AccountNum	string	Gets the account number of lender having multiple accounts for a recipient for whom more than one Form 1098 is filed. Size Range: 4..20 Note: If the account number on the return you file is the same as any previously filed return, TaxBandits will append 3 random numbers at the end of the account number.
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error Id
Name	string	Name of the validation error
Message	string	Description of the validation error

Response JSON

Success Response - This is a sample response for successful API requests.

{
  "StatusCode": 200,
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "Form1098Records": [
    {
      "SubmissionManiFest": {
        "SubmissionId": "c03feb88-d8a1-4080-8bc6-4e6adec1bba5",
        "TaxYear": "2023",
        "IsFederalFiling": true,
        "IsPostal": true,
        "IsOnlineAccess": true,
        "IsScheduleFiling": false,
        "ScheduleFiling": null
      },
      "ReturnHeader": {
        "Business": {
          "BusinessId": "8d177248-992e-4ca5-ba9e-1a5a8a93db56",
          "PayerRef": "Snow123",
          "BusinessNm": "Snowdaze LLC",
          "FirstNm": "James",
          "MiddleNm": null,
          "LastNm": "Smith",
          "Suffix": null,
          "TradeNm": "Iceberg Icecreams",
          "IsEIN": true,
          "EINorSSN": "71-3787159",
          "Email": "james@sample.com",
          "ContactNm": null,
          "Phone": "(663) 456-7890",
          "PhoneExtn": "12345",
          "Fax": "(663) 456-7890",
          "BusinessType": "ESTE",
          "SigningAuthority": null,
          "KindOfEmployer": "FEDERALGOVT",
          "KindOfPayer": "REGULAR941",
          "IsBusinessTerminated": true,
          "IsForeign": false,
          "USAddress": {
            "Address1": "3576 AIRPORT WAY",
            "Address2": "UNIT 9",
            "City": "FAIRBANKS",
            "State": "AK",
            "ZipCd": "99709"
          },
          "ForeignAddress": null,
          "IsGovernmentalUnit": false
        }
      },
      "ReturnData": [
        {
          "RecordId": "488b1c7e-d244-4d6a-8491-65ae2209a99f",
          "SequenceId": "1",
          "IsPostal": false,
          "IsOnlineAccess": true,
          "IsForced": true,
          "Recipient": {
            "RecipientId": "472079fb-2dcf-4228-8548-73656ddafc30",
            "TINType": "SSN",
            "TIN": "363-81-4579",
            "FirstPayeeNm": "Dairy Delights LLC",
            "SecondPayeeNm": "Coco Milk",
            "FirstNm": "Shawn",
            "MiddleNm": null,
            "LastNm": "Williams",
            "Suffix": null,
            "IsForeign": true,
            "USAddress": null,
            "ForeignAddress": {
              "Address1": "120 Bremner Blvd",
              "Address2": "Suite 800",
              "City": "Toronto",
              "ProvinceOrStateNm": "Ontario",
              "Country": "CA",
              "PostalCd": "4168682600"
            },
            "Email": "shawn@sample.com",
            "Fax": "(683) 456-7890",
            "Phone": "7634567890"
          },
          "Form1098Data": {
            "B1IntRec": 10000,
              "B2OutPrin": 75000,
              "B3OrgDate": "03/04/2023",
              "B4RfdPd": 700,
              "B5MIP": 700,
              "B6PtsPd": 2000,
              "B7PropAddSameAsRec": true,
              "B8DescrProp": "This is a residential property",
              "B9NumOfProp": 0,
              "B10Other": "Residential taxes paid for the recipient",
              "B11AcqDate": null,
              "AccountNum": "ABC001"
          }
        }
      ]
    }
  ],
  "Errors": null
}

W-9 Automation

1099 Automation

TIN Matching

ACA Automation

941/940 Automation

W-2 Automation

BOI Automation New

Supported Forms

Gig Software

Payroll Software

Affiliate Software

HOA Software

Reselling Platform

HCM Providers

Request Body

Request Json

Response Body

Response JSON