VerityVerity API
API Reference

Get policy by ID

Retrieve a single coverage policy by its ID with optional related data.

GET
/policies/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key in format: vrt_live_xxxxx or vrt_test_xxxxx

In: header

Path Parameters

id*string

Policy ID (e.g., L33831)

Query Parameters

include?string

Additional data to include (comma-separated: criteria, codes, attachments, versions)

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://verity.backworkai.com/api/v1/policies/string"
{
  "success": true,
  "data": {
    "policy_id": "string",
    "title": "string",
    "policy_type": "string",
    "jurisdiction": "string",
    "effective_date": "2019-08-24",
    "retire_date": "2019-08-24",
    "last_reviewed_date": "2019-08-24",
    "version": "string",
    "status": "string",
    "source_url": "http://example.com",
    "pdf_url": "http://example.com",
    "description": "string",
    "summary": "string",
    "specialty": "string",
    "keywords": [
      "string"
    ],
    "sections": {
      "indications": "string",
      "limitations": "string",
      "documentation": "string"
    },
    "mac": {
      "name": "string",
      "code": "string",
      "jurisdiction_name": "string",
      "states": [
        "string"
      ]
    },
    "payer": {
      "name": "string",
      "code": "string",
      "type": "string"
    },
    "criteria": {
      "property1": [
        {
          "block_id": "string",
          "text": "string",
          "logic_ast": {},
          "tags": [
            "string"
          ],
          "requires_manual_review": true,
          "confidence_score": 0
        }
      ],
      "property2": [
        {
          "block_id": "string",
          "text": "string",
          "logic_ast": {},
          "tags": [
            "string"
          ],
          "requires_manual_review": true,
          "confidence_score": 0
        }
      ]
    },
    "codes": {
      "property1": [
        {
          "code": "string",
          "display": "string",
          "disposition": "string",
          "condition_reference": "string",
          "notes": "string"
        }
      ],
      "property2": [
        {
          "code": "string",
          "display": "string",
          "disposition": "string",
          "condition_reference": "string",
          "notes": "string"
        }
      ]
    },
    "attachments": [
      {
        "file_type": "string",
        "url": "http://example.com",
        "title": "string",
        "page_number": 0,
        "file_size_bytes": 0
      }
    ],
    "versions": [
      {
        "old_version": "string",
        "new_version": "string",
        "change_type": "string",
        "change_summary": "string",
        "changed_fields": [
          "string"
        ],
        "timestamp": "2019-08-24T14:15:22Z"
      }
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "includes": [
      "string"
    ]
  }
}
{
  "success": false,
  "error": {
    "code": "AUTH_KEY_NOT_FOUND",
    "message": "API key not found",
    "hint": "Check that your API key is correct",
    "docUrl": "https://docs.verity.io/errors#auth-key-not-found"
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}
{
  "success": false,
  "error": {
    "code": "RESOURCE_POLICY_NOT_FOUND",
    "message": "Policy L99999 not found",
    "docUrl": "https://docs.verity.io/errors#resource-policy-not-found"
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}
{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded",
    "hint": "Upgrade to pay-as-you-go for higher limits",
    "docUrl": "https://docs.verity.io/errors#rate-limit-exceeded"
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}