Skip to main content
Version: 2.0.0

Update

Update

This endpoint can be used to update the details on an existing 1095-B return or to add additional returns under the same SubmissionId. Your request JSON must include the SubmissionId and RecordId of the return you want to modify.

Key points

  • You cannot update a return once it has been transmitted.
  • The Tax Year of a submission cannot be changed once created. All other fields can be updated.
POSTform1095b/update

Request Body

FieldTypeDescription
SubmissionManifestobject[]SubmissionManifest provides brief information about a particular submission on the whole.
It contains information like
- Submission ID
- Tax Year
- Federal Filing
- State Filing
- Distribution Details
SubmissionIdGUIDUnique identifier created by TaxBandits for each submission. Not required when you are creating a return.
TaxYearstringTax year of Form 1095-B to be filed.
Allowed values

"2025", "2026"

ReturnHeaderobjectContains information about the Business details.
BusinessobjectObject to identify the Business Details.
BusinessIdGuidUse the unique Business ID (Generated by TaxBandits) that you received in the response of the Business CREATE Endpoint. If you do not have a Business ID, ignore the field. By giving the Business ID, you do not have to provide all the business information again.
PayerRefstringOptional Your unique identifier for the payer. Can replace BusinessId in future requests.
Size Range: 50
IsDefaultBusinessBooleanWhen set to TRUE, this business will be set as the default across requests that do not specify a business.
TINDetailsobjectTIN information for the business.
FormatstringSpecifies how the TIN is passed.
Allowed values

"PLAIN_TIN" - Pass TIN directly.
"ENCRYPTED_TIN" - Pass encrypted TIN.
"TOKENIZED_TIN" - Pass tokenized TIN.

TINTypestringSpecify the TIN type of the business.
Allowed values

"EIN", "SSN", “QI-EIN”, “ITIN”, “WP-EIN”, “WT-EIN”, “NQI-EIN”, “IRSN”

TINstringThe TIN value according to the Format selected.
IndividualNmobjectRequired when TINType is SSN. Provide individual name fields instead of BusinessNm.
FirstNmstringThe first name of the individual.
Size Range: 20
MiddleNmstringOptional Middle name of the individual.
Size Range: 20
LastNmstringThe last name of the individual.
Size Range: 20
SuffixstringOptional Suffix of the individual's name.
Allowed values

"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"

BusinessNmstringLegal name of the business. Required when TINType is EIN.
Size Range: 75
NameCtrlstringIRS name control of the business.
Size Range: 3-4
DBADetailsobject[]Optional DBA (Doing Business As) information.
DBANmstringName of the DBA.
Size Range: 75
DBARefstringUnique identifier for the DBA.
Size Range: 1-50
DBAIdGuidTaxBandits-generated DBA identifier.
Use the unique DBA ID (Generated by TaxBandits) that you received in the response of the Business/AddDBA Endpoint. If you do not have a DBA ID, ignore the field. By giving the DBA ID, you do not have to provide all the DBA information again.
IsDefaultDBABooleanWhen TRUE, marks this DBA as the default.
Addressobject[]Address information of DBA.
Address1stringStreet address or PO Box.
Size Range: 46
Address2stringOptional Suite or apartment number.
Size Range: 46
CitystringDBA's city.
Size Range: 50
ProvinceOrStateNmStringDBA's province or state name.
Allowed values

When the country code is US:
"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", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
When the country code is CA:
"AB", "BC", "MB", "NB", "NL", "NT", "NS", "NU", "ON", "PE", "QC", "SK", "YT"

Note: The size range is set to 50 for all countries except the United States and Canada.
ZipCdstringZIP code of the business.
Size Range: 5-16
CountryString2-character country code of the business.
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", “US”, "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"

ContactDetailsobject[]Details of the person the IRS can contact regarding the given business.
FirstNmstringFirst name of the contact person.
Size Range: 20
MiddleNmstringOptional Middle name of the contact person.
Size Range: 20
LastNmstringLast name of the contact person.
Size Range: 20
SuffixstringOptional The suffix of the contact person.
Allowed values

"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"

