Getting started
Core resources
Other

Migrate from API v1 to v2

The SEEK Pass API v1 is deprecated. Partners are required to migrate existing integrations to API v2, and new integrations must use v2. The migration deadline is TBA.
Review the v2 OpenAPI specification and the sample request payloads on each credential page, then update your endpoint URLs and request bodies. The v1 OpenAPI specification remains available for reference while you plan and validate the migration.
Education is used as the example throughout this page. Each credential type has its own payload and fields, so refer to the Credential types section of the documentation for the credential you are migrating.

Endpoint URLs

Replace /api/partner/v1 with /api/partner/v2. Create and status paths also change shape. Other credential types use the same URL pattern with their own path segment, such as english_proficiency or microcredential.
ActionAPI v1API v2
OAuth tokenPOST /api/partner/v1/oauth/token.jsonPOST /api/partner/v2/oauth/token.json
Revoke OAuth tokenPOST /api/partner/v1/oauth/token/revoke.jsonPOST /api/partner/v2/oauth/token/revoke.json
Create an Education requestPOST /api/partner/v1/add/education.jsonPOST /api/partner/v2/add/requests/education.json
Create a batch
POST /api/partner/v1/add/batch.json
POST /api/partner/v1/add/batch/microcredential.json
POST /api/partner/v2/add/requests/batch.json
Submission statusGET /api/partner/v1/submissions/$ID/status.jsonGET /api/partner/v2/add/requests/$CREDENTIAL_ID
Multiple submission statusesPOST /api/partner/v1/submissions/status.jsonGET /api/partner/v2/add/requests?credential_id[]=...
OAuth request fields (grant_type, client_id, client_secret, and scope) are unchanged. Bulk status is now a GET with repeated credential_id[] query parameters, instead of a POST body containing ids.
Batch does not follow the same URL pattern. API v1 had POST /api/partner/v1/add/batch.json and POST /api/partner/v1/add/batch/microcredential.json. API v2 has one batch endpoint, POST /api/partner/v2/add/requests/batch.json. Learning and Development credentials in that request are microcredential_items.

Credential payloads

The same Education qualification is shown in both versions. Field names inside the qualification, such as course_name and conferral_year, stay the same. What changes is where those fields sit, and how the document is attached. See Education for the full v2 schema.

API v1

POST /api/partner/v1/add/education.json
{
  "id": "seek-pass-test-a9a4839f-53d9-4064-8b0b-1348113a33f8",
  "document_type": "open_cert",
  "credential_type": "education",
  "data": {
    "credential": {
      "full_name": "John Smith",
      "education_provider": "University of Melbourne",
      "course_name": "Bachelor of Commerce",
      "conferral_year": "2024",
      "has_majors": true,
      "majors": ["Finance"],
      "with_honours": true
    },
    "document": "<OPEN_CERTS>"
  }
}

API v2

POST /api/partner/v2/add/requests/education.json
{
  "credential_id": "seek-pass-test-a9a4839f-53d9-4064-8b0b-1348113a33f8",
  "fields": {
    "full_name": "John Smith",
    "education_provider": "University of Melbourne",
    "course_name": "Bachelor of Commerce",
    "conferral_year": "2024",
    "has_majors": true,
    "majors": ["Finance"],
    "with_honours": true
  },
  "assets": [
    {
      "asset_id": "open-cert-1",
      "asset_type": "open_cert",
      "asset_data": "<OPEN_CERTS>"
    }
  ]
}

Field mapping

  • id becomes credential_id. Status responses use credential_id as well.
  • credential_type is removed from the body. The credential type is part of the URL.
  • data.credential becomes fields.
  • document_type and data.document become an assets item with asset_id, asset_type, and asset_data. For an OpenCert, asset_type is open_cert and asset_data is the OpenCert content. For a PDF URL, asset_type is pdf and asset_data is the URL.
  • When v1 used document_type of none, omit assets.
  • A successful create response still includes redirect_uri and also includes asset_uploads. That array is empty when asset_data was sent inline.