Submit a new application
Creates an application for an applicant (status RECEIVED) and returns their ids.
The applicant is resolved in this order: by applicant.sourceRef if you send one, otherwise by
identity (givenNames, familyName, dob, emailAddress). An existing applicant is reused;
otherwise a new one is created and stamped with whatever source details you supplied.
The application’s own sourceName / sourceRef are separate from the applicant’s. The former
is your application number, the latter your student number. Both optional, both unique within
a sourceName, and either one lets you find the record again without storing our UUID.
Any qualifications supplied are added to the application. Assessment is asynchronous, so poll GET /institution/applications/{id} for the outcome.
specialisations is optional and takes handbook codes; see the field for how they are read.
Leaving it out behaves exactly as before, so an existing integration needs no change.
Authentication
Paste a Keycloak access token (no "Bearer " prefix)
Request
The applicant. Matched by identity (givenName1, familyName, dob, emailAddress); reused if they already exist for this institution, otherwise created.
Commencement (cohort) year, e.g. 2026.
Admission stream, e.g. "DOMESTIC_FP".
Your own code for the intake the applicant is starting, e.g. "5269" for Term 3 2026.
Optional, but worth sending: our officers work applications in intake order, and one with no intake cannot be prioritised against the rest.
Send the code rather than the name. These are YOUR term codes, loaded from the intake schedule you supply us, so a code you use is a code we hold; one we do not recognise is refused with a 400 naming it.
Optional free-text note.
Your own unique id for this application, e.g. an application number. Unique per sourceName.
Your own references for this record, one per system you keep it in. A person or an application known by a different id in SITS than elsewhere carries both.
Optional. sourceName and sourceRef still work exactly as before and count
as the FIRST entry here, so nothing you have already built needs to change.
Send both forms and they are combined, with duplicates collapsed.
Order matters: the first entry is the one echoed back as sourceRef, and the
one shown in lists and in the change feed.
The specialisations this application is for, as handbook codes — the majors, minors, honours streams or research areas the applicant is taking alongside the program.
Optional, and an application without any is completely normal: most programs offer none. Two is the usual maximum, and the applicant portal enforces that, but this endpoint does not — what you send is what happened.
The codes are resolved against the application's own year, the same handbook
year programCode is read in, so you send codes alone rather than a second
code-and-year pair. A code the catalogue does not hold for that year is a 400
naming it.