---
title: "IELTS Results Service Integration"
slug: "ielts-results-service-integration"
updated: 2026-04-16T16:25:09Z
published: 2026-04-16T16:25:09Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://knowledge.technolutions.net/llms.txt
> Use this file to discover all available pages before exploring further.

# IELTS Results Service Integration

The **International English Language Testing System** (IELTS) measures the language proficiency of people who want to study or work where English is used as a language of communication. It uses a nine-band scale to clearly identify levels of proficiency, from non-user (band score 1) through expert (band score 9). This article outlines the necessary steps to configure automated imports of IELTS results within Slate.

> [!WARNING]
> 📝 Note
> 
> Cambridge University Press and Assessments is piloting a program with some institutions to allow IELTS results to be automatically imported into Slate via the IELTS Results Service API. This program may not be available to your institution.

## Before you begin

If you have not done so already, register for the API with the [IELTS Results Service API Registration Form](https://cambridgeenglish.formstack.com/forms/ielts_results_service_api_application).

IELTS scores can be imported into Slate using an API call that is configured as a Source Format. In order to automatically fetch the data via the API, you will need the Client ID and Client Secret.

## Step 1: Obtaining your Client ID and Client Secret

1. Go to the Cambridge API Portal at [https://cambridge.my.site.com/s/apis](https://cambridge.my.site.com/s/apis).
2. Select **Log in**.
3. Select **Create new account**.
4. Fill out the **Create a My Cambridge account** form. Use the same email address you used for the Cambridge API Portal.
5. Select **Continue.**A verification email is sent to your account.
6. Verify your email using the link provided, then sign in.
7. Select **My Applications** in the top menu bar.
8. On a registered application, select **View**on the right side.

[![View_Client_Application_Credentials.png](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/view_client_application_credentials.png)](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/view_client_application_credentials.png)
9. Select **Copy**to access your credentials. Select **Reset Credentials**if new credentials are needed. [![Client_ID_and_Client_Secret.png](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/client_id_and_client_secret.png)](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/client_id_and_client_secret.png)

> [!NOTE]
> 💡 Questions about accessing your institution's Client ID and Client secret?
> 
> Contact Cambridge University Press and Assessments using the [IELTS Results Service Support Request Form](https://cambridgeenglish.formstack.com/forms/ielts_results_service_support_request). Select *I'm having difficulty enabling API integration with my institution's management system, e.g., CRM.*

#### Answer Slate Storage Questions

The IELTS Results Service API Registration Form includes questions about the way Slate stores and manages data. Answer these questions with the following:

- **Q:**How will your system store the IELTS result data?
  - **A:** All data in Slate is stored in encrypted databases on encrypted filesystems in secure datacenters, using 256-bit AES encryption.
- **Q:** Have you or your external system provider had any regulatory action for information incidents or breaches?
  - **A:**No.
- **Q:**If your system is provided by a third party will the external system provider be sharing IELTS Results data?
  - **A:**No.

> [!WARNING]
> 📝 Cambridge University Press and Assessments renews your Client ID and Secret every 12 months, so the authorization header in the source format must be updated annually.

For additional information and support, please reference the [IELTS Results Verification API page](https://cambridge.my.site.com/s/apis) of the Cambridge API Development portal.

## Step 2: Adding the IELTS test type

The test type stores the score results.

1. Go to **Database** → **Slate Template Library**.
2. Add the *IELTS* test type. **No changes should be made to the test type.**

## Step 3: Adding the source format

This Source Format automatically fetches score results shared with your institution.

1. Go to **Database** → **Source Format Library**.
2. Add the **IELTS Results Service (JSON)** Source Format.
3. Select **Edit**. The **IELTS Results Service** dialog appears.
4. Select the **Import Automation** tab.

[![](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/ls9ejzaaqecsj8vfjlobaqmceclip6.png)](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/ls9ejzaaqecsj8vfjlobaqmceclip6.png)
5. If you were not contacted to migrate your account to the **new API service**, you can leave the Import Remote Server setting as is.
6. If you were contacted, copy the text below and paste it in the **Import Remote Server**field:

```plainText
https://apis.cambridgeassessment.org.uk/v1/ielts/result-verification?startDateTime={{dtstart|date:'s'}}&endDateTime={{dtend|date:'s'}}&photoFlag=Y
```

The new API endpoint looks very similar to the old, the only differences being:

Take care to make sure your updated endpoint is the correct one.
  - `api` becomes `apis`
  - The **forward slash** preceding the query string parameters is removed
7. Add the authorization header to the **HTTP Headers** box according to the following:
  - Perform a base 64 encoding on the **Client ID** and **Client Secret** values provided by Cambridge University Press and Assessments. You can use a website such as [https://www.base64encode.org/](https://www.base64encode.org/) to get the base-64 encoded value by pasting in the **Client ID** and the **Client Secret** values, separated by a full colon.

![](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/Encoding client secret(1).png)
  - Add the authorization header using the format: *Basic*`{{base-64 encoded value}}`. 📝 **Note**: The base-64 encoded value wraps to the next line; however, there is a single space between the word `Basic` and this value. Do not add the braces to the value. Paste in the value exactly as it is generated.

![](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/Paste encoded ID and secret into HTTP Headers field with HTML formatting.png)
8. Override the **Last Remote Server Fetch** setting to be the approximate date of the last IELTS scores that were imported into Slate. By default, all currently valid IELTS scores released to your institution will be sent during the first fetch. Overriding this value will limit the fetch to just those since the last import.
9. Select **Override**.
10. Enter the confirmation message. This is case-sensitive.

[![](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/aioxscbbbusfcztedvk4twmceclip2.png)](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/aioxscbbbusfcztedvk4twmceclip2.png)
11. In the **Last Remote Server Fetch** field, enter the approximate timestamp that the source format should send to IELTS to restrict the data that is retrieved during the first data fetch. 📝 **Note:** The timestamp should be in the UTC timezone in the format: `yyyy-MM-ddTHH:mm:ss` (for example, `2025-06-16T00:00:00`)

![](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/Override last remote server fetch.png)
12. Select **Save** to update the configurations.
13. **Configure the Remap** settings for the Format Definition. Many items have been pre-mapped. As always, feel free to customize how the data will be imported.
  - Some institutions may wish to only accept IELTS scores from the Academic module. If you choose to prevent the General module scores from importing into Slate, you may map the Module source field to the Custom: Skip Import destination.

[![](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/ucpj3l6skctfruqqf09igmceclip2.png)](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/ucpj3l6skctfruqqf09igmceclip2.png)
  - On the **Value Mappings** page, map General Training to Skip Import to prevent these tests from importing. If your institution has not yet received data with this value, you may use the Append Values link to add this value as an option to map.

[![](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/iqcviqndbekhzw50jxjnbgmceclip5.png)](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/iqcviqndbekhzw50jxjnbgmceclip5.png)
14. Set the **Remap Active** flag to **Active** on the Source Format once you are finished mapping the Source Format. This will run the import using the Remap settings configured above for all files uploaded on or after the **Remap As Of Date** value.