POST /connect-requests

Mint a single-use link for a business that already uses Garfield to approve linking their entity to you. Send connect_url to the user; they approve it from inside Garfield. Unlike /onboardings, Garfield does not email this link. You deliver connect_url to the customer yourself.

Request

Required: partner_user_id. label is an optional human-readable note.

curl -X POST "$BASE/connect-requests" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d @connect-request.json

connect-request.json

{
  "partner_user_id": "acme-crm-7741",
  "label": "Acme recovery portal"
}

Response

201 Created:

{
  "connect_url": "https://garfield.law/connect?token=ab12...cd34",
  "expires_at": "2026-05-31T15:04:05.000Z"
}

The link expires one hour after issue. Once the customer approves it, obtain their entity_id from them or your Garfield contact. It is not returned by any API response (see Identifiers). That entity_id then works on the document, claim, and list endpoints.

Test mode

In test mode the token is deterministic and not redeemable (expires_at is null). See Test mode.