Skip to main content
Failures use one envelope:
error.type is stable and never translated. error.message is prose: it follows the workspace language, or Accept-Language: en / fr on that request. Accept-Language does not change the SMS body.

Types

A wrong OTP code with attempts remaining is not an error: 200 with valid: false.

Sender ID requests in the dashboard

Requesting a sender ID is not a /v1 call, and it does not use the error.type envelope above. The dashboard returns error (a sentence) and code. When the use case is lending and the request has no lending licence, the status is 422:
Any one of cbn, fccpc, or state_money_lender is enough. Other use cases are unchanged. See Sender IDs.