Identifiers

You supply most of these fields, not Garfield. Use stable ids from your own system so retries are safe and claims are easy to reconcile.

Field	Who provides it	Example	Use it for
partner_user_id	You	test-user-1	Your stable id for the referred or connected business/user. Required on /onboardings (where it is the idempotency key) and /connect-requests.
partner_claim_id	You	case-2026-00412	Your stable id for the recovery case. Required on /claims and /documents/upload-url; it is the claim idempotency key (scoped per entity), so reuse the same value on retries.
label	You	Postman test	Optional human-readable label for /connect-requests.
entity_id	Garfield	aZ4kQ9pX2	Assigned by Garfield to the connected business; not returned by any API response. Obtain it from the connecting business (or your Garfield contact) and pass it to the document, claim, and list endpoints.

partner_user_id and partner_claim_id are your idempotency keys. See Idempotency for exactly how each endpoint replays.

Examples

A quick Postman connect-request test:

{
  "partner_user_id": "test-user-1",
  "label": "Postman test"
}

For a document upload followed by a claim, use the same partner_claim_id in both calls:

{
  "entity_id": "<entity_id obtained from the connected business>",
  "partner_claim_id": "case-2026-00412"
}