TaxBandits API

# Business

# Create

Use this endpoint to add a Business or Payer in TaxBandits. The same Business/Payer can be later used in 1099, W-2, ACA, 94x and W-9 endpoints. The PayerRef or BusinessId will act as the unique reference identifier.

POST Business/Create
1

Request Body

Field Type Description
    BusinessNm string Name of the business
Size Range: ..75
    PayerRef String Optional 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: 1-50
    TradeNm string Optional Name under which the business operates
Size Range: ..75
    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)
Size Range: 9
    Email string Email address of the Business
Size Range: ..40
    ContactNm string Optional Name of the person who can be contacted by the IRS
Size Range: ..27
    Phone string Contact number of the business with area code
Size Range: 10
    PhoneExtn string Optional Extension number of the business phone number
Size Range: ..5
    Fax string Optional Fax number of the Business
Size Range: 10
    BusinessType string Type of business. Optional for W-2/1099 and mandatory for 94X series
Size Range: ..4
Allowed values: "ESTE", "PART", "CORP", "EORG", "SPRO"
    SigningAuthority object Details of the person who is authorized to sign the return.
        Name string Optional Name of the signing authority.
Size Range: ..75
        Phone string Optional Phone number of the authorized signatory.
Size Range: 10
        BusinessMemberType string Optional Business title of the authorized signatory.
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"
    KindOfEmployer string Identifies the kind of employer. Mandatory for W-2 and optional for 1099-MISC and 94X series
Allowed values: "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY"
    KindOfPayer string Identifies the kind of payer. Mandatory for W-2 and optional for 1099-MISC and 94X series
Allowed values: "REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1"
    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 Address of the Employer/Payer (street address or post office box of that locality)
Size Range: ..35
        Address2 string Optional Suite or apartment number of the Employer/Payer.
Size Range: ..35
        City string City where the Employer/Payer is based out of
Size Range: ..27
        State string Name of the state where the Employer/Payer is based out of
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"
        ZipCd string Zip Code the State where the Employer/Payer is based out of
    ForeignAddress object if IsForeign is true, pass foreign address of the business.
        Address1 string Address of the Employer/Payer (street address or post office box of that locality)
Size Range: ..35
        Address2 string Optional Suite or apartment number of the Employer/Payer.
Size Range: ..35
        City string City where the Employer/Payer is based out of
Size Range: ..27
        ProvinceOrStateNm string Name of the province or state where the Employer/Payer is based out of.
Size Range: ..30
        Country string Country of the Employer/Payer.
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"
        PostalCd string Postal Code the State where the Employer/Payer is based out of

Response Body

Field Type Description
StatusCode number Returns the status codes like 200,300 etc.
StatusName string Name of the status code.
StatusMessage string Detailed status message
BusinessId Guid Unique Identifier of the business
PayerRef string Unique identifier of the payer.
IsEIN Boolean When true, identifies the business with an EIN.
EINorSSN string Employer Identification Number (EIN) or Social Security Number (SSN)
BusinessNm string Name of the business
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.

Request JSON

