IELTS Result Service Verification API

Overview:

API returns candidate result details based on TRF number (cert number).

Rate limit is 500 requests per second.

Endpoint Details

GET /v2/ielts/result-verification

Query Parameters:

Mandatory Field:

• trfNumber: Unique Certificate Number for candidate (Example: 0SCR1234SSM20444) - Max 20 characters, Alphanumeric only.

Optional Field:

• forRO: Test Recognizing Organization Name (Example: Test University) - Max 255 characters, Alphanumeric and space only.

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

• X-TRANSACTION-ID (Optional): A unique ID to track API calls end to end. A GUID (https://en.wikipedia.org/wiki/Universally_unique_identifier) is highly recommended. This will live for the duration of a transaction. Min 5 characters should be provided if this field is added. Example: 7ff382b8-60cb-406e-98e8-169a934f7afa

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.

Error Codes