canonical: https://jentic.com/apis/nagaris.com/nagaris

# Nagaris API

Jentic publishes the only available OpenAPI specification for Nagaris API, keeping it validated and agent-ready. Nagaris is an Australian financial-services platform that supports SMSF (self-managed super fund) administration and adviser workflows. The 21-endpoint API covers ABN lookup against the Australian Business Register, address creation and lookup, email and OTP authentication with refreshable JWTs, banking accounts and transactions, and client contact records. Authentication uses an HTTP bearer token issued via the email/OTP login flow.

## For AI agents

Run ABN lookups, manage client contacts and addresses, control bank accounts and transactions, and authenticate with email and OTP for Australian SMSF and adviser workflows.

## Scope

Does not handle tax filing, payroll, or general-ledger accounting - use for ABN verification, adviser authentication, SMSF banking records, and client contact administration only.

## Capabilities

- Look up an Australian Business Number (ABN) against the Australian Business Register
- Create and retrieve postal addresses tied to client and adviser records
- Authenticate via email-and-OTP and refresh the resulting JWT
- Maintain bank accounts and ledger transactions for SMSF administration
- Create, update, and delete client contact records used across the adviser workspace
- Logout and invalidate the current adviser session

## Use cases

### ABN Lookup During Client Onboarding

When advisers onboard a new SMSF or business client, they verify the entity by ABN against the Australian Business Register. GET `/api/v1/abn/lookup` accepts the ABN and returns registration data so the adviser knows the entity is current and trading. Removes manual copy-paste from the ABR website during onboarding interviews.

Example prompt: Call GET `/api/v1/abn/lookup` with abn=12345678901 and add the resulting trading-name and entity-type to the new SMSF onboarding record.

### Adviser Authentication Flow

Advisers authenticate with email then OTP via POST `/api/v1/auth/login/email` and POST `/api/v1/auth/login/otp`, receiving a JWT they then refresh with POST `/api/v1/auth/token/refresh.` POST `/api/v1/auth/logout` invalidates the session. Suits a desktop adviser workspace and any agent that acts on the adviser's behalf during the working day.

Example prompt: Run the email/OTP flow for adviser jane@example.com and store the returned JWT for use on later calls.

### Bank Account and Transaction Administration

SMSF administrators manage fund bank accounts and pull transactions for ledger reconciliation via `/api/v1/banking/bank-accounts` and `/api/v1/banking/transactions.` PATCH and DELETE on the bank-account path support corrections and offboarding, while GET on `/banking/transactions` returns the records the accounting team reconciles against. Replaces manual CSV exports for monthly fund reporting.

Example prompt: List all bank transactions on bank-account ID 17 for the last 90 days via GET `/api/v1/banking/transactions` and post a reconciliation summary to the audit queue.

### Client Contact and Address Records

Maintain client contact records and their postal addresses for letter generation, BAS submissions, and trustee communications. `/api/v1/client-contacts` supports CRUD on the contact record and `/api/v1/addresses` captures the postal addresses they reference. Useful when integrating a separate CRM or document automation tool with the Nagaris adviser workspace.

Example prompt: Create a new client contact for John Smith via POST `/api/v1/client-contacts` and link a primary address created via POST `/api/v1/addresses.`

### AI Agent Adviser Co-Pilot

Wire Nagaris into an AI agent through Jentic so an adviser can ask 'verify this ABN' or 'list this fund's bank transactions' inside their chat surface, without copying tokens around. Through Jentic the bearer JWT lives in the encrypted vault and the agent picks the right operation from 21 endpoints via intent search. Saves advisers from clicking through several tabs of the Nagaris workspace for routine lookups.

