Skip to main content

Garfield Partner API

A server-to-server REST API for partners that refer businesses to Garfield AI and create debt-recovery claims on their behalf.

Base URLhttps://www.garfield.law/api/partner/v1
FormatJSON request and response bodies
AuthBearer API key on every request

Every endpoint requires authentication. Examples throughout the guide use $BASE and $TOKEN; set them once and every example runs as-is:

export BASE="https://www.garfield.law/api/partner/v1"
export TOKEN="pk_test_..." # your full key from Console → Keys

Start here​

  1. Authentication: send your API key as a bearer token.
  2. Test mode: build against the sandbox with a pk_test_… key, then switch to a pk_live_… key.
  3. The integration flow: onboard or connect a business, then file claims.
  4. API reference: the full request and response schema for every endpoint.
  5. Console → Usage: confirm your calls landed and watch error rates as you go live.
Get your keys

Existing Garfield users: open Settings → Partner API, select Go to developer console, and sign in with your Garfield account.

New users: sign up for API access.

New partners are reviewed by the Garfield team before keys can be created. Once approved, create a pk_test_… key from Console → Keys.

Two integration paths​

There are two ways to reach a connected entity_id you can create claims for, depending on whether the business already uses Garfield:

  • Path A, new to Garfield: POST /onboardings → upload documents → POST /claims.
  • Path B, already a customer: POST /connect-requests → upload documents → POST /claims.

See The integration flow for both paths end to end, with a copyable request and response for every endpoint.