Start here

Errors

Errors are JSON with a stable code, a plain message and, for bad parameters, the field that failed.

401 invalid_key

The key is missing, unknown, revoked or expired.

403 ip_not_allowed

The request came from an address the key is not allowed to use.

403 client_suspended

Your account has been suspended. Contact ValueApps.

403 institution_inactive

Your institution’s ValueApps subscription is not active.

403 wrong_key

A comparables key was used on an institution endpoint, or the other way round.

403 api_not_enabled

API access isn’t switched on for your institution.

403 not_in_plan

This API isn’t part of your institution’s plan.

403 insufficient_scope

The key doesn’t have the read or write access this call needs.

400 invalid_params

A query parameter is missing or out of range. The details say which.

422 validation_failed

A field in a write (POST or PATCH) is missing or not valid. The details name it.

404 not_found

Nothing has that id, or it isn’t available to you.

429 rate_limited

Too many requests this minute. Wait for Retry-After seconds.

429 quota_exceeded

The monthly allowance is used up. It resets on the first of the month.