HTTP Status Codes:
200 - OK
Meaning: The API call and response was successful
201 - Resource Created
Common Causes:
We post an API call to a resource that does NOT exist - A new resource is created
400 - Bad Request
Common Causes:
In the IM account, the locationId sent in by the requesting system either
Doesn't match the deverus clientId in IM Home
Or the locationId value is not mapped to the corresponding deverus clientId
In the IM account, the packageId sent in by the requesting system either
Doesn't match the deverus packageId in IM home
Or the packageId value is not mapped to the corresponding packageId
A locationId wasn't included in the requested order
A packageId wasn't included in the requested order
A required data point(s) was not included in the requested order
401 - Unauthorized
Common Causes:
The username and/or password configured in the IM account are incorrect values.
The username and/or password configured in the IM account have leading or trailing white spaces.
The username and/or password has been changed in the requesting system, but you were not notified to update the credentials in the IM account.
The username and/or password being used by the requesting ATS are incorrect.
The user submitting the order from the ATS doesn't have sufficient permissions within the ATS.
403 - Forbidden
Common Causes:
The Authorization API credentials are correct, but the requesting system hasn't configured access to permit calls to their resource
If using Greenhouse, this type of error usually occurs when the default user configured in the IM account is
Not active
Not a 'Site Admin'
No longer a user in the client's Greenhouse tenant
404 - Resource Not Found
Common Causes:
The resource included in the order payload is invalid.
The resource on the requesting system's side does not exist, or no longer exists.
The resource on the requesting system's side was changed after the order was submitted.
408 - Timeout
Common Causes:
The webhook to which we POST status updates to didn't respond to our call within the designated time limit.
Possible Solution:
Try re-completing one of the non-instant searches on the report to attempt the status update call again.
409 - Duplicate Order
Common Causes:
An order is submitted for the same candidate within a 24 hour timeframe. This can be because of one / or a combination of the following reasons:
Same SSN
Same candidate name & package selected
Same candidate email
If your client is using SuccessFactors, and our status updates are rejected by their API, we will continue to reprocess the candidate(s) resulting in duplicate orders
This is a "template" issue with SuccessFactors that must be resolved by the client and/or their SuccessFactors account manager/technical resource
It is a discrepancy between the UI and API that omits certain required properties that we need to POST back to SuccessFactors successfully
500 - General Application Error or Internal Server Error
Common Causes:
Duplicate package mappings in the IM account
Duplicate location mappings in the IM account
Same package mapping value in IM Account A and IM Account B
Same location mapping value in IM Account A and IM Account B
The package is not active
The package has expired
An Accounting Bar is active
The client profile in your deverus Admin is not enabled
Swifthire Mobile is not enabled or the settings are not configured
Null is assigned to a property that can only accept a specific data type
Integer
String
Boolean
FAQ:
Q. What does the Error: ‘The locationId ‘Test’ is not authorized to make API calls with the provided key. Please contact your administrator’ indicate?
A. This error message indicates that the Location ID being sent in the order payload does not match what is mapped to the location in IM Home. The location ID in the order payload needs to match either the System Location ID (if there is not an Integrations Partner Location ID present) or the Integrations Partner Location ID (if one is mapped to the location).
The Location ID being sent in the order payload needs to match either the System Location ID OR Integrations Partner Location ID that are listed in IM Home.
Example: For orders routing to the Deverus Support location, the Location ID sent in needs to be Test. If Integrations Partner Location ID: Test was not mapped for Deverus Support, the System Location ID: support1234 would need to be sent over as the Location ID.
Q. What does the 'Bad Package ID. No Package can be found' Error Message mean?
A. This error message typically occurs due to packages not being mapped correctly in IM, or the package ordered is not available to the ordering client.
Ensure that the value being sent in the order payload is mapped in the IM Account (value needs to match the System Location ID or the mapped Integrations Partner Location ID).
Make sure the package is 'active' in the respective client editor.
Packages at client level are only available for that specific client / Packages at client type level are globally available to all clients under the client type.
Q: What is the pricing model for Integration Manager?
A: There are two options for Integration Manager projects:
Self-Service Integration (No Cost)
We continue to provide comprehensive resources for self-implementation:
- Detailed integration documentation
- Step-by-step implementation guides
- Access to our knowledge base
These resources remain completely free and are sufficient for most standard integration scenarios.
2. Premium 14-Day Support Package ($2,250)
For situations requiring direct assistance from our team, we offer a 14-day support package:
- Direct access to our integration specialists
- Technical troubleshooting and guidance
- Implementation assistance
- Configuration help
- Testing support
How the 14-Day Support Package Works
- 14 consecutive business days of support
- Access to our integration team during business hours
- Email and ticket-based support
- Assistance with your specific integration challenges
How to Purchase
1. Create a support ticket
2. Review and sign the Statement of Work (SOW)
3. Submit payment (Net 30 terms available for eligible accounts)
4. Schedule your support period start date
Important Details
- The 14-day period begins on your first day of engagement
- Support access ends after 14 business days
- Additional support requires purchasing a new package
- The package is non-refundable and cannot be paused or extended
Q: What is auto-provisioning?
A: If the provided user (in the request payload) is not in the client, and the Auto-Provision option is turned on, deverus will add the user details automatically. If the option is off, the order will route to the default user.
*NOTE: Auto-Provisioning is not recommended for the majority of integrations, especially those that require SwiftHire Mobile, because the newly provisioned user will not have SwiftHire settings configured.
Q: How long once you save the credentials does IM need before testing an order?
A: If the configurations are complete on both the ATS side and in the Integration Manager account, testing can begin immediately.
Q: Is IM compatible with SH Mobile and 1.0?
A: Integration Manager is only compatible with SwiftHire Mobile. When using SwiftHire to gather additional information, any basic information that has been entered in the ATS will pre-populate in the applicant's SwiftHire Mobile invitation.
Q: Does the IM pre-population feature work with custom searches?
A. Pre-population only works with hard coded searches.
Q: What happens if there is more information in the ATS than is needed for the package in deverus?
A. Information not needed for the package will be excluded. For example, if the package holds x2 Employment Verifications and the applicant enters x3 Employment Verifications, the third will not be included in the order for processing in deverus.
Q: What is needed to establish a relationship with the ATS before using Integration Manager?
A: This varies by ATS. Please contact the ATS directly for confirmation of any potential partnership requirements.