Garfield Partner API
The request and response schema of each endpoint. For the steps, see the docs.
| Endpoint | Use |
|---|---|
POST /onboardings | Create an entity for a new business. |
POST /connect-requests | Get a link for a Garfield user to connect. |
GET /entities | List the entities connected to you or your own. |
POST /documents/upload-url | Get a signed URL to upload a document. |
POST /claims | Create a claim for a connected entity. |
GET /claims | List claims. |
GET /claims/{claim_id} | Get one claim's status. |
POST /claims/{claim_id}/messages | Add a note or documents to a claim. |
Each entity_id you send must be an entity connected to you or one of your
own. Your own entities are the ones the Garfield account behind your partner
account owns. Requests for one of your own entities return 403
entity_not_owned while it requires two-factor authentication for everyone,
and 403 partner_disconnected if it connected to you as a partner and
then disconnected.
Base your error handling on the code in each error response, because
code is stable. See Errors and limits.
The changelog lists changes to the API. Garfield emails approved partners before any change that could break an integration.
Authentication
- HTTP: Bearer Auth
Send your API key as a bearer token: Authorization: Bearer pk_test_<partner_id>.<key_id>.<secret>. A live key starts with pk_live_. See Get started for key modes and auth errors.
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | pk_live_PARTNER_ID.KEY_ID.SECRET (pk_test_ in test mode) |