{
   "BusinessNm": "Eastman Kodak Company",
   "PayerRef": "Pe126145",
   "TradeNm": "Kodak",
   "IsEIN": true,
   "EINorSSN": "003313330",
   "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": false,
   "IsForeign": true,
   "USAddress": {
       "Address1": null,
       "Address2": null,
       "City": null,
       "State": null,
       "ZipCd": null
   },
   "ForeignAddress": {
       "Address1": "22 St",
       "Address2": "Clair Ave E",
       "City": "Toronto",
       "ProvinceOrStateNm": "Ontario",
       "Country": "CA",
       "PostalCd": "M1R 0E9"
   }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

Response JSON

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "BusinessId": "17e1efa1-37b8-4ace-89e9-877fe749b64e",
 "PayerRef": "Pe126145",
 "IsEIN": true,
 "EINorSSN": "00-3313330",
 "BusinessNm": "Eastman Kodak Company",
 "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11

# Delete

Deletes a business by EIN or Business Id.

DELETE Business/Delete
1

Request Body

Field Type Description
BusinessId guid Unique Identifier of the business
EinOrSSN string EIN/SSN of the business to be deleted.
IsForceDelete Boolean When true, deletes a business without validating whether the business has returns or not.

Response Body

Field Type Description
StatusCode number Returns the status codes like 200,300 etc.
StatusName string Name of the status code.
StatusMessage string Detailed status message
BusinessId guid Unique Identifier of the business
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.

Request JSON

"Business/Delete?BusinessId=5b0aedcc-96f5-44ea-8643-c1fd1515398c&EINOrSSN=003313331&isForceDelete=True"
1

Response JSON

{
  "StatusCode": 200,
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "BusinessId": "9094e428-8aca-46b0-873b-be9cc679f1b9",
  "Errors": null
}
1
2
3
4
5
6
7

# Get

Get Business information by EIN or Business Id.

GET Business/Get
1

Request Body

Field Type Description
BusinessId string Unique Identifier of the business.
TIN string Taxpayer Identification Number of business.
PayerRef string Optional Unique identifier of the payer. Set by the client in the endpoint Business/RequestByUrl.

Response Body

Field Type Description
StatusCode number Returns the status codes like 200,300 etc.
StatusName string Name of the status code.
StatusMessage string Detailed status message
Business object[] Business Details
    BusinessId guid Unique Identifier of the business.
    PayerRef string Unique identifier of the payer. Set by the client.
    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 number 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 authorized signatory.
        BusinessMemberType string Optional Business title of the authorized signatory.
    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. Mandatory for W-2 and optional for 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 Address of the Employer/Payer (street address or post office box of that locality)
        Address2 string Optional Suite or apartment number of the Employer/Payer.
        City string City where the Employer/Payer is based out of
        State string Name of the state where the Employer/Payer is based out of
        ZipCd string Zip Code the State where the Employer/Payer is based out of
    ForeignAddress object if IsForeign is true, pass foreign address of the business.
        Address1 string Address of the Employer/Payer (street address or post office box of that locality)
        Address2 string Optional Suite or apartment number of the Employer/Payer.
        City string City where the Employer/Payer is based out of
        ProvinceOrStateNm string Name of the province or state where the Employer/Payer is based out of.
        Country string Country of the Employer/Payer.
        PostalCd string Postal Code the State where the Employer/Payer is based out of
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.

Request JSON

"Business/Get?BusinessId=7289099A-E20F-4271-AB29-06865CECCB03&TIN=12-3456767&PayerRef=B123"
1

Response JSON

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"Business": {
  "BusinessId": "17e1efa1-37b8-4ace-89e9-877fe749b64e",
  "PayerRef": "B123",
  "BusinessNm": "Eastman Kodak Company",
  "TradeNm": "Kodak",
  "IsEIN": true,
  "EINorSSN": "003313330",
  "Email": "john@gmail.com",
  "ContactNm": "John",
  "Phone": "1234567890",
  "PhoneExtn": "12345",
  "Fax": "(123) 456-7890",
  "BusinessType": "ESTE",
  "SigningAuthority": {
    "Name": "John",
    "Phone": "1234567890",
    "BusinessMemberType": "ADMINISTRATOR"
  },
  "KindOfEmployer": "FEDERALGOVT",
  "KindOfPayer": "REGULAR941",
  "IsBusinessTerminated": false,
  "IsForeign": true,
  "USAddress": {
    "Address1": null,
    "Address2": null,
    "City": null,
    "State": null,
    "ZipCd": null
  },
  "ForeignAddress": {
    "Address1": "22 St",
    "Address2": "Clair Ave E",
    "City": "Toronto",
    "ProvinceOrStateNm": " Ontario",
    "Country": "CA",
    "PostalCd": "M1R 0E9"
  }
},
"Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

# List

Lists every business created for a date range.

GET Business/List
1

Request Body

Field Type Description
Page int Selected page number to be listed.
PageSize int Number of businesses to be listed in each page.
FromDate string List Businesses created from
ToDate string List Businesses created upto

Response Body

Field Type Description
StatusCode number Returns the status codes like 200,300 etc.
StatusName string Name of the status code.
StatusMessage string Detailed status message
Business object[] Business Details of all the business
    BusinessId guid Business Identifier (Autogenerated)
    PayerRef string Unique identifier of the payer. Set by the client.
    BusinessNm string Name of the Business.
    EINorSSN string Employer Identification Number or Social Security Number
    Email string Employer's email address.
    ContactNm string Optional Name of a person who could be contacted by the IRS if needed.
    BusinessType string Type of business entity.
    IsBusinessTerminated Boolean When true, identifies the business as terminated.
Page number Requested Page Number.
TotalRecords number Total number of records returned in the response.
TotalPages number Number of pages with the records.
PageSize number Requested Page Size.

Request JSON

"Business/List?Page=1&PageSize=10&FromDate=08/01/2019&ToDate=08/02/2019"
1

Response JSON

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"Businesses": [
  {
    "BusinessId": "17e1efa1-37b8-4ace-89e9-877fe749b64e",
    "PayerRef": "B123",
    "BusinessNm": "Eastman Kodak Company",
    "EINorSSN": "00-3313330",
    "Email": "john@gmail.com",
    "ContactNm": "John",
    "BusinessType": "ESTE",
    "IsBusinessTerminated": false
  },
  {
    "BusinessId": "5b0aedcc-96f5-44ea-8643-c1fd1515398c",
    "PayerRef": "B124",
    "BusinessNm": "Ante Solutions",
    "EINorSSN": "12-1222877",
    "Email": "smith@gmail.com",
    "ContactNm": "Smith",
    "BusinessType": "PART",
    "IsBusinessTerminated": false
  },
  {
    "BusinessId": "c71a0eab-93a3-4df4-b67d-c2f33a9851c3",
    "PayerRef": "B126",
    "BusinessNm": "FloriTech Solutions",
    "EINorSSN": "15-4023615",
    "Email": "charleskenny@gmail.com",
    "ContactNm": "Charles Kennedy",
    "BusinessType": "CORP",
    "IsBusinessTerminated": false
  }
],
"Page": 1,
"TotalRecords": 3,
"TotalPages": 1,
"PageSize": 10
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

# RequestByURL

To complete the payer information for 1099 filing, TaxBandits will supply the URL that can be opened on its own or embedded as an Iframe into a web page or native app. To get the URL, you will have to send a request to our API with a unique Payer Reference Number such as a random number or even an email address (This will be used to identify the payer for future references).

How does this work?

  1. Like any other TaxBandits API Endpoint, the first step is to call the Auth method to get the access token. This access token must be supplied in the request header as the ‘Bearer‘ token. Refer to OAuth 2.0 Authentication for more information on JWT authentication and how to integrate with the subsequent requests.

  2. The second step is to call the Business/RequestByURL API endpoint. If you are trying to embed this link into your web page, this endpoint must be called before you load the page.

    You will need to supply the following parameters.

    • Access Token in the header as Bearer Token (Generated using TaxBandits OAuth authentication API).

    • Payer Reference (Unique information that identifies the Payer). The payer Reference can be anything that uniquely identifies the payer such as reference number or a random number or even an email address (This will be used to identify the payer for future references).

    • Callback URLs (Optional) - You can set the callback redirection for payer form completion/cancel.

  3. TaxBandits will generate a unique URL and will send the link in the response, which must then be embedded into the page for the payers to click. When clicked, this link will show the Payer Information page with built-in validations.

  4. Once the payer completes the Payer Information page, you will be notified via webhook. The webhook payload will have the payer data such as the Name, Address and EIN/SSN.

GET Business/RequestByURL
1

Request Body

Field Type Description
PayerRef String 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: 1-50
FormType String A Type of Form for requesting Business URL.
Allowed values: "form1099"
ReturnURL String Optional Return Redirection URL. Set the callback URL redirection once the payer completes filling the form.
Size Range: ..150
CancelURL String Optional Cancel Redirection URL. Set the callback URL when the payer clicks the cancel button on the Payer Information page.
Note: If you do not provide the Cancel Callback Redirection URL, the cancel button will not be shown to the payer.
Size Range: ..150

Response Body

Field Type Description
SubmissionId Guid Unique identifier of a submission.
PayerRef string Unique identifier of the payer.
BusinessUrl string URL that can be accessed on its own or embedded on the client's website using Iframe or other means.
Errors Object Shows error information. This object will list the errors in the request parameters.

Sample Request 1: Sample request with PayerRef and Redirection URLs

"business/requestbyurl?payerref=126145&formtype=form1099&returnurl=https://abcllc.com/some/success/url&cancelurl=https://abcllc.com/some/cancel/url"
1

Sample Response 1:

{
  "PayerRef": "126145",
  "BusinessUrl": "https://taxbandits.io?uId=0ae2e35d-9769-4f66-bc43-68d886d62b51",
  "Errors": null
}
1
2
3
4
5

Sample Request 2: Sample request with just the PayerRef and formtype

"business/requestbyurl?payerref=1261452&formtype=form1099"
1

Sample Response 2:

{
  "PayerRef": "1261452",
  "BusinessUrl": "https:taxbandits.io?uId=c0aa109f-6d9a-4102-906a-421de6f082b3",
  "Errors": null
}
1
2
3
4
5

Sample Request 3: Sample Request without the PayerRef

"business/requestbyurl?formtype=form1099"
1

Sample Response 3: Our system will throw error that PayerRef is required

{
  "PayerRef": null,
  "BusinessUrl": null,
  "Errors": [
    {
      "Id": "F00-100272",
      "Name": "PayerRef",
      "Message": "PayerReference is required"
    }
  ]
}
1
2
3
4
5
6
7
8
9
10
11

# Update

Use this endpoint to Update information on the existing Business/Payer added in TaxBandits.

PUT Business/Update
1

Request Body

Field Type Description
    BusinessId object Unique Identifier of the business
    BusinessNm string Name of the business
Size Range: ..75
    PayerRef String OptionalAn unique identifier for each payer completing their information. This identifier can be used in future references of the payer in the API.
Size Range: 1-50
    TradeNm string Optional Name under which the business operates
Size Range: ..75
    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)
