POST

/v1/login

X-Violet-App-Secret
X-Violet-App-Id
curl --request POST \
  --url https://sandbox-api.violet.io/v1/login
{
  "country_code": "US",
  "date_created": "string",
  "date_last_modified": "string",
  "email": "string",
  "first_name": "string",
  "id": "integer",
  "last_name": "string",
  "merchant_id": "integer",
  "merchant_ids": [
    "integer"
  ],
  "password": "string",
  "payment_configured": "boolean",
  "privacy_policy_accepted": "boolean",
  "refresh_token": "string",
  "roles": [
    {
      "name": "string",
      "permissions": [
        {
          "description": "string",
          "name": "string"
        }
      ]
    }
  ],
  "status": "INACTIVE",
  "store_url": "string",
  "token": "string",
  "tos_accepted": "boolean",
  "type": "ADMIN",
  "verified": "boolean"
}

Login to Violet using your App Secret and App Id, retrieved from channel.violet.io. This is required to receive an App Token, which is used to authenticate requests made to violet.

Headers

X-Violet-App-Secret
string
X-Violet-App-Id
integer

Response

200 - application/json
country_code
enum<string>

Country Code

Available options:
US,
AU,
AT,
BE,
CA,
DK,
FI,
FR,
DE,
HK,
IE,
IT,
JP,
LU,
MX,
NL,
NZ,
NO,
PT,
SG,
ES,
SE,
CH,
GB,
AF,
AX,
AL,
DZ,
AS,
AD,
AO,
AI,
AQ,
AG,
AR,
AM,
AW,
AZ,
BS,
BH,
BD,
BB,
BY,
BZ,
BJ,
BM,
BT,
BO,
BA,
BW,
BV,
BR,
IO,
BN,
BG,
BF,
BI,
KH,
CM,
CV,
KY,
CF,
TD,
CL,
CN,
CX,
CC,
CO,
KM,
CG,
CD,
CK,
CR,
CI,
HR,
CU,
CY,
CZ,
DJ,
DM,
DO,
EC,
EG,
SV,
GQ,
ER,
EE,
ET,
FK,
FO,
FJ,
GF,
PF,
TF,
GA,
GM,
GE,
GH,
GI,
GR,
GL,
GD,
GP,
GU,
GT,
GG,
GN,
GW,
GY,
HT,
HM,
VA,
HN,
HU,
IS,
IN,
ID,
IR,
IQ,
IM,
IL,
JM,
JE,
JO,
KZ,
KE,
KI,
KP,
KR,
KW,
KG,
LA,
LV,
LB,
LS,
LR,
LY,
LI,
LT,
MO,
MK,
MG,
MW,
MY,
MV,
ML,
MT,
MH,
MQ,
MR,
MU,
YT,
FM,
MD,
MC,
MN,
ME,
MS,
MA,
MZ,
MM,
NA,
NR,
NP,
AN,
NC,
NI,
NE,
NG,
NU,
NF,
MP,
OM,
PK,
PW,
PS,
PA,
PG,
PY,
PE,
PH,
PN,
PL,
PR,
QA,
RE,
RO,
RU,
RW,
SH,
KN,
LC,
PM,
VC,
WS,
SM,
ST,
SA,
SN,
RS,
SC,
SL,
SK,
SI,
SB,
SO,
ZA,
GS,
LK,
SD,
SR,
SJ,
SZ,
SY,
TW,
TJ,
TZ,
TH,
TL,
TG,
TK,
TO,
TT,
TN,
TR,
TM,
TC,
TV,
UG,
UA,
AE,
UM,
UY,
UZ,
VU,
VE,
VN,
VG,
VI,
WF,
EH,
YE,
ZM,
ZW
date_created
string

Date of creation

date_last_modified
string

Date of last update

emailrequired
string

The users unique email address

first_namerequired
string

The users first name

id
integer
last_namerequired
string

The users last name

merchant_id
integer

Merchant ID

merchant_ids
integer[]

Merchant IDs

passwordrequired
string

The users raw desired password

payment_configured
boolean

Is the Users Payment Settings Configured

privacy_policy_accepted
boolean

Privacy Policy Accepted

refresh_token
string

Refresh Token

roles
object[]
status
enum<string>

The status of the user

Available options:
INACTIVE,
ACTIVE,
DISABLED
store_url
string

Store Url

token
string

Token

tos_accepted
boolean

Terms of Service Accepted

typerequired
enum<string>

The allowed values for the user type

Available options:
ADMIN,
MERCHANT,
USER,
DEVELOPER,
INFLUENCER
verified
boolean

If a user has verified their emailed address

WelcomeRefresh Token