Skip to main content

Retrieve a Recipient

Returns the complete recipient object.
GET /v1/docks/:dockId/recipients/:id

Path Parameters

ParameterTypeDescription
dockIdstringThe dock ID
idstringThe recipient ID

Example Request

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

Response

{
  "id": "rcp_01HQ3N...",
  "dockId": "dock_01HQ3K...",
  "name": "First National Bank",
  "email": "[email protected]",
  "stakeholderClass": "mortgagee",
  "identifiers": {
    "lender_id": "LND-4821",
    "account_number": "ACC-99281"
  },
  "createdAt": "2025-01-15T10:32:00.000Z"
}

Error Handling

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