> ## Documentation Index
> Fetch the complete documentation index at: https://docs.illumiatech.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started

> Onboarding guide for the IDX Institution Management APIs, covering access, environments, authentication, and your first request

## Overview

The Institution Management APIs let authorized integrators look up cardholder, account, credential, and transaction information for campus applications through the IDX platform. They provide a secure, read-oriented interface for retrieving cardholder identity and account data scoped to a single institution.

## Who is this for?

These APIs are designed for campus technology partners who need to retrieve cardholder data as part of a campus app integration. Common use cases include:

* **Campus mobile apps** that display a student's credential information, meal plan balances, or account status.
* **Third-party systems** that verify cardholder identity or retrieve account details for downstream workflows.
* **Institutional IT teams** building custom integrations between IDX credentials and other campus platforms.

## APIs included

| Documentation                                                                                                                     | Description                                                                                                                                 |
| --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| [Cardholder API](/api-reference/idx/institution-management/cardholder/cardholder/get-cardholder)                                  | Create, retrieve, update, and delete cardholder records, and manage cardholder photos.                                                      |
| [Credential API](/api-reference/idx/institution-management/credential/credential/get-cardholder-credentials)                      | Retrieve and update a cardholder's credentials, and list the credential types, value types, and value pools configured for the institution. |
| [Lookup API](/api-reference/idx/institution-management/lookup/cardholder/find-cardholder)                                         | Find a cardholder's unique identifier and related information by their `customerId`.                                                        |
| [Cardholder Account API](/api-reference/idx/institution-management/cardholder-account/cardholder-account/get-cardholder-accounts) | Retrieve a cardholder's accounts, account balances, and transaction history.                                                                |

<Note>
  This guide is the shared onboarding entry point for the Institution Management APIs. Authentication, error responses, HTTP status codes, and pagination behave the same way across every API in this group and are documented once in the Introduction section.
</Note>

## Quick start

### 1. Obtain your API credentials

Access to the Institution Management APIs requires a valid subscription key. Request a key through your campus card office administration.

### 2. Set your base URL

All requests are routed through the IDX API gateway. Each API has its own versioned base path.

| API                | Environment | Base URL                                                                            |
| ------------------ | ----------- | ----------------------------------------------------------------------------------- |
| Cardholder         | UAT         | `https://api-uat.transactsp.net/idx/institution-management/cardholders/v1`          |
| Cardholder         | Production  | `https://api.transactcampus.com/idx/institution-management/cardholders/v1`          |
| Credential         | UAT         | `https://api-uat.transactsp.net/idx/institution-management/credentials/v1`          |
| Credential         | Production  | `https://api.transactcampus.com/idx/institution-management/credentials/v1`          |
| Lookup             | UAT         | `https://api-uat.transactsp.net/idx/institution-management/lookups/v1`              |
| Lookup             | Production  | `https://api.transactcampus.com/idx/institution-management/lookups/v1`              |
| Cardholder Account | UAT         | `https://api-uat.transactsp.net/idx/institution-management/cardholders-accounts/v1` |
| Cardholder Account | Production  | `https://api.transactcampus.com/idx/institution-management/cardholders-accounts/v1` |

### 3. Authenticate your request

Include your subscription key in the `Ocp-Apim-Subscription-Key` header on every request:

```http theme={null}
GET /idx/institution-management/cardholders/v1/cardholders/{cardholderId} HTTP/1.1
Host: api.transactcampus.com
Ocp-Apim-Subscription-Key: your-subscription-key-here
```

### 4. Make your first call

Retrieve a cardholder by ID:

```bash theme={null}
curl -X GET "https://api.transactcampus.com/idx/institution-management/cardholders/v1/cardholders/755a459f-ed84-46f3-a341-33f9fb83ba02" \
  -H "Ocp-Apim-Subscription-Key: your-subscription-key-here"
```

A successful response returns the cardholder record:

```json theme={null}
{
  "cardholderId": "755a459f-ed84-46f3-a341-33f9fb83ba02",
  "customerId": "A12345",
  "cardholderActiveState": true,
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "jane.doe@university.edu",
  "hasPhoto": true
}
```

<Warning>
  UAT data is synthetic and may be reset periodically. Do not send real cardholder information in UAT requests.
</Warning>

## What's next?

* Review [Authentication](https://transact.stoplight.io/docs/atlas-spec-common/b87d37ae48a0d-authentication-and-rate-limiting) for key management and rate limit policies.
* Review [Error Responses](https://transact.stoplight.io/docs/atlas-spec-common/e09fdf5e06f21-error-responses) and [HTTP Status Codes](https://transact.stoplight.io/docs/atlas-spec-common/3b3003f34d7eb-http-status-codes) to build robust error handling.
* Review [Pagination](https://transact.stoplight.io/docs/atlas-spec-common/ba4a485429b90-pagination) before working with list endpoints.
* Browse the API references in the sidebar for full request and response schemas, parameter details, and additional endpoints.

## Support

For questions about API access, integration guidance, or to report an issue, contact your campus card office.

**Document Version:** 1.0\
**Last Updated:** August 2026\
**© Illumia Inc. - Confidential**