Location-risk intelligence API

Build risk decisions directly into your workflow.

TrueViewly turns coordinates into modular location-risk reports with async jobs, PDF exports, batch processing, usage visibility, and signed webhooks.

Read the docs Explore API reference

Async reports Scoped API keys Signed webhooks

report-job.json

POST /api/v1/location-risk/report-jobs
Authorization: Bearer tvly_live_...
Idempotency-Key: site-001-2026-06-01

{
  "latitude": 36.98154,
  "longitude": -122.02934
}

202 Accepted
Location: /api/v1/location-risk/report-jobs/job_x7...

Documentation map

Start with the path that matches your integration.

Use the quickstart for first calls, the reference for endpoint details, and the webhook docs when your workflow needs callbacks.

Quickstart

Create a job, poll status, fetch summary JSON, and download the PDF.

Start here

Batch API

Submit coordinate batches and retrieve per-location results as JSON or CSV.

Review batch flow

Webhooks

Receive signed callbacks when async jobs complete or fail.

Set up callbacks

Reference

Inspect endpoints, scopes, payloads, errors, and copy request examples.

Open reference

Production shape

Built like an API product.

Review the supported endpoints, scopes, coverage and limits before connecting a production workflow.

Before your first API request

Use an active Business API workspace, or another plan explicitly showing API access. Free, Essentials and Professional do not include API access.

Switch to the correct workspace. Only its owner or admin can create and manage keys in Developer & API keys. Keys are workspace-scoped; a browser login is not an API credential.

Create a key with reports:create and reports:read for the quickstart; add reports:pdf for PDFs. Batch endpoints need bulk:create/bulk:read, but consume API generation quota, not CSV bulk-upload rows.

Compare plans and monthly allowances

Async jobs

Long-running report generation is queued and pollable.

Summary and full report

Use compact decision output or the complete report payload.

Signed webhooks

Verify callbacks with HMAC-SHA256 and replay protection.

Usage endpoints

Show quotas, remaining calls, and daily history inside your app.

OpenAPI JSON

Import into Postman, Insomnia, Swagger tooling, or client generators.

Clear errors

Every error has a code, status, meaning, and recommended fix.