Validate Frontend User Email

GET

https://api-b2b.bigcommerce.com/api/v2/companies/validations/frontend/user-emails/:email

Checks if an email address is associated with a BigCommerce customer account and a Company user account. Equivalent Storefront GraphQL API Query: `userEmailCheck`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground). The `isValid` value in the response indicates whether or not the email address is used by an existing customer or Company user. The following values are possible: * `0` — The email address is associated with a Company user account and a corresponding customer account. * `1` — The email address is not associated with a customer account or a Company user account. * `2` — The email address is associated with a customer account, but not a Company user account.

Validate Frontend User Email

GET

https://api-b2b.bigcommerce.com/api/v2/companies/validations/frontend/user-emails/:email

Checks if an email address is associated with a BigCommerce customer account and a Company user account.

Equivalent Storefront GraphQL API Query: userEmailCheck. For more information, see the GraphQL Playground.

The isValid value in the response indicates whether or not the email address is used by an existing customer or Company user. The following values are possible:

0 — The email address is associated with a Company user account and a corresponding customer account.
1 — The email address is not associated with a customer account or a Company user account.
2 — The email address is associated with a customer account, but not a Company user account.

Authentication

AuthorizationBearer

Authentication header

Header	Argument	Description
`Authorization`	`Bearer {{B2B_JWT_TOKEN}}`	You can obtain this token using the steps described in the REST Storefront API section[…]

Path parameters

emailstringRequiredformat: "email"

The email address of the user to be validated.

Query parameters

storeHashstringRequired

The unique alphanumeric store hash for the BigCommerce store.

roleenumRequired

The ID of the role assigned to the Company user account as given below.

Value	Code
0	Admin
1	Senior Buyer
2	Junior Buyer
3	Super Admin
4	Unknown

Allowed values:

companyIdstringOptional

The unique numeric ID of the Company account.

Response

messagestring

codedoubleDefaults to 200

dataobject

$	curl -G https://api-b2b.bigcommerce.com/api/v2/companies/validations/frontend/user-emails/user%40example.com \
>	-H "Authorization: Bearer <token>" \
>	-d storeHash=abc123 \
>	-d role=0

1	{
2	"message": "string",
3	"code": 200,
4	"data": {
5	"isValid": "1",
6	"userInfo": {
7	"firstName": "Marie",
8	"lastName": "Curie",
9	"email": "m.curie@greatbuys.com",
10	"id": "123",
11	"phoneNumber": "8001234567",
12	"role": "1"
13	}
14	}
15	}

$	curl -G https://api-b2b.bigcommerce.com/api/v2/companies/validations/frontend/user-emails/user%40example.com \
>	-H "Authorization: Bearer <token>" \
>	-d storeHash=abc123 \
>	-d role=0

1	{
2	"message": "string",
3	"code": 200,
4	"data": {
5	"isValid": "1",
6	"userInfo": {
7	"firstName": "Marie",
8	"lastName": "Curie",
9	"email": "m.curie@greatbuys.com",
10	"id": "123",
11	"phoneNumber": "8001234567",
12	"role": "1"
13	}
14	}
15	}