Resend a User Registration Verification Email

This API is used to resend the registration verification email to a User. This API is useful if the User has deleted the email, or the verification Id has expired. By default, the verification Id will expire after 24 hours.

Request#

Resend the registration verification email

PUT/api/user/verify-registration?applicationId={applicationId}&email={email}

OpenAPI Spec

Request Parameters#

applicationIdUUIDrequired

The unique Id of the Application for this User registration.

emailStringrequired

The email address used to uniquely identify the User.

Request Headers#

X-FusionAuth-TenantIdStringoptional

The unique Id of the tenant used to scope this API request.

The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.

Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

See Making an API request using a Tenant Id for additional information.

Resend the registration verification email using an API key

PUT/api/user/verify-registration?applicationId={applicationId}&email={email}&sendVerifyRegistrationEmail={sendVerifyRegistrationEmail}

OpenAPI Spec

Request Parameters#

applicationIdUUIDrequired

The unique Id of the Application for this User registration.

emailStringrequired

The email address used to uniquely identify the User.

sendVerifyRegistrationEmailBooleanoptionalDefaults to true

If you would only like to generate a new verificationId and return it in the JSON body without FusionAuth attempting to send the User an email set this optional parameter to false.

This may be useful if you need to integrate the Registration Verification process using a third party messaging service.

Request Headers#

X-FusionAuth-TenantIdStringoptional

The unique Id of the tenant used to scope this API request.

See Making an API request using a Tenant Id for additional information.

Response#

When authenticated using an API key a response body will be provided. If an API key was not used to authenticate the request no body is returned.

Response Codes

Code	Description
200	The request was successful. The response will contain a JSON body if an API key was used for authentication. If no API key was provided no response body will be returned.
400	The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401	You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404	The object you are trying to update doesn't exist. The response will be empty.
500	There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.
503	The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

Response Body#

verificationIdString

The Registration Verification Id that was generated by this API request. This identifier may be used by the Verify a User Registration API. This field is only returned in the JSON response body if the request was authenticated using an API key, if an API key is not used no response body is returned.

Example Response JSON

{
  "verificationId": "YkQY5Gsyo4RlfmDciBGRmvfj3RmatUqrbjoIZ19fmw4"
}