AKakahu
Referrals

Redeem referral

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.

post/v1/referral-redemptions

Request

  • Base URL
    https://api.apply.akahu.nz
  • URL
    https://api.apply.akahu.nz/v1/referral-redemptions
  • Auth
    HTTP bearer

Request body

codestring required

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

referencestring

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

report_type'standard' | 'income'

If report_type is omitted, the application uses your organisation's default report type.

Example request

{
  "code": "AK_23456789BC"
}

Response

Success

OR
OR

Example response

{
  "_id": "referral_redemption_tz4a98xxat96iws9zmbrgj3a"
}

Changes

No recorded changes to this operation across all 1 revision of this API.