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.
The old model is in PascalCase, while the new model is in CamelCase.
The UsersOrchestrator API only returns CRID and EncryptedCRID and does not return cookie tokens.
URL
/User/VerifyEmail
/v4/Users/Verification
Method
POST
POST
Request
Response
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.
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
Email*
String
Subscriber’s email.
VerificationCode*
String
Unique code for verification of the registration.
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
Note:– The associated Event IDs for the Event Type Codes are specified in parentheses (i.e., EventTypeCode (EventID)) in the table below.
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