- Home
- API errors
API errors
Firmary API errors include a code, a description, a request ID and a link to the error reference. Look up the code below for what to do next.
HTTP 400 Bad request
- Bad request
BAD_REQUEST - The request body can’t be read
MALFORMED_BODY - The file or data for the move is invalid
INVALID - This request can’t take an Idempotency-Key
IDEMPOTENCY_DISABLED - This request needs an Idempotency-Key
IDEMPOTENCY_KEY_ REQUIRED - The Idempotency-Key isn’t valid
IDEMPOTENCY_KEY_ INVALID
HTTP 401 Unauthorized
- Sign-in failed, no reason given
UNAUTHORIZED - Sign in first
UNAUTHENTICATED - Firmary couldn’t accept the credential
INVALID_CREDENTIAL - This needs a staff sign-in
STAFF_SESSION_ REQUIRED
HTTP 403 Forbidden
- Not allowed, no reason given
FORBIDDEN - Your access doesn’t allow this
AUTHZ_DENIED - Firmary couldn’t confirm that this change came from the same site
CSRF_ORIGIN_ MISMATCH - Confirm it’s you
FRESH_SIGN_ IN_ REQUIRED - This token can’t do that
CREDENTIAL_OPERATION_ DENIED - Manage API keys in Firmary
CREDENTIAL_SELF_ MANAGEMENT_ DENIED - This agent is paused
AGENT_PAUSED - Shared-space agents can’t work tasks
AGENT_SHARED_ SPACE - That belongs to another firm
TENANT_MISMATCH - Reserved for a disabled embedded app
DISABLED
HTTP 404 Not found
- Not found
NOT_FOUND
HTTP 405 Method not allowed
- Browser request not allowed
CORS_DENIED
HTTP 409 Conflict
- It changed, or it’s already done
CONFLICT - That Idempotency-Key was used for a different request
IDEMPOTENCY_KEY_ REUSED - Retry the same request shortly
IDEMPOTENCY_IN_ PROGRESS - Stripe payments aren’t available for this firm
PAYMENT_ACCOUNT_ NOT_ CONNECTED - Firmary can’t take this step right now
BUSY - That name is taken
DUPLICATE_NAME - The client already has this form
DUPLICATE_ASSIGNMENT - The client already has this request
DUPLICATE_REQUEST - No reminder was sent
REMINDER_REFUSED - The client needs an access-review manager
REVIEW_MANAGER_ REQUIRED - Not sure whether it went through
OUTCOME_UNKNOWN - The attachment can’t be sent
ATTACHMENT_NOT_ CLEAN - The conversation is closed
CONVERSATION_CLOSED - The file isn’t ready to download
NOT_SCANNED - The booking was turned down
BOOKING_REJECTED - That time is no longer free
SLOT_UNAVAILABLE - Not sure whether the booking was made
BOOKING_OUTCOME_ UNKNOWN - Already undone
ALREADY_UNDONE - This can’t be undone automatically
UNDO_NOT_ AVAILABLE - Changed since, so not undone
CHANGED_SINCE - Already being undone
UNDO_IN_ PROGRESS - Your firm has 100 webhook endpoints
LIMIT_REACHED
HTTP 410 Gone
- The invitation has expired
INVITATION_EXPIRED
HTTP 413 Payload too large
- Too large
PAYLOAD_TOO_ LARGE - The file is too large
FILE_TOO_ LARGE - Over the move’s limit
LIMIT
HTTP 415 Unsupported media type
- Wrong content type
UNSUPPORTED_MEDIA_ TYPE - That file type isn’t accepted
UNSUPPORTED_TYPE
HTTP 422 Unprocessable entity
- Some fields are missing or wrong
VALIDATION_FAILED - The cursor isn’t valid
VALIDATION - The request can’t be done
UNPROCESSABLE_CONTENT - Firmary’s rules don’t allow this
RULE_VIOLATED - An accounting value isn’t valid
INVALID_INPUT - The file failed the virus scan
INFECTED - The invitation isn’t valid
INVITATION_INVALID - Firmary won’t call that address
UNSAFE_URL - Firmary couldn’t reach that tool
UNREACHABLE - That tool needs a client ID for Firmary
REGISTRATION_UNSUPPORTED - The sign-in to that tool didn’t finish
SIGN_IN_ FAILED
HTTP 429 Too many requests
- You’ve hit a rate limit
RATE_LIMITED - Too many requests, no reason given
TOO_MANY_ REQUESTS
HTTP 500 Internal server error
- Something went wrong on Firmary’s side
INTERNAL_SERVER_ ERROR
HTTP 502 Bad gateway
- A service Firmary relies on failed
BAD_GATEWAY - A connected service failed
EXTERNAL_SERVICE_ ERROR - The file couldn’t be saved
STORAGE
HTTP 503 Service unavailable
- Not available right now
SERVICE_UNAVAILABLE - Permissions can’t be checked right now
AUTHZ_UNAVAILABLE - The accounting operation is unavailable
PROVIDER_UNAVAILABLE - Connected tools are turned off
UNAVAILABLE
HTTP 504 Gateway timeout
- A service Firmary relies on took too long
GATEWAY_TIMEOUT
Any other status
- The request failed
REQUEST_HTTP 4xx or 5xx, excluding 400 and 500FAILED
Command-line exit codes
The command line’s own exit codes are listed in the command line guide.
Getting help
If you need help, email [email protected] and include the request ID if one is shown.