Generate an access token - Precisely Data Integrity Suite

Data Integrity Suite APIs
Product
Data_Integrity
Spatial_Analytics
Data_Enrichment
geo_addressing_1
Services
Spatial Analytics
Data Enrichment
Geo Addressing
ft:title
Data Integrity Suite APIs
ft:locale
en-US
PublicationType
pt_developer
copyrightfirst
2023
copyrightlast
2026

Many Data Integrity Suite API endpoint requests require a token.

After obtaining an API Key and Secret, an application generates an access token by calling the Data Integrity Suite authentication endpoint. The access token is returned as a Bearer token and is used to authorize subsequent API requests.

This process applies to both trial users and existing Data Integrity Suite customers.

Endpoint

POST base_url/auth/v2/token

Request Parameters

No parameters

Request headers

Key Required Type Value Description
Authorization True string Basic Base64(api_key:api_secret) The Base64 API key pair as a Base64 encoded string. For example:
Basic e3thcGlfa2V5fX06QWJjYzMzc2xmYWtqc2RzZmFsa2phc2RmbGthc2psZmRrag
Content-Type True string application/x-www-form-urlencoded The format of the request body.
Important: A Base64 string is not encrypted. To protect these credentials, always send this value over a secure SSL‑encrypted connection (HTTPS).

Request body

Request body properties must be in URL encoded format. In URL encoded format, keys and values are encoded in key-value tuples separated by an ampersand (&), with an equals symbol (=) between the key and the value. Non-alphanumeric characters in both keys and values must be percent-encoded.

Property Required Type Value Description
grant_type True string client_credentials The client credentials grant type for a token.
scope True string scopes

A space (%20) separated list of permissions that a client application needs to perform its tasks.
Note: The Default scope is the generic level of access granted when specific scopes are not specified. The Default scope may not be specified with other scopes.
grant_type=client_credentials&scope=scopes
grant_type=client_credentials&scope=default

Response

Response headers include standard and representation headers for POST requests.

Response body
Property Type Value Description
access_token string token value The token generated by the API endpoint.
token_type string Bearer Type of token. This method creates a bearer token.
expires_in integer seconds The interval in seconds from when a token is created until it expires. Tokens last 3600 seconds.
scope string scopes Scopes that define specific permissions and access levels granted to an application or user when interacting with an API. 
{
  "access_token": "token value",
  "token_type": "Bearer",
  "expires_in": interval (seconds),
  "scope": "scopes"
}
{
  "access_token": "eyJraWQiOiJNcXY2RWNBR0JNUElKbEdnRG1LYkNISC1fZkpa...",
  "token_type": "Bearer",
  "expires_in": 3600,
  "scope": "default"
}

Status codes

Code Description
200 Token generated successfully
400 Request not valid
500 Internal server error

Error codes

  • DIS-AUTH-1002 API key is not valid.
  • DIS-AUTH-1003 API secret is not valid.
  • DIS-AUTH-1016 Grant type is not valid.
  • DIS-AUTH-1018 Request body is not valid.
  • DIS-AUTH-1019 Request body is not specified.
  • DIS-AUTH-1020 Authorization header is not provided.
  • DIS-AUTH-1021 Scope value is not valid.
  • DIS-AUTH-1022 Issue with internal services.