Create a Dock
Creates a new dock — an isolated workspace for managing artifacts, recipients, and access policies.
Request Body
| Parameter | Type | Required | Description |
|---|
name | string | Required | Display name for the dock |
domain | string | Optional | Primary domain for verification (e.g., acme.com) |
customDomain | string | Optional | Custom domain for branded portal access |
legalName | string | Optional | Official business name |
businessType | string | Optional | Business entity type (e.g., corporation, llc, partnership) |
taxId | string | Optional | Tax identification number / EIN |
registrationNumber | string | Optional | Business registration number |
businessAddress | object | Optional | Company address (see below) |
businessPhone | string | Optional | Business phone number |
businessEmail | string | Optional | Business email (validated format) |
primaryColor | string | Optional | Hex color for branding (e.g., #0066cc) |
secondaryColor | string | Optional | Hex color for secondary branding |
customCss | string | Optional | Custom CSS for the recipient portal |
businessAddress Object:
| Field | Type | Description |
|---|
street | string | Street address |
city | string | City |
state | string | State or province |
postalCode | string | Postal / ZIP code |
country | string | Country code |
Example Request
Insurance
Real Estate
Healthcare
Financial Services
curl -X POST https://api.docyard.io/v1/docks \
-H "Authorization: Bearer dk_live_a1b2c3d4..." \
-H "Content-Type: application/json" \
-d '{
"name": "Acme Insurance",
"domain": "acme-insurance.com",
"legalName": "Acme Insurance Co.",
"businessType": "corporation",
"taxId": "12-3456789",
"businessEmail": "[email protected]",
"primaryColor": "#003366"
}'
curl -X POST https://api.docyard.io/v1/docks \
-H "Authorization: Bearer dk_live_a1b2c3d4..." \
-H "Content-Type: application/json" \
-d '{
"name": "Pinnacle Title & Escrow",
"domain": "pinnacletitle.com",
"legalName": "Pinnacle Title & Escrow LLC",
"businessType": "llc",
"taxId": "45-6789012",
"businessEmail": "[email protected]",
"primaryColor": "#2D5016"
}'
curl -X POST https://api.docyard.io/v1/docks \
-H "Authorization: Bearer dk_live_a1b2c3d4..." \
-H "Content-Type: application/json" \
-d '{
"name": "Lakeside Health System",
"domain": "lakesidehealth.org",
"legalName": "Lakeside Health System Inc.",
"businessType": "corporation",
"taxId": "56-7890123",
"businessEmail": "[email protected]",
"primaryColor": "#1B4D6E"
}'
curl -X POST https://api.docyard.io/v1/docks \
-H "Authorization: Bearer dk_live_a1b2c3d4..." \
-H "Content-Type: application/json" \
-d '{
"name": "Summit Capital Partners",
"domain": "summitcapital.com",
"legalName": "Summit Capital Partners LLC",
"businessType": "llc",
"taxId": "78-9012345",
"businessEmail": "[email protected]",
"primaryColor": "#4A2C0A"
}'
Response
Insurance
Real Estate
Healthcare
Financial Services
{
"id": "dock_01HQ3K...",
"name": "Acme Insurance",
"domain": "acme-insurance.com",
"customDomain": null,
"status": "ACTIVE",
"domainVerificationStatus": "UNVERIFIED",
"kycStatus": "NOT_STARTED",
"legalName": "Acme Insurance Co.",
"businessType": "corporation",
"taxId": "12-3456789",
"businessEmail": "[email protected]",
"primaryColor": "#003366",
"secondaryColor": null,
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-15T10:30:00.000Z"
}
{
"id": "dock_01HQ3K...",
"name": "Pinnacle Title & Escrow",
"domain": "pinnacletitle.com",
"customDomain": null,
"status": "ACTIVE",
"domainVerificationStatus": "UNVERIFIED",
"kycStatus": "NOT_STARTED",
"legalName": "Pinnacle Title & Escrow LLC",
"businessType": "llc",
"taxId": "45-6789012",
"businessEmail": "[email protected]",
"primaryColor": "#2D5016",
"secondaryColor": null,
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-15T10:30:00.000Z"
}
{
"id": "dock_01HQ3K...",
"name": "Lakeside Health System",
"domain": "lakesidehealth.org",
"customDomain": null,
"status": "ACTIVE",
"domainVerificationStatus": "UNVERIFIED",
"kycStatus": "NOT_STARTED",
"legalName": "Lakeside Health System Inc.",
"businessType": "corporation",
"taxId": "56-7890123",
"businessEmail": "[email protected]",
"primaryColor": "#1B4D6E",
"secondaryColor": null,
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-15T10:30:00.000Z"
}
{
"id": "dock_01HQ3K...",
"name": "Summit Capital Partners",
"domain": "summitcapital.com",
"customDomain": null,
"status": "ACTIVE",
"domainVerificationStatus": "UNVERIFIED",
"kycStatus": "NOT_STARTED",
"legalName": "Summit Capital Partners LLC",
"businessType": "llc",
"taxId": "78-9012345",
"businessEmail": "[email protected]",
"primaryColor": "#4A2C0A",
"secondaryColor": null,
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-15T10:30:00.000Z"
}
Error Handling
| Status | Condition |
|---|
400 | domain or customDomain is already registered to another dock |
400 | businessEmail is not a valid email format |
401 | Missing or invalid API key |
The domain and customDomain fields must be globally unique across all docks. If a domain is already claimed, you must contact support to transfer it.
