Getting started
Core resources
Other

Add to SEEK Pass integration flow

Info
There have been important recent changes on this page, please see the release notes for information
The Add to SEEK Pass integration follows a standardized flow to securely transmit credential data from partner systems to SEEK Pass. This sequence diagram illustrates the complete process.

Integration flow

Partners prepare user data for the payload in JSON format based on credential type (e.g. Education qualifications or English proficiency). Detailed requirements are provided for each credential type in their respective sections.
The integration process involves these key steps:
  1. 1.
    Prepare data in JSON format according to credential type specifications
  2. 2.
    Authenticate with SEEK Pass to retrieve an OAuth access token
  3. 3.
    Check for an existing request to determine whether to create a new request or to reuse an existing one
  4. 4.
    1. a.
      If not reusing an existing request, post user data to receive a redirect URL
    2. b.
      If reusing an existing request, use returned redirect URL from fetched request details
  5. 5.
    Redirect user to the provided redirect URL for a seamless experience
  6. 6.
    (Optional) Check submission status to verify if the submission is successful, cancelled, or still in progress

Visual representation

The diagram below illustrates the data flow between partner systems, the SEEK Pass API, and end users:

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, ensure that you check your own records for any existing requests that may have already been created for this credential. Re-issuing the same credential is only allowed when the existing request is already finalised, otherwise an error will be returned.
If you have records for an existing request for the same user and credential being issued, call the respective endpoint to fetch the request details from the Add to SEEK Pass API. If the existing request is not yet finalised, direct users to the provided URL from the existing request's details to complete their SEEK Pass experience seamlessly.
If there is no existing request, or if an existing request is already finalised, prepare your user data in JSON format according to the relevant credential type specifications, such as Education Qualification . Then, submit this data through the Add to SEEK Pass API, and use the provided URL to direct users to complete their SEEK Pass seamlessly.
You may optionally monitor the submission status to track whether the process is successful, cancelled, or still in progress.

User journey

  1. 1.
    User enters flow: Users click a link / enter a code provided by partners (e.g., via a code / button in an email).
  2. 2.
    Data validation: Users are redirected to the partner's API for data validation.
  3. 3.
    Request link generation: The partner calls the SEEK Pass API to fetch and/or create a request which will return a redirect URL. The partner may optionally display a loading page during this period.
  4. 4.
    User redirect: The user's browser is then redirected by the partner to the provided URL to add the credential to SEEK Pass
  5. 5.
    Verification process: Users are guided through a short and seamless flow to add their credential to SEEK Pass

Technical implementation

For technical implementation details, refer to these specific sections:

Best practices

For optimal integration results:
  • Always validate payload data before submission
  • Always keep track of and check existing requests to understand when to create and when to reuse a request
  • Do not change an existing ID for the same credential. Re-issuing the same credential with different IDs can in some circumstances result in the credential being added to a user's account multiple times. Especially avoid generating a new ID every time a user clicks the Add to SEEK Pass button
  • Implement proper error handling for API responses
  • Provide a branded loading page during API calls
  • Follow SEEK Pass branding guidelines for button placement and design

OTP Email Authentication – Partner Domain Considerations

If your organisation uses a custom email domain (e.g. @youruniversity.edu.sg), please ensure that OTP (One-Time Password) emails from SEEK Pass are successfully delivered to your accounts.
What to check
  • Use a real email address from your domain to test the OTP flow
  • Ensure OTP emails are not blocked by your organisation’s email firewall or spam filters
  • Confirm that users can complete login or verification using the received OTP
  • If you're unable to receive OTP emails during testing, please contact your IT team to allow emails from @seek.com.au, @seekpass.co, @seekpass-staging.com (staging environment for testing purposes) or reach out to your SEEK Pass integration contact
ChevronPrevious: Revoke OAuth token
Next: Credential definitionsChevron