Requirements 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.
Integration overview
#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.
Integration steps
#1. Enable your integration
#Indeed sets up your app during partner setup. To request access to the Disposition Sync API, contact Indeed and share:
- Go-live target date
- Estimated three-month disposition volume
- Integration contact name and email address
Before you launch, make sure that your Indeed Apply integration is enabled.
At launch, you also send disposition data from before your go-live date. Agree with each employer in your ATS on the start date for that data.
After Indeed enables access, the technical support team or Japan ATS team replies to your case by email. You can then start coding. Use email for all further communication with the technical team.
2. Code your integration
#Use the test client that Indeed provides. For each test disposition, set indeedApplyID to a production value. You get this ID in the payload of each application that comes through your Indeed Apply integration. If you use a non-production value, the API might return an error.
During testing, Indeed stores the disposition data you send in a sandbox database. This data is excluded from metrics and analysis.
Make sure that your integration follows these guidelines:
- Send every status that an application moves through, in near real time, each time the status changes in your system. If you can't send each change as it happens, send disposition data on a schedule at least once a day.
- For each
indeedApplyID, send at least one disposition withdispositionStatusset toNEW. This status shows when the ATS received the application. - You can also pass the Indeed Apply ID as
universalApplyId. - In each request, sort dispositions by
statusChangeDateTime, oldest first. - When possible, send several dispositions in one request, up to 25 per request.
Disposition statuses
#In Japan, set dispositionStatus to the statuses in this table, instead of the Indeed standard disposition statuses. If employers customize their status labels, map each label to the matching status.
If your ATS doesn't support every required status yet, you can still start using the Disposition Sync API and add the missing statuses later.
| 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 |
3. Validate your content
#Send at least 20 test calls that use indeedApplyID values from your live Indeed Apply integration. For each call, make sure that the API returns no errors and that failedDispositions in the response is empty.
When all your test calls pass, reply in your technical support email thread. Indeed then reviews the data to confirm that your integration works and that the disposition statuses are accurate.
4. Launch your integration
#After the review, Indeed 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 that sends disposition data from the start date you agreed with each employer. When the job finishes, start sending disposition data continuously.
See also
#Guides
#- Disposition Sync API guide — Send job application disposition data to Indeed.
- Indeed Apply — Enable job seekers to apply for your jobs directly on Indeed.
References
#- Indeed standard disposition statuses — The Indeed standard disposition statuses, or hiring stages.
- Troubleshoot errors
GraphQL API references
#indeedApplyID— ID for a job application's disposition.dispositionStatus— One partner disposition to send.universalApplyId— Partner disposition ID.