Authentication or Authorization
- How can I authenticate with the Data Integrity Suite APIs?
- There are two main ways to authenticate with the Data Integrity Suite APIs:
- API Key Authentication (Using API Key and Secret): API keys grant basic access to an API, often for server-to-server communication or when accessing public data where the identity of a specific user is not paramount. For simpler integrations with third-party services where user-specific permissions are not required, an API key can be a straightforward solution. API keys can be used to track API usage associated with a specific application or workspace.
- Bearer Token Authentication: Tokens have a limited lifespan and can be revoked, enhancing security by reducing the window of opportunity for unauthorized access if a token is compromised. Tokens can be issued with specific scopes or claims, allowing for dynamic and granular control over what resources a user can access and what actions they can perform. Tokens are often preferred for client-side applications (such as web browsers, mobile apps) where user interaction and consent are involved in the authentication process.
- There are two main ways to authenticate with the Data Integrity Suite APIs:
- Which authentication method should I use?
- If you prioritize simplicity and do not mind including your credentials in every request, Basic Authentication is a good choice. However, for better security and to manage token expiration, Bearer Token Authentication is recommended.
- How many API keys can be generated in DIS Workspace, and how are they managed?
- Each admin user can create up to 2 API keys linked to their own account. If a customer needs more keys, they can assign additional users as
workspace admins/managers. Each of these users can also generate 2 keys. Because each key is associated with the user who created it, tracking will show which specific user is linked to each key.
- Each admin user can create up to 2 API keys linked to their own account. If a customer needs more keys, they can assign additional users as
- Are API keys tied to the workspace or the user?
- Keys are associated with the individual admin user who created them. For tracking purposes, each key is linked to the specific user who generated it.
- How do I obtain my API Key and Secret?
- You can generate your API Key and Secret within your Data Integrity Suite account settings. Click Account then API Keys.
- How do I authenticate using Basic Authentication?
- Encode your API Key and Secret together using Base64 encoding (programming languages, Postman, Swagger, and many online tools can do this).
- Include the encoded string in the Authorization header in the format
Basic Base64Encoded(key:secret).
- How do I obtain an access token for Bearer Token Authentication?
- Use a POST request to the authentication endpoint
/auth/v2/token. - Include the API Key and Secret in the Authorization header in the format
Basic Base64Encoded(key:secret). - The response will contain an access token with an expiration time.
- Use a POST request to the authentication endpoint
- How do I use the access token for Bearer Token Authentication?
- Include the access token in the Authorization header in the format:
Bearer access_token.
- Include the access token in the Authorization header in the format:
- How often should I refresh the access token?
- It is recommended to refresh the access token before it expires to avoid interruptions. Consider renewing the token a few seconds (such as 5 seconds) before its expiration time.
- Does the production DIS account use a single sign-on (SSO) solution like Okta?
- No, it requires individual usernames and passwords for each user.
Geo Addressing
- What are the core functionalities provided by Data Integrity Suite APIs?
- Data Integrity Suite APIs offer a comprehensive range of data quality and location intelligence services. For in-depth documentation, tutorials, and code examples, please refer to the API Reference and Data Integrity Suite API.
- What is the global coverage of your Geo Addressing APIs?
- Our Geo Addressing APIs support over 250 countries globally. For specific country coverage details, please refer to the Geo Addressing Country Coverage.
- What are the different Geo Addressing services offered?
- We offer three tiers of Geo Addressing services:
- Essentials (Option 1): Provides basic address search and verification capabilities.
- Enterprise (Option 2): Offers advanced address verification and geocoding features, including postal address support.
- Premium (Option 3): Delivers the highest level of accuracy and functionality, including unit-level address search, postal and non-postal address support, and PreciselyID.
- We offer three tiers of Geo Addressing services:
- What are the differences between the three service tiers?
Table 1. Feature Essentials Enterprise Premium Address Autocomplete Street name address search Postal address search - Search or Suggestions at Unit-level
- Postal & non-postal data support
- PreciselyID
- POI support
Address Verification Basic verification Postal address verification - Advanced verification, correction, and standardization
Address Geocoding Street-level geocode Address point-level geocode - High-precision geocoding
- Postal & non-postal data support
- PreciselyID
- What is the purpose of selecting a region for Geo Addressing API requests?
- By selecting a region, you can optimize the performance and compliance of your Geo Addressing API requests. This allows for faster response times and ensures that your data is processed in accordance with relevant regional regulations.
- What are the available regions for Geo Addressing API requests?
- Currently, the following regions are offered:
- US1 (Northern Virginia): Ideal for US-based data.
- EU1 (Ireland): Suitable for data residing in Europe or requiring EU compliance.
- AU1 (Sydney): Suitable for data residing in Australia or requiring AU compliance.
- GB1 (London): Suitable for data residing in Great Britain or requiring GB compliance.
- Currently, the following regions are offered:
- How do I select a region for my API requests?
- You can select the region through your API client or by specifying a region parameter in your API requests. Refer to Geo Addressing API documentation for further details.
- What is the default region for Geo Addressing API requests?
- The default region is US1 (Northern Virginia).
- Can I use the Geo Addressing API with Option1 (Essential) data?
- Yes, Option1 (Essential) data is supported for the Verify, Geocode, and Autocomplete APIs. You can use these APIs if you are entitled to Option1, Option2, or Option3 data.
- How do I determine which region is best for my specific needs?
- Consider the following factors when selecting a region:
- Data Location: Choose a region that is geographically closer to your data to improve performance and reduce latency.
- Compliance Requirements: If you need to comply with specific regional regulations (e.g., GDPR, CCPA), select a region that meets those requirements.
- Performance Considerations: If performance is a critical factor, consider the network latency and server load in different regions.
- Consider the following factors when selecting a region:
- Can I change the region for my API requests at any time?
- Yes, you can change the region for your API requests at any time. Refer to Geo Addressing API documentation for further details.
- What is the difference between Address Autocomplete and Address Autocomplete Express?
- Address Autocomplete is a comprehensive address suggestion service that offers:
- Global Coverage: Supports a wide range of countries and regions.
- Fast Response Times: Provides quick suggestions in milliseconds to seconds.
- Flexible Search Options: Accepts both keystroke-based and address-based searches.
- Advanced Features: Supports PO box searches, multiple languages, and SDK integration.
- Address Autocomplete Express is a simplified version currently in beta testing, offering:
- Limited Coverage: Currently supports only four countries.
- Fast Response Times: Provides quick suggestions in milliseconds.
- Flexible Search Options: Accepts both keystroke-based and address-based searches.
- Advanced Features: Supports location biasing (closest-nearest match first), no country search, and no zero results obtained for Address Search.
- Address Autocomplete is a comprehensive address suggestion service that offers:
- What is Address Autocomplete Postalcode-City Service?
- The Address Autocomplete Postalcode-City Service is a specialized API designed to provide intelligent suggestions for postal codes and city names as the user types. This service is particularly useful for applications that require users to input precise postal codes and city names, such as e-commerce websites, shipping address forms, and location-based services.
- How does Address Autocomplete Postalcode-City Service differ from Address Search?
- While both services involve searching for addresses, they have distinct focuses:
- Address Search: This service provides a comprehensive search for addresses based on various criteria, such as street address, city, state, and zip code. It returns detailed information about the address, including its geocoordinates.
- Address Autocomplete Postalcode-City: This service specifically focuses on suggesting postal codes and city names as the user types. It is optimized for quick and accurate input, enhancing user experience and reducing errors.
- While both services involve searching for addresses, they have distinct focuses:
- What kind of information does the Address Autocomplete Postalcode-City Service provide?
- When you provide a partial postal code or city name, the service returns a list of suggestions that include:
- Full Postal Code: The complete postal code.
- City Name: The full city name.
- Administrative Regions: State, province, or county information.
- Coordinates: Latitude and longitude for location identification.
- When you provide a partial postal code or city name, the service returns a list of suggestions that include:
- What is the global coverage of the Address Autocomplete Postalcode-City Service?
- The service offers global coverage, but the level of coverage may vary by country or region. The specific coverage depends on the availability and quality of data sources.
- What is New Vintage Management and what are its benefits?
- New Vintage Management is a feature that allows users to access data from both the current and previous vintages. This feature is exclusively available to users with a Premium Dataset subscription.
- Benefits of New Vintage Management
- Testing and Validation: Users can test and validate new data refresh logic without impacting existing integrations.
- Gradual Migration: Users can migrate to new features at their own pace, minimizing disruptions to business operations.
- Enhanced Flexibility: Access to multiple vintages provides greater flexibility for data analysis and reporting.
- How does New Vintage Management work?
- The New Vintage Management feature utilizes a custom preference called DATA_VERSION, which accepts a value in the format YYYY-MM. By specifying this preference, you can choose to access data from a specific vintage.
- Default Behavior: If no DATA_VERSION is specified, the latest vintage is used.
- Accessing Previous Vintage: To access the previous vintage, specify the previous month and year (e.g., 2023-12 for December 2023 data).
- Future Vintage Access: Accessing future vintages is not supported.
- The New Vintage Management feature utilizes a custom preference called DATA_VERSION, which accepts a value in the format YYYY-MM. By specifying this preference, you can choose to access data from a specific vintage.
- What happens if I try to access multi-vintage data without a Premium Dataset subscription?
- If you do not have a Premium Dataset subscription, you will receive a 403 Forbidden error due to insufficient permissions.
Service Availability & Security
- Availability model for Production system (where applicable)
- Contractual obligations for availability and support: Availability Service Level Availability (SLA) 99.9% in a quarter.
- Does the product store or process personally identifiable data (PII), electronic protected health information (ePHI), payment card data, or any other sensitive data?
- No
- What is the RTO & RPO for systems involved in delivery of service (if applicable)
- 24 hours, 48 hours
- Is the customer environment separate from other customer systems?
- Workspaces are logically separated in order to ensure that customer data is kept secure.
- What are the encryption protocols for database, OS, and data in transit?
- AES256
- What are the backup and data recovery procedures?
- Disaster recovery is tested at least annually.
- How often are backups performed?
- At least every 24 hours
- How regularly are your BC or DR plans tested?
- At least annually
- Do you have service level availabilities (SLAs) and support agreements in place with your hosting provider?
- Yes.
- Have you implemented backup mechanisms to ensure compliance with regulatory, statutory, contractual, or business requirements?
- Yes. Precisely has implemented backup and recovery policies for all essential systems. The frequency of backups varies depending on the nature and significance of the data and the underlying repositories. Whenever feasible, highly available, resilient, and redundant systems, services, and components are employed to enable automated fail over. Precisely conducts regular, secure tests of backup and recovery processes for both data and supporting systems.
- Do you encrypt tenant data at rest (on disk or storage) within your environment? If yes, to what strength?
- All customer data held by Precisely is encrypted in transit and at rest. Precisely uses industry-standard encryption algorithms and protocols, such as AES-256, TLS 1.2, and HTTPS, to protect data from unauthorized access, disclosure, or modification.
- What mechanism does Precisely provide for cloud-to-cloud connectivity with DIS APIs?
- Precisely supports AWS PrivateLink, which enables secure, private connectivity between your cloud environment and Precisely's APIs without exposing traffic to the public internet.
- Why should I use AWS PrivateLink for DIS API integration?
- AWS PrivateLink ensures that traffic remains within the AWS network, providing enhanced security, compliance, and performance for cloud-to-cloud integrations.
- How is AWS PrivateLink configured for DIS APIs?
- You create a VPC endpoint in your AWS account that connects to Precisely's API service via PrivateLink. Once set up, your applications route DIS API requests securely through this endpoint. For detailed information, see Precisely Data Integrity Suite regions.
- Where can I get help with setup?
- You can follow AWS PrivateLink documentation for configuration steps, and Precisely's support team can provide guidance tailored to DIS API integration.