Verify email - QShop API Documentation

Verify email

curl --request POST \
  --url http://staging.qshop.ng/apiv2/verify/{action} \
  --header 'Content-Type: application/json' \
  --data '
{
  "access_code": "LKSLIX",
  "email": "[email protected]"
}
'

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InRhcmViaUB5b2tlc29sdXRpb25zLmNvbSIsInVzZXJJZCI6IjVlN2U5NjU1MDk1ZDhiMTA4YTdjNWFjZCIsImlzQWRtaW4iOnRydWUsImlzU3VwZXJBZG1pbiI6dHJ1ZSwiaWF0IjoxNjU1ODAyNDMyLCJleHAiOjI2MDE4ODI0MzJ9.ZuEHNcH1-_QQK9_zXkVKmARwTlHe2yxufsST7rtVqaM",
    "user": {
      "email": "[email protected]",
      "full_name": "Tarebi Alebiosu",
      "id": "5e7e9655095d8b108a7c5acd",
      "isAdmin": true,
      "isSuperAdmin": true,
      "last_access": "2021-02-27T07:15:48.006Z",
      "reg_date": "2020-03-28T00:12:05.133Z",
      "reset_pass": false,
      "roles": [
        {
          "_id": "5e7e8827872c2c0f8c1c3fb2",
          "isAdmin": true,
          "isSuperAdmin": true,
          "name": "Super Admin User"
        }
      ],
      "shop": {
        "__v": 2,
        "_id": "5f3ef405c072de214d9d6703",
        "billingNotice": "2020-08-27T08:00:00.364Z",
        "bio": "Best uk used phone shop",
        "call": true,
        "created": "2020-08-20T22:07:01.725Z",
        "currencies": [],
        "email": "[email protected]",
        "inventoryConfig": {
          "displayOptionKeyId": "6c6f775f696e5f73746f636b",
          "enableProductPageStockCount": false,
          "isLowStockEnabled": false,
          "isOutOfStockEnabled": false
        },
        "locations": [],
        "logo": "5f3ef405c072de214d9d6702-inbound3469806257505107320.jpg",
        "modified": "2020-08-20T22:07:01.725Z",
        "name": "I sell phones and laptop",
        "owner": {
          "__v": 0,
          "_id": "5f3ef3c8c072de214d9d6701",
          "email": "[email protected]",
          "full_name": "Arinze Esomnofu",
          "last_access": "2021-08-11T09:14:41.759Z",
          "pass": "$2b$10$dmOPpIxa7dlfCYCbiMYWiueO2JWfQ9VcqynlIYfTlRu5RWCD9hDre",
          "profiles": [],
          "referred_by": "5f3c62f4bc19938f1ad2e212",
          "reg_date": "2020-08-20T22:06:00.935Z",
          "reset_pass": false,
          "roles": [
            "5e7e89bf872c2c0f8c1c3fb4"
          ],
          "shopCount": 1,
          "social": [],
          "telephone": "+2348031391676",
          "username": "[email protected]"
        },
        "paymentError": [],
        "paymentMethods": [],
        "productWeightConfig": {
          "unit": "kg"
        },
        "products": 1,
        "shippingRates": [
          {
            "_id": "5ee6a2f6eea46308e8f84863",
            "countryCode": "NG",
            "disableShipping": false,
            "enableShipping": true,
            "name": "Rivers",
            "rate": "4000"
          }
        ],
        "shopCategory": {
          "_id": "5f3c62287fe78f559ccf7793",
          "name": "Phones & Tablets",
          "weight": 140
        },
        "shopPreview": "2020-08-28T11:42:09.730Z",
        "slug": "i-sell-phones-and-laptop",
        "status": "pending",
        "telephone": "+2348031391676",
        "theme": "MINIMAL",
        "whatsApp": true
      },
      "telephone": "+2347061240799",
      "username": "[email protected]"
    }
  },
  "message": "User authenticated successfully",
  "status": 200,
  "success": true
}

POST

verify

{action}

Verify email

