Getting Started (for Senders)

This section will guide developers from GP Clinic CMSes or other sender systems through the end-to-end integration steps with RefX.

After reading this section, you should be able to:

• Authenticate against RefX
• Create a referral
• Generate and use a Referral Link
• Track referral statuses
• Handle common errors and edge cases

You can use the APIs Overview section to explore available endpoints, view each and test requests in your browser, and review example payloads and responses.

API keys are issued to approved partners through the HealthTech GovTech developer onboarding process. Each key is linked to a specific environment (e.g. Sandbox or Production).