Send Verification Code

Introduction

This endpoint handles the workflow orchestration between the integration services (such as Auth0, Gigya, SSOR, and Firefly) and Subscribe Registration API to send or resend a Verification Code by email so that users can click on the verification link provided in the email in order to start using their new registration.

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	/VerifyEmail/Resend	/v4/Users​/VerificationCode
Method	POST	POST
Request	{ "Email": "string", "ReturnUrl": "string" }	{ "email": "string", "returnUrl": "string" }
Response	{ "Code": 0, "Errors": [ { "Message": "string", "Code": "string", "Type": { "Id": 0, "Code": "string" }, "ErrorSource": "string" } ], "Result": { "Done": "true" }, "SessionId": "string", "RequestId": "string" }	{ "message": { "code": "string", "text": "string", "type": 0 }, "meta": "string" }

---

Send Verification Code

POST /v4/Users/VerificationCode

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.
ReturnUrl	String	URL to which users must be redirected after they have successfully verified their registration.

200

{
  "message": {
    "code": "string",
    "text": "string",
    "type": 0
  },
  "meta": "string"
}

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_18	The entered email address does not have any pending (and not expired) verification.
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
VERIFYCODE (670)	SUBSCRIBE_USER_CREATEPENDING (4003)	Changed event. The event will create User with pending status in Subscribe