For Japan partners
Additional requirements for partners in Japan using the Disposition Sync API.
By using this API and its documentation and building an integration, you agree to the Additional API Terms and Guidelines.
For an overview of the Disposition Sync API, see Disposition Sync API guide. In addition to the requirements described in that guide, partners in Japan must take additional steps that are described on this page.
Before you integrate
Indeed sets up your app as part of the onboarding process. Contact Indeed to request access to the Disposition Sync API.
Share the following information with Indeed:
- Go-live target date
- Estimated disposition volume in the last three months
- Integration contact name and email address
Confirm that you will enable your Indeed Apply integration prior to launching your Disposition Sync integration.
After you complete your integration, you must send disposition data from before your integration go-live date. Contact employers on your ATS and agree on a date from which you will send prior data.
After Indeed enables your access, we’ll respond to your case submission through our technical support or Japan ATS team email, and you can start coding your integration. All future communications with our technical team will occur through email.
Code your integration
Use the test client that Indeed gives you. For all test disposition data that you send in API requests, set indeedApplyId to a production value. Indeed sends this ID in the payload for each application you receive through your Indeed Apply integration.
If you do not set indeedApplyId to a production value, you may receive errors.
During testing, Indeed stores disposition data that you send through the Disposition Sync API in the sandbox database. Data sent to this database is excluded from metrics and analysis.
Confirm that your integration follows these guidelines:
-
API integrations are intended to be near real time. Use the Disposition Sync API to send all disposition statuses through which applications transition.
-
Send disposition data each time a change occurs in your system. Alternatively, you can send disposition data on a scheduled, periodic basis, but at least once a day.
-
For every
indeedApplyId, send at least one disposition with dispositionStatus set toNEW, which corresponds to when the ATS receives the application. -
Indeed Apply ID can be accepted as input to
universalApplyId. -
Before you send disposition data, sort all data sent in a single request by the statusChangeDateTime in ascending order (oldest first).
-
When possible, combine API requests by sending multiple dispositions in one request. However, send a maximum of 25 dispositions in one request.
Disposition statuses
Set dispositionStatus to the following statuses as required in Japan. Use these instead of the Indeed standard disposition statuses.
Even if some required statuses are currently lacking, you can start using the Disposition Sync API, but you must implement all required statuses in the future.
If employers can customize status labels, map them to the following statuses if there are appropriate corresponding statuses.
| Disposition status | Example raw statuses from ATS | Requirement | |
|---|---|---|---|
| 1 | NEW |
| Required |
| 2 | POSITIVELY_SCREENED |
| Required |
| 3 | INTERVIEW |
| Required |
| 4 | OFFER_MADE |
| Required |
| 5 | HIRED |
| Required |
| 6 | NOT_SELECTED |
| Required |
| 7 | WITHDRAWN |
| Required |
| 8 | ONBOARDED |
| Required |
Validate your content
Confirm that you don't receive any errors when sending your application disposition data. Send at least 20 test calls using the indeedApplyId of your live product so that you can ensure there are no issues with your implementation.
After you confirm that your disposition data does not cause errors, reach out in your technical support email thread. Indeed reviews the data to ensure that the integration works as expected and the disposition statuses are accurate.
Launch your integration
After Indeed reviews your implementation, we will switch your configuration to production mode and ask you to start sending disposition data with your production client.
On launch day, run a batch job to send previous disposition data from the agreed-upon date. After the job is complete, set your integration to continually send disposition data.