Socure Python API Docs | dltHub
Build a Socure-to-database pipeline in Python using dlt with AI harness support for Claude Code, Cursor, and Codex.
Last updated:
Socure is an identity verification platform whose ID+ REST API scores and verifies identity transactions (e.g. EmailAuthScore, transaction details, document verification) using environment-specific API keys. The REST API base URL is https://service.socure.com/api/3.0 and all requests require an Authorization header with the ID+ key prefixed by SocureApiKey, plus Content-Type: application/json.
dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv add "dlt[hub]" and start loading Socure data in under 10 minutes.
What data can I load from Socure?
Here are some of the endpoints you can load from Socure:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| alerts | watchlist/monitoring/alerts | GET | (not documented) | List Monitoring Alerts (Socure Alerts API, base URL https://api.socure.com) |
| docv_transactions | documents/{docvTransactionId} | GET | (not documented) | Get a DocV transaction by ID (Socure Transactions API) |
| evaluations | api/evaluation/{eval_id} | GET | (not documented) | Retrieve the current state and results of an existing RiskOS evaluation by eval_id (base URL https://riskos.socure.com) |
| reason_codes | (RiskOS reason codes list endpoint, path not documented in sources) | GET | (not documented) | List RiskOS reason codes with optional filters by product, name, search text, or active status |
| device_sessions | api/v1/summary/{sessionToken} | GET | (not documented) | Digital Intelligence: overall summary of all data captured in a session (device fingerprint, behavioral, entityProfiler) (base URL https://device.socure.com) |
| device_fingerprints | api/v1/device/{sessionToken} | GET | (not documented) | Digital Intelligence: get device fingerprint data for a session |
| behavioral_sessions | api/v1/behavioral-session/{sessionToken} | GET | (not documented) | Digital Intelligence: get behavioral data for a session |
How do I authenticate with the Socure API?
Authenticate by sending the header 'Authorization: SocureApiKey <SOCURE_ID+_KEY>' with your environment-specific ID+ key from the Admin Dashboard, and set 'Content-Type: application/json'. HTTPS is required (TLS 1.3 default, 1.2 minimum); each environment (Sandbox, Certification, Production) has its own key, and Sandbox uses https://sandbox.socure.com while Production/Certification use https://service.socure.com.
1. Get your credentials
- Log in to the Socure RiskOS Dashboard for your environment (Sandbox Dashboard for development/testing, or Production Dashboard at https://riskos.socure.com for live use). 2. Navigate to Developer Workbench > API Keys (the API & SDK Keys page). 3. In the API Keys table, find your key and click the eye icon to reveal the masked token, then click the Copy token icon (or the Download icon to save it as a text file). 4. Store the key securely (e.g., environment variable or secrets file) and use it in requests as a Bearer token: Authorization: Bearer YOUR_API_KEY. Note: Sandbox and Production use separate keys and separate endpoints (https://riskos.sandbox.socure.com/api/evaluation vs https://riskos.socure.com/api/evaluation); to create a new key, contact Socure Support.
2. Add them to .dlt/secrets.toml
[sources.socure_source] api_key = "your_api_key_here"
dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.
How do I set up and run the pipeline?
Set up a virtual environment and install dlt:
uv init uv add "dlt[hub]"
1. Install the dlt AI harness:
uv run dlthub ai init --agent <your-agent> # <agent>: claude | cursor | codex
This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →
2. Install the rest-api-pipeline toolkit:
uv run dlthub ai toolkit install rest-api-pipeline
This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →
3. Start LLM-assisted coding:
Use /find-source to load data from the Socure API into DuckDB.
The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.
4. Run the pipeline:
uv run python socure_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline socure_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset socure_data The duckdb destination used duckdb:/socure.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
uv run dlthub show
This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.
Python pipeline example
This example loads POST /api/evaluation and GET /api/evaluation/{eval_id} from the Socure API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def socure_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://service.socure.com/api/3.0", "auth": {"type": "bearer", "token": api_key}, }, "resources": [ {"name": "alerts", "endpoint": {"path": "watchlist/monitoring/alerts"}}, {"name": "docv_transactions", "endpoint": {"path": "documents/{docvTransactionId}"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="socure_pipeline", destination="duckdb", dataset_name="socure_data", ) load_info = pipeline.run(socure_source()) print(load_info)
To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.
How do I query the loaded data?
Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.
Python (pandas DataFrame):
import dlt data = dlt.pipeline("socure_pipeline").dataset() sessions_df = data.alerts.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM socure_data.alerts LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("socure_pipeline").dataset() data.alerts.df().head()
See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.
What destinations can I load Socure data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example value |
|---|---|
| DuckDB (local, default) | "duckdb" |
| PostgreSQL | "postgres" |
| BigQuery | "bigquery" |
| Snowflake | "snowflake" |
| Redshift | "redshift" |
| Databricks | "databricks" |
| Filesystem (S3, GCS, Azure) | "filesystem" |
Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.
Next steps
Continue your data engineering journey with the other toolkits of the dltHub AI harness:
data-exploration— Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.dlthub-platform— Deploy, schedule, and monitor your pipeline in production.
uv run dlthub ai toolkit install data-exploration uv run dlthub ai toolkit install dlthub-platform
Was this page helpful?
Community Hub
Need more dlt context for Socure?
Request dlt skills, commands, AGENT.md files, and AI-native context.