Update
After the business is created and requires any update, you can use this endpoint to update the information.
For the description of ENUM values, Click Here.
PUT Business/Update 
Request Body
| Field | Type | Description |
|---|---|---|
| BusinessId | object | Unique Identifier of the business |
| BusinessNm | string | Name of the business Size Range: ..75 |
| FirstNm | string | First Name of the Individual Size Range: ..20 |
| MiddleNm | string | Middle Name of the Individual Size Range: ..20 |
| LastNm | string | Last Name of the Individual Size Range: ..20 |
| Suffix | string | Suffix of the IndividualAllowed values |
| 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-11 |
| string | Optional Email address of the Business Size Range: ..100 | |
| 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 |
| 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 |
| KindOfEmployer | string | Identifies the kind of employer. Mandatory for W-2 and optional for 1099-MISC and 94X seriesAllowed values |
| KindOfPayer | string | Identifies the kind of payer. Mandatory for W-2 and optional for 1099-MISC and 94X seriesAllowed values |
| 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: ..46 |
| Address2 | string | Optional Suite or apartment number of the Employer/Payer. Size Range: ..46 |
| City | string | City where the Employer/Payer is based out of Size Range: ..50 |
| State | string | Name of the state where the Employer/Payer is based out of Size Range: 2 Allowed values |
| ZipCd | string | Zip Code the State where the Employer/Payer is based out of. Size Range: 5..10 |
| 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: ..50 |
| Address2 | string | Optional Suite or apartment number of the Employer/Payer. Size Range: ..50 |
| City | string | City where the Employer/Payer is based out of Size Range: ..50 |
| ProvinceOrStateNm | string | Name of the province or state where the Employer/Payer is based out of. Size Range: ..50 |
| Country | string | Country of the Employer/Payer. Size Range: 2 Allowed values |
| PostalCd | string | Postal Code the State where the Employer/Payer is based out of Size Range: ..16 |
Request JSON
- Sample 1
- Sample 2
Update the EIN and name of the business using BusinessId.
{
"BusinessId": "519a84f4-5e56-496a-82f3-18f51fdf3d75",
"BusinessNm": "Snowdaze LLC",
"FirstNm": null,
"MiddleNm": null,
"LastNm": null,
"Suffix": null,
"PayerRef": "Snow123",
"TradeNm": "Iceberg Icecreams",
"IsEIN": true,
"EINorSSN": "10-7310999",
"Email": "james@sample.com",
"ContactNm": "James Smith",
"Phone": "(870) 862-0033",
"PhoneExtn": "91",
"Fax": "3454553465",
"BusinessType": "PART",
"SigningAuthority": {
"Name": "James Smith",
"Phone": "9865321550",
"BusinessMemberType": "MANAGINGMEMBER"
},
"KindOfEmployer": "NONGOVT501C",
"KindOfPayer": "RAILROADFORMCT1",
"IsBusinessTerminated": false,
"IsForeign": false,
"USAddress": {
"Address1": "3576 AIRPORT WAY",
"Address2": "UNIT 9",
"City": "FAIRBANKS",
"State": "AK",
"ZipCd": "99709"
},
"ForeignAddress": {
"Address1": null,
"Address2": null,
"City": null,
"ProvinceOrStateNm": null,
"Country": null,
"PostalCd": null
}
}
Update the SSN and name using BusinessId.
{
"BusinessId": "69b9461c-c107-41d4-9582-1ef544a4a961",
"BusinessNm": null,
"FirstNm": "James",
"MiddleNm": null,
"LastNm": "Smith",
"Suffix": null,
"PayerRef": "Snow123",
"TradeNm": "Iceberg Icecreams",
"IsEIN": false,
"EINorSSN": "104-31-0999",
"Email": "james@sample.com",
"ContactNm": "James Smith",
"Phone": "(870) 862-0033",
"PhoneExtn": "91",
"Fax": "3454553465",
"BusinessType": "PART",
"SigningAuthority": {
"Name": "James Smith",
"Phone": "9865321550",
"BusinessMemberType": "MANAGINGMEMBER"
},
"KindOfEmployer": "NONGOVT501C",
"KindOfPayer": "RAILROADFORMCT1",
"IsBusinessTerminated": false,
"IsForeign": false,
"USAddress": {
"Address1": "3576 AIRPORT WAY",
"Address2": "UNIT 9",
"City": "FAIRBANKS",
"State": "AK",
"ZipCd": "99709"
},
"ForeignAddress": {
"Address1": null,
"Address2": null,
"City": null,
"ProvinceOrStateNm": null,
"Country": null,
"PostalCd": null
}
}
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. |
Response JSON
- 200
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"BusinessId": "519a84f4-5e56-496a-82f3-18f51fdf3d75",
"PayerRef": "Snow123",
"IsEIN": true,
"EINorSSN": "XX-XXX0999",
"BusinessNm": "Snowdaze LLC",
"FirstNm": null,
"MiddleNm": null,
"LastNm": null,
"Suffix": null,
"Errors": null
}