Sign in

v1

latestOpenAPI 3.1.02026-07-2483219318.4 KB
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 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.

Example request

{
  "code": "AK_23456789BC"
}

Response

Success

OR
OR

Example response

{
  "_id": "referral_redemption_tz4a98xxat96iws9zmbrgj3a"
}