curl --request POST \
  --url http://staging.qshop.ng/apiv2/verify/{action} \
  --header 'Content-Type: application/json' \
  --data '
{
  "access_code": "LKSLIX",
  "email": "[email protected]"
}
'

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InRhcmViaUB5b2tlc29sdXRpb25zLmNvbSIsInVzZXJJZCI6IjVlN2U5NjU1MDk1ZDhiMTA4YTdjNWFjZCIsImlzQWRtaW4iOnRydWUsImlzU3VwZXJBZG1pbiI6dHJ1ZSwiaWF0IjoxNjU1ODAyNDMyLCJleHAiOjI2MDE4ODI0MzJ9.ZuEHNcH1-_QQK9_zXkVKmARwTlHe2yxufsST7rtVqaM",
    "user": {
      "email": "[email protected]",
      "full_name": "Tarebi Alebiosu",
      "id": "5e7e9655095d8b108a7c5acd",
      "isAdmin": true,
      "isSuperAdmin": true,
      "last_access": "2021-02-27T07:15:48.006Z",
      "reg_date": "2020-03-28T00:12:05.133Z",
      "reset_pass": false,
      "roles": [
        {
          "_id": "5e7e8827872c2c0f8c1c3fb2",
          "isAdmin": true,
          "isSuperAdmin": true,
          "name": "Super Admin User"
        }
      ],
      "shop": {
        "__v": 2,
        "_id": "5f3ef405c072de214d9d6703",
        "billingNotice": "2020-08-27T08:00:00.364Z",
        "bio": "Best uk used phone shop",
        "call": true,
        "created": "2020-08-20T22:07:01.725Z",
        "currencies": [],
        "email": "[email protected]",
        "inventoryConfig": {
          "displayOptionKeyId": "6c6f775f696e5f73746f636b",
          "enableProductPageStockCount": false,
          "isLowStockEnabled": false,
          "isOutOfStockEnabled": false
        },
        "locations": [],
        "logo": "5f3ef405c072de214d9d6702-inbound3469806257505107320.jpg",
        "modified": "2020-08-20T22:07:01.725Z",
        "name": "I sell phones and laptop",
        "owner": {
          "__v": 0,
          "_id": "5f3ef3c8c072de214d9d6701",
          "email": "[email protected]",
          "full_name": "Arinze Esomnofu",
          "last_access": "2021-08-11T09:14:41.759Z",
          "pass": "$2b$10$dmOPpIxa7dlfCYCbiMYWiueO2JWfQ9VcqynlIYfTlRu5RWCD9hDre",
          "profiles": [],
          "referred_by": "5f3c62f4bc19938f1ad2e212",
          "reg_date": "2020-08-20T22:06:00.935Z",
          "reset_pass": false,
          "roles": [
            "5e7e89bf872c2c0f8c1c3fb4"
          ],
          "shopCount": 1,
          "social": [],
          "telephone": "+2348031391676",
          "username": "[email protected]"
        },
        "paymentError": [],
        "paymentMethods": [],
        "productWeightConfig": {
          "unit": "kg"
        },
        "products": 1,
        "shippingRates": [
          {
            "_id": "5ee6a2f6eea46308e8f84863",
            "countryCode": "NG",
            "disableShipping": false,
            "enableShipping": true,
            "name": "Rivers",
            "rate": "4000"
          }
        ],
        "shopCategory": {
          "_id": "5f3c62287fe78f559ccf7793",
          "name": "Phones & Tablets",
          "weight": 140
        },
        "shopPreview": "2020-08-28T11:42:09.730Z",
        "slug": "i-sell-phones-and-laptop",
        "status": "pending",
        "telephone": "+2348031391676",
        "theme": "MINIMAL",
        "whatsApp": true
      },
      "telephone": "+2347061240799",
      "username": "[email protected]"
    }
  },
  "message": "User authenticated successfully",
  "status": 200,
  "success": true
}

Path Parameters

action

string

required

Example:

"login"

Body

application/json

access_code

string

Example:

"LKSLIX"

string

Example:

"[email protected]"

Response

200 - application/json

200

data

object

Show child attributes

data.token

string

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InRhcmViaUB5b2tlc29sdXRpb25zLmNvbSIsInVzZXJJZCI6IjVlN2U5NjU1MDk1ZDhiMTA4YTdjNWFjZCIsImlzQWRtaW4iOnRydWUsImlzU3VwZXJBZG1pbiI6dHJ1ZSwiaWF0IjoxNjU1ODAyNDMyLCJleHAiOjI2MDE4ODI0MzJ9.ZuEHNcH1-_QQK9_zXkVKmARwTlHe2yxufsST7rtVqaM"

data.user

object

Show child attributes

data.user.email

string

Example:

"[email protected]"

data.user.full_name

string

Example:

"Tarebi Alebiosu"

data.user.id

string

Example:

"5e7e9655095d8b108a7c5acd"

data.user.isAdmin

boolean

Example:

true

data.user.isSuperAdmin

boolean

Example:

true

data.user.last_access

string

Example:

"2021-02-27T07:15:48.006Z"

data.user.reg_date

string

Example:

"2020-03-28T00:12:05.133Z"

data.user.reset_pass

boolean

Example:

false

data.user.roles

object[]

Show child attributes

data.user.roles._id

string

Example:

"5e7e8827872c2c0f8c1c3fb2"

data.user.roles.isAdmin

boolean

Example:

true

data.user.roles.isSuperAdmin

boolean

Example:

true

data.user.roles.name

string

Example:

"Super Admin User"

Example:

