SDKs overview
Software Development Kits (SDKs) and libraries for the LexisNexis API facilitate programmatic interaction with its various data and analytics services. These tools typically encapsulate the underlying RESTful API calls, handle authentication, request formatting, and response parsing, offering developers language-specific interfaces. SDKs can streamline the integration process by providing higher-level abstractions than direct HTTP client usage.
LexisNexis provides access to extensive public and proprietary data via APIs for identity, fraud, and risk solutions. Their developer portal offers documentation and API references, detailing how to interact with their services programmatically LexisNexis Developer Documentation. While LexisNexis maintains a robust API surface for direct integration, official SDKs simplify common development tasks.
The primary benefit of using an SDK or library is often reduced development time and fewer errors compared to manually constructing API requests and parsing responses. For instance, an SDK might automatically manage token refreshing for OAuth 2.0 authentication flows, or provide strongly typed objects corresponding to API response schemas.
Official SDKs by language
LexisNexis offers official SDKs designed to integrate with specific products and services. These SDKs are developed and maintained by LexisNexis Risk Solutions and are the recommended method for developers to connect their applications to the LexisNexis API ecosystem.
The availability and specific features of an SDK can vary depending on the LexisNexis product it supports. For instance, some SDKs may focus on identity verification workflows, while others target fraud detection or compliance screening.
| Language | Package/Module Name | Installation Command (Example) | Maturity/Status |
|---|---|---|---|
| Java | com.lexisnexis.risk.client (Illustrative) |
<dependency><groupId>com.lexisnexis.risk</groupId><artifactId>client</artifactId><version>1.0.0</version></dependency> (Maven) |
Actively supported; product-specific |
| .NET (C#) | LexisNexis.Risk.Client (Illustrative) |
Install-Package LexisNexis.Risk.Client -Version 1.0.0 (.NET CLI) |
Actively supported; product-specific |
| Python | lexisnexis-risk-sdk (Illustrative) |
pip install lexisnexis-risk-sdk==1.0.0 |
Actively supported; product-specific |
Note: Specific package names and versions are illustrative examples. Developers should refer to the official LexisNexis API documentation for the most current and accurate package information and installation instructions relevant to their specific LexisNexis product integration. Access to certain SDKs might be provided directly upon engagement with LexisNexis sales or support, depending on the service tier and licensing.
Installation
Installation procedures for LexisNexis SDKs follow common patterns for their respective programming language ecosystems. Developers typically use package managers to add the SDK to their project dependencies.
Java
For Java projects, SDKs are often distributed through Maven Central or a private LexisNexis repository. To include a LexisNexis SDK in a Maven project, add a dependency entry to your pom.xml file:
<dependencies>
<dependency>
<groupId>com.lexisnexis.risk</groupId>
<artifactId>client</artifactId>
<version>1.0.0</version>
</dependency>
</dependencies>
For Gradle users, the dependency would be added to build.gradle:
dependencies {
implementation 'com.lexisnexis.risk:client:1.0.0'
}
Ensure your build tool is configured to resolve dependencies from the appropriate repositories, potentially including LexisNexis' own. Consult the LexisNexis developer guides for specific repository configurations.
.NET (C#)
For .NET projects, LexisNexis SDKs are distributed as NuGet packages. You can install them using the NuGet Package Manager Console or the .NET CLI.
Using the .NET CLI:
dotnet add package LexisNexis.Risk.Client --version 1.0.0
Using the NuGet Package Manager Console in Visual Studio:
Install-Package LexisNexis.Risk.Client -Version 1.0.0
Python
Python SDKs are typically installed via pip. It is recommended to use a virtual environment to manage project dependencies.
pip install lexisnexis-risk-sdk==1.0.0
After installation, you can import the library into your Python scripts.
Quickstart example
The following example demonstrates a conceptual quickstart for using a LexisNexis SDK to perform an identity verification lookup. This snippet is illustrative; actual code will depend on the specific LexisNexis product, API version, and SDK design. Authentication details (e.g., API keys, client secrets, token acquisition) are typically configured during SDK initialization.
Python Quickstart (Illustrative)
This example assumes an SDK designed to interact with an identity verification service, requiring an API key for authentication and specific parameters for the lookup.
import os
from lexisnexis_risk_sdk import LexisNexisClient # Illustrative SDK import
from lexisnexis_risk_sdk.models import IdentityVerificationRequest # Illustrative model
# --- Configuration ---
# Replace with your actual LexisNexis API Key or other authentication credentials
API_KEY = os.environ.get("LEXISNEXIS_API_KEY")
# API_BASE_URL = "https://api.risk.lexisnexis.com/" # Base URL, might be configured in client
if not API_KEY:
raise ValueError("LEXISNEXIS_API_KEY environment variable not set.")
# Initialize the LexisNexis client
# Authentication and base URL might be passed here or configured globally
client = LexisNexisClient(api_key=API_KEY)
# --- Prepare the request payload ---
# This will vary greatly based on the specific LexisNexis product/API being called
identity_request = IdentityVerificationRequest(
first_name="John",
last_name="Doe",
date_of_birth="1980-01-15",
address={
"street": "123 Main St",
"city": "Anytown",
"state": "CA",
"zip_code": "90210"
},
# Other required or optional parameters as per API documentation
request_id="my-app-session-123" # Example of a common request identifier
)
# --- Make the API call ---
try:
print("Attempting identity verification...")
response = client.identity.verify(identity_request) # Illustrative method call
# --- Process the response ---
if response.status == "SUCCESS":
print("Identity verification successful.")
print(f"Verification Score: {response.verification_score}")
print(f"Flags: {response.flags}")
# Access detailed verification results, match indicators, etc.
else:
print(f"Identity verification failed: {response.status}")
print(f"Errors: {response.errors}")
except Exception as e:
print(f"An error occurred: {e}")
# Implement robust error handling and logging
For specific API endpoints and their corresponding SDK methods, developers should consult the LexisNexis API Reference and any accompanying SDK-specific documentation.
Community libraries
While LexisNexis provides official SDKs, the broader developer community may also contribute open-source libraries or wrappers. These community-maintained resources are often developed to address specific use cases, provide different programming language support, or offer alternative architectural patterns.
Community libraries are not officially supported or endorsed by LexisNexis. Their stability, feature completeness, and adherence to best practices can vary. Developers considering community libraries should evaluate them based on several factors:
- Active Maintenance: Is the library regularly updated to match changes in the LexisNexis API?
- Documentation: Is there clear and comprehensive documentation for installation and usage?
- Community Support: Are there active forums, issue trackers, or contributors who can provide assistance?
- Security: Has the library been audited or reviewed for potential security vulnerabilities, especially when handling sensitive data like personally identifiable information (PII) or financial data?
- Compatibility: Is the library compatible with the specific LexisNexis API endpoints and versions you intend to use?
Examples of common platforms where developers might find community-contributed libraries include GitHub, PyPI (for Python), npm (for JavaScript), or packagist (for PHP).
Due to the sensitive nature of data processed by LexisNexis APIs (e.g., identity, fraud, credit risk), reliance on official SDKs is generally recommended to ensure compliance, security, and access to the latest features and bug fixes. For any mission-critical applications, direct engagement with LexisNexis for official support is advised.