Skip to content

HTTP API

When an API response fails for any reason, a 4xx or 5xx error will always be provided with an object in the error schema format. The HTTP response code is determined based on the associated HTTP status code for the Autopilot error code in the base object. Any codes within the Error Detail schema will have no effect on the HTTP status code.

Optionally, when applicable, Autopilot will also contain an errors key inside of the error schema with information about specific field validation, and as much other information that Autopilot is able to provide regarding the reason for the request failure. If an error is being forwarded from a 3rd party (such as from a payment or payout provider). Autopilot may not always be able to provide precise information about the reason of the failure.

FieldTypeDescription
codestringThe Autopilot error code.
errorserror detail[]Sub-errors providing more error contextual information.
messagestringError explanation
FieldTypeDescription
codestringThe Autopilot error code.
location?stringThe location of the error in the request input, provided when performing during request validation
metadata?objectThe request validation parameters
messagestringError explanation
CODEMESSAGEHTTP STATUS CODE
UnknownAn unknown error has occured.500
EntityNotFoundEntity not found.404
UnauthenticatedUnauthenticated.401
InsufficientPermissionsInsufficient permissions.403
InvalidIdempotencyKeyInvalid idempotency key. Length must be between 12 and 36 characters400
IdempotencyKeyNotAllowedIdempotency is not supported for this HTTP method.400
InvalidBodyInvalid request body400
RequiredThis field is required.400
InvalidValueInvalid value provided.400
InvalidDateInvalid date format.400
InvalidDateTimeInvalid datetime format.400
InvalidTimeInvalid time format.400
InvalidEmailInvalid email address.400
InvalidHostnameInvalid hostname.400
InvalidIPv4Invalid IPv4 address.400
InvalidIPv6Invalid IPv6 address.400
InvalidUUIDInvalid UUID.400
InvalidURIInvalid URI.400
InvalidPublicKeyInvalid public key.400
MissingLowercaseExpected at least one lowercase letter.400
MissingUppercaseExpected at least one uppercase letter.400
MissingNumberExpected at least one number.400
MissingSpecialExpected at least one special character.400
TooShortLength is too short.400
TooLongLength is too long.400
DuplicateItemsDuplicate items are not allowed.400
TooSmallValue is too small.400
TooLargeValue is too large.400
InvalidImageFormatInvalid image format.400
InvalidCursorInvalid cursor format400
InvalidTurnstileTokenInvalid Turnstile token.401
FailedToVerifyTurnstileTokenFailed to verify Turnstile token.401
InvalidCurrencyInvalid currency code.400
InvalidCountryInvalid country code.400
InvalidFinancialAmountInvalid financial amount.400
ProviderNotFoundProvider not found.404
ProviderUnavailableProvider is not available at this time.503
UnsupportedProviderUnsupported provider for specified method.400
UnsupportedProviderCountryCurrencyUnsupported provider for specified country and currency.422
ProviderNotConfiguredProvider not configured by entity.422
ProviderFailedProvider could not process transaction.503
InvalidPayoutMethodInvalid payout method type provided.422
TransactionNotFoundTransaction not found.404
ClientReferenceIDUnavailableThe provided client reference ID is already used.409
ProcessorErrorUnknown processor error.503
InvalidTransactionAmountInvalid request amount provided400
InvalidBeneficiaryInvalid beneficiary details.422
InvalidSenderInvalid sender details.422
AccountLockedThe account is temporarily locked.429
EmailNotVerifiedEmail verification is required.401
InvalidCredentialsInvalid login credentials.401
InvalidRefreshTokenInvalid refresh token.401
APIKeyNotFoundAPI key not found.404
APIKeyExpiredAPI key has expired.401
APIKeyMissingEntityAPI key has no associated entity.401
InvalidAPIKeyModeInvalid API key mode422
InvalidNameInvalid API key name422
InvalidAPIKeyTokenInvalid API key token422
ConnectionNotFoundConnection not found.404
InvalidConnectionCredentialsInvalid connection credentials.422
InvalidConnectionWebhookSlugThe specified webhook slug is not available.422
WebhookNotFoundWebhook not found.404
InvalidWebhookEventInvalid webhook event.422
EmailExistsEmail already exists.422
InvalidOrExpiredTokenThe verification token is invalid or expired.401
UserNotFoundUser not found.404
InvalidTwoFactorCodeInvalid two-factor code.401
TwoFactorNotEnabledTwo-factor authentication is not enabled.400
TwoFactorAlreadyEnabledTwo-factor authentication is already enabled.400
TwoFactorPendingTwo-factor authentication verification pending.400
BackupCodeValidationInvalid or used backup code.401
TwoFactorLockedTwo-factor authentication is locked.429