Example prompt: On a chat request 'is ABN 12345678901 still active?', search Jentic for 'Nagaris ABN lookup', execute GET `/api/v1/abn/lookup`, and reply with the entity status.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/v1/abn/lookup` | Look up an ABN against the Australian Business Register |
| POST | `/api/v1/auth/login/email` | Start an adviser email/OTP login flow |
| POST | `/api/v1/auth/login/otp` | Complete adviser login with the OTP code |
| POST | `/api/v1/auth/token/refresh` | Refresh the adviser's JWT |
| GET | `/api/v1/banking/bank-accounts` | List bank accounts attached to client funds |
| GET | `/api/v1/banking/transactions` | List ledger transactions for reconciliation |
| POST | `/api/v1/client-contacts` | Create a client contact record |
| POST | `/api/v1/addresses` | Create a postal address record |

## Key resources

- **ABN Lookup** — Verify an Australian Business Number against the Australian Business Register
- **Authentication** — Email and OTP login, JWT refresh, and logout
- **Addresses** — Create and retrieve postal addresses tied to client and adviser records
- **Banking** — Maintain bank accounts and ledger transactions for fund administration
- **Client Contacts** — Create, update, and delete client contact records

## Why Jentic

- **Setup:** Wiring Nagaris by hand means running its email and OTP login, holding the issued bearer JWT, refreshing it, and mapping the ABN, banking, and client-contact calls against core.nagaris.com yourself. Through Jentic you install once, import Nagaris from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** Nagaris addresses its ABN, banking, and contact resources through request parameters and bodies rather than a resource id in the URL path, so scope the agent to the operations it needs, such as verifying an ABN or reading fund transactions, and leave writes like creating a client contact out of the allowed set unless you include them.
- **Credential handling:** Your Nagaris bearer JWT is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'verify an Australian ABN' or 'list fund bank transactions', and Jentic returns the matching Nagaris operation with its parameter schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Xero Accounting API** — General-ledger accounting that pairs with Nagaris's SMSF-specific administration
- **Plaid API** — Bank-account aggregation feed that can populate Nagaris's banking module
- **Onfido Identity Verification API** — KYC and identity verification that pairs with Nagaris's ABN lookup at onboarding

## FAQ

### Why is there no official OpenAPI spec for Nagaris API?

Nagaris does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Nagaris API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Nagaris API use?

The Nagaris API uses an HTTP bearer token. Advisers authenticate with email and OTP via POST `/api/v1/auth/login/email` then POST `/api/v1/auth/login/otp`, then refresh the token with POST `/api/v1/auth/token/refresh.` Through Jentic the bearer JWT is stored encrypted in the vault and injected at execution time so the raw token never enters agent context.

### Can I look up an ABN through the Nagaris API?

Yes. GET `/api/v1/abn/lookup` accepts the ABN as a query parameter and returns the entity's registration details from the Australian Business Register, useful during SMSF and business client onboarding.

### How do I list bank transactions for a fund through the Nagaris API?

Call GET `/api/v1/banking/transactions` with the bank-account filter to list transactions, and GET `/api/v1/banking/transactions/{id}` for an individual record. Combine with `/api/v1/banking/bank-accounts` for account-level metadata when reconciling the fund ledger.

### What rate limits apply to the Nagaris API?

Rate limits are not declared in the OpenAPI spec. Treat the API as moderately rate-limited per adviser session, implement exponential backoff on HTTP 429, and contact Nagaris for committed throughput before running large historical-transaction pulls during EOFY processing.

### How do I run a Nagaris ABN lookup from an AI agent through Jentic?

Install the Jentic SDK with pip install jentic. Use SearchRequest with a query like 'verify an Australian ABN' to surface GET `/api/v1/abn/lookup`, LoadRequest for its schema, and ExecutionRequest to call it. Get an agent API key through Jentic One, the self-hosted execution layer.

### Can I limit what my agent is allowed to do with the Nagaris API?

Yes. Because you run Jentic One yourself, your own rules decide which Nagaris operations and credentials the agent may use. Nagaris addresses its ABN, banking, and client-contact resources through request parameters and bodies rather than a resource id in the path, so you scope the agent to the specific operations it needs, such as verifying an ABN via GET `/api/v1/abn/lookup` or reading fund records via GET `/api/v1/banking/transactions.` Writes like creating a client contact via POST `/api/v1/client-contacts` stay out of the allowed set unless you explicitly include them.
