Add a new applicant | UAC

Creates an applicant. givenNames, familyName, dob (YYYY-MM-DD) and emailAddress are required; phoneNumber and postalAddress are optional. Look the applicant up first (GET) to avoid creating a duplicate.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

givenNamesstringRequired

familyNamestringRequired

dobdateRequired

emailAddressstringRequiredformat: "email"

phoneNumberstringRequired

postalAddressstringRequired

Response

idstringformat: "uuid"

givenNamesstring

familyNamestring

dobdate

emailAddressstringformat: "email"

phoneNumberstring

postalAddressstring

Errors

400

Bad Request Error

1	curl -X POST https://https//https/institution/applicants \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"givenNames": "Test",
6	"familyName": "Applicant",
7	"dob": "2000-01-01",
8	"emailAddress": "test.applicant@example.com",
9	"phoneNumber": "0212345678",
10	"postalAddress": "123 Walker St, North Sydney, NSW Australia"
11	}'

1	{
2	"id": "fe30eb6f-3a8e-480c-817c-a52301bca990",
3	"givenNames": "Test",
4	"familyName": "Applicant",
5	"dob": "2000-01-01",
6	"emailAddress": "test.applicant@example.com",
7	"phoneNumber": "0212345678",
8	"postalAddress": "123 Walker St, North Sydney, NSW Australia"
9	}