Skip to main content

​
Retrieve a Policy

Returns the full details of a single policy, including its recipe definition and current version number. 
GET /v1/docks/:dockId/policies/:policyId

​
Path Parameters

ParameterTypeDescription
dockIdstringThe dock ID
policyIdstringThe policy ID

​
Example Request

curl https://api.docyard.io/v1/docks/dock_01HQ3K.../policies/pol_01HQ3P... \
  -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",
  "updatedAt": "2025-01-20T14:30:00.000Z"
}

​
Error Handling

StatusCondition
401Missing or invalid API key
404Policy or dock not found