# Akahu Referrals API

**Canonical:** https://apis.io/apis/akahu/akahu-referrals-api/  
**Provider:** Akahu — https://apis.io/providers/akahu/  
**Base URL:** https://api.apply.akahu.nz  
**Documentation:** https://developers.akahu.nz/docs/apply

Akahu Referrals API is one of 27 APIs that [Akahu](https://apis.io/providers/akahu/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 25 JSON Schema definitions. Tagged areas include Referrals. The published artifact set on APIs.io includes an OpenAPI specification and 25 JSON Schemas.

The Referrals API from Akahu — 5 operation(s) for referrals.

## Operations (6)

| Method | Path | Summary |
|---|---|---|
| POST | `/v1/applications/{applicationId}/referrals` | Create referral |
| GET | `/v1/applications/{applicationId}/referrals` | List referrals |
| GET | `/v1/applications/{applicationId}/referrals/{referralId}` | Get referral |
| PUT | `/v1/applications/{applicationId}/referrals/{referralId}/revoke` | Revoke referral |
| POST | `/v1/referral-redemptions` | Redeem referral |
| GET | `/v1/referral-redemptions/{redemptionId}` | Get redemption status |

## Machine-readable artifacts (26)

- **OpenAPI** — https://artifacts.apis.io/akahu/openapi/akahu-referrals-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-resource-schema.json
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-report-account-schema.json
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-document-schema.json
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-datafile-schema.json
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-create-sharing-request-params-schema.json
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-report-transaction-schema.json
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-account-schema.json
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-transaction-schema.json
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-payment-schema.json
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-party-schema.json
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-connection-schema.json
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-pending-transaction-schema.json
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-genie-outlet-schema.json
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-genie-merchant-schema.json
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-genie-feedback-schema.json
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-genie-category-schema.json
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-genie-search-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-genie-search-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-one-off-payment-schema.json
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-one-off-payment-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-one-off-payment-request-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-one-off-payment-connections-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-status-schema.json
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-pdf-statement-schema.json
- **JSONSchema** — https://artifacts.apis.io/akahu/json-schema/akahu-pdf-export-schema.json

## Other Akahu APIs (12)

- [Akahu Accounts API](https://apis.io/apis/akahu/akahu-accounts-api/)
- [Akahu Applications API](https://apis.io/apis/akahu/akahu-applications-api/)
- [Akahu Auth API](https://apis.io/apis/akahu/akahu-auth-api/)
- [Akahu Authorisations API](https://apis.io/apis/akahu/akahu-authorisations-api/)
- [Akahu Categories API](https://apis.io/apis/akahu/akahu-categories-api/)
- [Akahu Connections API](https://apis.io/apis/akahu/akahu-connections-api/)
- [Akahu Data Refresh API](https://apis.io/apis/akahu/akahu-data-refresh-api/)
- [Akahu Datafiles API](https://apis.io/apis/akahu/akahu-datafiles-api/)
- [Akahu Documents API](https://apis.io/apis/akahu/akahu-documents-api/)
- [Akahu Feedback API](https://apis.io/apis/akahu/akahu-feedback-api/)
- [Akahu Identity API](https://apis.io/apis/akahu/akahu-identity-api/)
- [Akahu Me API](https://apis.io/apis/akahu/akahu-me-api/)

## Tags

Referrals

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/akahu/akahu-referrals-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/akahu/.