PhonestringOptional Phone number of the contact person.
Size Range: 10 digits
PhoneExtnstringOptional Phone extension number.
Size Range: 5
EmailstringOptional Email address of the contact person.
Size Range: 100
FaxstringOptional Fax number of the contact person.
Size Range: 10
ACASpecificobject[]Object to identify the ACA specific details.
IsInsurerBooleanIf true, identifies that you are a health insurance provider
IsGovernmentalUnitBooleanIf true, identifies that you are a government agency or governmental organization providing health coverage.
ReturnDataobject[]Contains information about the recipient details and Form 1095-B details.
SequenceIdstringOptional A unique reference ID for the return that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference.
Size Range: 50
RecipientobjectObject to identify the recipient details.
RecipientIdGuidA unique ID generated by TaxBandits after the recipient is created and will be returned in the Response. You can use this ID for your future reference to update.
PayeeRefstringOptional Your unique identifier for the recipient. Can replace RecipientId in future requests.
Size Range: 50
TINDetailsobjectRecipient TIN information.
FormatstringSpecifies how the TIN is passed.
Allowed values

"PLAIN_TIN" - Pass TIN directly.
"TOKENIZED_TIN" - Pass tokenized TIN.

TINTypestringTIN type of the recipient.
Allowed values

"SSN", "NA"

TINstringThe TIN value according to the Format selected.
IndividualNmobjectRequired when TINType is SSN. Provide individual name fields instead of BusinessNm.
FirstNmstringThe first name of the individual.
Size Range: 20
MiddleNmstringOptional The middle name of the individual.
Size Range: 20
LastNmstringLast name of the individual.
Size Range: 20
SuffixstringOptional The suffix of the individual’s name.
Allowed values

"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"

BusinessNmstringLegal name of the recipient business. Required when TINType is EIN.
Size Range: 75
NameCtrlstringIRS name control of the recipient.
Size Range: 3-4
DBADetailsObjectOptional DBA (Doing Business As) information.
DBAIdGUIDTaxBandits-generated DBA identifier.
Use the unique DBA ID (Generated by TaxBandits) that you received in the response of the Recipient/AddDBA Endpoint. If you do not have a DBA ID, ignore the field. By giving the DBA ID, you do not have to provide all the DBA information again.
DBANmStringName of the DBA.
Size Range: 75
DBARefStringYour unique identifier for this DBA.
1-50 characters
Addressobject[]Address information of DBA
Address1StringStreet address or PO Box.
Max 46 characters
Address2StringOptional Suite or apartment number.
Max 46 characters
CityStringDBA’s city.
Max 50 characters
ProvinceOrStateStringDBA’s province or state name.
When the country code is US :
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", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"

When the country code is CA:
Allowed values

"AB", "BC", "MB", "NB", "NL", "NT", "NS", "NU", "ON", "PE", "QC", "SK", "YT"

Note: The size range is set to 50 for all countries except the United States and Canada.
ZipCdStringDBA’s ZIP code.
5 - 16 characters
CountryStringDBA’s 2-character country code.
Allowed values

"US", "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AT", "AU", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DO", "DM", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RO", "RS", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "SS", "ES", "LK", "SD", "SR", "SJ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TK", "TF", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"

DOBStringOptional Date of Birth of the recipient.
Format: MM/DD/YYYY
AddressObjectPrimary address of the recipient.
Address1StringStreet address or PO Box of the recipient.
Size Range: 46
Address2StringOptional Suite or apartment number of the recipient.
Size Range: 46
CityStringCity of the recipient.
Size Range: 50
ProvinceOrStateStringProvince or state name of the recipient.
When the country code is US :
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"

When the country code is CA:
Allowed values

"AB", "BC", "MB", "NB", "NL", "NT", "NS", "NU", "ON", "PE", "QC", "SK", "YT"

Note: The size range is set to 50 for all countries except the United States and Canada.
ZipCdStringZIP code of the recipient.
Size Range: 5 - 16
CountryString2-character country code of the recipient.
Allowed values

The size range is set to 50 for all countries except the United States and Canada.