[
  {
    "_id": "5e7e8827872c2c0f8c1c3fb2",
    "isAdmin": true,
    "isSuperAdmin": true,
    "name": "Super Admin User"
  }
]

data.user.shop

object

Show child attributes

data.user.shop.__v

number

Example:

2

data.user.shop._id

string

Example:

"5f3ef405c072de214d9d6703"

data.user.shop.billingNotice

string

Example:

"2020-08-27T08:00:00.364Z"

data.user.shop.bio

string

Example:

"Best uk used phone shop"

data.user.shop.call

boolean

Example:

true

data.user.shop.created

string

Example:

"2020-08-20T22:07:01.725Z"

data.user.shop.currencies

any[]

Example:

[]

data.user.shop.email

string

Example:

"[email protected]"

data.user.shop.inventoryConfig

object

Show child attributes

data.user.shop.inventoryConfig.displayOptionKeyId

string

Example:

"6c6f775f696e5f73746f636b"

data.user.shop.inventoryConfig.enableProductPageStockCount

boolean

Example:

false

data.user.shop.inventoryConfig.isLowStockEnabled

boolean

Example:

false

data.user.shop.inventoryConfig.isOutOfStockEnabled

boolean

Example:

false

data.user.shop.locations

any[]

Example:

[]

data.user.shop.logo

string

Example:

"5f3ef405c072de214d9d6702-inbound3469806257505107320.jpg"

data.user.shop.modified

string

Example:

"2020-08-20T22:07:01.725Z"

data.user.shop.name

string

Example:

"I sell phones and laptop"

data.user.shop.owner

object

Show child attributes

data.user.shop.owner.__v

number

Example:

0

data.user.shop.owner._id

string

Example:

"5f3ef3c8c072de214d9d6701"

data.user.shop.owner.email

string

Example:

"[email protected]"

data.user.shop.owner.full_name

string

Example:

"Arinze Esomnofu"

data.user.shop.owner.last_access

string

Example:

"2021-08-11T09:14:41.759Z"

data.user.shop.owner.pass

string

Example:

"$2b$10$dmOPpIxa7dlfCYCbiMYWiueO2JWfQ9VcqynlIYfTlRu5RWCD9hDre"

data.user.shop.owner.profiles

any[]

Example:

[]

data.user.shop.owner.referred_by

string

Example:

"5f3c62f4bc19938f1ad2e212"

data.user.shop.owner.reg_date

string

Example:

"2020-08-20T22:06:00.935Z"

data.user.shop.owner.reset_pass

boolean

Example:

false

data.user.shop.owner.roles

string[]

Example:

["5e7e89bf872c2c0f8c1c3fb4"]

data.user.shop.owner.shopCount

number

Example:

1

Example:

[]

data.user.shop.owner.telephone

string

Example:

"+2348031391676"

data.user.shop.owner.username

string

Example:

"[email protected]"

data.user.shop.paymentError

any[]

Example:

[]

data.user.shop.paymentMethods

any[]

Example:

[]

data.user.shop.productWeightConfig

object

Show child attributes

data.user.shop.productWeightConfig.unit

string

Example:

"kg"

data.user.shop.products

number

Example:

1

data.user.shop.shippingRates

object[]

Show child attributes

data.user.shop.shippingRates._id

string

Example:

"5ee6a2f6eea46308e8f84863"

data.user.shop.shippingRates.countryCode

string

Example:

"NG"

data.user.shop.shippingRates.disableShipping

boolean

Example:

false

data.user.shop.shippingRates.enableShipping

boolean

Example:

true

data.user.shop.shippingRates.name

string

Example:

"Rivers"

data.user.shop.shippingRates.rate

string

Example:

"4000"

Example:

[
  {
    "_id": "5ee6a2f6eea46308e8f84863",
    "countryCode": "NG",
    "disableShipping": false,
    "enableShipping": true,
    "name": "Rivers",
    "rate": "4000"
  }
]

data.user.shop.shopCategory

object

Show child attributes

data.user.shop.shopCategory._id

string

Example:

"5f3c62287fe78f559ccf7793"

data.user.shop.shopCategory.name

string

Example:

"Phones & Tablets"

data.user.shop.shopCategory.weight

number

Example:

140

data.user.shop.shopPreview

string

Example:

"2020-08-28T11:42:09.730Z"

data.user.shop.slug

string

Example:

"i-sell-phones-and-laptop"

data.user.shop.status

string

Example:

"pending"

data.user.shop.telephone

string

Example:

"+2348031391676"

data.user.shop.theme

string

Example:

"MINIMAL"

data.user.shop.whatsApp

boolean

Example:

true

data.user.telephone

string

Example:

"+2347061240799"

data.user.username

string

Example:

"[email protected]"

message

string

Example:

"User authenticated successfully"

status

number

Example:

200

success

boolean

Example:

true

Request access Check slug

⌘I