Get

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

GET Online94xPINRequest/Get 

Request Params

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission

Request Params

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

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.
SubmissionId	Guid	Unique identifier of a submission
OnlinePINRequest94x	object	Pulls the Online 94X PIN request records.
Business	object	Business Details
BusinessId	Guid	Unique Identifier of the business
BusinessNm	string	Name of the business
TradeNm	string	Optional Name under which the business operates
IsEIN	Boolean	When true, identifies the business with an EIN.
EINorSSN	string	When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN).
Email	string	Email address of the Business.
ContactNm	string	Optional Name of the person who can be contacted by the IRS
Phone	string	Contact number of the business with area code
PhoneExtn	string	Optional Extension of the business phone number
Fax	string	Optional Fax number of the Business
BusinessType	string	Type of business. Optional for W-2/1099 and mandatory for 94X series
SigningAuthority	object	Details of the person who is authorized to sign the return.
Name	string	Optional Name of the signing authority
Phone	string	Optional Phone number of the signing authority
BusinessMemberType	string	Optional Business title of the signing authority.
KindOfEmployer	string	Identifies the kind of employer. Mandatory for W-2 and optional for 1099-MISC and 94X series.
KindOfPayer	string	Identifies the kind of payer. This field is mandatory in W-2 and optional in 1099-MISC and 94X series.
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)
Address2	string	Optional Employer/Payer's suite or apartment
City	string	Employer/Payer's city
State	string	State code of the employer/payer. Refer Static values.
ZipCd	string	Employer/Payer's zip code Size Range: 5..10
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)
Address2	string	Optional Employer/Payer's suite or apartment
City	string	Employer/Payer's city
ProvinceOrStateNm	string	Employer/Payer's province or state name
Country	string	Employer/Payer country code. Refer Static values.
PostalCd	string	Employer/Payer's postal code
PINDetails	object	Object to create Online PIN
SSN	string	Employer's Social Security Number
ContactNm	string	Employer's Contact Name
ContactTitle	string	Employer's Contact Title
Email	string	Employer's Email Address
RecordId	Guid	Unique identifier of a record.
CreateTimeStamp	DateTime	Returns date and time of 94X return created
UpdateTimeStamp	DateTime	Returns date and time of 94X return updated
Errors	object[]	Shows detailed error information.
Code	string	Returns the validation error code.
Name	string	Name of the validation error.
Message	string	Description of the validation error.
Type	string	Type of validation error.

Response JSON

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

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "144b8a27-5802-46c5-b1f6-0510026ca46a",
   "OnlinePINRequest94x": {
       "Business": {
           "BusinessId": "1a96e2ad-8a4a-4e39-b116-76502227fda3",
           "BusinessNm": "Snowdaze LLC",
           "TradeNm": "Kodak",
           "IsEIN": true,
           "EINorSSN": "003333334",
           "Email": "sample@bodeem.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": "sample@bodeem.com"
       },
       "RecordId": "e4b666b2-54a0-4753-92e0-d94d7a2a6ae0"
   },
   "CreateTimeStamp": "2019-08-02T03:40:42.047",
   "UpdateTimeStamp": "2019-08-02T03:40:42.047",
   "Errors": null
}