Extend your software with TaxBandits IRS E-file API Integration

Skip to main content
Version: 1.7.1

Create

Creates Online 94X PIN requests with an unique Submission Id which is further used for all other methods referencing these requests.

POST Online94xPINRequest/Create

Request Body

FieldTypeDescription
    BusinessobjectBusiness Details
        BusinessIdGuidUnique Identifier of the business
        BusinessNmstringName of the business
Size Range: ..75
        TradeNmstringOptional Name under which the business operates
Size Range: ..75
        IsEINBooleanWhen true, identifies the business with an EIN.
        EINorSSNstringWhen IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN).
Size Range: 9
        EmailstringEmail address of the Business.
Size Range: ..40
        ContactNmstringOptional Name of the person who can be contacted by the IRS
Size Range: ..27
        PhonestringContact number of the business with area code
Size Range: 10
        PhoneExtnstringOptional Extension of the business phone number
Size Range: ..5
        FaxstringOptional Fax number of the Business
Size Range: 10
        BusinessTypestringType of business. Optional for W-2/1099 and mandatory for 94X series
Size Range: ..4
Allowed values: "ESTE", "PART", "CORP", "EORG", "SPRO"
        SigningAuthorityobjectDetails 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", "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"
        KindOfEmployerstringIdentifies the kind of employer. Mandatory for W-2 and optional for 1099-MISC and 94X series.
Allowed values: "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY"
        KindOfPayerstringIdentifies the kind of payer. This field is mandatory in W-2 and optional in 1099-MISC 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 address or post office box of that locality)
Size Range: ..35
            Address2stringOptional Employer/Payer's suite or apartment
Size Range: ..35
            CitystringEmployer/Payer's city
Size Range: ..27
            StatestringState code of the employer/payer. 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
        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: ..35
            Address2stringOptional Employer/Payer's suite or apartment
Size Range: ..35
            CitystringEmployer/Payer's city
Size Range: ..27
            ProvinceOrStateNmstringEmployer/Payer's province or state name
Size Range: ..30
            CountrystringEmployer/Payer country code. Refer Static values.
Size Range: 2
Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI"
            PostalCdstringEmployer/Payer's postal code
    PINDetailsobjectObject to create Online PIN
        SSNstringEmployer's Social Security Number
Size Range: 9
        ContactNmstringEmployer's Contact Name
Size Range: ..27
        ContactTitlestringEmployer's Contact Title
Size Range: ..40
        EmailstringEmployer's Email Address
Size Range: ..40

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code.
StatusMessagestringDetailed status message.
SubmissionIdGuidUnique identifier of a submission.
Errorsobject[]Shows detailed error information.
    CodestringReturns the validation error code.
    NamestringName of the validation error.
    MessagestringDescription of the validation error.
    TypestringType of validation error.
Online94xPINRecordsobjectPulls the Online 94X PIN request records with Success and Error statuses.
    SuccessRecordsobject[]It will show the detailed information about the success status of Form 941 Records
        SequencestringA unique number given by an inbound application to identify failed records.
        RecordIdGuidUnique identifier of a record.
        RecordStatusstringReturns the status of the records.
        CreatedTsstringDate and time of return created.
        UpdatedTsstringDate and time of return updated.
    ErrorRecordsobject[]It will show the detailed information about the error status of Form 941 Records
        SequencestringA unique number given by an inbound application to identify failed records.
        RecordIdGuidUnique identifier of a record
        Errorsobject[]Shows detailed error information.
            CodestringReturns the validation error code.
            NamestringName of the validation error.
            MessagestringDescription of the validation error.
            TypestringType of validation error.

Request JSON

{   "Business": {       "BusinessNm": "Eastman Kodak Company",       "TradeNm": "Kodak",       "IsEIN": true,       "EINorSSN": "003333334",       "Email": "john@gmail.com",       "ContactNm": "John",       "Phone": "1234567890",       "PhoneExtn": "12345",       "Fax": "1234567890",       "BusinessType": "ESTE",       "SigningAuthority": {           "Name": "John",           "Phone": "1234567890",           "BusinessMemberType": "ADMINISTRATOR"       },       "KindOfEmployer": "FederalGovt",       "KindOfPayer": "REGULAR941",       "IsBusinessTerminated": true,       "IsForeign": false,       "USAddress": {           "Address1": "1751 Kinsey Rd",           "Address2": "Main St",           "City": "Dothan",           "State": "AL",           "ZipCd": "36303"       },       "ForeignAddress": {           "Address1": null,           "Address2": null,           "City": null,           "ProvinceOrStateNm": null,           "Country": null,           "PostalCd": null       }   },   "PINDetails": {       "SSN": "393848037",       "ContactNm": "John",       "ContactTitle": "Sole Proprietor",       "Email": "john@gmail.com"   }}

Response JSON

{   "StatusCode": 200,   "StatusName": "Ok",   "StatusMessage": "Successful API call",   "SubmissionId": "144b8a27-5802-46c5-b1f6-0510026ca46a",   "Errors": null,   "Online94xPINRecords": {       "SuccessRecords": [           {               "Sequence": null,               "RecordId": "e4b666b2-54a0-4753-92e0-d94d7a2a6ae0",               "RecordStatus": "Created",               "CreatedTs": "2019-08-02 03:40:42 -04:00",               "UpdatedTs": "2019-08-02 03:40:42 -04:00"           }       ],       "ErrorRecords": null   }}