List claims
Lists the claims that you created: for one entity, or across every entity you can still reach if you leave out entity_id. Without updated_since, the newest comes first. A test key lists its test claims. Once an entity disconnects from you, listing that entity's claims returns 403 partner_disconnected, and the listing across entities leaves its claims out.
To get only the claims that changed, send updated_since. The least recently updated comes first. Garfield stamps last_updated_at when it starts working on a claim, which can be a few minutes before it saves the change, so start each poll from the largest last_updated_at you have seen minus 15 minutes. Claims in that overlap can come back more than once, so make processing the same claim twice harmless. See Create a claim.
Request
GET/claims
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 500
- 503
The claims.
Response Headers
The maximum number of requests your partner account can send in each window. Only production enforces limits and sends this header.
The window length in seconds, always 60. The API does not report how much of the current window is left. Only production sends this header.
You sent partner_user_id without entity_id, updated_since is not a date-time with Z or an offset, or page_token does not refer to a claim in this listing.
Authentication failed. code gives the cause: auth_missing (no Authorization header), auth_invalid_format (the token has no pk_test_ or pk_live_ prefix, or its format is not valid), auth_revoked (Garfield revoked your partner account or rejected your application, or you revoked the key) or auth_bad_secret (the partner id, key id or secret is incorrect, or the prefix does not match the key's mode).
The key is valid but does not have access. code is auth_partner_not_approved (Garfield has not approved your partner account yet, so only test keys work), entity_not_owned (the entity is not connected to you and is not your own) or partner_disconnected (the entity disconnected from you).
No entity has this id, or you sent a real entity_id with a test key.
Too many requests. Each partner can send 120 requests per minute across all endpoints and keys, and only requests with a verified key count. Until Garfield approves a partner, the limit is 30 requests per minute. Requests that fail authentication count separately, 10 per minute for each IP address. Past that, fix the key before you send more requests. For the partner limit, wait the number of seconds in Retry-After, then retry. The API counts requests per minute as they arrive, so treat the limits as approximate.
Response Headers
The number of seconds to wait before you retry.
The maximum requests in each window, for the limit you exceeded.
Only on a 429, where it is 0. The API does not report a running count.
The window length in seconds, always 60. The API does not report how much of the current window is left. Only production sends this header.
A server error. code is internal_error. Retry with exponential backoff.
A dependency is temporarily unavailable. code is service_unavailable, or document_verification_failed when the API could not check an uploaded document in storage. Retry after Retry-After when the response has it, otherwise with exponential backoff.
Response Headers
The number of seconds to wait before you retry.