The V1 API is deprecated. Technical support will end by October 2025 and will be removed by April 2026. No new features nor functionality will be added to the V1 API. Please use the V2 Verify API instead. For more information refer to the V2 Migration Guide.

Prelude uses conventional HTTP statuses to indicate the success or failure of a request:

  • Codes in the 2xx range indicate success.
  • Codes in the 4xx range indicate an error that failed given the information provided (e.g. required parameter was omitted or an authentication failed).
  • Codes in the 5xx range indicate an error with Prelude’s servers (these are rare).

Codes

Below is a list of possible error codes, along with additional information about how to resolve them.

CodeDescription
account_invalidThe provided customer UUID is invalid.
bad_requestThe request was malformed.
blocked_numberThe phone number is in the blocklist.
duplicated_feedback_statusDuplicated feedback status has found.
internal_server_errorAn internal server error occurred.
invalid_app_versionThe provided application version is invalid.
invalid_auth_uuidThe provided authentication UUID is invalid.
invalid_device_idThe provided device ID is invalid.
invalid_device_modelThe provided device model is invalid.
invalid_feedback_statusThe provided feedback status is invalid.
invalid_linePrelude does not support this type of phone number.
invalid_os_versionThe provided OS version is invalid.
invalid_phone_numberThis is not a valid E.164 number.
invalid_sender_idThe provided Sender ID is invalid.
invalid_template_idThe provided template ID is invalid.
negative_balanceYou have a negative balance.
no_associated_auth_foundThe associated authentication was not found.
suspended_accountYour account has been suspended.
unauthorized_sender_idThe provided sender ID is not authorized to send messages.
unsupported_regionPrelude does not support this region yet.
spending_limit_exceededThe spending limit for a time period has been exceeded. You can set the spending limits from your Dashboard.

code
enum<string>

A machine-readable code that describes the error.

Available options:
account_invalid,
app_realm_require_device_type,
bad_request,
blocked_number,
duplicated_feedback_status,
internal_server_error,
invalid_app_realm,
invalid_app_version,
invalid_auth_uuid,
invalid_device_id,
invalid_device_model,
invalid_feedback_status,
invalid_line,
invalid_os_version,
invalid_phone_number,
invalid_sender_id,
invalid_template_id,
negative_balance,
no_associated_auth_found,
suspended_account,
unauthorized_sender_id,
unsupported_app_realm_device_type,
unsupported_region
Example:

"invalid_phone_number"

message
string

A human-readable message that describes the error.

Example:

"+0 is not a valid phone number"

doc_url
string

A link to the documentation that describes the error.

Example:

"https://docs.prelude.so/verify/v1/documentation/errors#invalid_phone_number"