Skip to navigation

Secondary education

View as Markdown

Secondary and vocational studies held by your customer, from the official education registry.

The same register as the university degrees, one level below: what was studied, where, and when it was completed. Field by field in Academic Records.

Requires the academic_data feature

Features are chosen when the execution starts, not here. An execution that did not ask for academic_data answers 204, and the only way to get the data is to run another one.

The same feature produces Higher education.

StatusMeaning
200The records.
202feature_not_ready — academic_data is still running. Only this family waits: the ones that already closed answer now.
204The execution never asked for academic_data. No body.
404No execution with that id for your application, or it has been deleted.

Server to server only. This call is authorised with your application secret: it belongs in your backend, never in a browser, a mobile app or anything your customer can read.

Authentication

X-APP-SECRETstring
Application Secret

Path parameters

execution_idstringRequiredformat: "object-id"
The execution, as the acceptance response returned it.

Response

200 OK
Secondary studies on the same register as the degrees. Both read from the same academic_data feature, so an execution that asked for it can call either.

An empty list is an answer, not a gap: the feature ran and the source reported none.

product"academic_data"
sub_familyenum
Allowed values:
fetch_datestringformat: "datetime"
Date this product was fetched
qualification_namestring
Qualification name.
institution_namestring
Institution name.
institution_countrystringformat: "country"
Country of the institution.
completion_statusstring
Completion status
institution_codestringOptional
Local school ID or center code.
regionstringOptional
State, Province, or Autonomous Community.
issue_datedateOptional
Date when the qualification was issued.
start_datedateOptional
Date when the education started.
end_datedateOptional
Date when the education ended.
official_idstringOptional

National registry number / Diploma serial number.

verification_urlstringOptional
Link to public administration validator.
study_frameworkstringOptional

Education system/law (e.g., “LOE”, “K-12”, “GCSE”)

national_registry_idstringOptional

National level ID (e.g., MEC in Spain)

regional_registry_idstringOptional

State/Regional level ID

archive_volumestringOptional

Book/Volume number (Libro)

archive_entrystringOptional

Entry or order number (Folio/Orden)

Errors

404
Not Found Error
422
Unprocessable Entity Error