{"basePath":"/v1/user","consumes":["application/json"],"definitions":{"AdditionalServiceCostType":{"enum":["amount","percentage","multiplier"],"type":"string"},"AdditionalServiceType":{"enum":["delivery","commission","tip"],"type":"string"},"AppleAuthRequestData":{"properties":{"client_id":{"description":"Apple Service ID","type":"string"},"create":{"default":false,"description":"Create/register new user if not exists","type":"boolean"},"credential":{"description":"User Apple authorization code","type":"string"},"link_by_email":{"default":true,"description":"Link Google credentials by email with the existing account","type":"boolean"},"user":{"$ref":"#/definitions/AppleAuthUserData","description":"User information returned by Apple","x-nullable":true}},"required":["client_id","credential"],"type":"object"},"AppleAuthUserData":{"properties":{"name":{"$ref":"#/definitions/AppleAuthUserNameData","description":"User information returned by Apple","x-nullable":true}},"type":"object"},"AppleAuthUserNameData":{"properties":{"firstName":{"description":"User first name","type":"string","x-nullable":true},"lastName":{"description":"User last name","type":"string","x-nullable":true}},"type":"object"},"BenefitsChargeTypeBase":{"enum":["regular-bonuses","promotional-bonuses","special-account"],"type":"string"},"BenefitsChargeTypeBaseNone":{"enum":["none","regular-bonuses","promotional-bonuses","special-account"],"type":"string"},"BenefitsChargeTypeExtended":{"enum":["none","regular-bonuses","promotional-bonuses","special-account","coupon"],"type":"string"},"BenefitsPriceType":{"enum":["bonuses","special-account"],"type":"string"},"BenefitsTopUpReferenceObjectType":{"enum":["loyalty-rule","external-system"],"type":"string"},"BillingInfo":{"properties":{"address":{"description":"Address (depends on the payment system)","type":"object"},"email":{"description":"Email","type":"string"},"name":{"description":"Name","type":"string"},"phone":{"description":"Phone number","type":"string"}},"type":"object"},"BonusAccountOperationType":{"enum":["bonus-add","bonus-write-offs","bonus-adjustment"],"type":"string"},"CardRecord":{"description":"Customer card record","properties":{"business_id":{"description":"Business ID","format":"uuid","type":"string","x-nullable":true},"code":{"description":"Card code","type":"string","x-nullable":true},"id":{"description":"Card id","format":"uuid","type":"string","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"photo":{"description":"Url of loyalty photo","type":"string","x-nullable":true},"scope":{"description":"Card scope","enum":["all","business","loyalty"],"type":"string","x-nullable":true},"title":{"description":"Card title, depends of scope (Loyalty name or Platform name)","type":"string","x-nullable":true}},"type":"object"},"CardRecordsList":{"items":{"$ref":"#/definitions/CardRecord"},"type":"array"},"CheckItemEnterMode":{"enum":["without-limits","presets-only","manually-only"],"type":"string"},"CustomPreferencesParameter":{"properties":{"name":{"description":"Preferences parameter name","type":"string"},"value":{"description":"Preferences parameter value","type":"object","x-nullable":true}},"type":"object"},"CustomPreferencesParameterRequest":{"properties":{"name":{"description":"Preferences parameter name","type":"string"}},"required":["name"],"type":"object"},"CustomerAccessType":{"enum":["full-bonuses-access","add-bonuses-only","waiting-for-confirmation","in-black-list"],"type":"string"},"CustomerFeedbackPrintOnCheck":{"enum":["none","qr-code","url","all"],"type":"string"},"DataRequiredType":{"enum":["no","yes","possible"],"type":"string"},"EmailRecord":{"description":"E-mail address record","properties":{"confirm":{"description":"Email address is confirmed","enum":[0,1],"type":"integer"},"id":{"description":"Email id (optional)","format":"uuid","type":"string"},"primary":{"description":"Email address is primary (used for access to account)","enum":[0,1],"type":"integer"},"value":{"description":"Email address","type":"string"}},"type":"object"},"EmailRecordsList":{"items":{"$ref":"#/definitions/EmailRecord"},"type":"array"},"EmailsList":{"items":{"description":"Email","type":"string"},"type":"array"},"ExternalCheckIdScope":{"enum":["system","business","loyalty","pos","terminal"],"type":"string"},"GoodsCodes":{"items":{"description":"goods code","type":"string"},"type":"array"},"GoodsPassThru":{"properties":{"fleet":{"$ref":"#/definitions/GoodsPassThruFleet","description":"PassThru data for Fleet","x-nullable":true}},"type":"object"},"GoodsPassThruFleet":{"properties":{"measure_unit":{"description":"Unit of measure","enum":["L","G"],"type":"string","x-nullable":true},"product_code":{"description":"NACS Product Code","type":"string","x-nullable":true}},"type":"object"},"GoogleAuthRequestData":{"properties":{"client_id":{"description":"Google OAuth 2.0 Client ID","type":"string"},"create":{"default":false,"description":"Create/register new user if not exists","type":"boolean"},"credential":{"description":"User Google ID token","type":"string"},"link_by_email":{"default":true,"description":"Link Google credentials by email with the existing account","type":"boolean"}},"required":["client_id","credential"],"type":"object"},"IdType":{"enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"type":"string"},"IdentifierValidationRequestObject":{"properties":{"value":{"description":"Identifier (phone number, email) value","type":"string","x-nullable":true}},"required":["value"],"type":"object"},"IdentifierVerificationRequestObject":{"properties":{"pin":{"description":"One-time code sent to recipient by identifier (optional)","type":"string","x-nullable":true},"recaptcha_token":{"description":"Protection recaptcha token","type":"string","x-nullable":true},"token":{"description":"Token previous verified object (optional, for phone verification only)","type":"string","x-nullable":true},"value":{"description":"Identifier (phone number, email) value","type":"string","x-nullable":true}},"required":["value"],"type":"object"},"IdentifierVerifiedObject":{"properties":{"expire":{"description":"Date and time of token expire (UTC)","format":"date-time","type":"string"},"token":{"description":"One-time token of verified object","type":"string"},"value":{"description":"Identifier (phone number, email) value","type":"string","x-nullable":true}},"required":["value"],"type":"object"},"ImageObject":{"properties":{"id":{"description":"Image asset ID","format":"uuid","type":"string","x-nullable":true},"url":{"description":"Image asset URL","type":"string","x-nullable":true}},"type":"object"},"ImageObjectsList":{"items":{"$ref":"#/definitions/ImageObject"},"type":"array"},"LoyaltyCategoriesList":{"items":{"$ref":"#/definitions/LoyaltyCategory"},"type":"array"},"LoyaltyCategory":{"properties":{"id":{"description":"ID","type":"integer"},"image_url":{"description":"Image URL (optional)","type":"string"},"title":{"description":"Title","type":"string"}},"type":"object"},"LoyaltyLinks":{"properties":{"facebook":{"type":"string"},"google":{"type":"string"},"instagram":{"type":"string"},"linkedin":{"type":"string"},"pinterest":{"type":"string"},"twitter":{"type":"string"},"vk":{"type":"string"},"web":{"type":"string"}},"type":"object"},"MessageResponse":{"properties":{"code":{"description":"Error code","format":"int32","type":"integer"},"description":{"description":"Error description","type":"string"},"message":{"description":"Error message","type":"string"},"recipient":{"description":"Recipien masked address (optional)","type":"string"}},"type":"object"},"MultiLanguageObject":{"description":"ISO language code / Value pairs","properties":{"az":{"type":"string","x-nullable":true},"de":{"type":"string","x-nullable":true},"en":{"type":"string","x-nullable":true},"fr":{"type":"string","x-nullable":true},"pl":{"type":"string","x-nullable":true},"ru":{"type":"string","x-nullable":true},"sk":{"type":"string","x-nullable":true},"uk":{"type":"string","x-nullable":true}},"type":"object"},"NotificationsSettings":{"properties":{"business":{"$ref":"#/definitions/NotificationsSettingsBusiness","description":"Deprecated"},"user":{"$ref":"#/definitions/NotificationsSettingsUser"}},"type":"object"},"NotificationsSettingsBusiness":{"properties":{"notify_balance_less_than_by_email":{"description":"Notify if balance less than specified value by Email (readonly if automatic type)","enum":[0,1],"type":"integer"},"notify_balance_less_than_by_push":{"description":"Notify if balance less than specified value by PUSH (readonly if automatic type)","enum":[0,1],"type":"integer"},"notify_balance_less_than_by_sms":{"description":"Notify if balance less than specified value by SMS (readonly if automatic type)","enum":[0,1],"type":"integer"},"notify_balance_less_than_type":{"description":"Low balance notification type","enum":["automatic","manual"],"type":"string"},"notify_balance_less_than_value":{"description":"Balance value for notifications less than (readonly if automatic type)","format":"float","type":"number"},"subscribe_incust_news":{"description":"Subscribe for inCust news","enum":[0,1],"type":"integer"}},"type":"object"},"NotificationsSettingsUser":{"properties":{"marketing_email":{"description":"Receive marketing Email","enum":[0,1],"type":"integer"},"marketing_sms":{"description":"Receive marketing SMS","enum":[0,1],"type":"integer"},"news_email":{"description":"Receive news Email","enum":[0,1],"type":"integer"},"transactional_sms":{"description":"Receive transactional SMS","enum":[0,1],"type":"integer"}},"type":"object"},"ObjectIds":{"items":{"description":"Object ID","format":"uuid","type":"string"},"type":"array"},"OdometerUnitType":{"enum":["K","M","H"],"type":"string"},"PhoneNumber":{"properties":{"number":{"description":"Phone number","type":"string"}},"type":"object"},"PhoneNumbersList":{"items":{"$ref":"#/definitions/PhoneNumber"},"type":"array"},"PhoneRecord":{"description":"Phone address record","properties":{"compact":{"description":"Phone number (E164 format)","type":"string"},"confirm":{"description":"Phone number is confirmed","enum":[0,1],"type":"integer"},"id":{"description":"Phone id","format":"uuid","type":"string"},"primary":{"description":"Phone number is primary (used for access to account)","enum":[0,1],"type":"integer"},"value":{"description":"Phone number (prettified international format)","type":"string"}},"type":"object"},"PhoneRecordsList":{"items":{"$ref":"#/definitions/PhoneRecord"},"type":"array"},"PinConfirmationResponse":{"properties":{"code":{"description":"Response code","format":"int32","type":"integer"},"description":{"description":"Error description","type":"string"},"info":{"properties":{"channel":{"description":"Confirmation channel","enum":["sms","email","external-system","external-verification-service"],"type":"string"},"code":{"description":"PIN-code (masked)","type":"string"},"length":{"description":"PIN-code length","type":"integer"},"recipient":{"description":"Recipien masked address","type":"string"}},"type":"object"},"message":{"description":"Response message","type":"string"},"recipient":{"description":"Recipien masked address","type":"string"}},"type":"object"},"PosCatalogPublicationState":{"enum":["none","requested","rejected","allowed"],"type":"string"},"PosType":{"enum":["pos","road-tanker","online-store"],"type":"string"},"PreProcessingResult":{"properties":{"protection_options":{"$ref":"#/definitions/ProtectionOptions"}},"type":"object"},"PrimaryIdentifierChangeObject":{"properties":{"pin":{"description":"Verification pin (optional)","type":"string"},"value":{"description":"Primary identifier value or verified token","type":"string"}},"required":["value"],"type":"object"},"PromotionalBonusesExpireType":{"enum":["none","date","day","month"],"type":"string"},"PromotionalBonusesExpireTypeBase":{"enum":["date","day","month"],"type":"string"},"PromotionalBonusesStartingType":{"enum":["immediately","date","day","month"],"type":"string"},"ProtectionOptions":{"properties":{"operation":{"description":"Protected action marker","enum":["signup_request","signup_process","signin_request","signin_process","verification_request","verification_process","identifier_change_request","identifier_change_process"],"type":"string"},"params":{"description":"Protection parameters (depends on protection type)","type":"object"},"protection":{"description":"Protection type ('none' - without protection)","enum":["none","recaptcha"],"type":"string"}},"type":"object"},"QRCode":{"properties":{"qrcode":{"description":"QR string.","type":"string"}},"type":"object"},"QrCodeLegacy":{"description":"Language object","properties":{"qr_v1_allowed":{"description":"QR Code version 1 alloved (readonly)","type":"boolean","x-nullable":true},"qr_v1_user_id":{"description":"User ID for QR code generation (readonly)","type":"string","x-nullable":true}},"type":"object"},"RewardGrantPeriodType":{"enum":["day","month"],"type":"string"},"RewardValueType":{"enum":["check-percentage","fixed-amount"],"type":"string"},"SignInRequestData":{"properties":{"login":{"description":"User phone number/email/external id or verified object token.","minLength":3,"type":"string"},"password":{"description":"User password","type":"string","x-nullable":true},"type":{"description":"Login type (optional)","enum":["business","client"],"type":"string","x-nullable":true}},"required":["login"],"type":"object"},"SignUpRequestData":{"properties":{"country":{"description":"User country","type":"string","x-nullable":true},"external_id":{"description":"User external Id or verified object token (maximum 128 chars)","type":"string","x-nullable":true},"login":{"description":"User email or verified object token (minimum 3 chars, maximum 80 chars)","type":"string","x-nullable":true},"name":{"description":"User public name (maximum 128 chars)","type":"string","x-nullable":true},"password":{"description":"User login password","type":"string","x-nullable":true},"phone":{"description":"User phone number or verified object token (maximum 20 chars)","type":"string","x-nullable":true},"pincode":{"description":"Secure pin code","type":"string","x-nullable":true},"type":{"description":"Registration type (optional)","enum":["business","client"],"type":"string","x-nullable":true}},"type":"object"},"SocialIdentityProviderRecord":{"description":"Social network record","properties":{"id":{"description":"Social Identity Providers unique identifier","type":"string"},"type":{"description":"Social Identity Provider type","enum":["google"],"type":"string"}},"type":"object"},"SocialIdentityProviderRecordsList":{"items":{"$ref":"#/definitions/SocialIdentityProviderRecord"},"type":"array"},"SortDirection":{"enum":["asc","desc"],"type":"string"},"SpecialAccountCreditType":{"enum":["debit","credit","credit-unlimited"],"type":"string"},"SpecialAccountOperationType":{"enum":["special-account-refill","special-account-write-offs","special-account-adjustment"],"type":"string"},"SpecialAccountType":{"enum":["money","goods","punches"],"type":"string"},"StringValuesList":{"items":{"description":"Value","type":"string"},"type":"array"},"TemporaryCode":{"properties":{"code":{"description":"Temporary code","type":"string"},"redeem_allowed":{"description":"Allowed redeem bonuses or special account flag","type":"boolean"}},"type":"object"},"TerminalEventStatusCode":{"enum":["terminal-sign-in-awaiting","staff-sign-in-awaiting","customer-awaiting","customer-processing","refueling-started","refueling-finished","terminal-settings-processing","customer-tap-splashscreen","payment-process"],"type":"string"},"TerminalType":{"enum":["register","steward","validator","prepaid-services","road-tanker-driver","kiosk","kiosk-and-register"],"type":"string"},"ThresholdsValue":{"properties":{"threshold":{"description":"Threshold","format":"float","type":"number","x-nullable":true},"value":{"description":"Value","format":"float","type":"number","x-nullable":true}},"required":["threshold","value"],"type":"object"},"ThresholdsValues":{"description":"Values set based on thresholds","items":{"$ref":"#/definitions/ThresholdsValue"},"type":"array"},"Token":{"properties":{"access":{"description":"Token access by type.","enum":["owner","admin","business-staff"],"type":"string"},"access_scopes":{"$ref":"#/definitions/TokenAccessScopes","description":"Token access scopes."},"owned_by_trusted_system":{"description":"Is user owned (created) by trusted system (optional, only for auth by trusted system).","type":"boolean"},"owner":{"description":"Signed in as owner.","type":"boolean"},"token":{"description":"Token for next authorization requests.","type":"string"},"user":{"$ref":"#/definitions/UserProfile"}},"type":"object"},"TokenAccessScopes":{"items":{"enum":["administration","payments","security"],"type":"string"},"type":"array"},"TransactionPaymentType":{"enum":["currency","special-account","corporate-special-account-access","retail-special-account-access"],"type":"string"},"TransactionReceiptTemplateType":{"enum":["business","customer","commercial"],"type":"string"},"TransactionSubType":{"enum":["sale","special-account-refill","special-account-refill-direct","special-account-refill-by-customer","special-account-write-offs-direct","special-account-write-offs-loan","special-account-write-offs-scheduled"],"type":"string"},"TransactionType":{"enum":["reserve","presale","sale","cancel","redeem-giftcard","bonus-add","special-account-refill","coupon-sale","authorize-payment","bonus-write-offs","special-account-write-offs"],"type":"string"},"TrustedAuthRequestData":{"properties":{"create":{"default":false,"description":"Create/register new user if not exists","type":"boolean"},"system":{"description":"Trusted system type","type":"string"},"token":{"description":"User token from trusted system","type":"string"}},"required":["system","token"],"type":"object"},"UserGender":{"enum":["male","female","other"],"type":"string"},"UserLanguage":{"description":"Language object","properties":{"changed":{"description":"language changed (optional, for language change operation only, readonly)","type":"boolean"},"language":{"description":"language ISO code","type":"string"}},"required":["language"],"type":"object"},"UserProfile":{"properties":{"avatar":{"description":"User avatar url","type":"string","x-nullable":true},"birth_date":{"description":"user date of birth","format":"date","type":"string","x-nullable":true},"cards":{"$ref":"#/definitions/CardRecordsList","description":"List of users customer cards","x-nullable":true},"country":{"description":"ISO code of country","type":"string","x-nullable":true},"emails":{"$ref":"#/definitions/EmailRecordsList","description":"List of users Emails","x-nullable":true},"external_id":{"description":"User external id (maximum 128 chars)","type":"string","x-nullable":true},"gender":{"$ref":"#/definitions/UserGender","description":"User gender","x-nullable":true},"id":{"description":"User ID","format":"uuid","type":"string","x-nullable":true},"language":{"description":"ISO code of language","type":"string","x-nullable":true},"login":{"description":"User primary email for access to account (User login)  (maximum 80 chars)","type":"string","x-nullable":true},"marketing_email":{"description":"Allow send marketing emails to the user","enum":[0,1],"type":"integer","x-nullable":true},"marketing_sms":{"description":"Allow send marketing SMS to the user","enum":[0,1],"type":"integer","x-nullable":true},"name":{"description":"Public user Name (maximum 128 chars)","type":"string","x-nullable":true},"news_email":{"description":"Allow send news emails to the user","enum":[0,1],"type":"integer","x-nullable":true},"password_exist":{"description":"Password exist (optional)","type":"boolean","x-nullable":true},"phone":{"description":"User primary phone number for access to account  (maximum 20 chars)","type":"string","x-nullable":true},"phones":{"$ref":"#/definitions/PhoneRecordsList","description":"List of users phones","x-nullable":true},"qr_legacy":{"$ref":"#/definitions/QrCodeLegacy","description":"QR code legacy info (readonly) (optional)","x-nullable":true},"qr_secret_key":{"description":"Secret key for QR code generation (readonly) (optional)","type":"string","x-nullable":true},"qr_user_id":{"description":"User ID for QR code generation (readonly) (optional)","type":"string","x-nullable":true},"qr_version":{"description":"Current version of QR code (readonly) (optional)","type":"integer","x-nullable":true},"social_identity_providers":{"$ref":"#/definitions/SocialIdentityProviderRecordsList","description":"List of users social networks","x-nullable":true},"transactional_sms":{"description":"Allow send transactional SMS to the user","enum":[0,1],"type":"integer","x-nullable":true},"welcome_message_sent":{"description":"Welcome message sent to the user","enum":[0,1],"type":"integer","x-nullable":true}},"type":"object"},"UserShipToAddress":{"properties":{"address":{"description":"Address string","type":"string"},"first_name":{"description":"First name","type":"string"},"id":{"description":"Address ID","format":"uuid","type":"string"},"last_name":{"description":"Last name","type":"string"},"phone":{"description":"Phone number","type":"string"}},"required":["first_name","phone","address"],"type":"object"},"UserStatus":{"enum":["deleted","blocked","banned","suspended","registered","active"],"type":"string"},"UserStatusForAdmin":{"enum":["deleted","blocked","banned","suspended","registered","activated"],"type":"string"},"UserVehicle":{"properties":{"color":{"description":"Vehicle color","type":"string"},"created":{"description":"Vehicle added date and time (read only)","format":"date-time","type":"string","x-nullable":true},"fuel_tank_cap_locked":{"default":0,"description":"Fuel cap locked flag","enum":[0,1],"type":"integer"},"id":{"description":"Vehicle ID","format":"uuid","type":"string","x-nullable":true},"model":{"description":"Vehicle model","type":"string","x-nullable":true},"photo":{"$ref":"#/definitions/ImageObject","description":"Photo image object (optional)","x-nullable":true},"plate_number":{"description":"Vehicle plate number","type":"string","x-nullable":true},"type":{"description":"Vehicle type","enum":["car","suv","truck","van","equipment"],"type":"string"}},"type":"object"},"UserVehiclesList":{"items":{"$ref":"#/definitions/UserVehicle"},"type":"array"},"VolumeUnitType":{"enum":["L","G"],"type":"string"},"WeekDaysList":{"items":{"description":"Day of week","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"type":"string"},"type":"array"}},"info":{"description":"API for user management  \n\n\n### Methods\n`GET`: \t\tRetrieve resources  \n`POST`:\t\tCrete resources      `PATCH`:\tUpdate resources\n\n**Why use PATCH rather than a PUT?**\n`JLab13`: I think PATCH method is the correct choice for updating an\nexisting resources. PUT should only be used if you're replacing a \nresource in its entirety.\n\nFurther information on partial resource modification is available in\n[RFC 5789](http://tools.ietf.org/html/rfc5789). Specifically, the\nPUT method is described as follows:\n\n> Several applications extending the Hypertext Transfer Protocol (HTTP)\n> require a feature to do partial resource modification. The existing\n> HTTP PUT method only allows a complete replacement of a document. \n> This proposal adds a new HTTP method, PATCH, to modify an\n> existing HTTP resource.  \n\n### X-Application-Type HTTP Header\nAll requests must contain a header **X-Application-Type**.  \nThis header defines the type of application that makes the request.  \n\n**Available values:**  \n`web`: \t\t    application that runs in browser as web application  \n`android`: \t\tapplication that runs on android as android application  \n`ios`: \t\t    application that runs on iPhone/iPad/etc as iOS application  \n`windows`: \t\tapplication that runs on windows as windows application  \n`chatbot`: \t    application that runs as chatbot\n`external`: \texternal application and systems which itegrated with inCust API\n","title":"inCust User API","version":"1.0"},"paths":{"/avatar":{"post":{"consumes":["image/jpeg","image/png"],"description":"Set user avatar. Alloved ContentType (image/jpeg, image/png)","operationId":"incust.controllers.user.store_avatar","parameters":[{"description":"Octet stream","in":"body","name":"data","required":true,"schema":{"description":"stream"}}],"responses":{"200":{"description":"Profile data","schema":{"$ref":"#/definitions/UserProfile"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["User"]}},"/change_password":{"post":{"description":"Change user password","operationId":"incust.controllers.user.change_password","parameters":[{"description":"First account data","in":"body","name":"data","required":true,"schema":{"properties":{"password":{"description":"Password","minLength":4,"type":"string"}},"required":["password"],"type":"object"}}],"responses":{"200":{"description":"Response TOKEN","schema":{"$ref":"#/definitions/Token"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["User"],"x-application-access-scope-restriction":{"allowed":["security"]}}},"/confirm_email/{email_token}":{"get":{"description":"Confirm mail","operationId":"incust.controllers.user.confirm_email","parameters":[{"description":"Protected data","in":"path","name":"email_token","required":true,"type":"string"}],"responses":{"200":{"description":"Email info","schema":{"$ref":"#/definitions/EmailRecord"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Auth Identifiers"]}},"/custom/preferences":{"patch":{"description":"Set custom preferences parameter by name","operationId":"incust.controllers.user.user_preferences_set","parameters":[{"description":"Parameter data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomPreferencesParameter"}}],"responses":{"202":{"description":"Parameter data","schema":{"$ref":"#/definitions/CustomPreferencesParameter"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["User"]},"post":{"description":"Get custom preferences parameter by name","operationId":"incust.controllers.user.user_preferences_get","parameters":[{"description":"Parameter data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomPreferencesParameterRequest"}}],"responses":{"202":{"description":"Parameter data","schema":{"$ref":"#/definitions/CustomPreferencesParameter"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["User"]}},"/deactivate":{"delete":{"description":"Deactivate user account","operationId":"incust.controllers.user.deactivate","responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["User"],"x-application-access-scope-restriction":{"allowed":["security"]}}},"/email/change":{"post":{"description":"Change user primary email (login)","operationId":"incust.controllers.user.change_primary_email","parameters":[{"description":"New Email","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PrimaryIdentifierChangeObject"}}],"responses":{"200":{"description":"Profile data","schema":{"$ref":"#/definitions/UserProfile"}},"202":{"description":"Send email with pin code for verification","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Auth Identifiers"],"x-application-access-scope-restriction":{"allowed":["security"]}}},"/email/change/pre":{"post":{"description":"Change user primary email (login) pre-processing","operationId":"incust.controllers.user.change_primary_email_pre_processing","parameters":[{"description":"New Email","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PrimaryIdentifierChangeObject"}}],"responses":{"200":{"description":"Pre-processing result","schema":{"$ref":"#/definitions/PreProcessingResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Auth Identifiers"],"x-application-access-scope-restriction":{"allowed":["security"]}}},"/email/validate":{"post":{"description":"Check email for correctness and uniqueness","operationId":"incust.controllers.user.validate_email","parameters":[{"description":"Email for validation","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/IdentifierValidationRequestObject"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Auth Identifiers"]}},"/email/verify":{"post":{"description":"Check email for correctness and uniqueness and verify","operationId":"incust.controllers.user.verify_email","parameters":[{"description":"Email for verification","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/IdentifierVerificationRequestObject"}}],"responses":{"200":{"description":"Verified email","schema":{"$ref":"#/definitions/IdentifierVerifiedObject"}},"202":{"description":"Sent email with pin code for verification","schema":{"$ref":"#/definitions/PinConfirmationResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Auth Identifiers"]}},"/email/verify/pre":{"post":{"description":"Check email for correctness and uniqueness and verify pre-processing","operationId":"incust.controllers.user.verify_email_pre_processing","parameters":[{"description":"Email for verification","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/IdentifierVerificationRequestObject"}}],"responses":{"200":{"description":"Pre-processing result","schema":{"$ref":"#/definitions/PreProcessingResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Auth Identifiers"]}},"/external_id/change":{"post":{"description":"Change user external ID","operationId":"incust.controllers.user.change_primary_external_id","parameters":[{"description":"New external ID","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PrimaryIdentifierChangeObject"}}],"responses":{"200":{"description":"Profile data","schema":{"$ref":"#/definitions/UserProfile"}},"202":{"description":"Send message with pin code for verification","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Auth Identifiers"],"x-application-access-scope-restriction":{"allowed":["security"]}}},"/external_id/change/pre":{"post":{"description":"Change user external ID pre-processing","operationId":"incust.controllers.user.change_primary_external_id_pre_processing","parameters":[{"description":"New external ID","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PrimaryIdentifierChangeObject"}}],"responses":{"200":{"description":"Pre-processing result","schema":{"$ref":"#/definitions/PreProcessingResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Auth Identifiers"],"x-application-access-scope-restriction":{"allowed":["security"]}}},"/external_id/validate":{"post":{"description":"Check external ID for uniqueness","operationId":"incust.controllers.user.validate_external_id","parameters":[{"description":"External ID number for validation","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/IdentifierValidationRequestObject"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Auth Identifiers"]}},"/external_id/verify":{"post":{"description":"Check external ID for uniqueness and verify","operationId":"incust.controllers.user.verify_external_id","parameters":[{"description":"External ID number for verification","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/IdentifierVerificationRequestObject"}}],"responses":{"200":{"description":"Verified external ID number","schema":{"$ref":"#/definitions/IdentifierVerifiedObject"}},"202":{"description":"Sent message with pin code for verification","schema":{"$ref":"#/definitions/PinConfirmationResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Auth Identifiers"]}},"/external_id/verify/pre":{"post":{"description":"Check external ID for uniqueness and verify pre-processing","operationId":"incust.controllers.user.verify_external_id_pre_processing","parameters":[{"description":"External ID number for verification","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/IdentifierVerificationRequestObject"}}],"responses":{"200":{"description":"Pre-processing result","schema":{"$ref":"#/definitions/PreProcessingResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Auth Identifiers"]}},"/incust_support":{"post":{"description":"Make e-mail for inCust support","operationId":"incust.controllers.user.incust_support","parameters":[{"description":"First account data","in":"body","name":"data","required":true,"schema":{"properties":{"subject":{"description":"Subject of email","type":"string"}},"type":"object"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["User"]}},"/language":{"get":{"description":"Return user language","operationId":"incust.controllers.user.language_get","responses":{"200":{"description":"Language data","schema":{"$ref":"#/definitions/UserLanguage"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["User"]},"patch":{"description":"Change and return modifyed user language","operationId":"incust.controllers.user.language_patch","parameters":[{"description":"Language data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/UserLanguage"}}],"responses":{"200":{"description":"Profile data","schema":{"$ref":"#/definitions/UserLanguage"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["User"]}},"/notifications_settings":{"get":{"description":"Return user notifications settings - DEPRECATED","operationId":"incust.controllers.user.notifications_settings","responses":{"200":{"description":"User notification settings","schema":{"$ref":"#/definitions/NotificationsSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["User"]},"patch":{"description":"Modify user notifications settings - DEPRECATED","operationId":"incust.controllers.user.notifications_settings_edit","parameters":[{"description":"Account data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/NotificationsSettings"}}],"responses":{"200":{"description":"User notification settings","schema":{"$ref":"#/definitions/NotificationsSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["User"],"x-application-access-scope-restriction":{"forbidden":["administration"]}}},"/phone/change":{"post":{"description":"Change user primary phone","operationId":"incust.controllers.user.change_primary_phone","parameters":[{"description":"New Phone number","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PrimaryIdentifierChangeObject"}}],"responses":{"200":{"description":"Profile data","schema":{"$ref":"#/definitions/UserProfile"}},"202":{"description":"Send email with pin code for verification","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Auth Identifiers"],"x-application-access-scope-restriction":{"allowed":["security"]}}},"/phone/change/pre":{"post":{"description":"Change user primary phone pre-processing","operationId":"incust.controllers.user.change_primary_phone_pre_processing","parameters":[{"description":"New Phone number","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PrimaryIdentifierChangeObject"}}],"responses":{"200":{"description":"Pre-processing result","schema":{"$ref":"#/definitions/PreProcessingResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Auth Identifiers"],"x-application-access-scope-restriction":{"allowed":["security"]}}},"/phone/validate":{"post":{"description":"Check phone for correctness and uniqueness","operationId":"incust.controllers.user.validate_phone","parameters":[{"description":"Phone number for validation","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/IdentifierValidationRequestObject"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Auth Identifiers"]}},"/phone/verify":{"post":{"description":"Check phone for correctness and uniqueness and verify","operationId":"incust.controllers.user.verify_phone","parameters":[{"description":"Phone number for verification","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/IdentifierVerificationRequestObject"}}],"responses":{"200":{"description":"Verified phone number","schema":{"$ref":"#/definitions/IdentifierVerifiedObject"}},"202":{"description":"Sent sms with pin code for verification","schema":{"$ref":"#/definitions/PinConfirmationResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Auth Identifiers"]}},"/phone/verify/pre":{"post":{"description":"Check phone for correctness and uniqueness and verify pre-processing","operationId":"incust.controllers.user.verify_phone_pre_processing","parameters":[{"description":"Phone number for verification","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/IdentifierVerificationRequestObject"}}],"responses":{"200":{"description":"Pre-processing result","schema":{"$ref":"#/definitions/PreProcessingResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Auth Identifiers"]}},"/profile":{"get":{"description":"Return user profile","operationId":"incust.controllers.user.profile_get","responses":{"200":{"description":"Profile data","schema":{"$ref":"#/definitions/UserProfile"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["User"]},"patch":{"description":"Change and return modifyed user profile","operationId":"incust.controllers.user.profile_patch","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/UserProfile"}}],"responses":{"200":{"description":"Profile data","schema":{"$ref":"#/definitions/UserProfile"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["User"]}},"/qrcode":{"get":{"description":"Generate qrcode","operationId":"incust.controllers.user.qrcode_generate","parameters":[{"description":"QR code version","enum":[1,2],"in":"query","name":"version","required":false,"type":"integer"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["QrCode"],"x-application-access-scope-restriction":{"allowed":["security"]}}},"/register":{"post":{"description":"If pincode not set then send sms with pin code, owerviese create new user, return token and user profile.","operationId":"incust.controllers.user.register","parameters":[{"description":"First account data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/SignUpRequestData"}}],"responses":{"201":{"description":"Response TOKEN","schema":{"$ref":"#/definitions/Token"}},"202":{"description":"Sent pin code for access","schema":{"$ref":"#/definitions/PinConfirmationResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Auth"]}},"/register/pre":{"post":{"description":"User register pre-processing","operationId":"incust.controllers.user.register_pre_processing","parameters":[{"description":"First account data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/SignUpRequestData"}}],"responses":{"200":{"description":"Pre-processing result","schema":{"$ref":"#/definitions/PreProcessingResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Auth"]}},"/request_confirm_email/{email}":{"get":{"description":"Request confirm  mail","operationId":"incust.controllers.user.request_confirm_email","parameters":[{"description":"User email","in":"path","name":"email","required":true,"type":"string"},{"description":"Specify if request from CLIENT site-part","in":"query","name":"client","required":false,"type":"string"}],"responses":{"200":{"description":"Information message"}},"tags":["Auth Identifiers"],"x-application-access-scope-restriction":{"allowed":["security"]}}},"/shipto_addresses":{"get":{"description":"Return user ship to addresses","operationId":"incust.controllers.user.shipto_addresses_get","responses":{"200":{"description":"Ship to address data array","schema":{"items":{"$ref":"#/definitions/UserShipToAddress"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Shipping and Delivery"]},"post":{"description":"Add user ship to address","operationId":"incust.controllers.user.shipto_address_add","parameters":[{"description":"Ship to address data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/UserShipToAddress"}}],"responses":{"200":{"description":"Ship to address data array","schema":{"items":{"$ref":"#/definitions/UserShipToAddress"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Shipping and Delivery"]}},"/shipto_addresses/{address_id}":{"delete":{"description":"Delete user ship to address","operationId":"incust.controllers.user.shipto_address_delete","parameters":[{"description":"Address id","in":"path","name":"address_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ship to address data array","schema":{"items":{"$ref":"#/definitions/UserShipToAddress"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Shipping and Delivery"]},"patch":{"description":"Edit user ship to address","operationId":"incust.controllers.user.shipto_address_edit","parameters":[{"description":"Address id","in":"path","name":"address_id","required":true,"type":"string"},{"description":"Ship to address data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/UserShipToAddress"}}],"responses":{"200":{"description":"Ship to address data array","schema":{"items":{"$ref":"#/definitions/UserShipToAddress"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Shipping and Delivery"]}},"/social_login/apple/token":{"post":{"description":"User authentication via Apple Auth. If the user does not exist, a user is created if this is enabled.","operationId":"incust.controllers.user.auth_social_login_apple","parameters":[{"description":"User auth data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/AppleAuthRequestData"}}],"responses":{"200":{"description":"Response TOKEN","schema":{"$ref":"#/definitions/Token"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Social Login"]}},"/social_login/google/token":{"post":{"description":"User authentication via Google Auth. If the user does not exist, a user is created if this is enabled.","operationId":"incust.controllers.user.auth_social_login_google","parameters":[{"description":"User auth data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/GoogleAuthRequestData"}}],"responses":{"200":{"description":"Response TOKEN","schema":{"$ref":"#/definitions/Token"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Social Login"]}},"/token":{"post":{"description":"Check existing user and if valid return token and user profile. Can be use as e-mail/password or phone/pin.","operationId":"incust.controllers.user.token","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/SignInRequestData"}}],"responses":{"200":{"description":"Response TOKEN","schema":{"$ref":"#/definitions/Token"}},"202":{"description":"Sent pin code for access","schema":{"$ref":"#/definitions/PinConfirmationResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Auth"]}},"/token/pre":{"post":{"description":"Authorize user pre-processing","operationId":"incust.controllers.user.token_pre_processing","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/SignInRequestData"}}],"responses":{"200":{"description":"Pre-processing result","schema":{"$ref":"#/definitions/PreProcessingResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Auth"]}},"/token/renew":{"get":{"description":"Renew and return new token and user profile.","operationId":"incust.controllers.user.token_renew","responses":{"200":{"description":"Response TOKEN","schema":{"$ref":"#/definitions/Token"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Auth"]}},"/trusted/token":{"post":{"description":"Check existing user by trusted system token and if valid return token and user profile. Create/register new user if needed.","operationId":"incust.controllers.user.token_by_trusted_system","parameters":[{"description":"User auth data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TrustedAuthRequestData"}}],"responses":{"200":{"description":"Response TOKEN (Sign In)","schema":{"$ref":"#/definitions/Token"}},"201":{"description":"Response TOKEN (Sign Up)","schema":{"$ref":"#/definitions/Token"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Auth"]}},"/vehicles":{"get":{"description":"Return user's vehicles list","operationId":"incust.controllers.user_vehicle.vehicles_get","responses":{"200":{"description":"Vehicles data array","schema":{"$ref":"#/definitions/UserVehiclesList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["User's Vehicles"]},"post":{"description":"Add user's vehicle","operationId":"incust.controllers.user_vehicle.vehicle_add","parameters":[{"description":"Vehicle data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/UserVehicle"}}],"responses":{"200":{"description":"Vehicle data","schema":{"$ref":"#/definitions/UserVehicle"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["User's Vehicles"]}},"/vehicles/{vehicle_id}":{"delete":{"description":"Delete user's vehicle","operationId":"incust.controllers.user_vehicle.vehicle_delete","parameters":[{"description":"Vehicle Id","format":"uuid","in":"path","name":"vehicle_id","required":true,"type":"string"}],"responses":{"200":{"description":"Vehicles data array","schema":{"$ref":"#/definitions/UserVehiclesList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["User's Vehicles"]},"get":{"description":"Return user's vehicle info","operationId":"incust.controllers.user_vehicle.vehicle_get","parameters":[{"description":"Vehicle Id","format":"uuid","in":"path","name":"vehicle_id","required":true,"type":"string"}],"responses":{"200":{"description":"Vehicle data","schema":{"$ref":"#/definitions/UserVehicle"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["User's Vehicles"]},"patch":{"description":"Edit user's vehicle info","operationId":"incust.controllers.user_vehicle.vehicle_edit","parameters":[{"description":"Vehicle Id","format":"uuid","in":"path","name":"vehicle_id","required":true,"type":"string"},{"description":"Vehicle data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/UserVehicle"}}],"responses":{"200":{"description":"Vehicle data","schema":{"$ref":"#/definitions/UserVehicle"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["User's Vehicles"]}},"/vehicles/{vehicle_id}/photo":{"delete":{"description":"Delete user's vehicle photo","operationId":"incust.controllers.user_vehicle.vehicle_photo_delete","parameters":[{"description":"Vehicle Id","format":"uuid","in":"path","name":"vehicle_id","required":true,"type":"string"}],"responses":{"200":{"description":"Vehicle data","schema":{"$ref":"#/definitions/UserVehicle"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["User's Vehicles"]},"post":{"consumes":["image/jpeg","image/png"],"description":"Set user's vehicle photo. Allowed ContentType (image/jpeg, image/png)","operationId":"incust.controllers.user_vehicle.vehicle_photo_store","parameters":[{"description":"Vehicle Id","format":"uuid","in":"path","name":"vehicle_id","required":true,"type":"string"},{"description":"Octet stream","in":"body","name":"data","required":true,"schema":{"description":"stream"}}],"responses":{"200":{"description":"Vehicle data","schema":{"$ref":"#/definitions/UserVehicle"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["User's Vehicles"]}}},"produces":["application/json"],"schemes":["https","http"],"securityDefinitions":{"bearer":{"in":"header","name":"Authorization","type":"apiKey","x-apikeyInfoFunc":"incust.auth.apikey_auth"}},"swagger":"2.0"}