Credential Batch

Using the Batch API

The Batch API allows you to submit multiple credentials in a single API request. This endpoint is able to streamline the user experience of adding multiple credentials at once. This can be used to handle:

1. Multiple of a single type of credential (e.g. 2x Education Qualifications)
2. Multiple of multiple types of credentials (e.g. 1x Digital Identity, 2x Education Qualifications and 5x Learning and Development Credentials)

Copy
curl -L $SEEK_PASS_URL/api/partner/v1/add/batch.json \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $ACCESS_TOKEN" \
--data '<BATCH PAYLOAD>'

Field descriptions

Copy
{
  "id": { "type": "string" }, // (Required) Unique identifier for the data
  "credentials": [ // { "type": "array" }, (Required) Array of credentials
    {
      "id": { "type": "string" }, // (Required) Unique identifier for this batch item
      "credential_type": { "type": "string" }, // (Required) Example: "microcredential", "education", "english_proficiency"
      "data": { // { "type": "object" }, (Required)
        "credential": { // { "type": "object" }, (Required)
          // (Required) Credential data appropriate to the credential_type,
          // see non-batch version for the particular credential_type
          // Example: {
          //  "full_name": "string", // (Required)
          //  "issuer_name": "string", // (Required)
          //  "microcredential_name": "string", // (Required)
          //  "issue_date": "YYYY-MM-DD", // (Required) Date format
          //  "expiry_date": "YYYY-MM-DD" // (Optional), Date format
          //  "assessment_result": { "type": ["string", null] } // (Optional) Text description
          //}
        },
      }
    }
  ]
}

Sample payload

Copy
{
  "id": "67a7cd42-e5c0-4b92-8dd6-050025873c0c",
  "credentials": [
    {
      "id": "67a7cd42-e5c0-4b92-8dd6-050025873c0c-education-1",
      "credential_type": "education",
      "data": {
        "credential": {
          "full_name": "Winston Rath",
          "education_provider": "University of Melbourne",
          "course_name": "Bachelor of Testing",
          "conferral_year": "2020",
          "with_honours": true,
          "majors": [],
          "has_majors": false
        }
      }
    },
    {
      "id": "67a7cd42-e5c0-4b92-8dd6-050025873c0c-english_proficiency-1",
      "credential_type": "english_proficiency",
      "data": {
        "credential": {
          "full_name": "Winston Rath",
          "test_provider": "IELTS",
          "test_name": "IELTS Academic",
          "completion_date": "2021-05-01",
          "test_scores": {
            "cefr_scores": {
              "combined": "C1",
              "listening": "C1",
              "reading": "C1",
              "speaking": "C1",
              "writing": "C1"
            },
            "overall": { score": "8.5", scale": "IELTS" },
            "subskills": [
              "{ skill": "Listening", score": "8.5" },
              "{ skill": "Reading", score": "8.5" },
              "{ skill": "Speaking", score": "8.5" },
              "{ skill": "Writing", score": "8.5" }
            ]
          }
        }
      }
    },
    {
      "id": "67a7cd42-e5c0-4b92-8dd6-050025873c0c-microcredential-1",
      "credential_type": "microcredential",
      "data": {
        "credential": {
          "full_name": "Winston Rath",
          "issuer_name": "Coursera",
          "microcredential_name": "Machine Learning",
          "issue_date": "2020-01-15",
          "expiry_date": "2022-01-15",
          "assessment_result": "90%"
          "document_type": "PDF",
          "document": "
        }
      }
    }
  ]
}