OAuth 2.0 authentication

OAuth2 client credentials

SEEK Pass provides OAuth 2.0 credentials (client_id and client_secret) for authentication. These are provided via secure channels (e.g., 1Password) for both staging and production environments.

For more information on OAuth 2.0, please refer to the documentation.

Environments

The staging and production environment endpoints are provided below:

Staging: https://app.seekpass-staging.com
Production: https://app.seekpass.co

SEEK Pass uses OAuth 2.0 and the Client Credentials grant type for server-to-server authentication.

For more information about Client Credentials, please refer to the documentation.

export SEEK_PASS_URL=https://app.seekpass-staging.com
export CLIENT_ID=<YOUR CLIENT ID>
export CLIENT_SECRET=<YOUR CLIENT SECRET>

Request an OAuth access token by calling the following endpoint with the appropriate scope for your credential type (e.g. write.education, write.english_proficiency):

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.education'

Batch request

In order to use the batch request feature, you need to include all the requested types in the scope field in your OAuth token request.

This allows you to submit multiple credentials in a single API call.

Example:

curl -L $SEEK_PASS_URL/api/partner/v1/oauth/token.json \
-H '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.microcredential write.education write.digital_identity'

Response codes

Below are the HTTP status codes returned by the SEEK Pass API. Understanding these response codes will help you handle different scenarios in your integration.

200 OK: Successful Authentication

{
    "access_token": "eyJhbGciOiJIUzUxMiJ9.eyJpYXQiOjE3NDAzNTkyNTEsImV4cCI6MTc.ZnOZlWaSeJx_ySk3Pl88Xy8KnPKc4EX",
    "token_type": "Bearer",
    "expires_in": 7199,
    "scope": "write.education",
    "created_at": 1736144436
}

Save the access_token for the next steps:

export ACCESS_TOKEN=eyJhbGciOiJIUzUxMiJ9.eyJpYXQiOjE3NDAzNTkyNTEsImV4cCI6MTc.ZnOZlWaSeJx_ySk3Pl88Xy8KnPKc4EX

Previous: Overview

Next: Revoke OAuth token