Get a claim
Returns one claim that you created, in the same shape as a claim from GET /claims. A test key reads its test claims, whose status moves on as Simulated claims describes. Once its entity disconnects from you, the API returns 403 partner_disconnected for it. See Create a claim.
Request
GET/claims/:claim_id
Responses
- 200
- 401
- 403
- 404
- 429
- 500
- 503
The claim.
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).
partner_disconnected: the claim's entity disconnected from you. auth_partner_not_approved: Garfield has not approved your partner account yet, so only test keys work.
You have not created a claim with this claim_id using a key of this mode, or you can no longer reach its entity.
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.