Universal Credential

Universal Credential uses Partner API v2 (POST /api/partner/v2/add/requests/universal_credential.json). Requests require the OAuth scope write.universal.

You may attach up to one supporting document per credential; assets must be pdf, png, or jpg. Omit assets when there is no document.

Field descriptions

See the OpenAPI specification for the full schema (including optional fields).

{
  "credential_id": { "type": "string" }, // (Required) Unique identifier for this credential payload
  "fields": { // { "type": "object" }, (Required)
    "full_name": { "type": "string" }, // (Required)
    "credential_name": { "type": "string" }, // (Required)
    "credential_category": { "type": "string" }, // (Required) See supported credential categories below
    "issuer_name": { "type": "string" }, // (Required)
    "expiry_date": { "type": ["string", "null"], "format": "date" }, // (Optional) Date format: "YYYY-MM-DD"
    "credential_details": { // (Optional) { "type": ["object", "null"] }
      "scope_of_practice": { "type": ["string", "null"] },
      "speciality": { "type": ["array", "null"], "items": { "type": "string" } },
      "version": { "type": ["string", "null"] },
      "date_completed": { "type": ["string", "null"], "format": "date" },
      "country": { "type": ["string", "null"] },
      "state": { "type": ["string", "null"] },
      "province": { "type": ["string", "null"] },
      "city": { "type": ["string", "null"] },
      "region": { "type": ["string", "null"] },
      "place": { "type": ["string", "null"] }
    }
  },
  "assets": [ // (Optional) Omit when there is no supporting document; up to one asset
    {
      "asset_id": { "type": "string" }, // (Required when assets are present)
      "asset_type": { "type": "string" }, // (Required when assets are present) One of "pdf", "jpg", "png"
      "asset_data": { "type": ["string", "null"] } // URL or data URL for the document
    }
  ]
}

Supported credential categories

Use one of the following values for fields.credential_category. SEEK Pass may add supported categories over time; check this guide or the OpenAPI specification for updates.

AVPRC Registration

Required fields

credential_id: A unique identifier for this credential payload.
fields.full_name: The individual's full name as it should appear on the credential.
fields.credential_name: The title or name of the qualification or credential.
fields.credential_category: The credential category; must be one of the supported credential categories listed above.
fields.issuer_name: The organisation that issued the credential.

Sample payload

{
  "credential_id": "uc_ext_1",
  "fields": {
    "full_name": "John Doe",
    "credential_name": "Test Credential",
    "credential_category": "AVPRC Registration",
    "issuer_name": "Test Issuer",
    "expiry_date": "2026-08-31",
    "credential_details": {
      "scope_of_practice": "Registered Veterinary Nurse",
      "speciality": [
        "Speciality #1",
        "Speciality #2"
      ],
      "version": "V2025",
      "date_completed": "2018-08-31",
      "country": "Australia",
      "state": "Victoria",
      "city": "Melbourne"
    }
  },
  "assets": [
    {
      "asset_id": "asset_id_1",
      "asset_type": "pdf",
      "asset_data": "https://example.com/certificate.pdf"
    }
  ]
}

Previous: Career History

Next: Credential Batch