Skip to main content
Version: 1.7.3

GetbyRecordIds

This endpoint can be used to get the information from the 1099-DIV 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 1099-DIV Form data.

POST Form1099DIV/GetbyRecordIds 
Run in Postman

Request Body

FieldTypeDescription
RecordIdsobject[]Contains the object of RecordId
RecordIdGuidThe unique identifier of the record. Provide the RecordId for which you need to obtain the information

Request Json

{
"RecordIds": [
{
"RecordId": "a21f67a0-4b91-4cb8-8270-409c3ecce2f9"
},
{
"RecordId": "8ce1aa59-0f4a-415a-ac11-865568d8e901"
}
]
}

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code
StatusMessagestringDetailed status message
Form1099Recordsobject []Contains information about Form 1099-DIV returns.
SubmissionManifestobjectSubmissionManifest provides the brief information about a particular submission on the whole. It contains information like Submission ID, Tax Year, IsPostal, IsFederalFiling, IsStateFiling, IsOnlineAccess, IsScheduleFiling & ScheduleFiling service details.
    SubmissionIdGuidUnique identifier created by TaxBandits for each submission. Not required when you are creating a return.
    TaxYearstringTax year of Form 1099-DIV to be filed.
Allowed values: "2022","2023","2024"
    IsFederalFilingBooleanFederal Filing for the return will be enabled when the value is True. The Form 1099-DIV will be sent directly to the IRS.
    IsStateFilingBooleanState Filing for the return will be enabled when the value is True. Form 1099-DIV forms will be directly filed with the respective recipient states.
Note: State Filing will not be created for the states that do not require State filing.
    IsPostalBooleanPostal Order will be created when the value is set as True. Once the return is Transmitted, Form 1099-DIV Recipient copies will be postal mailed to the recipient's address via USPS.
Note: Postal Orders for Foreign Address will not be created.
    IsOnlineAccessBooleanOnline 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 1099-DIV Recipient copies from the portal.
    IsScheduleFilingBooleanWhen true, schedule filing services will be provided for Form 1099-DIV returns under this submission.
    ScheduleFilingobjectContains preferred date to submit the returns to the IRS. Required only when "IsScheduleFiling" is True.
        EfileDatestringDate of Schedule Filing. Enter the date in the format: MM/DD/YYYY or MM-DD-YYYY Example: 10/20/2024 or 10-20-2024
ReturnHeaderobjectContains information about the Business details.
    BusinessobjectObject to identify the Business Details.
        BusinessIdGuidReturns the unique Business ID for the Business. It can be used in future to refer the same business.
        BusinessNmstringName of the business
Size Range: ..80
        FirstNmstringFirst Name of the Individual
Size Range: ..20
        MiddleNmstringMiddle Name of the Individual
Size Range: ..20
        LastNmstringLast Name of the Individual
Size Range: ..20
        SuffixstringSuffix of the Individual
Size Range: ..20
        PayerRefstringOptional An unique identifier for each payer completing their information. This identifier can be used in future references of the payer in the API.
Size Range: ..50
        TradeNmstringOptional Name under which the business operates
Size Range: ..80
        IsEINBooleanWhen true, identifies the business with an EIN.
        EINorSSNstringReturns the Employer Identification Number of Business
Size Range: 9
        EmailstringOptional Email address of the Business
Size Range: ..100
        ContactNmstringOptional Name of the person who can be contacted by the IRS
Size Range: ..27
        PhonestringOptional Phone number of the business
Size Range: 10
        PhoneExtnstringOptional Extension of the business phone number
Size Range: ..5
        FaxstringOptional Fax number of the Business
Size Range: 10
        BusinessTypestringOptional Type of business. Optional for W-2/1099 and mandatory for 94X series
Size Range: ..4
Allowed values

"ESTE", "PART", "CORP", "EORG", "SPRO"

        SigningAuthorityobjectOptional Details of the person who is authorized to sign the return
            NamestringOptional Name of the signing authority
Size Range: ..35
            PhonestringOptional Phone number of the signing authority
Size Range: 10
            BusinessMemberTypestringOptional Business title of the signing authority
Size Range: 5..29
Allowed values

"CORPORATESECRETARY", "SECRETARYTREASURER", "PARTNER", "GENERALPARTNER", "LIMITEDPARTNER", "LLCMEMBER", "MANAGINGMEMBER", "MANAGER", "TAX MATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEX ECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CH AIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROF RELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OW NER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER"

        KindOfEmployerstringOptional Identifies the kind of employer. Mandatory for W-2 and optional for Form 1099-DIV and 94X series
Allowed values

"FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY"

        KindOfPayerstringOptional Identifies the kind of payer. This field is mandatory in W-2 and optional in Form 1099-DIV and 94X series
Allowed values

"REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1"

        IsBusinessTerminatedBooleanWhen true, identifies the business as terminated.
        IsForeignBooleanWhen true, identifies the business address with a foreign address.
        USAddressobjectIf IsForeign is false, pass US address of the business
            Address1stringEmployer/Payer's US address (street or post office box of that locality)
Size Range: ..46
            Address2stringOptional Employer/Payer's suite or apartment
Size Range: ..46
            CitystringEmployer/Payer's city
Size Range: ..50
            StatestringEmployer/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"

            ZipCdstringEmployer/Payer's zip code
Size Range: 5..10
        ForeignAddressobjectIf IsForeign is true, pass foreign address of the business
            Address1stringEmployer/Payer's foreign address (street address or post office box of that locality)
Size Range: ..50
            Address2stringOptional Employer/Payer's suite or apartment
Size Range: ..50
            CitystringEmployer/Payer's city
Size Range: ..50
            ProvinceOrStateNmstringEmployer/Payer's province or state name
Size Range: ..50
            CountrystringEmployer/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"

            PostalCdstringEmployer/Payer's postal code
Size Range: ..16
ReturnDataobject[]Contains information about the recipient details and Form 1099-DIV details.
    RecordIdGuidOptionalUnique identifier of a record. Not required when you are creating a return.
    SequenceIdstringAn 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.
    RecipientobjectObject to identify the recipient details.
        RecipientIdGuidOptionalAn unique identifier generated by TaxBandits for a Recipient when a 1099-DIV return is created. You can use this id for your future reference to Update.
        TINTypestringSpecify the TIN type of the recipient.
Allowed values

"SSN", "EIN", "ITIN", "ATIN", "N/A"

        TINstringEnter the nine-digit taxpayer identification number of the Recipient (SSN, ITIN, ATIN, or EIN).
Size Range: 9
        FirstPayeeNmstringEnter 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.
        SecondPayeeNmstringOptional 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.
        FirstNmstringFirst Name of the Individual
Size Range: ..20
        MiddleNmstringMiddle Name of the Individual
Size Range: ..20
        LastNmstringLast Name of the Individual
Size Range: ..20
        SuffixstringSuffix of the Individual
Size Range: ..20
        IsForeignBooleanWhen true, identifies the recipient address with a foreign address.
        USAddressobjectIf IsForeign is false, pass US address of the recipient
            Address1stringRecipient's US address (street address or post office box of that locality)
Size Range: ..46
            Address2stringOptional Recipient's suite or apartment
Size Range: ..46
            CitystringRecipient's city
Size Range: ..50
            StatestringRecipient'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"

            ZipCdstringRecipient's zip code
Size Range: 5..10
        ForeignAddressobjectIf IsForeign is true, pass foreign address of the recipient
            Address1stringRecipient's foreign address (street address or post office box of that locality)
Size Range: ..50
            Address2stringOptional Recipient's suite or apartment
Size Range: ..50
            CitystringRecipient's city.
Size Range: ..50
            ProvinceOrStateNmstringRecipient's Province or State Name.
Size Range: ..50
            CountrystringRecipient'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"

            PostalCdstringRecipient's Postal Code
Size Range: ..16
        EmailstringOptional Recipient's email address.
Size Range: 0..100
        FaxstringOptional Recipient's Fax number.
Size Range: 10
        PhonestringOptional Recipient's Phone Number.
Size Range: 10
    DIVFormDataobjectRecipient's Form 1099-DIV information.
        B1aTotOrdiDivnumberGets dividends, including dividends from money market funds, net short-term capital gains from mutual funds, and other distributions on stock.
Size Range: 0-9999999999.99
        B1bQualiDivnumberGets the portion of the dividends in box 1a that qualifies for the reduced capital gains rates.
Size Range: 0-9999999999.99
        B2aTotCapGainnumberGet total capital gain distributions (long-term). Include all amounts shown in boxes 2b, 2c, 2d, and 2f.
Size Range: 0-9999999999.99
        B2bUnRecapSecGainnumberGet any amount included in box 2a that is an unrecaptured section 1250 gain from certain depreciable real property.
Size Range: 0-9999999999.99
        B2cSec1202GainnumberGet any amount included in box 2a that is a section 1202 gain from certain qualified small business stock.
Size Range: 0-9999999999.99
        B2dCollGainnumberGet any amount included in box 2a that is a 28% rate gain from sales or exchanges of collectibles.
Size Range: 0-9999999999.99
        B2eSec897OrdiDivnumberGet any amount included in box 1a that is section 897 gain from dispositions of USRPI.
Size Range: 0-9999999999.99
        B2fSec897CapGainnumberGet any amount included in box 2a that is section 897 gain from dispositions of USRPI.
Size Range: 0-9999999999.99
        B3NonDivDistnumberGet nondividend distributions, if determinable.
Size Range: 0-9999999999.99
        B4FedIncTaxWHnumberGet the backup withholding, for the payments reported in box1, box 2 and box 8 of this form.
