Connect your website form or system so referrals flow straight to your broker, tagged to you.
Who this is for: Referral partners, Enterprise admins
Your Partner API key identifies you, so every referral you send through the API is tagged to you automatically. Your welcome email includes it; here's how a broker admin can find it again.
Find the key (broker admins)
In the broker portal, go to Referrers and open the referral partner.
Scroll to the Lead Enquiry Form section.
Click the Partner API Key to copy it, and send it securely to the partner's developer.
Use the key (partners and developers)
Ask the broker business for the API documentation.
Paste the key into the authorisation field in the API documentation tool (Swagger) or your integration.
Send a test referral and ask the broker to confirm it arrived tagged to you.
Keep it safe
Treat the key like a password. Don't put it in public website code; send requests from your server.
Copy the whole key, without extra spaces.
If the key may have been exposed, ask the broker business to issue a new one.
Prefer no code?
Ask your broker for the embeddable referral form code and paste it into your website instead.
Need a hand?
Contact the broker business you refer to. For technical questions about the Partner API, they can contact the platform support team for you.