SAP Knowledge Base Article - Public

2245676 - API calls return error due to invalid company ID - SuccessFactors

Symptom

You are trying to connect to the API and the following errors could have occurred:

  • "Authentication failed due to invalid companyId"
  • "Login failure due to the invalid company!"

Environment

  • SuccessFactors
  • Boomi
  • PI
  • Direct API Web Service
  • HCI / CPI

Cause

There are 3 possibilities:

  1. The API end-point URL is incorrect.
  2. The company ID specified is incorrect.
  3. The company ID was not provided at all during the call.

Resolution

Image/data in this KBA is from SAP internal systems, sample data, or demo systems. Any resemblance to real data is purely coincidental.

First, ensure that the correct API end-point URL is used to connect to Successfactors API ("/" or a typo, or a wrong URL path could lead to the error).

For example:
If your Successfactors company ID is provisioned in Data Center 4, the API url would be https://api4.successfactors.com

Refer to the KBA 2215682 to check all the Successfactors API URLs for each Data Centers.

Also, some calls require the Company ID to be provided along with the API call. In these cases, please ensure that the Company ID is entered correctly (as it appears in the SuccessFactors instance). Note that the company ID "Abcd" and "ABCD" are treated as two different companies (the system is case-sensitive).

Some environments don't show where you need to specify the Company ID. Be aware that you can provide it along with the user, separating the two values with a "@".

For example:

For SFAPI connections on CPI environment:

If you will use a SFAPI connection, the credentials need to be stored according the example:

        sfapi-cred.JPG

For Odata connections on CPI environment:

Your company ID is "abc123", and your API user is "admin". You would specify them as "admin@abc123", this way:

        companyID_1.jpg

See Also

Guides for SFAPI and Odata API

SAP SuccessFactors HCM Suite SFAPI: Developer Guide

SAP SuccessFactors HCM Suite OData API: Developer Guide

Keywords

successfactors, success, factors, api, call, sfapi, odata, invalid, companyId, company, id, error, authentication, @, boomi, hci, cpi, pi, middleware, middle, ware, fail, login, failed, url, , KBA , LOD-SF-INT , Integrations , LOD-SF-INT-ODATA , OData API Framework , LOD-SF-INT-CUS , Boomi & CPI (HCI) Custom Content , LOD-SF-INT-HCI , Standard SF to 3rd Party CPI (HCI) Content , Problem

Product

SAP SuccessFactors HXM Suite all versions

Attachments

sfapi-cred.JPG