Clearing House Find
Find a clearing house by name.
Available to: All authenticated users
Environments: Demo, Live
Rate Limit: No endpoint-specific limit
Look up a clearing house by its name to get its id. Use this endpoint when you know a clearing house by name and need the id that other records reference it by. Clearing houses are read-only reference data.
Common Failure Scenarios
- No clearing house matches the
name. This returnsHTTP 404with an empty body. - The
nameparameter is missing or repeated (HTTP 404). - 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
clearingHouseItemto resolve a clearing house byidinstead. - Use
clearingHouseListto retrieve every clearing house.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
name
Response
ClearingHouse
name
id