Skip to main content

Retrieve a Dock

Returns the complete dock object including counts of associated resources.
GET /v1/docks/:id

Path Parameters

ParameterTypeDescription
idstringThe dock ID

Example Request

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

Response

{
  "id": "dock_01HQ3K...",
  "name": "Acme Insurance",
  "domain": "acme-insurance.com",
  "customDomain": null,
  "status": "ACTIVE",
  "domainVerificationStatus": "VERIFIED",
  "kycStatus": "APPROVED",
  "legalName": "Acme Insurance Co.",
  "businessType": "corporation",
  "taxId": "12-3456789",
  "businessAddress": {
    "street": "100 Main St",
    "city": "Hartford",
    "state": "CT",
    "postalCode": "06103",
    "country": "US"
  },
  "businessPhone": "+1-860-555-0100",
  "businessEmail": "[email protected]",
  "logoUrl": null,
  "primaryColor": "#003366",
  "secondaryColor": null,
  "customCss": null,
  "_count": {
    "recipients": 247,
    "artifacts": 1893,
    "policies": 12
  },
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-20T14:00:00.000Z"
}

Error Handling

StatusCondition
401Missing or invalid API key
404Dock with the specified id does not exist