# Illumia Documentation

- [Introduction](https://docs.illumiatech.com/api-reference/idx/index.md): Programmatically manage cardholders, credentials, transactions, and more through the IDX REST APIs
- [Getting Started](https://docs.illumiatech.com/api-reference/idx/idx-institution-management/getting-started.md): Onboarding guide for the IDX Institution Management APIs, covering access, environments, authentication, and your first request
- [Authentication](https://docs.illumiatech.com/api-reference/idx/idx-institution-management/authentication.md)
- [Error Responses](https://docs.illumiatech.com/api-reference/idx/idx-institution-management/error-responses.md)
- [HTTP Status Codes](https://docs.illumiatech.com/api-reference/idx/idx-institution-management/http-status-codes.md)
- [Pagination](https://docs.illumiatech.com/api-reference/idx/idx-institution-management/pagination.md)
- [Ping](https://docs.illumiatech.com/api-reference/idx/institution-management/cardholder/ping/ping.md): Basic request to check if the API is accessible.
- [Get Cardholder](https://docs.illumiatech.com/api-reference/idx/institution-management/cardholder/cardholder/get-cardholder.md): Gets the cardholder by its identifier.
- [Delete Cardholder](https://docs.illumiatech.com/api-reference/idx/institution-management/cardholder/cardholder/delete-cardholder.md): Deletes the cardholder.
- [Update Cardholder](https://docs.illumiatech.com/api-reference/idx/institution-management/cardholder/cardholder/update-cardholder.md): Updates the cardholder. Only cardholder properties provided will be updated.
- [Get Cardholder Photo](https://docs.illumiatech.com/api-reference/idx/institution-management/cardholder/cardholder/get-cardholder-photo.md): Gets the cardholder's photo.
- [Upload Cardholder Photo](https://docs.illumiatech.com/api-reference/idx/institution-management/cardholder/cardholder/upload-cardholder-photo.md): Uploads the cardholder photo. Replaces the cardholder's photo if one already exists.
- [Delete Cardholder Photo](https://docs.illumiatech.com/api-reference/idx/institution-management/cardholder/cardholder/delete-cardholder-photo.md): Deletes the cardholder's photo.
- [Create Cardholder](https://docs.illumiatech.com/api-reference/idx/institution-management/cardholder/cardholder/create-cardholder.md): Creates the cardholder.
- [Ping](https://docs.illumiatech.com/api-reference/idx/institution-management/credential/ping/ping.md): Basic request to check if the API is accessible.
- [Get Cardholder Credentials](https://docs.illumiatech.com/api-reference/idx/institution-management/credential/credential/get-cardholder-credentials.md): Lists the cardholder's credentials. Query parameters can be used to limit the scope of the list.
- [Create Cardholder Credential](https://docs.illumiatech.com/api-reference/idx/institution-management/credential/credential/create-cardholder-credential.md): Creates a new credential with one or more values for a cardholder. Credentials can only be created for credential types with a `BIOMETRIC` or `PHYSICAL` issuer type.
- [Admin Update Cardholder Credential](https://docs.illumiatech.com/api-reference/idx/institution-management/credential/credential/admin-update-cardholder-credential.md): Admins can use this endpoint to update a cardholder's credential.
- [Delete Cardholder Credential](https://docs.illumiatech.com/api-reference/idx/institution-management/credential/credential/delete-cardholder-credential.md): Deletes the cardholder credential. This will also retire all the credential values associated with that credential.
- [Consumer Update Cardholder Credential](https://docs.illumiatech.com/api-reference/idx/institution-management/credential/credential/consumer-update-cardholder-credential.md): Consumers can use this endpoint to update their credential.
- [List Credential Types](https://docs.illumiatech.com/api-reference/idx/institution-management/credential/credential-type/list-credential-types.md): Returns a list of credential types. Query parameters can be used to limit the scope of the list.
- [List Credential Value Types](https://docs.illumiatech.com/api-reference/idx/institution-management/credential/credential-value-type/list-credential-value-types.md): Lists the credential value types. Query parameters can be used to limit the scope of the list.
- [List Credential Value Pools](https://docs.illumiatech.com/api-reference/idx/institution-management/credential/credential-value-pool/list-credential-value-pools.md): Lists the credential value pools. Only pools with `INST_APP` as an allowed source will be returned in this list. Query parameters can be used to limit the scope of the list.
- [Ping](https://docs.illumiatech.com/api-reference/idx/institution-management/lookup/ping/ping.md): Basic request to check if the API is accessible.
- [Find Cardholder](https://docs.illumiatech.com/api-reference/idx/institution-management/lookup/cardholder/find-cardholder.md): Finds the cardholder using the provided query parameter. A query parameter must be provided to identify the cardholder.
- [Ping](https://docs.illumiatech.com/api-reference/idx/institution-management/cardholder-account/ping/ping.md): Basic request to check if the API is accessible.
- [Get Cardholder Accounts](https://docs.illumiatech.com/api-reference/idx/institution-management/cardholder-account/cardholder-account/get-cardholder-accounts.md)
- [Get Cardholder Account Balances](https://docs.illumiatech.com/api-reference/idx/institution-management/cardholder-account/cardholder-account/get-cardholder-account-balances.md)
- [List Cardholder Transactions](https://docs.illumiatech.com/api-reference/idx/institution-management/cardholder-account/cardholder-transaction/list-cardholder-transactions.md)

## OpenAPI Specs

- [idx-institution-management-cardholders-accounts-v1.0](/api-reference/idx/apollo-spec-instmgmt-cardholder-account/1.0/idx-institution-management-cardholders-accounts-v1.0.json)
- [ping](/api-reference/idx/apollo-spec-instmgmt-cardholder-account/ping/ping.json)
- [idx-instmgmt-cardholder](/api-reference/idx/atlas-spec-instmgmt-cardholder/1.0/idx-instmgmt-cardholder.json)
- [ping](/api-reference/idx/atlas-spec-instmgmt-cardholder/ping/ping.json)
- [idx-instmgmt-credential](/api-reference/idx/atlas-spec-instmgmt-credential/1.0/idx-instmgmt-credential.json)
- [ping](/api-reference/idx/atlas-spec-instmgmt-credential/ping/ping.json)
- [idx-instmgmt-lookup](/api-reference/idx/atlas-spec-instmgmt-lookup/1.0/idx-instmgmt-lookup.json)
- [ping](/api-reference/idx/atlas-spec-instmgmt-lookup/ping/ping.json)