API v1

Extract verified addresses from call recordings by API

VoiceAddress exposes a server-to-server API for creating address extraction jobs, resolving transcripts, listing history, and retrieving normalized address results with evidence, confidence, role labels, and map links.

Create API key OpenAPI JSON

create extractionmultipart/form-data

curl -X POST https://hearloc.com/api/v1/address-extractions \
  -H "Authorization: Bearer $VOICEADDRESS_API_KEY" \
  -H "Idempotency-Key: upload-2026-06-02-001" \
  -F "[email protected]"

{
  "id": "job_...",
  "object": "address_extraction",
  "status": "queued",
  "duration_seconds": 74.2,
  "review_flags": [],
  "rejected_candidates": [],
  "addresses": [],
  "confidence_band": "low"
}

curl https://hearloc.com/api/v1/address-extractions/job_... \
  -H "Authorization: Bearer $VOICEADDRESS_API_KEY"

File extraction

Upload MP3, WAV, M4A, MP4, WEBM, OGG, FLAC, AAC, AIFF, 3GP, or MKV recordings as multipart form data.

Transcript extraction

Send already-transcribed call text when your telephony or contact-center platform has its own ASR output.

Scoped API keys

Create bearer keys with read and write scopes. Keys are shown once and should only be used server-side.

Operational limits

Paid-plan enforcement, hourly rate limits, upload-size limits, and tenant-scoped access are enforced server-side.

Authentication and security

API keys are bearer credentials. Store them in a backend secret manager, never in a browser, mobile app, or customer-visible configuration file.

Header

Authorization: Bearer va_live_...

Rate limits

Create endpoints are limited per tenant per hour. List and read endpoints have separate limits so integrations can poll without sharing upload capacity.

Transcript-only request

curl -X POST https://hearloc.com/api/v1/address-extractions/resolve-transcripts \
  -H "Authorization: Bearer $VOICEADDRESS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"transcripts":[{"provider":"manual","text":"The service address is 524 Agewood Drive, Simpsonville, SC 29680."}]}'

Status codes

201Extraction created

401Missing or invalid API key

402Paid plan required

403Required scope missing

413Upload exceeds 100 MB

415Unsupported media type

429Rate limit exceeded