Check a friend referral code
Checks whether a Joulo friend referral code exists, so you can validate it before an upload. It discloses only the referrer's first name.
Partner API key, sent as Authorization: Bearer <key>. Production keys start with jpk_live_ and work only on https://api.joulo.nl. Sandbox keys start with jpk_test_ and work only on https://api-staging.joulo.nl. Sandbox keys minted before September 2026 also start with jpk_live_. A key used on the wrong host returns 401 with a detail. A key is bound to one partner and reaches only the Partner API routes. Any other route returns 404 when it does not exist. A route that needs a scope the key lacks, such as GET /sessions, returns 403 with error: Insufficient scope and a required_scope. Every other route returns 403 with error: partner_api_key_scope. Mint and revoke keys in the partner portal. A partner has one active key at a time.
In: header
Query Parameters
The referral code. Joulo trims it, uppercases it and cuts it to 12 characters before the lookup.
1 <= lengthResponse Body
curl -X GET "https://api.joulo.nl/functions/v1/api/partner/referral-codes/check?code=string"{
"ok": true,
"code": "AB12CD34",
"valid": true,
"referrer_first_name": "Sanne"
}{
"error": "code query parameter is required"
}{
"error": "Missing or invalid API token"
}{
"error": "No partner is linked to this API key"
}{
"error": "Too many requests",
"retry_after_seconds": 3
}{
"error": "Failed to check referral code"
}{
"error": "Authentication is temporarily unavailable, try again shortly"
}