Developer Center

Our API infrastructure utilizes consistent terminology and labeling

Companies

Endpoint: https://api.paychex.com/companies

Verbs supported: GET

GET: Array of companies that your application has been granted with some level of access. Your Application (APIKey) can be granted access to one or more companies (clients) accounts that are associated with one or more product lines within Paychex.

Request:No request forms are available at this time.

Response: Company Profile  

Endpoint: https://api.paychex.com/companies/{companyId}

Verbs supported: GET

GET: Information about a single company that your application has access to.

Request:

Element NameTypeDescription
companyId stringThe ID of the company.

Response: Company Profile
 

Endpoint: https://api.paychex.com/companies?displayid={displayId}

Verbs supported: GET

GET: Search for a single company that your application has access to by its display Id.

Request:

Element NameTypeDescription
displayIdstringThe client account number used for identification purposes.

Response: Company Profile
 

Response

Profile: Company

The state representation of a company.
Element NameTypeDescription
companyIdstringThe unique identifier associated with this companies representation.
legalNamestringThe legal name of the company.
displayIdstringThe client account number used for identification purposes.
legalIdobjectThe Legal information associated with a Company.
communicationsobjectArray of communication types.

 

Object Components:

legalId: Legal information associated with a Company.

Element NameTypeDescription
legalIdValuestringThe federal level taxpayer id number assigned to a business
legalIdTypestringA value that identifies the type of taxpayer identification number provided.
  • SSN: Social Security Number - 9 digit number
  • SIN: Social Insurance Number
  • FEIN: Federal Employer Identification Number (EIN)

communications: Array of properties which specify communication information associated with an entity.

Element NameTypeDescription
typestringA set of communication types classifying an instruction with which the customer, requester, or subject must comply for the screening to go forward.
  • STREET_ADDRESS
  • PO_BOX_ADDRESS
  • PHONE
  • MOBILE_PHONE
  • FAX
  • EMAIL
  • PAGER
usageTypestringA code classifying a designated use associated with a contact method. For example, whether a telephone or email address is one for business communications or one primarily for personal use.
  • PERSONAL
  • BUSINESS
dialCountrystringThe country dialing code for a communication number.
dialAreastringThe area dialing code for a communication number.
dialNumberstringThe communication number, not including country dialing or area dialing codes.
dialExtentionstringThe extension of the associated communication number.
uristringThe mailto address as specified in RFC2368 .
streetLineOnestringThe street address line one
streetLineTwostringThe street address line two
postOfficeBoxstringThe postal office box
citystringThe city name
countrySubdivisionCodestringThe state code (ISO 3166 subdivision code)
postalCodestringThe zip-code
countryCodestringThe country code (ISO 3166 alpha-2)

 

{
   "metadata": {"contentItemCount": 1},
   "content": [   {
      "companyId": "99Z5V9BTI8J2FCGESC05",
      "displayId": "09620579",
      "legalName": "Monsters, Inc",
      "legalId":       {
         "legalIdType": "FEIN",
         "legalIdValue": "995886885"
      },
      "communications": [      {
         "type": "STREET_ADDRESS",
         "usageType": "BUSINESS",
         "streetLineOne": "Mike St",
         "streetLineTwo": "Sulley Ln",
         "city": "ANAHEIM",
         "countrySubdivisionCode": "CA",
         "postalCode": "92802",
         "countryCode": "US"
      }],
      "links":       [
                  {
            "rel": "self",
            "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05"
         },
                  {
            "rel": "workers",
            "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05/workers"
         }
      ]
   }],
   "links":    [
            {
         "rel": "self",
         "href": "https://api.paychex.com/companies"
      }
   ]
}