# VerifyUserAttribute Submits a verification code for a signed-in user who has added or changed a value of an auto-verified attribute. When successful, the user's attribute becomes verified and the attribute `email_verified` or `phone_number_verified` becomes `true`. If your user pool requires verification before Amazon Cognito updates the attribute value, this operation updates the affected attribute to its pending value. See also [UserAttributeUpdateSettingsType](API_UserAttributeUpdateSettingsType.md). Authorize this action with a signed-in user's access token. It must include the scope `aws.cognito.signin.user.admin`. **Note** Amazon Cognito doesn't evaluate AWS Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html). ## Request Syntax ``` { "AccessToken": "string", "AttributeName": "string", "Code": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AccessToken](#API_VerifyUserAttribute_RequestSyntax) ** A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for `aws.cognito.signin.user.admin`. Type: String Pattern: `[A-Za-z0-9-_=.]+` Required: Yes ** [AttributeName](#API_VerifyUserAttribute_RequestSyntax) ** The name of the attribute that you want to verify. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+` Required: Yes ** [Code](#API_VerifyUserAttribute_RequestSyntax) ** The verification code that your user pool sent to the added or changed attribute, for example the user's email address. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `[\S]+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AliasExistsException ** This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you've configured to use email address or phone number as a sign-in alias. ** message ** The message that Amazon Cognito sends to the user when the value of an alias attribute is already linked to another user profile. HTTP Status Code: 400 ** CodeMismatchException ** This exception is thrown if the provided code doesn't match what the server was expecting. ** message ** The message provided when the code mismatch exception is thrown. HTTP Status Code: 400 ** ExpiredCodeException ** This exception is thrown if a code has expired. ** message ** The message returned when the expired code exception is thrown. HTTP Status Code: 400 ** ForbiddenException ** This exception is thrown when AWS WAF doesn't allow your request based on a web ACL that's associated with your user pool. ** message ** The message returned when AWS WAF doesn't allow your request based on a web ACL that's associated with your user pool. HTTP Status Code: 400 ** InternalErrorException ** This exception is thrown when Amazon Cognito encounters an internal error. ** message ** The message returned when Amazon Cognito throws an internal error exception. HTTP Status Code: 500 ** InvalidParameterException ** This exception is thrown when the Amazon Cognito service encounters an invalid parameter. ** message ** The message returned when the Amazon Cognito service throws an invalid parameter exception. ** reasonCode ** The reason code of the exception. HTTP Status Code: 400 ** LimitExceededException ** This exception is thrown when a user exceeds the limit for a requested AWS resource. ** message ** The message returned when Amazon Cognito throws a limit exceeded exception. HTTP Status Code: 400 ** NotAuthorizedException ** This exception is thrown when a user isn't authorized. ** message ** The message returned when the Amazon Cognito service returns a not authorized exception. HTTP Status Code: 400 ** PasswordResetRequiredException ** This exception is thrown when a password reset is required. ** message ** The message returned when a password reset is required. HTTP Status Code: 400 ** ResourceNotFoundException ** This exception is thrown when the Amazon Cognito service can't find the requested resource. ** message ** The message returned when the Amazon Cognito service returns a resource not found exception. HTTP Status Code: 400 ** TooManyRequestsException ** This exception is thrown when the user has made too many requests for a given operation. ** message ** The message returned when the Amazon Cognito service returns a too many requests exception. HTTP Status Code: 400 ** UserNotConfirmedException ** This exception is thrown when a user isn't confirmed successfully. ** message ** The message returned when a user isn't confirmed successfully. HTTP Status Code: 400 ** UserNotFoundException ** This exception is thrown when a user isn't found. ** message ** The message returned when a user isn't found. HTTP Status Code: 400 ## Examples ### Example The following example request verifies the email attribute for the current user with a code that was sent in an email message to them. #### Sample Request ``` POST HTTP/1.1 Host: cognito-idp.us-west-2.amazonaws.com X-Amz-Date: 20230613T200059Z Accept-Encoding: gzip, deflate, br X-Amz-Target: AWSCognitoIdentityProviderService.VerifyUserAttribute User-Agent: Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=, Signature= Content-Length: { "AccessToken": "eyJra456defEXAMPLE", "AttributeName": "email", "Code": "123456" } ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Tue, 13 Jun 2023 20:00:59 GMT Content-Type: application/x-amz-json-1.0 Content-Length: x-amzn-requestid: a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111 Connection: keep-alive {} ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cognito-idp-2016-04-18/VerifyUserAttribute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cognito-idp-2016-04-18/VerifyUserAttribute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cognito-idp-2016-04-18/VerifyUserAttribute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cognito-idp-2016-04-18/VerifyUserAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cognito-idp-2016-04-18/VerifyUserAttribute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cognito-idp-2016-04-18/VerifyUserAttribute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cognito-idp-2016-04-18/VerifyUserAttribute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cognito-idp-2016-04-18/VerifyUserAttribute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cognito-idp-2016-04-18/VerifyUserAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cognito-idp-2016-04-18/VerifyUserAttribute)