Event Data Models
An events data payload may contain complex nested objects with their own schema.
Address
A mailing address. Addresses from Canada are validated against Canada Post data and corrected for postal code matching and formatting.
Addresses outside of Canada are not validated.
| Property | Type | Notes |
|---|---|---|
| street | string (min 1, max 80) | |
| city | string (min 1, max 30) | |
| province | [nullable] string see ProvinceState Lookup | |
| country | string see Country Lookup | |
| postalCode | string (min 1, max 17) |
ApplicantBrief
All details about the applicant independent of the Application record including contact and demographic.
| Property | Type | Notes |
|---|---|---|
| id | string guid | Unique identifier of the Applicant record |
| number | string (min 1, max 20) | The Applicant's Account Number (not the same as the Application Number) |
| updated | string ISO 8601 Date Formatted String | Date the Applicant data was last updated |
| legalName | ApplicantName | Names used by the person for formal and legal purposes |
| formerNames | Array[0..10] of ApplicantName | Names previously used by the person for formal and legal purposes. Presently OCAS only captures one former name. |
| casualNames | Array[0..10] of ApplicantName | Preferred names used by the person for informal purposes. Presently OCAS only captures one casual name. |
| dateOfBirth | string date string in format yyyy-mm-dd | Date of Birth of the applicant. Note that the application does not support two applicants with identically matching First Name, Last Name and Date of Birth |
| gender | string see Gender Lookup | Declared gender of the applicant |
| canadianStatus | string see CanadianStatus Lookup | Applicant's declared status in Canada |
| primaryCitizenshipCountry | string see Country Lookup | Country to which the applicant presently holds Citizenship |
| countryOfBirth | string see Country Lookup | Country of birth of the applicant |
| primaryLanguage | string see Languages Lookup | Declared primary spoken language of the applicant |
| indigenousPersonIndicator | boolean | Whether or not the applicant self-identifies as a person with Canadian Indigenous ancestry |
| indigenousPersonDeclaration | [nullable] string see IndigenousPersonDeclarationType Lookup | If indigenousPersonIndicator is true, specifies how the applicant identifies their Indigenous ancestry |
| indigenousPersonDescription | [nullable] string | If the applicant includes an option in indigenousPersonDeclaration that includes the Other option, this specifies the applicant's self-identification |
| firstGeneration | [nullable] boolean | Whether or not the applicant declares they are the first in their immediate families to attend post-secondary education |
| sponsorAgency | [nullable] Number see SponsorAgency Lookup | The agency, if applicable, sponsoring the applicant's post-secondary education |
| languageOfCorrespondence | string see Languages Lookup | Language in which the applicant prefers to receive communication (restricted to French or English) |
| emailAddress | string (min 5, max 128) | Email address of the applicant to be used for email correspondence from the college |
| oen | [nullable] string (min 9, max 9) | This number is issued by the Ministry of Education to all students in the secondary school system in Ontario. Defaulted to nine zeros if not provided |
| oenValid | [nullable] string (OenStatus Lookup) | Status of the validation with the Ministry of Education |
| oenValidDate | [nullable] string date string in format yyyy-mm-dd | The date the OEN was last validated with the Ministry of Education |
| mailingAddress | Address | Mailing address of the applicant to be used for email correspondence from the college |
| phones | Array[1..2] of Phone | Collection of phone numbers to be used to contact the applicant. First phone in the array is the preferred option. Applicants may only specify one each of a Mobile phone and Home phone numbers. |
| militaryConnected | [nullable] string see MilitaryConnection Lookup | Military connection supplied by the applicant. e.g. Currently serving regular or reserve force, Veteran, or immediate family of any of these groups |
| disabilities | Array[0..N] of Disability Lookup | Disabilities and/or impairments supplied by the applicant |
| disabilityDescription | [nullable] string | Declaration of the applicant's other disability |
| ethnicGroups | Array[0..N] of Ethnic Group Lookup | Ethnic groups supplied by the applicant |
| ethnicGroupDescription | [nullable] string | Declaration of the applicant's other ethnic group |
| religions | Array[0..N] of Religion Lookup | Religions and/or spiritual self-identities supplied by the applicant |
| religionDescription | [nullable] string | Applicant's declaration of the applicant's other religion |
| sexualOrientations | Array[0..N] of Sexual Orientation Lookup | Sexual orientation supplied by the applicant |
| sexualOrientationDescription | [nullable] string | Declaration of the applicant's other sexual orientation |
Applicant
All details about the applicant independent of the Application record including contact and demographic as well as any supporting academic and credential data for admissions decisions.
| Property | Type | Notes |
|---|---|---|
| id | string guid | Unique identifier of the Applicant record |
| number | string (min 1, max 20) | The Applicant's Account Number (not the same as the Application Number) |
| updated | string ISO 8601 Date Formatted String | Date the Applicant data was last updated |
| legalName | ApplicantName | Names used by the person for formal and legal purposes |
| formerNames | Array[0..10] of ApplicantName | Names previously used by the person for formal and legal purposes. Presently OCAS only captures one former name. |
| casualNames | Array[0..10] of ApplicantName | Preferred names used by the person for informal purposes. Presently OCAS only captures one casual name. |
| dateOfBirth | string date string in format yyyy-mm-dd | Date of Birth of the applicant. Note that the application does not support two applicants with identically matching First Name, Last Name and Date of Birth |
| gender | string see Gender Lookup | Declared gender of the applicant |
| canadianStatus | string see CanadianStatus Lookup | Applicant's declared status in Canada |
| primaryCitizenshipCountry | string see Country Lookup | Country to which the applicant presently holds Citizenship |
| countryOfBirth | string see Country Lookup | Country of birth of the applicant |
| primaryLanguage | string see Languages Lookup | Declared primary spoken language of the applicant |
| indigenousPersonIndicator | boolean | Whether or not the applicant self-identifies as a person with Canadian Indigenous ancestry |
| indigenousPersonDeclaration | [nullable] string see IndigenousPersonDeclarationType Lookup | If indigenousPersonIndicator is true, specifies how the applicant identifies their Indigenous ancestry |
| indigenousPersonDescription | [nullable] string | If the applicant includes an option in indigenousPersonDeclaration that includes the Other option, this specifies the applicant's self-identification |
| firstGeneration | [nullable] boolean | Whether or not the applicant declares they are the first in their immediate families to attend post-secondary education |
| sponsorAgency | [nullable] Number see SponsorAgency Lookup | The agency, if applicable, sponsoring the applicant's post-secondary education |
| languageOfCorrespondence | string | Language in which the applicant prefers to receive communication. Possible values are 1 - English and 2 - French |
| emailAddress | string (min 5, max 128) | Email address of the applicant to be used for email correspondence from the college |
| oen | [nullable] string (min 9, max 9) | This number is issued by the Ministry of Education to all students in the secondary school system in Ontario. Defaulted to nine zeros if not provided |
| oenValid | [nullable] string (OenStatus Lookup) | Status of the validation with the Ministry of Education |
| oenValidDate | [nullable] string date string in format yyyy-mm-dd | The date the OEN was last validated with the Ministry of Education |
| mailingAddress | Address | Mailing address of the applicant to be used for email correspondence from the college |
| phones | Array[1..2] of Phone | Collection of phone numbers to be used to contact the applicant. First phone in the array is the preferred option. Applicants may only specify one each of a Mobile phone and Home phone numbers. |
| ontarioAcademicData | [nullable] OntarioAcademicData | Education and academic data related to the Ontario High School experience |
| internationalAcademicData | [nullable] InternationalAcademicData | Education and academic data related to the international evaluation of the applicant |
| educationDeclarations | Array[1..N] of Education | All prior secondary and post-secondary education institutions declared as having been attended by the applicant |
| credentials | Array[0..N] of ApplicantCredential | Available credentials on record for the applicant. Includes official transcripts (with grades if available) |
| proficiencies | Array[0..N] of ApplicantProficiency | Official test scores provided to OCAS for the applicant |
| supportingDocuments | Array[0..N] of SupportingDocument | Any additional supporting documentation (PDF documents) supplied by the applicant. Can include documents from both unofficial and official sources |
| militaryConnected | [nullable] string see MilitaryConnection Lookup | Military connection supplied by the applicant. e.g. Currently serving regular or reserve force, Veteran, or immediate family of any of these groups |
| disabilities | Array[0..N] of Disability Lookup | Disabilities and/or impairments supplied by the applicant |
| disabilityDescription | [nullable] string | Declaration of the applicant's other disability |
| ethnicGroups | Array[0..N] of Ethnic Group Lookup | Ethnic groups supplied by the applicant |
| ethnicGroupDescription | [nullable] string | Declaration of the applicant's other ethnic group |
| religions | Array[0..N] of Religion Lookup | Religions and/or spiritual self-identities supplied by the applicant |
| religionDescription | [nullable] string | Applicant's declaration of the applicant's other religion |
| sexualOrientations | Array[0..N] of Sexual Orientation Lookup | Sexual orientation supplied by the applicant |
| sexualOrientationDescription | [nullable] string | Declaration of the applicant's other sexual orientation |
ApplicantCredential
Credential (i.e. Transcript) data received by OCAS from a trusted, official source.
Course data for Ontario transcripts may be supplied in the following means:
- For current Ontario High School students, grades are submitted 6 times a year by all Ontario School Boards and will include interim/mid-term grades for in-progress courses
- For former Ontario High School students, grades may be requested by a student and submitted electronically by the supplying institution in XML or PDF form. PDF documents (attached as Supporting Documents) are subsequently transcribed and included here
- For applicants with secondary education received outside Canada that request an International Evaluation be submitted to OCAS will have their evaluation attached in PDF form as a Supporting Document, and any included equivalency grades will be transcribed and included here. The
schoolCodewill be set to "ICAS" and theschoolNamewill be set to "ICAS of Canada".
| Property | Type | Notes |
|---|---|---|
| id | string guid | Unique identified for the ApplicantCredential record |
| schoolType | string (SchoolType Lookup) | Type of institution issuing the credential |
| schoolCode | string | Unique code of the institution (e.g. MIDENT, ESIS, CSIS, USIS or PSIS code, or "ICAS") |
| schoolName | string (min 1, max 100) | Name of the institution |
| city | string (min 1, max 30) | City of the institution |
| province | [nullable] string (ProvinceState Lookup) | Province of the institution |
| country | [nullable] string (Country lookup) | Country of the institution |
| courses | Array[1..N] of Course | Set of Ontario High School courses (or equivalents) included in the transcript |
ApplicantName
| Property | Type | Notes |
|---|---|---|
| firstName | string (min 0, max 35) | |
| middleNames | Array[0..10] of strings (each item, min 1, max 20) | The order of the name in the array reflects the order of the declared middle names |
| lastName | string (min 0, max 35) | |
| prefix | [nullable] string (NamePrefix Lookup) |
ApplicantProficiency
Proficiency data received by OCAS from a trusted, official source, in the form of Test results.
Applicants may not add/declare proficiency data themselves - this is added to the application when such data is received through a trusted channel.
| Property | Type | Notes |
|---|---|---|
| id | string guid | Unique identifier of the ApplicantProficiency record |
| city | [nullable] string (min 1, max 30) | City in which the test proficiency was evaluated |
| province | [nullable] string | Display name of the province/state only |
| country | [nullable] string Country Lookup | Country in which the test proficiency was evaluated |
| type | [nullable] string TestType Lookup | Type of proficiency/test |
| completionDate | [nullable] string date string in format yyyy-mm-dd | Date the test proficiency was evaluated |
| normingGroup | [nullable] string NormingGroup Lookup | This is the group that the particular score for the applicant has been normalized against. |
| subScores | Array[1..N] of ApplicantProficiencySubScore | Detail records/results of the proficiency(-ies) evaluated |
ApplicantProficiencySubScore
Details of a test score
| Property | Type | Notes |
|---|---|---|
| id | string guid | Unique identifier for the applicant proficiency subscore record |
| applicantProficiencyId | string guid | Unique identifier for the parent applicant proficiency record |
| type | string (TestSubType Lookup) | |
| score | [nullable] number (min 0, max 999) | |
| percentile | [nullable] number (min 0, max 100) |
ApplicationBrief
Record of the applicant's Application to College. Includes the basic data for admissions consideration such as Basis of Admission
| Property | Type | Notes |
|---|---|---|
| id | string guid | |
| number | string (min 1, max 20) the Application Number | |
| state | string (ApplicationStates Lookup) | |
| updated | string ISO 8601 Date Formatted String | |
| submitted | string ISO 8601 Date Formatted String | |
| basisOfAdmissionCode | string (min 1, max 50) (BasisOfAdmissionReason Lookup) | |
| currentStudent | boolean |
Application
Record of the applicant's Application to College. Includes the unique identifier (Application Number), Applicant record, all Program Choices for the college and basic data for admissions consideration such as Basis of Admission
| Property | Type | Notes |
|---|---|---|
| id | string guid | |
| number | string (min 1, max 20) the Application Number | |
| state | string (ApplicationStates Lookup) | |
| updated | string ISO 8601 Date Formatted String | |
| submitted | string ISO 8601 Date Formatted String | |
| basisOfAdmissionCode | string (min 1, max 50) (BasisOfAdmissionReason Lookup) | |
| currentStudent | boolean | |
| programChoices | Array[1..5] of ProgramChoice | |
| applicant | Applicant |
Course
A record of a single course the student enrolled in. Currently only supports Ontario High School courses and their equivalencies. Courses that come from an International Evaluation or International Credit Assessment are identifiable by the school indicated in its containing ApplicantCredential record (e.g. "ICAS" or "WES").
| Property | Type | Notes |
|---|---|---|
| id | string guid | Unique identifier for the course record |
| applicantCredentialId | string guid | Unique identifier for the parent applicant credential record |
| courseCode | string (CourseCode lookup) | 5-6 character code identifying the course |
| courseDelivery | [nullable] string (CourseDelivery lookup) | The type of secondary school where the course was taken. Not specified for International credit assessment courses |
| completionDate | [nullable] string date string in format yyyy-MM-dd | The date when the course has been completed in the case of final grades already earned, or when the course will be completed if the student is currently registered. |
| creditValue | number | The credit value of the course. |
| grade | string | Must be specified for midterm or final grades. The values are usually a three-digit grade (e.g., 67 = 067, 100 = 100, 67.5 = 068, 67.33 = 067); various character values (e.g. A+, A, A-, B+, B, etc.) and/or other equivalency values such as EQV, QEE, QEV, N/A (Not Applicable), ALT = Alternative course, does not lead to credit and ***. |
| gradeType | [nullable] string (GradeType lookup) | Whether the grade, if present is a midterm or final grade. Not specified for International credit assessment courses |
| courseType | [nullable] string (CourseType lookup) | The type of course taken. Not specified for International credit assessment courses |
| courseStatus | [nullable] string (CourseStatusType lookup) | Identifies if a course is repeated or if the student withdrew from the course. This new field is based on the Ministry of Education's full disclosure policy. Not specified for International credit assessment courses |
| midentCode | [nullable] string | The Mident Code indicating the institution at which this course was taken. Note that this can differ from the MIDENT of the parent applicantCredential |
| notes | Array[0..5] of string (CourseNote Lookup) | A special circumstance indicator for a course. This field is based on the O.S.T. / new school curriculum. |
Education
Record of education experience, domestic or international, as declared by the applicant.
| Property | Type | Notes |
|---|---|---|
| id | [nullable] string guid | |
| schoolType | string (SchoolType Lookup) | |
| schoolCode | [nullable] string | |
| schoolName | string (min 1, max 100) | |
| academicUpgrade | boolean | |
| city | [nullable] string (min 1, max 30) | |
| province | [nullable] string (ProvinceState Lookup) | |
| country | [nullable] string (Country lookup) | |
| status | string (EducationCredentialStatus Lookup) | |
| startDate | [nullable] string date string in format yyyy-mm-dd | |
| completionDate | [nullable] string date string in format yyyy-mm-dd | |
| credentialCode | [nullable] string (ProgramCredentialType Lookup) | |
| credentialDescription | [nullable] string | |
| programName | [nullable] string | |
| levelOfStudy | [nullable] string (LevelOfStudyType Lookup) | |
| levelAchieved | [nullable] string (LevelAchievedType Lookup) | |
| attendanceFirstName | [nullable] string | |
| attendanceLastName | [nullable] string | |
| lastGradeCompleted | [nullable] number |
InternationalAcademicData
Education and academic data related to the Ontario High School experience or the international evaluation of the applicant.
| Property | Type | Notes |
|---|---|---|
| id | string guid | Identifier of this InternationalAcademicData record |
| secondarySchoolEvaluation | [nullable] string (SecondarySchoolEvaluationType Lookup) | This data item is based on the evaluation of International Transcripts and is the highest level achieved by the applicant at a secondary school. |
| evaluationGraduationDate | [nullable] string date string in format yyyy-mm-dd | The date that the applicant graduated from an international secondary school |
OntarioAcademicData
Education and academic data related to the Ontario High School experience or the international evaluation of the applicant.
| Property | Type | Notes |
|---|---|---|
| id | string guid | Identifier of this OntarioAcademicData record |
| midentCode | [nullable] string (min 6, max 6) | Six-digit Ministry assigned school identification number representing a secondary school in Ontario. |
| ossdIssueDate | [nullable] string date string in format yyyy-mm-dd | The date that the student achieved the Ontario Secondary School Diploma (OSSD) |
| ossdToBeAchieved | boolean | Whether the student will achieve the OSSD by the selected programs' earliest start date |
| osscIssueDate | [nullable] string date string in format yyyy-mm-dd | The date that the student achieved the Ontario Secondary School Certificate (OSSC) |
| osscToBeAchieved | boolean | Whether the student will achieve the OSSC by the selected programs' earliest start date |
| ssLiteracyTest | [nullable] string (LiteracyTest Lookup) | Completion of Provincial Secondary School literacy test |
| communityInvolvement | [nullable] string (CommunityInvovementType Lookup) | Completion of required number of hours for community involvement. |
| gedCompletionDate | [nullable] string date string in format yyyy-mm-dd | The date that the student achieved a GED |
| shsmCode | [nullable] string (ShsmCode Lookup) | This field only applies for Ontario High School applicants who are taking a High Skills major program |
Offer
The record of an offer of admission to an applicant for a specified program and intake.
| Property | Type | Notes |
|---|---|---|
| offerSisIdentifier | [nullable] string (min 1, max 100) | Identifier assigned by the college to uniquely identify the offer record. Can be a string composed of the unique elements of the offer (application, campus code, program code, start date, delivery, entry level) |
| applicationNumber | string (min 1, max 20) | |
| campusCode | [nullable] string (min 1, max 4) | Campus Code on record with OCAS (not necessarily campus code used in your SIS) |
| programCode | [nullable] string (min 1, max 10) | Program Code on record in the Program Catalogue with OCAS |
| deliveryOption | [nullable] string (IntakeDeliveryOption Lookup) | |
| entryLevelType | [nullable] string (EntryLevelType Lookup) | |
| startDate | [nullable] string date string in format yyyy-mm-dd | Start date of the program. If stored as a month intake, specify '01' as the day portion of the date |
| intakeId | [nullable] string guid | [Deprecated] Unique identifier of the Program Intake assigned by OCAS. Informational only. Not to be used for matching. |
| intakeSisIdentifier | [nullable] string (min 1, max 100) | Unique identifier of the Program Intake assigned by the college. Only use if college has provided intakeSisIdentifer values in the program catalogue. |
| choiceNumber | number 1 to 6 | 1 through 5 is the sequence from the original program choice and 6 is an alternate offer. If the applicant has removed the program choice prior to the offer being processed, it will be assigned 6 indicating an alternate offer. |
| isLateAdmit | boolean | |
| activeDate | string date string in format yyyy-mm-dd | The date when the offer is to be displayed to the applicant. The active time will be set to 12:01:00 AM on the date specified |
| softExpiryDate | string date string in format yyyy-mm-dd | The expiry date that will be displayed to the applicant. The applicant will be able to view and accept this offer beyond this date up to the date in hardExpiryDate. The expired time will be set to 11:59:59 PM on the date specified. |
| hardExpiryDate | string date string in format yyyy-mm-dd | The date the offer expires. Once this date has passed, the applicant will be able to view this expired offer but will not be able to accept it. The system will indicate that this offer has expired. The expired time will be set to 11:59:59 PM on the date specified. |
| state | string (min 1, max 50) (OfferState Lookup) | The state of the offer being updated |
Phone
A phone number
| Property | Type | Notes |
|---|---|---|
| type | string (PhoneType Lookup) | |
| number | string (min 1, max 15) follows format "1234567890" |
Example:
{
"type": "mobile",
"number": "234567890"
}
ProgramChoice
Record of the applicant's request to be considered for admission for a specific program and intake. In the event of an offer of admission, also a record of the applicants acceptance of the offer. Program choices are uniquely identified for a given program intake (college, program, campus, delivery, start date) and the entry semester.
| Property | Type | Notes |
|---|---|---|
| id | string guid | Unique identifier of the Program Choice |
| collegeCode | string (CollegeCode Lookup) | |
| programCode | string | Unique code for the program as defined by the college as part of the full-time Program Catalogue |
| campusCode | string | |
| delivery | string (IntakeDeliveryOption Lookup) | |
| startDate | string date string in format yyyy-mm-dd | |
| semester | string (EntryLevelType Lookup) | |
| choiceNumber | Number {1..6} | Sequential order of program choice on the application. It will always be in the range 1-5. The only exception occurs when alternate choices (confirmation of acceptances) are processed. The sequence number could take on a value of 6 for these situations. |
| effectiveDate | string date string in format yyyy-mm-dd | The date the program choice was added to the application. For choices included in the original application, this will match the Application's effective date. |
| intakeId | string guid | [Deprecated] The OCAS-assigned unique identifier for the selected Program Intake. Informational only. Not to be used for matching. |
| intakeSisIdentifier | [nullable] string (min 1, max 100) | The College-assigned unique code for the selected Program Intake, if available |
| offerId | [nullable] string guid | [Deprecated] The OCAS-assigned unique identifier for the related Offer of Admission. Informational only. Not to be used for matching. |
| offerSisIdentifier | [nullable] string (min 1, max 100) | The College-assigned unique code for the related Offer of Admission, if available |
| decision | string (ProgramChoiceDecision Lookup) | The applicant's decision on a college's issued Offer of Admission |
| dateDecisionReceived | [nullable] string date string in format yyyy-mm-dd | The date the applicant made their decision for an Offer of Admission |
| previousAppliedYear | [nullable] string (min 4, max 4) | The applicant has indicated that they have previously applied to the college and are providing the year they last applied (YYYY) |
| previousAttendedYear | [nullable] string (min 4, max 4) | The applicant has indicated that they have previously attended the college and are providing the year they last attended (YYYY). |
Example:
{
"id": "0754c6ac-c388-4040-afb9-eda4a61b276c",
"collegeCode": "CODE",
"programCode": "1000G",
"campusCode": "CA",
"delivery": "F",
"startDate": "2023-01-01",
"semester": "01",
"choiceNumber": "1",
"effectiveDate": "2021-11-09",
"intakeId": "0123c6ac-d388-7040-bfb9-eda4a61b442e",
"intakeSisIdentifier": "1000G-CA-F-20230101",
"offerId": null,
"offerSisIdentifier": null,
"decision": "nodecision",
"dateDecisionReceived": null,
"previousAppliedYear": null,
"previousAttendedYear": null
}
SupportingDocument
Record of a document that has been received by OCAS in support of the applicant's application to a college program.
| Property | Type | Notes |
|---|---|---|
| id | string Guid | Unique identifier for the supporting document |
| type | string (SupportingDocumentType Lookup) | The type of supporting document. |
| dateReceived | string date string in format yyyy-mm-dd | Date the supporting document was received at OCAS. Supporting documents for an applicant can be distinguished from each other by a combination of type and dateReceived |
| official | [nullable] boolean | An indicator of the supporting document’s designation as official or a non-official |
| original | [nullable] boolean | An indicator of the supporting document as an original or a copy of the original supporting document |
| issueDate | [nullable] string date string in format yyyy-mm-dd | The issue date of the supporting document, as specified by the issuing agency |
| issuingAgencyCode | [nullable] string (Agency Lookup) | The issuing agency of the supporting document |
| documentNumber | [nullable] string | The file number (document number) that appears on the supporting document. This value is generated by the issuing agency |
| schoolType | [nullable] string (SchoolType Lookup) | The type of academic institution referenced in the supporting document |
| schoolCode | [nullable] string | Numeric code assigned uniquely to each educational institute name. A reference table for educational institutes is not available as new additions are made weekly |
| schoolName | [nullable] string (max 100) | The name of the institution |
| city | [nullable] string (max 30) | City of the institution |
| province | [nullable] string (ProvinceState Lookup) | Province of the issuing agency or institution, or the jurisdiction of the document |
| country | [nullable] string (Country lookup) | Country of the issuing agency or institution, or the jurisdiction of the document |
| graduationDate | [nullable] string date string in format yyyy-mm-dd | Date the applicant earned the credential according to the supporting document |
| level | [nullable] string | Certification level of the supporting document |
| expiryDate | [nullable] string date string in format yyyy-mm-dd | The expiry date of the supporting document |
| driversLicenseClass | [nullable] string | The class of the applicant’s driver’s license. |
| driversLicenseTemporary | [nullable] boolean | Indicate if the applicant’s driver’s license is temporary or permanent |
| fileName | [nullable] string (max 255) | The original file name |
| mimeType | [nullable] string (max 255) | The original file mime type (ie. application\pdf) |
SupportingDocument Property Mapping
For the SupportingDocumentTypes below, some properties may be present in the SupportingDocument model. Note that not all SupportingDocumentTypes include additional properties.
| SupportingDocumentType | official | original | issueDate | issuingAgencyCode | documentNumber | schoolType | schoolCode | schoolName | city | country | province | graduationDate | level | expiryDate | driversLicenseClass | driversLicenseTemporary |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| transcript | ✔️ | ✔️ | ✔️ | ✔️ | ||||||||||||
| degree | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |||||||
| diplomapostsecondary | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |||||||
| postsecondarycertificate | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |||||||
| transcriptcollege | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |||||||
| transcriptuniversity | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |||||||
| transcriptunknown | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |||||||
| cprfirstaid | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ||||||||||
| firstaidcertificate | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ||||||||||
| canadiancitizenshipcertificate | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |||||||||||
| canadianimmigrationidcard | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |||||||||||
| canadianimmigrationidrecord | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |||||||||||
| canadianpassport | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |||||||||||
| canadianstatus | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |||||||||||
| employmentletter | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |||||||||||
| immigrantvisa | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |||||||||||
| recordoflanding | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |||||||||||
| visitor | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |||||||||||
| studentauthorization | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ||||||||||
| driverslicense | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |