Important: Please ensure the file is in PDF format.
{ "id": { "type": "string" }, // (Required) Unique identifier for the data "document_type": { "type": "string" }, // (Required) Must be "english_assessment" "credential_type": { "type": "string" }, // (Required) Must be "english_proficiency" "data": { // { "type": "object" }, (Required) "credential": { // { "type": "object" }, (Required) "full_name": { "type": "string" }, // (Required) "test_provider": { "type": "string" }, // (Required) "test_name": { "type": "string" }, // (Required) "completion_date": { "type": "string" }, // (Required) Date format: "YYYY-MM-DD" "expiry_date": { "type": "string" }, // (Optional) Date format: "YYYY-MM-DD" "test_scores": { // { "type": "object" }, (Required) "cefr_scores": { // { "type": "object" }, (Required) "combined": "string", { "type": "string" }, // (Optional), Combined CEFR score across all other skills "reading": "string", { "type": "string" }, // (Optional), CEFR score for Reading "listening": "string", { "type": "string" }, // (Optional), CEFR score for Listening "speaking": "string", { "type": "string" }, // (Optional), CEFR score for Speaking "writing": "string" { "type": "string" }, // (Optional), CEFR score for Writing }, "overall": { // { "type": "object" }, (Required) "score": { "type": "string" }, // (Required) "scale": { "type": "string" }, // (Required) }, "subskills": [ // { "type": "array" }, (Optional) { "skill": { "type": "string" }, // (Required) "score": { "type": "string" }, // (Required) } ] } }, "document": { "type": "string" }, // (Required) Certificate URL } }
Granular CEFR key values pairs are important to how the English proficiency credential is displayed on the SEEK platform. By including a CEFR score for Combined (refers to an individual's overall skill level in English), Reading, Listening, Speaking and/or Writing we are able to showcase a user's English proficiency in a granular and consistent manner.
For example, when candidates respond to hirer role requirement questions about English proficiency, they are able to select options such as "Speaks proficiently in a professional setting". By having a Combined or Speaking CEFR score, we are able to highlight a candidate's proficiency in relation to this question.
The API accepts the following CEFR score values for all CEFR score fields (combined, reading, listening, speaking, writing):
{ "id": "1", "document_type": "english_assessment", "credential_type": "english_proficiency", "data": { "credential": { "full_name": "John Doe", "test_provider": "EnglishTestProvider", "test_name": "EnglishTestProvider Speaking", "completion_date": "2024-08-31", "expiry_date": "2026-08-31", "test_scores": { "cefr_scores": { "speaking": "A1" }, "overall": { "score": "150", "scale": "EnglishTestProvider" }, "subskills": [ { "skill": "Communication", "score": "50" }, { "skill": "Fluency", "score": "50" }, { "skill": "Pronunciation", "score": "50" } ] } }, "document": "https://example.com/testreport" } }
{ "id": "1", "document_type": "english_assessment", "credential_type": "english_proficiency", "data": { "credential": { "full_name": "John Doe", "test_provider": "EnglishTestProvider", "test_name": "EnglishTestProvider Certificate Summary Report", "completion_date": "2024-08-31", "expiry_date": "2026-08-31", "test_scores": { "cefr_scores": { "combined": "A1", "speaking": "B1", "listening": "C1", "reading": "B2", "writing": "C2" }, "overall": { "score": "415", "scale": "EnglishTestProvider" }, "subskills": [ { "skill": "Core Skills", "score": "401" }, { "skill": "Speaking", "score": "406" }, { "skill": "Writing", "score": "466" } ] } }, "document": "https://example.com/testreport" } }