IELTS Results CRM API

Overview:

API returns candidate result based on either date range or TRF number (cert number). If a customer sends both date range and TRF number, date range will be ignored, and record will be returned only for the given TRF number.

By default, candidate photo is excluded from the API response to reduce the response size. Customer can send photoFlag with 'Y' to include candidate photo in response.

API can return upto 2000 records in single request. If given date range query returns more than 2000 records, API would return error. In this case API consumer can either send pagination fields (page & limit) or reduce the date range to reduce the number of records.

API usage is restricted to 10,000 requests per day per customer.

Endpoint Details

GET /v1/ielts/result-verification

Request query parameters are mandatory or optional as given below

Either date range(startDateTime and endDateTime) or trfNumber should be supplied

Mandatory Fields

The API can be set up to use either the TRF Number, or a date range, as the key criteria.

If using a date range, the following fields are mandatory:

• startDateTime: Start value of last modified date range in UTC – this is usually the date on which the candidate shared their result with you and should be set to the earliest date from which you’re willing to accept a result. startDateTime format should be ("YYYY-MM-DDThh:mm:ss") - an example of 24 September 2019, at 06:12:25, would be: 2019-09-24T06:12:25
• endDateTime: End value of last modified date range in UTC – this is usually the date on which the candidate shared their result with you and should be set to the latest date from which you’re willing to accept a result. endDateTime format should be ("YYYY-MM-DDThh:mm:ss") – an example of 7 October 2019, at 06:12:25, would be: 2019-10-07T06:12:25

If using specific TRF Numbers, then instead of the 2 date fields, the following field is mandatory:

• trfNumber: unique certificate number for candidate(Example: 17UZ010772RAKN025A)

For both alternatives, there is one further mandatory field:

• photoFlag: PhotoFlag (Y/N). Flag to include or exclude the candidate photo in the response.

Optional Fields

• page: Page number. By default, If nothing is sent as part of this field the API response is restricted by 2000 records. If a query resulted in more than 2000 records, send additional request with incremented the page number to get the remaining set.
• limit: Number of records returned per page. Maximum value is 2000. Default value is 2000.
• OSRFlag: OSRFlag (Y/N). Flag to include or exclude the additional fields in the response.

Header Parameters

• Authorization (required): Consumer can use either Basic authentication or Bearer authentication for authorization.
  • Basic authentication: Consumer need to send access token generated after performing a base64 encoding on the client ID and client secret values. You can use a website such as 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. Format: Basic {Access_Token} Ex. Authorization: Basic VYCaP6VfOAAAJA2IFM9p8Gq9fWrk
  • Bearer authentication: Consumer need to send access token obtained from Oauth API to authenticate. Format: Bearer {Access_Token} Ex. Authorization: Bearer VYCaP6VfOAAAJA2IFM9p8Gq9fWrk
• Accept (required): Defines the response content type. At the moment API supports application/json only. XML content type will be supported in the future.

Get an Access Token

To get an access token, pass your client credentials to Get Token Endpoint

More information on Token endpoint is available here.

Country Codes

Error Codes