---
title: "Get redemption status"
method: GET
path: "/v1/referral-redemptions/{redemptionId}"
tags: ["Referrals"]
---

# Get redemption status

`GET /v1/referral-redemptions/{redemptionId}`

## Request

- Base URL: `https://api.apply.akahu.nz`
- URL: `https://api.apply.akahu.nz/v1/referral-redemptions/{redemptionId}`
- Auth: HTTP bearer

Get the current status of a referral redemption. Use this endpoint to poll until the status is `completed` or `failed`.

## Path parameters

- `redemptionId` string, required

## Response `200`

Success

- union: A redemption of a referral code into a new application owned by the authenticated organisation.
  - ReferralRedemptionProcessing
    - `_id` string, required: The unique ID of the referral redemption.
    - `referrer` ReferralOrgDetails, required: Details for an organisation involved in a referral.
      - `name` string, required
      - `logo` string: A URL referencing the org's logo in PNG format.
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `status` 'processing', required
  - ReferralRedemptionCompleted
    - `_id` string, required: The unique ID of the referral redemption.
    - `referrer` ReferralOrgDetails, required: Details for an organisation involved in a referral.
      - `name` string, required
      - `logo` string: A URL referencing the org's logo in PNG format.
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `_application` string, required: The ID of the new application created. Only present when `status` is `completed`.
    - `status` 'completed', required
  - ReferralRedemptionFailed
    - `_id` string, required: The unique ID of the referral redemption.
    - `referrer` ReferralOrgDetails, required: Details for an organisation involved in a referral.
      - `name` string, required
      - `logo` string: A URL referencing the org's logo in PNG format.
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `status` 'failed', required
    - `failure_reason` ReferralRedemptionFailureReason, required: If a referral redemption has failed, this field provides additional information about what went wrong.
      - `code` 'document_unavailable' | 'internal_error', required: The reason for a referral redemption's failure: - `document_unavailable` One or more referral snapshot artifacts are no longer available. - `internal_error` An unhandled internal error prevented the redemption from completing.
      - `message` string

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/akahu/apis/akahu-apply-api.md) - [All operations](https://skmtc.dev/akahu/apis/akahu-apply-api/llms.txt) - [OpenAPI document](https://skmtc.dev/akahu/apis/akahu-apply-api/revisions/3f18eb1ead75?raw)