Look up applicants by identity | UAC

Finds applicants matching ALL of givenNames, familyName, dob (YYYY-MM-DD) and emailAddress (names and email matched case-insensitively), scoped to the caller’s institution. Returns an array — empty if none match.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

dobstringOptional

emailAddressstringOptional

familyNamestringOptional

givenNamesstringOptional

Response

idstringformat: "uuid"

givenNamesstring

familyNamestring

dobdate

emailAddressstringformat: "email"

phoneNumberanyOptional

postalAddressanyOptional

Errors

400

Bad Request Error

1	curl -G https://https//https/institution/applicants \
2	-H "Authorization: Bearer <token>" \
3	-d dob=2000-01-01 \
4	--data-urlencode emailAddress=test.tafe.pathway@example.com \
5	-d familyName=TestTafePathway \
6	-d givenNames=Test

1	[
2	{
3	"id": "0582af03-90bd-4ab4-9669-970fced94fec",
4	"givenNames": "Test",
5	"familyName": "TestTafePathway",
6	"dob": "2000-01-01",
7	"emailAddress": "test.tafe.pathway@example.com"
8	}
9	]