Extend your software with TaxBandits IRS E-file API Integration

Skip to main content
Version: 1.6.1

Get

Gets information of Online 94X PIN request records by Submission Id.

GET Online94xPINRequest/Get

Request Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission

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
OnlinePINRequest94xobjectPulls the Online 94X PIN request records.
    BusinessobjectBusiness Details
        BusinessIdGuidUnique Identifier of the business
        BusinessNmstringName of the business
        TradeNmstringOptional Name under which the business operates
        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).
        EmailstringEmail address of the Business.
        ContactNmstringOptional Name of the person who can be contacted by the IRS
        PhonestringContact number of the business with area code
        PhoneExtnstringOptional Extension of the business phone number
        FaxstringOptional Fax number of the Business
        BusinessTypestringType of business. Optional for W-2/1099 and mandatory for 94X series
        SigningAuthorityobjectDetails of the person who is authorized to sign the return.
            NamestringOptional Name of the signing authority
            PhonestringOptional Phone number of the signing authority
            BusinessMemberTypestringOptional Business title of the signing authority.
        KindOfEmployerstringIdentifies the kind of employer. Mandatory for W-2 and optional for 1099-MISC and 94X series.
        KindOfPayerstringIdentifies the kind of payer. This field is mandatory in W-2 and optional in 1099-MISC and 94X series.
        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)
            Address2stringOptional Employer/Payer's suite or apartment
            CitystringEmployer/Payer's city
            StatestringState code of the employer/payer. Refer Static values.
            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)
            Address2stringOptional Employer/Payer's suite or apartment
            CitystringEmployer/Payer's city
            ProvinceOrStateNmstringEmployer/Payer's province or state name
            CountrystringEmployer/Payer country code. Refer Static values.
            PostalCdstringEmployer/Payer's postal code
    PINDetailsobjectObject to create Online PIN
        SSNstringEmployer's Social Security Number
        ContactNmstringEmployer's Contact Name
        ContactTitlestringEmployer's Contact Title
        EmailstringEmployer's Email Address
    RecordIdGuidUnique identifier of a record.
CreateTimeStampDateTimeReturns date and time of 94X return created
UpdateTimeStampDateTimeReturns date and time of 94X return updated
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

"Online94xPINRequest/Get?SubmissionId=144b8a27-5802-46c5-b1f6-0510026ca46a"

Response JSON

{   "StatusCode": 200,   "StatusName": "Ok",   "StatusMessage": "Successful API call",   "SubmissionId": "144b8a27-5802-46c5-b1f6-0510026ca46a",   "OnlinePINRequest94x": {       "Business": {           "BusinessId": "1a96e2ad-8a4a-4e39-b116-76502227fda3",           "BusinessNm": "Eastman Kodak Company",           "TradeNm": "Kodak",           "IsEIN": true,           "EINorSSN": "003333334",           "Email": "john@gmail.com",           "ContactNm": "John",           "Phone": "1234567890",           "PhoneExtn": "12345",           "Fax": "(123) 456-7890",           "BusinessType": "ESTE",           "SigningAuthority": {               "Name": "John",               "Phone": "1234567890",               "BusinessMemberType": "ADMINISTRATOR"           },           "KindOfEmployer": null,           "KindOfPayer": null,           "IsBusinessTerminated": false,           "IsForeign": false,           "USAddress": {               "Address1": "1751 Kinsey Rd",               "Address2": "Main St",               "City": "Dothan",               "State": "AL",               "ZipCd": "36303"           },           "ForeignAddress": null       },       "PINDetails": {           "SSN": "393-84-8037",           "ContactNm": "John",           "ContactTitle": "Sole Proprietor",           "Email": "john@gmail.com"       },       "RecordId": "e4b666b2-54a0-4753-92e0-d94d7a2a6ae0"   },   "CreateTimeStamp": "2019-08-02T03:40:42.047",   "UpdateTimeStamp": "2019-08-02T03:40:42.047",   "Errors": null}