Before you can try the API, you will need to have a registered account with an approved App containing this API Product. Find your App details under My Apps.




Get User Authorization

The first step when using the Connect API is to seek authorisation from the end user to share their unique Telstra credential with your application.   The 'authorize' endpoint will respond with a 302 redirect to a Telstra hosted form that prompts the user to enter their mobile phone number. The end-user will then receive an SMS asking them to reply with a 4-digit code. Once the correct code is received another 302 redirect will be issued to send the end-user back to the URL specified in the redirect_uri parameter. A code will also be returned that can be used for obtaining an access token for getting the user's information.  


Get Access Token

This method obtains an access token by exchanging the authorization code obtained using the authorization endpoint.


Get User Information

This endpoint retrieves attributes that describe the user - currently, it will only return the unique Telstra subscriber identifier.This identifier is what you would initially store against a user in your database, and then going forward would use to determine who the person trying to authenticate into your application.Future implementations are planned to return more information about the user which Telstra knows and stores.