Size Range: 9
    Email string Email address of the Business
Size Range: ..40
    ContactNm string Optional Name of the person who can be contacted by the IRS
Size Range: ..27
    Phone string Contact number of the business with area code
Size Range: 10
    PhoneExtn string Optional Extension number of the business phone number
Size Range: ..5
    Fax string Optional Fax number of the Business
Size Range: 10
    BusinessType string Type of business. Optional for W-2/1099 and mandatory for 94X series
Size Range: ..4
Allowed values: "ESTE", "PART", "CORP", "EORG", "SPRO"
    SigningAuthority object Details of the person who is authorized to sign the return.
        Name string Optional Name of the signing authority.
Size Range: ..35
        Phone string Optional Phone number of the authorized signatory.
Size Range: 10
        BusinessMemberType string Optional Business title of the authorized signatory.
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"
    KindOfEmployer string Identifies the kind of employer. Mandatory for W-2 and optional for 1099-MISC and 94X series
Allowed values: "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY"
    KindOfPayer string Identifies the kind of payer. Mandatory for W-2 and optional for 1099-MISC and 94X series
Allowed values: "REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1"
    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 Address of the Employer/Payer (street address or post office box of that locality)
Size Range: ..35
        Address2 string Optional Suite or apartment number of the Employer/Payer.
