The integration flow

There are two ways to reach a connected entity_id you can create claims for, depending on whether the business already uses Garfield. Examples use $BASE for the base URL and $TOKEN for your bearer token.

Path A: the business is new to Garfield

POST /onboardings           → provision an entity, email the user a magic link
POST /documents/upload-url  → (optional) one call per supporting document, then PUT the file
POST /claims                → create the claim (your message field and any documents form its opening message)
GET  /claims                → reconcile what you originated

1. Create an onboarding to provision a brand-new Garfield entity and email the user a magic link.
2. Wait for the user to finish onboarding, then obtain the entity_id for the connected business. It is not returned by any API response (see Identifiers).
3. Upload supporting documents (optional) before creating the claim.
4. Create the claim for the connected entity.
5. List claims to reconcile what you originated.

Path B: the business already uses Garfield

POST /connect-requests      → return a connect_url you send to the user to approve
POST /documents/upload-url  → (optional) one call per supporting document, then PUT the file
POST /claims                → create the claim
GET  /claims                → reconcile what you originated

1. Create a connect request and send the returned connect_url to the user to approve. Unlike onboarding, Garfield does not email this link; you deliver it yourself.
2. Wait for the user to approve the link (documents and claims only work after approval), then obtain the entity_id for the connected business (see Identifiers).
3. Upload supporting documents (optional) before creating the claim.
4. Create the claim for the connected entity.
5. List claims to reconcile what you originated.

Full schemas live in the API reference

Each endpoint page below shows the happy-path request and response. For the complete field-by-field schema, see the API reference.