Skip to main content
Version: 1.7.0

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
Run in Postman

Request Body

FieldTypeDescription
    BusinessIdobjectUnique Identifier of the business
    BusinessNmstringName of the business
Size Range: ..75
    FirstNmstringFirst Name of the Individual
Size Range: ..20
    MiddleNmstringMiddle Name of the Individual
Size Range: ..20
    LastNmstringLast Name of the Individual
Size Range: ..20
    SuffixstringSuffix of the Individual
Allowed values

"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"

    PayerRefStringOptionalAn 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
    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-11
    EmailstringOptional Email address of the Business
Size Range: ..100
    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 number 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"

For the description of the Allowed Values , click here
    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 authorized signatory.
Size Range: 10
        BusinessMemberTypestringOptional 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"

    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. Mandatory for W-2 and optional for 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
        Address1stringAddress of the Employer/Payer (street address or post office box of that locality)
Size Range: ..46
        Address2stringOptional Suite or apartment number of the Employer/Payer.
Size Range: ..46
        CitystringCity where the Employer/Payer is based out of
Size Range: ..50
        StatestringName 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"

        ZipCdstringZip Code the State where the Employer/Payer is based out of.
Size Range: 5..10
    ForeignAddressobjectif IsForeign is true, pass foreign address of the business.
        Address1stringAddress of the Employer/Payer (street address or post office box of that locality)
Size Range: ..50
        Address2stringOptional Suite or apartment number of the Employer/Payer.
Size Range: ..50
        CitystringCity where the Employer/Payer is based out of
Size Range: ..50
        ProvinceOrStateNmstringName of the province or state where the Employer/Payer is based out of.
Size Range: ..50
        CountrystringCountry of the Employer/Payer.
Size Range: 2
Allowed values

"AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"

        PostalCdstringPostal Code the State where the Employer/Payer is based out of
Size Range: ..16

Request JSON

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
    }
}

Response Body

FieldTypeDescription
StatusCodenumberReturns the status codes like 200, 300 etc.
StatusNamestringName of the status code.
StatusMessagestringDetailed status message
BusinessIdGuidUnique Identifier of the business
PayerRefstringUnique identifier of the payer.
IsEINBooleanWhen true, identifies the business with an EIN.
EINorSSNstringEmployer Identification Number (EIN) or Social Security Number (SSN)
BusinessNmstringName of the business
Errorsobject[]Shows detailed error information.
    CodestringReturns the validation error code.
    NamestringName of the validation error.
    MessagestringDescription of the validation error.
    TypestringType of validation error.

Response JSON

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
}