Initiate Account Verification
POST/verification-actions-srv/account/initiation
This API initiates the account verification process for communication mediums (email or mobile number). It sends a verification code or link to the user's email or mobile number.
Use Case:
- Initiate verification when user is prompted during the
communication_medium_verificationprecheck - Send verification code or link to user's email or mobile number
- Required before validating the verification code
Processing Types:
- CODE: Sends a verification code that the user must enter manually
- LINK: Sends a verification link that the user clicks to verify
Verification Mediums:
- email: Verify user's email address
- sms: Verify user's mobile number
- ivr: Verify via Interactive Voice Response (phone call)
Authentication:
- Public endpoint using the
requestIdis provided in the request body
Request
Responses
- 200
- 302
- 400
Success
Redirect to verification_complete page. This redirect occurs for both CODE and LINK processing types.
Success Redirect URL: /identity/verification_complete
Query Parameters:
accvid(string): Account verification ID to be used in the validate endpointemail(string): Masked email address (not masked if email was provided in request)mobile(string): Masked mobile number (not masked if mobile was provided in request)processingType(string): The processing type used (CODE or LINK)requestId(string): The request ID from the authorization requesttype(string): The verification type (email, sms, or ivr)
Error Redirect URL: /identity/error
Error Query Parameters:
error(string): Error type (e.g., "Expectation Failed")error_code(string): Error code (e.g., "VER_0005")error_description(string): Error description (e.g., "requestId or token is missing")
Response Headers
Location
The redirect URL
Bad Request