Add a new applicant
Creates an applicant. givenNames, familyName, dob (YYYY-MM-DD) and emailAddress are
required; phoneNumber, postalAddress, sourceName and sourceRef are optional.
sourceName and sourceRef record who this person is in YOUR systems: the system’s name and
its own id for them, typically a student number. Supplying them is worth it: the pair is what
you quote to find the person again, and it lets us match a returning applicant even when their
name or email has since changed.
A sourceRef must be unique within a sourceName, and sourceName is
required whenever you send one, since an id with no system to interpret it isn’t findable.
Look the applicant up first (GET) to avoid creating a duplicate.
Authentication
Paste a Keycloak access token (no "Bearer " prefix)
Request
Date of birth, ISO format YYYY-MM-DD.
Your own unique id for this person, e.g. a student 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.
Response
Your own unique id for this person, e.g. a student 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.