Cold storage API
Swagger UI has display inconsistencies with the dark page theme.
Use the light theme to view the API definition.
Errors
Shield API returns various error codes depending on the type of failure encountered. Each error response includes an HTTP status code, an error code, and a descriptive message.
{ "message" : "Error description" , "code" : "ERROR_CODE" } OTP errors
HTTP Status Error Code Message 429 OTP_RATE_LIMITRate limit exceeded to generate OTP 422 OTP_EXPIREDOTP is expired 400 OTP_INVALIDATEDOTP invalidated after max failed attempts 400 OTP_INVALIDReceived otp is invalid 400 OTP_REQUESTED_BUT_NOT_SENTOTP was requested but not sent 428 OTP_MISSINGOTP is required for this request 404 OTP_RECORD_NOT_FOUNDOTP record not found for user 400 OTP_USER_INFO_MISSINGMissing user information like email or phone number 400 OTP_NOT_SUPPORTEDProject doesn't support OTP 409 OTP_ALREADY_ENABLEDProject already has OTP enabled
Project errors
HTTP Status Error Code Message 404 PJ_NOT_FOUNDProject not found 409 EC_EXISTSEncryption part already exists 409 EC_MISSINGThe requested share have project entropy and encryption part is required 400 EC_INVALIDInvalid encryption part 400 EC_INVALIDInvalid encryption session
Share errors
HTTP Status Error Code Message 404 SH_NOT_FOUNDShare not found 409 SH_EXISTSShare already exists
User errors
HTTP Status Error Code Message 404 US_NOT_FOUNDUser not found 404 US_EXT_NOT_FOUNDExternal user not found 409 US_EXT_EXISTSExternal user already exists 400 USER_CONTACTS_MISMATCHUser contact information mismatch 400 EMAIL_INVALIDProvided Email is invalid 400 PHONE_INVALIDProvided phone number is invalid
Provider errors
HTTP Status Error Code Message 400 PV_UNKNOWNUnknown provider type 400 PV_MISSINGMissing provider 404 PV_NOT_FOUNDProvider not found 400 PV_CFG_INVALIDInvalid provider config 400 PV_CFG_INVALIDMissing key type 400 PV_CFG_INVALIDInvalid PEM certificate 409 PV_CFG_INVALIDJWK and PEM cannot be set at the same time 409 PV_EXISTSCustom authentication already registered for this project
Authentication errors
HTTP Status Error Code Message 401 A_MISSINGMissing API key 401 A_MISSINGMissing API secret 401 A_MISSINGMissing token 401 A_MISSINGMissing auth provider 401 A_INVALIDInvalid API key or API secret 401 A_INVALIDInvalid token 401 A_INVALIDInvalid auth provider
General errors
HTTP Status Error Code Message 500 INTERNALInternal error 500 MISSING_NOTIFICATION_SERVMissing notification service 400 BAD_REQUESTVarious messages
