API ReferenceCustom Benchmarks

Create Custom Benchmark

Create a new custom benchmark with an initial rate. Custom benchmarks allow institutions to define their own rate indices that can be referenced by account rate tiers. When a custom benchmark's rate is updated, all accounts using it in their rate tiers will automatically receive the new rate.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
namestringRequired<=128 characters

Name of the custom benchmark (e.g., ‘Short-Term Funding Cost’)

ratedouble or stringRequired

Initial rate for the custom benchmark (e.g., 0.0425 for 4.25%)

descriptionstring or nullOptional<=512 characters
Optional description providing additional context about this benchmark

Response

Successful Response

Errors

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