Skip to main content
POST
Generate a Ping.Location report (PDF)

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Body

Schema-only serializer for external API documentation.

sovid
string
required

Unique building identifier.

Minimum string length: 1
highlight_bounds
object | null

Optional region to highlight on the map, drawn as a rectangle.

layer
string | null

Risk overlay layer. When provided, the map is captured via server-side browser rendering so the overlay is visible in the PDF. Supported values: ping-flood, ping-eq-zones, ping-slosh-1, ping-slosh-3, ping-slosh-4, ping-tier-combined, ping-usda-wildfire, crime-tract.

Minimum string length: 1
map_bounds
object

Geographic bounds for the map image. When omitted, the backend infers bounds from the building's coordinates.

map_type
enum<string>
default:satellite

Base map style.

  • satellite - satellite
  • roadmap - roadmap
  • hybrid - hybrid
  • terrain - terrain
Available options:
satellite,
roadmap,
hybrid,
terrain

Response

Generation queued — poll with task_id and document_id