Getting started with our APIs

Learn about what APIs we offer and how you can connect to them.

If you own an API and want to list it on the marketplace, read the producer onboarding steps instead.

Steps to get connected

1. Learn about our APIs

Before designing your software, read the onboarding guide, browse the API catalogue, and check the consumer guidance for rate limits and error handling. Review the data governance standards for the data classification and legal obligations that apply. All APIs use OAuth 2.0 with JWT bearer tokens.

2. Confirm your use case

Before proceeding with next steps on using the APIs, confirm you have a valid use case.

3. Start using our APIs

Sign in to your developer account, or create one if you do not have one yet.

To use our APIs you need to:

• create an application in our sandbox (test) environment
• choose which APIs you want to use
• get credentials to use our APIs by submitting an access request describing your use case, expected call volume and the environments you need
• test your software integrates with our APIs

Your request is sent to the HMCTS Data Access Panel for review and approval. This is currently an offline process, so look out for emails requesting clarification, or confirming approval or rejection.

Once the Data Access Panel has approved your request, the API owner reviews it and issues you with credentials for the relevant environments.

4. Apply to go live on the API Marketplace

• add your production application
• apply for production credentials

We’ll check your application and get back to you with approval, or ask for more information if needed.

5. Start using secure data

If your request for production access is successful, you can retrieve credentials and start using APIs with secure data.

In this section

• Onboarding guide — the non-technical walkthrough for consumers and producers
• Consumer guidance — using APIs responsibly, rate limits, error handling
• Introduction to justice sector technology — how HMCTS systems fit together
• Building justice sector software — designing for court and tribunal settings
• Glossary of developer terms
• Request API access — submit an access request for the APIs you need

Get help and support

If you have any issues, either during development or once your software is live, you can contact the marketplace team.

Read the consumer guidance for detailed information on using APIs responsibly, or the data governance standards for your legal obligations.