Clearing House Suggest
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
tparameter is missing or repeated, or thelparameter is repeated (HTTP 404). Anlvalue that isn’t a whole number in the 32-bit range returnsHTTP 500. - The caller’s user type, or the API key’s permissions, can’t read clearing houses. This returns
HTTP 401with"Access is denied".
Error Messages
Related Endpoints
- Use
clearingHouseListto retrieve every clearing house. - Use
clearingHouseFindto look up a clearing house by its fullname(the match ignores case).
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
t
Text
l
Max number of entities
Response
ClearingHouse
name
id