Skip to main content

List Policies

Returns all policies in a dock, ordered by createdAt descending.
GET /v1/docks/:dockId/policies

Path Parameters

ParameterTypeDescription
dockIdstringThe dock ID

Example Request

curl https://api.docyard.io/v1/docks/dock_01HQ3K.../policies \
  -H "Authorization: Bearer dk_live_a1b2c3d4..."

Response

[
  {
    "id": "pol_01HQ3P...",
    "dockId": "dock_01HQ3K...",
    "name": "Standard Mortgagee Access",
    "recipe": {
      "access": "read",
      "artifactTypes": ["declaration-page", "coi"],
      "requireFactors": ["email_verified"],
      "expiresInDays": 90
    },
    "status": "PRODUCTION",
    "currentVersion": 3,
    "createdAt": "2025-01-15T11:00:00.000Z"
  },
  {
    "id": "pol_01HQ3Q...",
    "dockId": "dock_01HQ3K...",
    "name": "Auditor Full Access",
    "recipe": {
      "access": "read",
      "artifactTypes": ["*"],
      "requireFactors": ["email_verified", "secret"],
      "expiresInDays": 30
    },
    "status": "DRAFT",
    "currentVersion": 1,
    "createdAt": "2025-01-14T09:00:00.000Z"
  }
]

Error Handling

StatusCondition
401Missing or invalid API key
404Dock not found