> 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

GET https://unsw-v6-dev.advance-uac.com/institution-api/institution/applicants

Finds applicants, either way round:

- **by your own id**: send `sourceRef` (optionally with `sourceName` to name the system it
  belongs to). The identity parameters are then ignored. Returns at most one applicant.
- **by identity**: send ALL of `givenNames`, `familyName`, `dob` (YYYY-MM-DD) and
  `emailAddress`. Names and email are matched case-insensitively.

Prefer the first when you have it: an id survives a name change or a corrected typo, where
identity matching would miss the person entirely.

Returns an array, empty if nothing matches.

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

## Authentication

- `Authorization` header (bearer token, required) — Paste a Keycloak access token (no "Bearer " prefix)

## Servers

- `https://unsw-v6-dev.advance-uac.com/institution-api` (Dev, default)
- `https://unsw-v6-test.advance-uac.com/institution-api` (Test)

## Request

### Query parameters

- `dob` (string, optional)
- `emailAddress` (string, optional)
- `familyName` (string, optional)
- `givenName1` (string, optional)
- `sourceName` (string, optional) — The system `sourceRef` belongs to, e.g. "SITS". Optional; omit to search every system.
- `sourceRef` (string, optional) — Your own id for the person, e.g. a student number. When given, the identity parameters are ignored.

## Response

### 200

OK

- `list of ApplicantView`

## Types

### ApplicantView

An applicant.

- `id` (string, optional)
- `givenName1` (string, optional)
- `givenName2` (string, optional)
- `givenNames` (string, optional)
- `familyName` (string, optional)
- `dob` (date, optional)
- `emailAddress` (string, optional)
- `phoneNumber` (string, optional)
- `postalAddress` (string, optional)
- `sourceName` (string, optional) — The system this record was fed from, in your own vocabulary. Free text, and required whenever you send a sourceRef.
- `sourceRef` (string, optional) — Your own unique id for this person, e.g. a student number. Unique per `sourceName`.
- `sources` (list of SourceReference, optional) — 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.

### SourceReference

One of your own references for this person: the system it came from, and its id there.

- `sourceName` (string, optional) — The system this record was fed from, in your own vocabulary. Free text, and required whenever you send a sourceRef.
- `sourceRef` (string, optional) — Your own unique id for this person, e.g. a student number. Unique per `sourceName`.

## Examples

**Response**

```json
[
  {
    "id": "string",
    "givenName1": "string",
    "givenName2": "string",
    "givenNames": "string",
    "familyName": "string",
    "dob": "2022-03-10",
    "emailAddress": "string",
    "phoneNumber": "string",
    "postalAddress": "string",
    "sourceName": "SITS",
    "sourceRef": "z1234567",
    "sources": [
      {
        "sourceName": "SITS",
        "sourceRef": "z1234567"
      }
    ]
  }
]
```

**SDK Code**

```python
import requests

url = "https://unsw-v6-dev.advance-uac.com/institution-api/institution/applicants"

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

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

print(response.json())
```

```javascript
const url = 'https://unsw-v6-dev.advance-uac.com/institution-api/institution/applicants';
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
package main

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

func main() {

	url := "https://unsw-v6-dev.advance-uac.com/institution-api/institution/applicants"

	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
require 'uri'
require 'net/http'

url = URI("https://unsw-v6-dev.advance-uac.com/institution-api/institution/applicants")

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
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://unsw-v6-dev.advance-uac.com/institution-api/institution/applicants")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://unsw-v6-dev.advance-uac.com/institution-api/institution/applicants', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://unsw-v6-dev.advance-uac.com/institution-api/institution/applicants");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://unsw-v6-dev.advance-uac.com/institution-api/institution/applicants")! 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()
```