> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs-unsw-v6.advance-uac.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs-unsw-v6.advance-uac.com/_mcp/server.

# Look up applicants by identity

GET https://institution/applicants

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.

Reference: https://docs-unsw-v6.advance-uac.com/unsw-advance-institution-api/institution/applicants/look-up-applicants-by-identity

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: collection
  version: 1.0.0
paths:
  /institution/applicants:
    get:
      operationId: Look up applicants by identity
      summary: Look up applicants by identity
      description: >-
        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.
      tags:
        - applicants
      parameters:
        - name: dob
          in: query
          required: false
          schema:
            type: string
        - name: emailAddress
          in: query
          required: false
          schema:
            type: string
        - name: familyName
          in: query
          required: false
          schema:
            type: string
        - name: givenNames
          in: query
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: Bearer authentication
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/InstitutionApplicantsGetResponsesContentApplicationJsonSchemaItems
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/GetInstitutionApplicantsRequestBadRequestError
servers:
  - url: https:/
    description: https://{baseurl}
components:
  schemas:
    InstitutionApplicantsGetResponsesContentApplicationJsonSchemaItems:
      type: object
      properties:
        id:
          type: string
          format: uuid
        givenNames:
          type: string
        familyName:
          type: string
        dob:
          type: string
          format: date
        emailAddress:
          type: string
          format: email
        phoneNumber:
          description: Any type
        postalAddress:
          description: Any type
      required:
        - id
        - givenNames
        - familyName
        - dob
        - emailAddress
      title: InstitutionApplicantsGetResponsesContentApplicationJsonSchemaItems
    GetInstitutionApplicantsRequestBadRequestError:
      type: object
      properties:
        status:
          type: integer
        error:
          type: string
      required:
        - status
        - error
      title: GetInstitutionApplicantsRequestBadRequestError
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

```

## Examples



**Response**

```json
[
  {
    "id": "0582af03-90bd-4ab4-9669-970fced94fec",
    "givenNames": "Test",
    "familyName": "TestTafePathway",
    "dob": "2000-01-01",
    "emailAddress": "test.tafe.pathway@example.com"
  }
]
```

**SDK Code**

```python institution_applicants_Look up applicants by identity_example
import requests

url = "https://https/institution/applicants"

querystring = {"dob":"2000-01-01","emailAddress":"test.tafe.pathway@example.com","familyName":"TestTafePathway","givenNames":"Test"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript institution_applicants_Look up applicants by identity_example
const url = 'https://https/institution/applicants?dob=2000-01-01&emailAddress=test.tafe.pathway%40example.com&familyName=TestTafePathway&givenNames=Test';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go institution_applicants_Look up applicants by identity_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://https/institution/applicants?dob=2000-01-01&emailAddress=test.tafe.pathway%40example.com&familyName=TestTafePathway&givenNames=Test"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby institution_applicants_Look up applicants by identity_example
require 'uri'
require 'net/http'

url = URI("https://https/institution/applicants?dob=2000-01-01&emailAddress=test.tafe.pathway%40example.com&familyName=TestTafePathway&givenNames=Test")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java institution_applicants_Look up applicants by identity_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://https/institution/applicants?dob=2000-01-01&emailAddress=test.tafe.pathway%40example.com&familyName=TestTafePathway&givenNames=Test")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php institution_applicants_Look up applicants by identity_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://https/institution/applicants?dob=2000-01-01&emailAddress=test.tafe.pathway%40example.com&familyName=TestTafePathway&givenNames=Test', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp institution_applicants_Look up applicants by identity_example
using RestSharp;

var client = new RestClient("https://https/institution/applicants?dob=2000-01-01&emailAddress=test.tafe.pathway%40example.com&familyName=TestTafePathway&givenNames=Test");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift institution_applicants_Look up applicants by identity_example
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://https/institution/applicants?dob=2000-01-01&emailAddress=test.tafe.pathway%40example.com&familyName=TestTafePathway&givenNames=Test")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```