Getting started
Core resources
Other
Caution
This feature is currently under development. Updates will be provided as soon as they become available.

Verify with SEEK Pass

Verify with SEEK Pass provides a seamless way for verifying credentials (e.g. digital identity) via SEEK Pass. For this integration, partners embed a button in their application flow which directs users to the SEEK Pass app where they need to choose a credential to be verified (e.g. passport, driver’s licence). Partners can integrate with SEEK Pass using REST APIs to authenticate and create a verification request, and redirect users to the SEEK Pass app.Verify with SEEK Pass - User Journey FlowVerify with SEEK Pass - Digital Identify Workflow

Technical details

There are 3 phases for this integration:
  • Authenticating with SEEK Pass
  • Submitting a verification request
  • Retrieving verification result
SEEK Pass authenticates and authorises partner requests using the OAuth2 Client Credentials flow for server-to-server authentication. Upon onboarding, partners will be provided with OAuth credentials to obtain a JWT access token for subsequent API calls. The OAuth credentials will be provided via a secure channel (e.g. 1Password).
# POST /api/partner/v1/oauth/token

curl --location $SEEK_PASS_URL/api/partner/v1/oauth/token.json 
--header 'Accept: application/json' 
--header 'Content-Type: application/x-www-form-urlencoded' 
--data-urlencode grant_type=client_credentials 
--data-urlencode client_id=$CLIENT_ID 
--data-urlencode client_secret=$CLIENT_SECRET 
--data-urlencode 'scope=write.digital_identity read.digital_identity'
Once authenticated, partners can submit a verification request using our verification API (POST /api/partner/v2/verify/requests/digital_identity.json). The request payload contains a callback URL which will be used to redirect users back to the partner’s nominated location (e.g. web app). This API returns a redirect URI which must be used to direct users to SEEK Pass. Refer to next sections for more details on the redirect URI format.After users complete the verification flow, they will be redirected back to the partner callback URL and the verification result will be provided via an API or a registered webhook. The response payload contains a request ID, user’s credential data, and verification result. Webhook security implementation is covered in the following sections.Sample verification request:
# POST /api/partner/v2/verify/requests/digital_identity.json

{
  "request_id": "7cbc7e51-82f5-43ec-8d63-b7cdf1170425",  // Optional. For tracking requests. If not passed, auto-generated.
  "callback_url": "https://www.partner.com/callback",    // Optional. For redirecting users
  "display_options": {           // required
    "partner_name": "string",    // required
    "partner_logo_url": "string" // optional
  },
  "request_source": [  // optional
    {
      "name": "string" // required
    }
  ],
  "metadata": {                  // optional - context about the verification
    "position_title": "string",  // optional
    "position_url": "string",   // optional
    "position_location": "string", // optional
    "job_categories": "string",  // optional
    "applied_on_seek": true     // optional - true if candidate applied via SEEK
  }
}
Sample verification response:
{
  "request_id": "7cbc7e51-82f5-43ec-8d63-b7cdf1170425",
  "redirect_uri": "https://app.seekpass.co/partner/verify/digitalIdentity?clientId=963266fbwtvbwrg34h35r&requestId=fa651300-b91a-49cb-8ee7-cac68b3fdf74"
}

Sequence diagram

Verify with SEEK Pass - Sequence Diagram

SEEK Pass account

SEEK Pass will provide OAuth credentials for partners for authentication in staging and production environments:
  • OAuth token endpoint: POST /api/partner/v2/oauth/token.json
  • Host:
    • Production: https://app.seekpass.co
    • Staging: https://app.seekpass-staging.com
  • Client credentials will be provided via a secure channel (e.g. 1Password)

Redirect URI structure

  • Path: /partner/verify/[Credential type]
  • Host:
    • Production: https://app.seekpass.co
    • Staging: https://app.seekpass-staging.com
  • Query: The below parameters as URL query parameters
    • clientId: OAuth Application ID
    • requestId: Verification request ID
  • Sample: https://app.seekpass-staging.com/partner/verify/digitalIdentity?clientId=963266fb0dd6488b506&requestId=a18eaa1d-4d9a-475e-bfb5-17ddfa159525

Verification result

The verification data and result of a request is provided via an API or a partner-registered webhook. SEEK Pass can provide webhook updates for various events at different stages of a verification workflow.
ChevronPrevious: Check submission status
Next: Check submission statusChevron