Skip to navigation

Clearing House Suggest

View as Markdown

Suggest clearing houses matching a search term.

Available to: All authenticated users

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Return the clearing houses that match the search text in t. Use this endpoint to power a type-ahead or search box over clearing houses, rather than retrieving the full list and filtering client-side. Clearing houses are read-only reference data.

The search ignores case and matches from the start of a word in the clearing house’s name. By default, the response returns at most 10 clearing houses, even if l is larger. Set l lower to return fewer.

Common Failure Scenarios

  • The t parameter is missing or repeated, or the l parameter is repeated (HTTP 404). An l value that isn’t a whole number in the 32-bit range returns HTTP 500.
  • The caller’s user type, or the API key’s permissions, can’t read clearing houses. This returns HTTP 401 with "Access is denied".

Error Messages

MessageResponseTrigger
"Access is denied"401The caller’s user type, or the API key’s permissions, can’t read clearing houses.
(no message text)404The t parameter is missing or repeated, or the l parameter is repeated.
"Internal Server Error, error id: {id}"500l isn’t a whole number in the 32-bit range. The error ID is generated per request.

Related Endpoints

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

tstringRequired
Text
lintegerRequired
Max number of entities

Response

ClearingHouse
namestring<=64 characters
idlongOptional