Size Range: 0-9999999999.99
        B5Sec199ADivnumberGet the qualified REIT dividends paid by a REIT or section 199A dividends paid by a RIC to the recipient.
Size Range: 0-9999999999.99
        B6InvestExpnumberGet the recipient's pro rata share of certain amounts deductible by a nonpublicly offered RIC in computing its taxable income.
Size Range: 0-9999999999.99
        B7ForeignTaxPaidnumberGet foreign tax paid on dividends and other distributions on stock.
Size Range: 0-9999999999.99
        B8ForeignCountryOrUsPossstringGet the name of the foreign country or U.S. possession for which the foreign tax was paid and reported in box 7.
Size Range: 40
        B9CashLiquiDistnumberGet cash distributed as part of a liquidation.
Size Range: 0-9999999999.99
        B10NonCashLiquiDistnumberGet noncash distributions made as part of a liquidation. Show the fair market value as of the date of distribution.
Size Range: 0-9999999999.99
        B11ExemptIntDivnumberGet exempt-interest dividends from a mutual fund or other RIC. Include specified private activity bond interest dividends in box 12 and in the total for box 11.
Size Range: 0-9999999999.99
        B12SpeciPrivActiBondIntDivnumberGet exempt-interest dividends paid by a RIC on specified private activity bonds to the extent that the dividends are attributable to interest on the bonds received by the RIC minus an allocable share of the expenses.
Size Range: 0-9999999999.99
        IsFATCABooleanWhen true, identifies a U.S. payer reporting on Form(s) 1099 (including reporting payments on this Form 1099-Div) to satisfy their foreign financial asset reporting requirement with respect to a U.S. account.
        AccountNumstringAccount number of Payer having multiple accounts for a recipient for whom more than one Form 1099-DIV 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.
        Is2ndTINnotBooleanWhen true, identifies a Payer who is notified by the IRS twice within 3 calendar years for providing an incorrect TIN and do not want the IRS to send any more notices.
        Statesobject[]Contains list of state returns information.
            StateCdstringState Code.
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", "M O", "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"

            StateIdNumstringIdentification Number of State.
Size Range: ..20
            StateWHnumberIncome tax amount withheld for State.
Size Range: 0-9999999999.99
Errorsobject[]Shows detailed error information
    IdstringReturns the validation error Id
    NamestringName of the validation error
    MessagestringDescription 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",
"Form1099Records": [
{
"SubmissionManifest": {
"SubmissionId": "46c0e092-bcc4-4067-83e3-167583e569bb",
"TaxYear": "2024",
"IsFederalFiling": true,
"IsStateFiling": null,
"IsPostal": true,
"IsOnlineAccess": true,
"IsScheduleFiling": false,
"ScheduleFiling": null
},
"ReturnHeader": {
"Business": {
"BusinessId": "2c12d45c-9d34-4cfd-acab-ada8613250a1",
"PayerRef": "Snow123",
"BusinessNm": "Snowdaze LLC",
"FirstNm": null,
"MiddleNm": null,
"LastNm": null,
"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": null,
"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,
"ACADetails": null
}
},
"ReturnData": [
{
"RecordId": "b02bf9c8-291e-4795-ab15-c4438ed1b74f",
"SequenceId": "1",
"IsPostal": true,
"IsOnlineAccess": true,
"IsForced": false,
"Recipient": {
"RecipientId": "d85fbc97-2eb8-4ffc-ba47-b70a3261a261",
"TINType": "EIN",
"TIN": "36-3814577",
"FirstPayeeNm": "Dairy Delights LLC",
"SecondPayeeNm": "Coco Milk",
"FirstNm": null,
"LastNm": null,
"MiddleNm": null,
"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": "(763) 456-7890"
},
"DIVFormData": {
"B1aTotOrdiDiv": 400.00,
"B1bQualiDiv": 200.00,
"B2aTotCapGain": 2227.00,
"B2bUnRecapSecGain": 41.55,
"B2cSec1202Gain": 42.55,
"B2dCollGain": 48.55,
"B2eSec897OrdiDiv": 50.55,
"B2fSec897CapGain": 3.55,
"B3NonDivDist": 43.55,
"B4FedIncTaxWH": 44.55,
"B5Sec199ADiv": 45.55,
"B6InvestExp": 46.55,
"B7ForeignTaxPaid": 70.55,
"B8ForeignCountryOrUsPoss": "canada",
"B9CashLiquiDist": 80.55,
"B10NonCashLiquiDist": 90.55,
"B11IsFATCA": true,
"B12ExemptIntDiv": 40748.55,
"B13SpeciPrivActiBondIntDiv": 23740.50,
"AccountNum": "20123130000009000001",
"Is2ndTINnot": true,
"States": [
{
"StateCd": "PA",
"StateIdNum": "99999999",
"StateWH": 15.00
},
{
"StateCd": "AZ",
"StateIdNum": "99-9999999",
"StateWH": 17.00
}
]
}
}
]
}
],
"Errors": null
}