Size Range: ..35
        City string City where the Employer/Payer is based out of
Size Range: ..27
        State string Name of the state where the Employer/Payer is based out of
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"
        ZipCd string Zip Code the State where the Employer/Payer is based out of
    ForeignAddress object if IsForeign is true, pass foreign address of the business.
        Address1 string Address of the Employer/Payer (street address or post office box of that locality)
Size Range: ..35
        Address2 string Optional Suite or apartment number of the Employer/Payer.
Size Range: ..35
        City string City where the Employer/Payer is based out of
Size Range: ..27
        ProvinceOrStateNm string Name of the province or state where the Employer/Payer is based out of.
Size Range: ..30
        Country string Country of the Employer/Payer.
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"
        PostalCd string Postal Code the State where the Employer/Payer is based out of

Response Body

Field Type Description
StatusCode number Returns the status codes like 200,300 etc.
StatusName string Name of the status code.
StatusMessage string Detailed status message
BusinessId Guid Unique Identifier of the business
PayerRef string Unique identifier of the payer.
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.

Request JSON

{
   "BusinessId": "c71a0eab-93a3-4df4-b67d-c2f33a9851c3",
   "BusinessNm": "Eastman Kodak Company update",
   "PayerRef": "Pe126145",
   "TradeNm": "Kodak",
   "IsEIN": true,
   "EINorSSN": "003313332",
   "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
   }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

Response JSON

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "BusinessId": "c71a0eab-93a3-4df4-b67d-c2f33a9851c3",
 "PayerRef": "Pe126145",
 "Errors": null
}
1
2
3
4
5
6
7
8

← Contact →