Memulai
Sumber daya inti
Lainnya

Kredensial Universal

Caution
Kredensial Universal hanya didukung di API versi 2.
Info
Permintaan API memerlukan cakupan OAuth write.universal.

Deskripsi kolom

Anda dapat melampirkan hingga satu dokumen pendukung per kredensial; aset harus berupa pdf, png, atau jpg. Hilangkan assets jika tidak ada dokumen.
Lihat Spesifikasi OpenAPI V2 untuk skema lengkap (termasuk bidang opsional).
{
  "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
    }
  ]
}

Kategori kredensial yang didukung

Gunakan salah satu nilai berikut untuk fields.credential_category. SEEK Pass dapat menambahkan kategori yang didukung dari waktu ke waktu; periksa panduan ini atau spesifikasi OpenAPI untuk pembaruan.
  • AVPRC Registration

Bidang yang diperlukan

  • credential_id: Pengidentifikasi unik untuk payload kredensial ini.
  • fields.full_name: Nama lengkap individu seperti yang seharusnya tertera pada kredensial.
  • fields.credential_name: Judul atau nama kualifikasi atau kredensial.
  • fields.credential_category: Kategori kredensial; harus salah satu dari kategori kredensial yang didukung yang tercantum di atas.
  • fields.issuer_name: Organisasi yang menerbitkan kredensial.

Contoh 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"
    }
  ]
}