API Reference

Create referral redemption

post
https://api.apply.akahu.nz/v1/referral-redemptions

Redeem a referral code into a new application.

Referral redemption is asynchronous. The response includes a redemption ID and processing status. Poll GET /v1/referral-redemptions/{redemptionId} until the redemption status is completed or failed. The completed response includes the new application ID.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

A referral code using the format AK_ followed by 10 uppercase alphanumeric characters.

string
length ≤ 500

Optional reference to use for the application created in the redeeming organisation. Defaults to the referral application reference.

Responses

Updated about 15 hours ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 15 hours ago