EmailstringEmail address of the recipient.
Size Range: 100
Note: Required if the DistributionType is either "ONLINE_ACCESS" or "POSTAL_AND_ONLINE"
FaxstringOptional Fax number of the recipient.
Size Range: 10
PhonestringOptional Phone number of the recipient.
Size Range: 10
PhoneExtnstringOptional Phone extension number.
Size Range: 10
ReturnDataobject[]Contains information about the recipient details and Form 1095-B details.
Form1095BDataobject[]Form 1095-B details for the recipient.
HealthCoverageCdnumberCode identifying Origin of the Health Coverage
Allowed values

"A","B","C","D","E","F","G"

EmployerSponsoredCoverageDetailsObjectOptional Object identifying Employer-Sponsored Coverage details
SponsorNmStringOptional Name of the sponsor
Size Range: 75
EINStringOptional Employer Identification Number of the Sponsor
Size Range: 9-10
AddressObjectAddress information of Sponsor
Address1StringStreet address or PO Box. of Sponsor
Size Range: 46
Address2StringOptional Suite or apartment number
Size Range: 46
CityStringSponsor's city.
Size Range: 50
ProvinceOrStateStringSponsor's province or state name.
When the country code is US :
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"

When the country code is CA:
Allowed values

“AB”, ”BC”, ”MB”, ”NB”, ”NL”, ”NT”, ”NS”, ”NU”, ”ON”, ”PE”, ”QC”, ”SK”, ”YT”

Note: The size range is set to 50 for all countries except the United States and Canada.
ZipCdStringSponsor's ZIP code.
5 - 16 characters
CountryStringSponsor's 2-character country code.
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"

CoveredIndividualDetailsObject []Object identifying Covered Individual's details of the recipient
FirstNmstringFirst name of the covered individual.
Size Range: 20
MiddleNmstringOptional Middle name of the covered individual.
Size Range: 20
LastNmstringLast name of the covered individual.
Size Range: 20
SuffixstringOptional Suffix of the covered individual.
Allowed values

"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"

SSNstringOptional Social Security Number of the covered individual
Allowed values

"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"

DOBstringOptional Date of birth of the covered individual Enter the date in the format: MM/DD/YYYY or MM-DD-YYYY
Example: 01/25/2026 or 01-25-2026
IsCoverageAllMonthsBooleanIf true, indicates that the individual had coverage for all months of the tax year.
CoverageMonthsObjectMonths of coverage of the tax year
Allowed values

"JAN", "FEB", "MAR", "APR", "MAY", "JUN", "JUL", "AUG", "SEP", "OCT", "NOV", "DEC"

Form1099HCDataObjectMassachusetts Form 1099-HC information for the covered individual.
Note: Required only when StateFiling is set to true and the recipient's state is Massachusetts (MA).
SubscriberNumObjectSubscriber number of the covered individual
Size Range: 6-20
IsFullYearMinimumCreditCoverageBooleanIf true, indicates that the covered individual had full-year minimum creditable coverage.
MinimumCreditCoverageMonthsObjectMonths with minimum creditable coverage:
Allowed values

"JAN", "FEB", "MAR", "APR", "MAY", "JUN", "JUL", "AUG", "SEP", "OCT", "NOV", "DEC"

Form1099HCDataObjectMassachusetts Form 1099-HC information for the covered individual. Note: Required only when StateFiling is set to true and the recipient's state is Massachusetts (MA).
SubscriberNumStringSubscriber number of the covered individual
Size Range: 6-20
IsFullYearMinimumCreditCoverageBooleanIf true, indicates that the covered individual had full-year minimum creditable coverage.
MinimumCreditCoverageMonthsObjectMonths with minimum creditable coverage:
Allowed values

"JAN", "FEB", "MAR", "APR", "MAY", "JUN", "JUL", "AUG", "SEP", "OCT", "NOV", "DEC"

