Identity API

Sequence Diagram

API returns access token based upon the client credentials. These client credentials can be obtained by going to MyApplications page and then selecting the APP for which you want to get the access token.

We currently support client credential and JWT Token grants type.

Use client credentials as grant type when you want to authenticate your application to consume Cambridge Assessment APIs

User password as grant type when you want to authenticate end user to consume Cambridge Assessment APIs

Note: Client credentials differ between non-production and production environments.

End Point details:

Example curls:

curl --location --request POST 'https://apis.cambridgeassessment.org.uk/v1/cambridge.id/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id=356d03dd284XXXXXXXXX' \
--data-urlencode 'client_secret=e14114Da832XXXXXXXXXXXX' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'scope=openid'

Sample Response:

{

    "refresh_token_expires_in": "0",
    "api_product_list": "ca-ielts-result-verification-xapi:v1",
    "organization_name": "PROD",
    "developer.email": "abcdef@ttt.edu",
    "token_type": "Bearer",
    "issued_at": "1675861928817",
    "client_id": "356d03dd284XXXXXXXXX",
    "access_token": "ODc0MTlmMjMtYzQ0Ni00YWJkLWFkZjYtNGEzZmXXXXXXXXXXXXXXXXXXXXXXXXXX==",
    "application_name": "0000000-IELTS-ResultVerification-CRM-PROD",
    "scope": "",
    "expires_in": "3600",
    "refresh_count": "0",
    "status": "approved"

}

Body Parameters

Error Codes