— DEVELOPERS —

API documentation

The ResidenceProof REST API lets approved organizations create cases, poll status, and retrieve signed reports programmatically. Authentication uses per-organization API keys issued from the console. The reference below is a preview; the live, interactive API arrives in Phase 08.

POST/api/v1/cases

Create a verification case with subject, declared address, household roster, case type, risk tier, and permissible purpose.

GET/api/v1/cases/{id}/status

Retrieve the current case status in the lifecycle (Intake → Awaiting Consent → … → Report Issued).

GET/api/v1/cases/{id}/report

Fetch the signed assurance report (expiring signed download link) once issued.

POST/api/v1/webhooks

Register a webhook endpoint to receive case status-change events.

EXAMPLE REQUEST

curl -X POST https://api.residenceproof.com/v1/cases \
  -H "Authorization: Bearer <ORG_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": { "name": "Jane Doe", "dob": "1988-04-12" },
    "declared_address": "4307 Avenue G, Austin, TX 78751",
    "case_type": "underwriting",
    "risk_tier": "Medium",
    "permissible_purpose": "insurance_underwriting"
  }'