Skip to navigation
API ReferenceInstitution Opt Out Catalog

List Institution Opt Out Catalog

Search the FDIC/NCUA catalog for institutions a depositor may exclude.

Authentication

AuthorizationBearer

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

Query parameters

searchstring or nullOptional<=256 characters
Partial match on institution name, cert number, or federal id, or an exact ABA routing number.
limitintegerOptional1-1000Defaults to 100
Max rows to return.
offsetintegerOptional>=0Defaults to 0
Rows to skip before returning.

Response

Successful Response
institutionslist of objects
Institutions of the caller's own type matching the search, ordered by name.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error