Introduction
This documentation outlines the process for SEEK Pass partners to integrate user data for digital credential creation via the Add to SEEK Pass integration. It includes details about authentication, data submission, redirect URL generation, and redirecting users to SEEK Pass.
The Add to SEEK Pass integration allows partners to submit users' credential data (e.g. graduation details and certificates, language assessment results and certificates) to SEEK Pass to create digital credentials in the SEEK Pass app.
Once in SEEK Pass, a user is able to showcase this information across all SEEK job boards (i.e. SEEK, Jobstreet and JobsDB job boards across all geographies). These digital credentials allow users to stand out within job applications and help hirers shortlist candidates more efficiently.
Integration journey
The integration workflow consists of two primary phases, authentication and user data submission:
Authentication using OAuth
Begin by authenticating with SEEK Pass using OAuth 2.0. You will receive a client ID and client secret upon registering as a partner with SEEK Pass. Use these credentials with the Authentication API to obtain an OAuth access token for subsequent API calls.
Data Submission
Once authenticated, prepare your user data in JSON format according to the relevant credential type specifications, such as Education Qualification. Submit this data through the Add to SEEK Pass API, which returns a redirect URL. Direct users to the provided URL to complete their SEEK Pass experience seamlessly. You may optionally monitor the submission status to track whether the process is successful, cancelled, or still in progress.
The diagram below illustrates the data flow between partner systems, the SEEK Pass API, and end users:
User journey
-
User enters flow: Users click a link / enter a code provided by partners (e.g., via a code / button in an email).
-
Data validation: Users are redirected to the partner's API for data validation.
-
Request link generation: The partner calls the SEEK Pass API to generate a request link and optionally displays a loading page.
-
User redirect: Users are redirected to the provided URL to add the credential to SEEK Pass
-
Verification process: Users are guided through a short and seamless flow to add their credential to SEEK Pass