Response Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission.
BusinessIdGuidUnique identifier of the business generated by TaxBandits. Store this for use in all subsequent requests.
PayerRefstringYour unique identifier for the payer, as provided in the request.
DBARefstringYour unique identifier for the DBA.
DBAIdGuidUnique identifier of the DBA generated by TaxBandits.
RecordIdGuidAn unique identifier generated by TaxBandits when a 1095-B return is created.
Form1095TypestringDenotes the type of ACA form
Form1095BRecordsobjectPulls Form 1095-B records with Success and Error statuses
SuccessRecordsobject[]It will show the detailed information about the success status of Form 1095-B Records.
SequenceIdstringA unique reference ID for the return that can be used to identify a particular record.
RecipientIdGuidA unique ID generated by TaxBandits after the recipient is created
PayeeRefstringYour unique identifier for the recipient, as provided in the request.
DBARefstringUnique identifier for the recipient's DBA.
DBAIdGuidUnique identifier of the recipient's DBA generated by TaxBandits.
Form1095BIdGuidUnique id to identify each Form 1095-B.
CoveredIndividualRecordsObject[]Contains collection of each individual enrolled in coverage, including the employee. Required only when "IsSelfInsured" is true.
CoveredIndividualIdGuidUnique ID generated by TaxBandits for the covered individual.
FederalobjectReturns the record status and StatusTs of the federal return.
StatusstringStatus of the operation.
StatusCdstringPredefined status code for the status
StatusTsstringDate and time of the return created.
InfostringReturns information about the Federal Filing service.
Errorsobject[]Validation error details.
IdstringValidation error code.
NamestringName of the validation rule that failed.
MessagestringClear description of what went wrong and how to fix it.
StateobjectReturns a collection of status and StatusTs of the State returns.
StateCdstringReturns the state code of the state for which the return is filed.
StatusstringReturns the record status of the state return.
StatusCdstringPredefined status code for the status
StatusTsstringDate and time of the return created.
InfostringReturns the information about the return processed for the state.
Errorsobject[]Validation error details.
IdstringValidation error code.
NamestringName of the validation rule that failed.
MessagestringClear description of what went wrong and how to fix it.
Distributionobject[]Returns information about the distribution.
DistributionTypestringReturns the distribution method used.
Postalobject[]Returns information about postal mailing.
PostalTypestringReturns the postal service used.
StatusstringReturns the Postal status.
StatusCdstringPredefined status code for the status
StatusTsstringDate and time of the postal created.
InfostringReturns the information about the postal order.
OnlineAccessobjectReturns information about Online access.
StatusstringReturns status of online access for Form 1095-B return.
EmailstringEmail address for whom the online access to be given.
InfostringInformation about the online access service.
ErrorRecordsobjectIt will show the detailed information about the error status of Form 1095-B Records.
SequenceIdstringA unique reference ID for the return that can be used to identify a particular record.
RecordIdGuidAn unique identifier generated by TaxBandits when a 1095-B return is created.
ErrorsObject[]Validation error details.
IdStringValidation error code.
NameStringName of the validation rule that failed.
MessageStringClear description of what went wrong and how to fix it.
ErrorsObject[]Top-level request errors if the entire request cannot be processed.
IdStringValidation error code.
NameStringName of the validation rule that failed.
MessageStringClear description of what went wrong and how to fix it.
Request JSON
SampleDescriptionAction
Sample 1
Business – EIN, Recipient – SSN (Individual)
Sample 1
{
"SubmissionManifest": {
"SubmissionId": "f561a414-c92f-4026-9c29-71cd1979bf72",
"TaxYear": "2026",
"IsFederal": true,
"IsState": true,
"IsDistribution": true,
"DistributionDetails": {
"DistributionType": "POSTAL_AND_ONLINE",
"PostalType": "USPS_FIRST_CLASS"
}
},
"ReturnHeader": {
"Business": {
"PayerRef": "HZN-10001",
"BusinessId": null,
"IsDefaultBusiness": true,
"TINDetails": {
"Format": "PLAIN_TIN",
"TINType": "EIN",
"TIN": "72-5564875"
},
"IndividualNm": null,
"BusinessNm": "Horizon LLC",
"NameCtrl": "HORI",
"DBADetails": null,
"Address": {
"Address1": "2500 Horizon Parkway",
"Address2": "Suite 200",
"City": "Plano",
"ProvinceOrState": "TX",
"ZipCd": "75024",
"Country": "US"
},
"ContactDetails": {
"FirstNm": "Michael",
"MiddleNm": "A",
"LastNm": "Carter",
"Suffix": "Jr",
"Phone": "9725550100",
"PhoneExtn": "205",
"Email": "horizonllc@sample.com",
"Fax": "9725550199"
},
"ACASpecific": {
"IsInsurer": false,
"IsGovernmentalUnit": true
}
}
},
"ReturnData": [
{
"SequenceId": "1",
"Recipient": {
"RecipientId": null,
"PayeeRef": "PAYEE-001",
"TINDetails": {
"Format": "PLAIN_TIN",
"TINType": "SSN",
"TIN": "321-44-5789"
},
"NameCtrl": "THOM",
"BusinessNm": null,
"DBADetails": null,
"IndividualNm": {
"FirstNm": "David",
"MiddleNm": "R",
"LastNm": "Thompson",
"Suffix": null
},
"Address": {
"Address1": "780 Market Street",
"Address2": "Suite 1200",
"City": " San Francisco",
"ProvinceOrState": "CA",
"ZipCd": "94103",
"Country": "US"
},
"Email": "david.thompson@sample.com",
"Fax": "2145550199",
"Phone": "2145550100"
},
"Form1095BData": {
"HealthCoverageCd": "D",
"EmployerSponsoredCoverageDetails": {
"SponsorNm": "David Baland",
"EIN": "459878987",
"Address": {
"Address1": "123 Main St",
"Address2": "Suite 1001",
"City": "Rock Hill",
"ProvinceOrState": "MA",
"ZipCd": "02108",
"Country": "US"
}
},
"CoveredIndividualDetails": [
{
"FirstNm": "Steven",
"MiddleNm": null,
"LastNm": "David",
"Suffix": null,
"SSN": "548678987",
"DOB": null,
"IsCoverageAllMonths": false,
"CoverageMonths": [
"JAN",
"MAR",
"JUN"
],
"Form1099HCData": {
"SubscriberNum": "4598687",
"IsFullYearMinimumCreditCoverage": false,
"MinimumCreditCoverageMonths": [
"JAN",
"FEB",
"MAR"
]
}
}
],
"Form1099HCData": {
"SubscriberNum": "4598687",
"IsFullYearMinimumCreditCoverage": false,
"MinimumCreditCoverageMonths": [
"JAN",
"FEB",
"MAR"
]
}
}
}
]
}
Response JSON
ResponseDescriptionAction
200
Success Response - You'll get the below response when the request is processed successfully.
Response: 200
{
"SubmissionId": "57dc81d7-254f-450c-b12c-f064267f492a",
"BusinessId": "442b9537-aa24-47d0-af16-596e84671f80",
"PayerRef": null,
"DBARef": null,
"DBAId": null,
"Form1095Type": "1095-B",
"Form1095Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "4adcc213-5855-4bab-9f29-5637be00b459",
"RecipientId": "69936c40-5438-48b1-bf19-0cb60170ce23",
"PayeeRef": null,
"DBARef": null,
"DBAId": null,
"Federal": {
"Status": "CREATED",
"StatusCd": "FED_001",
"StatusTs": "2026-07-21 09:40:25 -04:00",
"Info": null,
"Errors": null
},
"State": {
"StateCd": "MA",
"Status": "CREATED",
"StatusCd": "STATE_001",
"StatusTs": "2026-07-21 09:40:25 -04:00",
"Info": "State filing will be submitted via CF/SF",
"Errors": null
},
"Distribution": {
"DistributionType": "POSTAL_AND_ONLINE",
"Postal": {
"PostalType": "USPS_FIRST_CLASS",
"Status": "CREATED",
"StatusCd": "POSTAL_001",
"StatusTs": "2026-07-21 09:40:25 -04:00",
"Info": "Postal order created"
},
"OnlineAccess": {
"Status": "CREATED",
"StatusCd": "ONLINE_001",
"Email": "olivia.harris@sample.com",
"Info": null
}
}
}
],
"ErrorRecords": null
},
"Errors": null
}