Verify Email

Introduction

This endpoint handles the workflow orchestration between the integration services (such as Auth0, Gigya, SSOR, and Firefly) and Subscribe Registration API to verify the email of a user based on the provided Email and Verification Code.

Comparison

Note:

1. The old model is in PascalCase, while the new model is in CamelCase.

2. The UsersOrchestrator API only returns CRID and EncryptedCRID and does not return cookie tokens.

	User API	Users Orchestrator API
URL	/User/VerifyEmail	/v4/Users/Verification
Method	POST	POST
Request	{ "VerificationCode": "string", "Email": "string" }	{ "email": "string", "verificationCode": "string" }
Response	{ "Code": 0, "Errors": [ { "Message": "string", "Code": "string", "Type": { "Id": 0, "Code": "string" }, "ErrorSource": "string" } ], "Result": { "CustomerRegistrationId": "string", "EncryptedCustomerRegistrationId": "string", "Mg2RegistrationId": 0, "RegistrationVerificationId": 0, "Tokens": [ { "Name": "string", "Content": "string", "CookieDurationDays": "string" } ] }, "SessionId": "string", "RequestId": "string" }	{ "message": { "code": "string", "text": "string", "type": 0 }, "meta": "string", "data": { "customerRegistrationId": "string", "encryptedCustomerRegistrationId": "string" } }

---

Verify Email

POST /v4/Users/Verification

This endpoint is used to verify the email of a user based on the provided Email and Verification Code.

Note: The parameters marked with an asterisk (*) are mandatory and must be included in the input model.

Headers

Name	Type	Description
Authorization*	String	JSON Web Token used for security purposes
X-SourceSystem*	String	To identify the consumer or the Source System
X-ClientCode*	String	Client Code of the Tenant
X-PaperCode*	String	Paper Code of the Tenant
X-ClientGroupCode*	String	Client Group Code of the Tenant

Request Body

Name	Type	Description
Email*	String	Subscriber’s email.
VerificationCode*	String	Unique code for verification of the registration.

200

{
  "message": {
    "code": "UsersOrchestrator_S200_13",
    "text": "Verify Email completed.",
    "type": "Success"
  },
  "data": {
    "customerRegistrationId": "string",
    "encryptedCustomerRegistrationId": "string"
  },
  "meta": null
}

Error Codes

Status Code	Code	Message
400	UsersOrchestrator_E400	Bad Request
400	UsersOrchestrator_E400_00	Invalid InputModel - {Message}
400	UsersOrchestrator_E400_14	The email is not registered.
400	UsersOrchestrator_E400_15	The verification code is invalid.
400	UsersOrchestrator_E400_16	Email is already verified.
500	UsersOrchestrator_E500	Internal Server Error

Events

Note:– The associated Event IDs for the Event Type Codes are specified in parentheses (i.e., EventTypeCode (EventID)) in the table below.

Current	New	Note
GETUSER (73)	SUBSCRIBE_USER_GET (4000)	Renamed. This event will get User from Subscribe
CREATELOGIN (68)	SUBSCRIBE_USER_CREATE (4002)	Renamed. This event will create User in Subscribe