{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-portal/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Getting Access","description":"API documentation for SERV property and land registry services"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"getting-access","__idx":0},"children":["Getting Access"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client ID"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client Secret"]}," are required to access these APIs. To request access please reach out to: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"mailto:data.services@servictoria.com.au"},"children":["data.services@servictoria.com.au"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A different set of credentials will be provided for the Test and Production environments."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This API supports the OAuth 2.0 client credentials flow for authentication, which has the following high level steps:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use Client ID and Client Secret to get an access token from token endpoint."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Call API with access token included in the authorization header."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"using-credentials-to-get-an-access-token","__idx":2},"children":["Using credentials to get an access token"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"test-environment","__idx":3},"children":["Test Environment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To get a token for the Test environment use:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Token endpoint: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://stg.auth.servictoria.com.au/oauth/token"},"children":["https://stg.auth.servictoria.com.au/oauth/token"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Audience: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://test.api.servictoria.io/vicland/ddp"},"children":["https://test.api.servictoria.io/vicland/ddp"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"curl --request POST \\\n  --url 'https://stg.auth.servictoria.com.au/oauth/token' \\\n  --header 'content-type: application/x-www-form-urlencoded' \\\n  --data grant_type=client_credentials \\\n  --data client_id=YOUR_CLIENT_ID \\\n  --data client_secret=YOUR_CLIENT_SECRET \\\n  --data audience='https://test.api.servictoria.io/vicland/ddp'\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"production-environment","__idx":4},"children":["Production Environment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To get a token for the Production environment use:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Token endpoint: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://auth.servictoria.com.au/oauth/token"},"children":["https://auth.servictoria.com.au/oauth/token"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Audience: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://api.servictoria.io/vicland/ddp"},"children":["https://api.servictoria.io/vicland/ddp"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"curl --request POST \\\n  --url 'https://auth.servictoria.com.au/oauth/token' \\\n  --header 'content-type: application/x-www-form-urlencoded' \\\n  --data grant_type=client_credentials \\\n  --data client_id=YOUR_CLIENT_ID \\\n  --data client_secret=YOUR_CLIENT_SECRET \\\n  --data audience='https://api.servictoria.io/vicland/ddp'\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response","__idx":5},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["On successfully sending the request, you’ll get back a response that includes an access_token. Example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"access_token\": \"example-308ryntpiwepfnr-jw3-rj3rh34h0trh834thnf3wrh3df-truncated\",\n  \"scope\": \"obj1:read obj2:read obj2:write\",\n  \"expires_in\": 3600,\n  \"token_type\": \"Bearer\"\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once obtained an access token can be cached and reused until it expires. The expiry time can be calculated by taking a timestamp prior to requesting the access token and adding ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expires_in"]}," seconds."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"call-api-using-access-token","__idx":6},"children":["Call API using access token"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To call this API include the access token in the 'authorization' header with the prefix: 'Bearer '. Example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"curl --request GET \\\n  --url https://test.api.servictoria.io/example \\\n  --header 'authorization: Bearer ACCESS_TOKEN'\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"more-information","__idx":7},"children":["More information"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more information see:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow"},"children":["https://auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow/call-your-api-using-the-client-credentials-flow#steps"},"children":["https://auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow/call-your-api-using-the-client-credentials-flow#steps"]}]}]}]},"headings":[{"value":"Getting Access","id":"getting-access","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Using credentials to get an access token","id":"using-credentials-to-get-an-access-token","depth":2},{"value":"Test Environment","id":"test-environment","depth":4},{"value":"Production Environment","id":"production-environment","depth":4},{"value":"Response","id":"response","depth":4},{"value":"Call API using access token","id":"call-api-using-access-token","depth":2},{"value":"More information","id":"more-information","depth":2}],"frontmatter":{"seo":{"title":"Getting Access"}},"lastModified":"2026-08-20T01:18:31.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/portal/rest/ddp-subscriptions-api/docs/getting-access","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}