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 the Disposition Sync API guide. Partners in Japan must complete the steps on this page and meet the requirements in that guide.
Before you integrate
Indeed sets up your app as part of partner setup. Contact Indeed to request access to the Disposition Sync API.
Share the following information with Indeed:
- Go-live target date
- Estimated three-month disposition volume
- Integration contact name and email address
Confirm that your Indeed Apply integration is enabled before launching your Disposition Sync integration.
After you complete the integration, send disposition data from before your go-live date. Contact employers in your ATS and agree on a start date for that earlier data.
After Indeed enables access, the technical support team or Japan ATS team replies to your case by email. You can then start coding your integration. Use email for all future communication with the technical team.
Code your integration
Use the test client that Indeed provides. In every test disposition, set indeedApplyId to a production value. Indeed sends this ID in the payload for each application you receive through your Indeed Apply integration.
If indeedApplyId is not a production value, the API might return an error.
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:
- Send dispositions in near real time. Use the Disposition Sync API to send every disposition status that an application moves through.
- Send disposition data every time a status changes in your system. If you cannot send each change, send disposition data on a schedule at least once a day.
- For every
indeedApplyId, send at least one disposition with dispositionStatus set toNEW. This status marks when the ATS receives the application. - You can pass the Indeed Apply ID as
universalApplyId. - Before you send a request, sort dispositions by statusChangeDateTime in ascending order, oldest first.
- When possible, combine dispositions in a single request. Send no more than 25 dispositions per request.
Disposition statuses
Set dispositionStatus to the statuses required in Japan. Use these statuses instead of the Indeed standard disposition statuses.
If your ATS does not yet support every required status, you can still start using the Disposition Sync API. Add the missing statuses later.
If employers customize status labels, map each label to the matching status.
| 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 the API returns no errors when you send disposition data. Send at least 20 test calls that use the indeedApplyId from your live product to verify your implementation.
When your disposition data returns no errors, reply in your technical support email thread. Indeed reviews the data to confirm that your integration works as expected and that the disposition statuses are accurate.
Launch your integration
After Indeed reviews your implementation, the team switches your configuration to production mode and asks you to start sending disposition data through your production client.
On launch day, run a batch job to send previous disposition data from the agreed start date. After the job finishes, configure your integration to send disposition data continuously.