# Manage registrations
The following sections contain directions on how to manage a registration.
**Topics**
+ [Create a new registration using the console](registrations-create.md)
+ [Create a registration using the AWS CLI](registrations-sms-cli.md)
+ [Check a registration's status](registrations-status.md)
+ [Change a registration's name](registrations-friendly-name.md)
+ [Edit a registration](registrations-edit.md)
+ [Discard a registration's current version](registrations-discard.md)
+ [Delete a registration](registrations-delete.md)
+ [View a registration associated resources](registrations-associated-resource.md)
# Create a new registration using the AWS End User Messaging SMS console
You can use the AWS End User Messaging SMS console to manage registrations for your AWS End User Messaging SMS account. If your registration was already created as part of requesting a phone number or sender ID then you do not need to create a new registration. You can view the resources associated with a registration in the **Associated resources** tab, for more information see [View a registration associated resources in AWS End User Messaging SMS](registrations-associated-resource.md).
**Important**
Some registrations have multiple steps that need to be completed in exact order.
To register a US 10DLC number, you must first register and complete a **US 10DLC Brand registration**, then apply for optional **US 10DLC Brand vetting** to increase your Messages per second (MPS), and then register a **US 10DLC Campaign registration**. If you require sending 10DLC SMS messages from more than one AWS Region and from a single account, you must re-registering all 10DLC resources for each AWS Region required. For more information about the process, see [United States 10DLC registration](registrations-10dlc.md).
To register a **Singapore sender ID registration** you must first obtain a Singapore Unique Entity Number (UEN), create and submit a Singapore sender ID registration, once the registration is approved then register the sender ID with Singapore Network Information Centre (SGNIC). For more information about the process, see [Singapore sender ID registration process](registrations-sg.md).
To register a **India sender ID registration** you must first register your company and use case with TRAI, create and submit a case with Support and then to send messages you must specify **Entity ID** and **Template ID** values that you received. For more information about the process, see [India sender ID registration process in AWS End User Messaging SMS](registrations-sms-senderid-india.md).
**Create a new registration**
1. Open the AWS End User Messaging SMS console at [https://console.aws.amazon.com/sms-voice/](https://console.aws.amazon.com/sms-voice/).
1. In the navigation pane, under **Registrations**, choose **Create registration**.
**Note**
If you already created a registration when requesting the origination identity then you should use that registration form.
1. For **Registration form name** enter a friendly name.
1. For **Registration type**, choose the registration form from the dropdown list. Each **Registration type** has different forms depending on the regulatory body the registration form is sent to.
1. (optional) Expand **Tags** to:
+ **Add a tag** – In **Manage tags** choose **Add new tag** to create a new blank key/value pair.
+ **Delete a tag** – In **Manage tags**, choose **Remove** next to the key/value pair.
+ **Edit a tag** – In **Manage tags** choose the **Key** or **Value** and edit the text.
1. Choose **Create**.
1. Your registration has now been created and you need to enter in all required information then submit.
+ **US toll-free number registration** – [US toll-free number registration form](registrations-tfn-register.md).
+ **US 10DLC Brand vetting** – The 10DLC brand has been submitting for vetting and you don't need to fill out any additional forms, see [10DLC brand vetting form](registrations-10dlc-vetting.md).
+ **US 10DLC Brand registration** – [10DLC brand registration form](registrations-10dlc-company.md).
+ **US-10DLC campaign registration** – [10DLC campaign registration form](registrations-10dlc-register-campaign.md).
+ **Singapore sender ID registration** – [Singapore sender ID registration form](registrations-sg-form.md).
# Create a registration using the AWS CLI in AWS End User Messaging SMS
The following section gives examples of how to create, populate, and submit a registration using the AWS CLI. For examples of how to create and submit a Toll-free phone number registration using python or shell script, see [Automate AWS End User Messaging US toll-free Number Registrations](https://aws.amazon.com/blogs/messaging-and-targeting/automate-us-tfn-registrations/). Registrations vary from country to country, some are single page forms while others, like 10DLC, may require multiple forms to be submitted in a specific order. Check the [individual registration](registrations.md) for details on order and if you need to upload any supporting documentation like a Letter of Authorization (LOA).
## Background
Some countries require you to register your company's identity to be able to purchase an origination identity and review the messages you send to recipients in their country.
+ The registration information you provide may be reviewed by a third-party. The third-party varies from country to country but could be a governmental regulatory agency or mobile carrier that perform the review.
+ The amount of time the third-party company takes to review your registration varies by registration type.
## Prerequisites
Before you begin you must:
+ Install and configure the AWS CLI, see [Configure the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) in the [AWS Command Line Interface User Guide](https://docs.aws.amazon.com/cli/latest/userguide/).
+ An AWS account with [permissions](security-iam.md) to use AWS End User Messaging SMS in the target region.
+ A registrations **AssociationBehavior** specifies the order for when a registration can be associated with an origination identity and disassociated from an origination identity, see [SupportedAssociation](https://docs.aws.amazon.com/pinpoint/latest/apireference_smsvoicev2/API_SupportedAssociation.html).
+ `ASSOCIATE_BEFORE_SUBMIT` The origination identity has to be supplied when submitting a registration.
+ `ASSOCIATE_ON_APPROVAL` This applies to all sender ID registrations. The sender ID will be automatically provisioned once the registration is approved.
+ `ASSOCIATE_AFTER_COMPLETE` This applies to phone number registrations when you must complete a registration first, then associate one or more phone numbers later.
**Important**
Once you purchase an origination identity you are changed for it regardless of the registrations status, see [AWS End User Messaging Pricing](https://aws.amazon.com/end-user-messaging/pricing/).
Once you submit your registration you can not make any changes to the registration or disassociate any resources with the registration until after it has been reviewed by a third party and returned back to you.
The following are additional resources for registrations.
+ [How to Build a Compliant SMS Opt-In Process](https://aws.amazon.com/blogs/messaging-and-targeting/how-to-build-a-compliant-sms-opt-in-process-with-amazon-pinpoint/)
+ [10DLC Registration Best Practices to Send SMS with AWS End User Messaging](https://aws.amazon.com/blogs/messaging-and-targeting/10dlc-registration-best-practices-to-send-sms-with-amazon-pinpoint/)
# Create a registration (create-registration AWS CLI command)
Use the [create-registration](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/create-registration.html) command to create a new blank registration. The **RegistrationType** parameter determines the type of registration to create. If you don't know the value for the type of registration you want to create then use the [describe-registration-type-definitions](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/describe-registration-type-definitions.html) command to retrieve a list of all registration types.
The following examples show how to create a Toll-free number registration form.
```
$ aws pinpoint-sms-voice-v2 create-registration --registration-type US_TOLL_FREE_REGISTRATION --tags "Key=Name,Value=MyTFNRegistration"
```
On successful completion save the value of **RegistrationId** as it will be needed for other commands.
**Note**
To add a friendly name to your registration you must add a tag with the **Key** set to **Name** and the **Value** set to the friendly name to use.
You can also add tags to resources for billing purposes, see [Tag resources for billing](sms-billing-tag.md).
The following example is partial output of the `describe-registration-type-definitions` command. Because **AssociationBehavior** is set to `ASSOCIATE_BEFORE_SUBMIT` the toll-free number must be purchased and associated with the registration before the registration can be submitted for approval. For more information on **AssociationBehavior** and **DisassociationBehavior**, see [SupportedAssociation](https://docs.aws.amazon.com/pinpoint/latest/apireference_smsvoicev2/API_SupportedAssociation.html).
```
{
"RegistrationTypeDefinitions": [
{
"RegistrationType": "US_TOLL_FREE_REGISTRATION",
"SupportedAssociations": [
{
"ResourceType": "TOLL_FREE",
"IsoCountryCode": "US",
"AssociationBehavior": "ASSOCIATE_BEFORE_SUBMIT",
"DisassociationBehavior": "DISASSOCIATE_ALL_CLOSES_REGISTRATION"
}
],
"DisplayHints": {
"Title": "US toll-free number registration"
}
},
...
```
# Get the field definitions (describe-registration-field-definitions AWS CLI command)
Next you need to get the definitions for each field to know what the requirements are, such as the maximum number of characters for the field.
Each registration is divided into sections and each section has one or more fields. Use the [describe-registration-field-definitions](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/describe-registration-field-definitions.html) command to retrieve all section and field definitions for a registration. You will need the **FieldPath** for each field later to be able to set its value. Also **FieldRequirement** is used to determine if a field will be required or optional.
The following examples show how to retrieve field definitions for the Toll-free registration form.
```
$ aws pinpoint-sms-voice-v2 describe-registration-field-definitions --registration-type US_TOLL_FREE_REGISTRATION
```
The following is partial output from the command:
```
{
"RegistrationFieldDefinitions": [
{
"SectionPath": "companyInfo",
"FieldPath": "companyInfo.companyName",
"FieldType": "TEXT",
"FieldRequirement": "REQUIRED",
"TextValidation": {
"MinLength": 1,
"MaxLength": 100,
"Pattern": "^(?=\\s*\\S)[\\s\\S]+$"
},
"DisplayHints": {
"Title": "Company name",
"ShortDescription": "Legal name which your company is registered under.",
"ExampleTextValue": "Example Corp"
}
},
...
```
# Create attachments (create-registration-attachment AWS CLI command)
Depending on the registration you may be required to complete and attach a Letter of Authorization (LOA), opt-in workflow, or another type of required document. Check the [individual registration](registrations.md) for details and to download any forms.
Use the [create-registration-attachment](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/create-registration-attachment.html) command to create the registration attachment. You can either upload the file to an Amazon S3 bucket and use the url or attach the document as part of the command. Use either **AttachmentUrl** or **AttachmentBody**, if both are specified then an exception is returned. The maximum file size is 500KB and valid file extensions are PDF, JPEG, and PNG.
The following example shows how to create the registration attachment and use the **AttachmentUrl** parameter.
```
$ aws pinpoint-sms-voice-v2 create-registration-attachment --attachment-url s3://BucketName/FileName
```
On successful completion the command returns a **RegistrationAttachmentID** which is needed for other commands.
For more information on Amazon S3 commands such as creating a bucket or uploading a file, see [Use high-level (s3) commands with the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-services-s3-commands.html).
# Set the field definition values (put-registration-field-value AWS CLI command)
Next you need to add values for all of the required fields returned from the *Get the field definitions* step, this includes any attachments that you created. We recommend that you also complete any optional fields where applicable to your use case. A field is required or optional depending on the **FieldRequirement** value. Use the [put-registration-field-value](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/put-registration-field-value.html) command to set the field values.
+ The following examples show to add a value for the company name or text value.
```
$ aws pinpoint-sms-voice-v2 put-registration-field-value --registration-id RegID --field-path companyInfo.companyName --text-value AnyCompany
```
In the preceding command replace the following:
+ Replace *RegID* with the registration id returned from the *Create a registration* step.
+ Replace *AnyCompany* with you company's name.
+ The following examples show to add a value for a select field.
```
$ aws pinpoint-sms-voice-v2 put-registration-field-value --registration-id RegID --field-path messagingUseCase.monthlyMessageVolume --text-choices SelectValue
```
In the preceding command replace the following:
+ Replace *RegID* with the registration id returned from the *Create a registration* step.
+ Replace *SelectValue* with one of the option values for the field.
Use the [describe-registration-field-definitions](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/describe-registration-field-definitions.html) command to get the options for just one field:
```
aws pinpoint-sms-voice-v2 describe-registration-field-definitions --registration-type US_TOLL_FREE_REGISTRATION --field-paths messagingUseCase.monthlyMessageVolume
```
```
{
"RegistrationFieldDefinitions": [
{
"SectionPath": "messagingUseCase",
"FieldPath": "messagingUseCase.monthlyMessageVolume",
"FieldType": "SELECT",
"FieldRequirement": "REQUIRED",
"SelectValidation": {
"MinChoices": 1,
"MaxChoices": 1,
"Options": [
"10",
"100",
"1,000",
"10,000",
"100,000",
"250,000",
"500,000",
"750,000",
"1,000,000",
"5,000,000",
"10,000,000+"
]
},
"DisplayHints": {
"Title": "Monthly SMS volume",
"ShortDescription": "Estimated number of SMS messages which will be sent from this toll-free number each month."
}
}
],
"RegistrationType": "US_TOLL_FREE_REGISTRATION"
}
```
+ The following examples show how to add an attachment.
```
$ aws pinpoint-sms-voice-v2 put-registration-field-value --registration-id RegID --field-path messagingUseCase.optInImage --registration-attachment-id RegistrationAttachmentID
```
In the preceding command replace the following:
+ Replace *RegID* with the registration id returned from the *Create a registration* step.
+ Replace *RegistrationAttachmentID* with the registration attachment id returned from the *Create attachments* step.
# Request an origination identity (request-phone-number AWS CLI command)
**Note**
Once you purchase an origination identity you are charged for it regardless of registration status, see [AWS End User Messaging Pricing](https://aws.amazon.com/end-user-messaging/pricing/).
If the registration's **AssociationBehavior** is `ASSOCIATE_AFTER_COMPLETE` then you do not need to purchase or associate the origination identity until after the registration has been submitted and approved.
Now you need to request an origination identity which will later be associated with the registration. This example shows how to use the [request-phone-number](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/request-phone-number.html) command to request a toll-free phone number through the AWS CLI. Use the [request-sender-id](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/request-sender-id.html) to request a sender ID.
```
$ aws pinpoint-sms-voice-v2 request-phone-number --iso-country-code US --message-type TRANSACTIONAL --number-capabilities SMS --number-type TOLL_FREE
```
On successful completion the command returns the phone number unique identifier which is needed to associate the phone number with the registration.
# Associate a resource with a registration (create-registration-association AWS CLI command)
**Note**
If the registration's **AssociationBehavior** is `ASSOCIATE_AFTER_COMPLETE` then you do not need to purchase or associate the origination identity until after the registration has been submitted and approved.
To associate an origination identity to the registration use the [create-registration-association](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/create-registration-association.html) AWS CLI command.
```
$ aws pinpoint-sms-voice-v2 create-registration-association --registration-id RegID --resource-id PhoneNumberID
```
In the preceding command replace the following:
+ Replace *RegID* with the registration id returned from the *Create a registration* step.
+ Replace *PhoneNumberID* with the phone number id returned from the *Request an origination identity* step.
**Note**
This command is used to associate any applicable resource with the registration. For example, it can be used to associate a 10DLC campaign registration with a 10DLC brand registration.
# Submit your registration (submit-registration-version AWS CLI command)
Once you submit your registration you will not be able to make any changes to it. Review you registration to make sure that all of your data is correct before submitting it.
**Important**
Once you submit your registration you can not make any changes to the registration or disassociated any resources from the registration until after it has been reviewed by a third party and returned back to you.
To submit a registration with the AWS CLI use the [submit-registration-version](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/create-registration-association.html) command.
```
$ aws pinpoint-sms-voice-v2 submit-registration-version --registration-id RegID
```
In the preceding command replace the following:
+ Replace *RegID* with the registration id returned from the *Create a registration* step.
## Check your registrations status (describe-registrations AWS CLI command)
Once your registration has been submitted you can check its status using the [describe-registrations](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/describe-registrations.html) command or [console](registrations-status.md).
If the registration's **AssociationBehavior** is `ASSOCIATE_AFTER_COMPLETE` you can purchase an origination identity and associate it with the registration, once the registration's status is set to **COMPLETE**.
If your registration's status is changed to **REQUIRES\$1UPDATES** then you can find and [edit the flagged fields](registrations-edit.md) and resubmit the registration. For a list of registration rejection reasons, see [Gen-AI Feedback on Registrations](registrations-genai-feedback.md). If you require help from Support with your registration rejection you can [open a ticket](registrations-request-support.md).
# Check a registration's status in AWS End User Messaging SMS
Your registration will be in one of these different statuses:
+ **AUTHENTICATION\$1REQUIRED** – You need to complete two-factor authentication for your registration.
+ **CLOSED** – You deleted the resources and must also delete the registration for the number.
+ **COMPLETE** – Your registration has been approved and you can start using the resource.
+ **CREATED** – Your registration is created but not submitted.
+ **DELETED** – Your registration has been deleted.
+ **REVIEWING** – Your registration has been accepted and is being reviewed. You can't make any changes to your registration or any resources associated to the registration while it is in this state.
+ **REQUIRES\$1UPDATES** – You must fix your registration and resubmit it. See [Edit a registration in AWS End User Messaging SMS](registrations-edit.md) for more information. Fields that require updates display a warning icon and a brief description of the issue.
+ **SUBMITTED** – Your registration has been submitted and is awaiting review.
**Check your registration status**
1. Open the AWS End User Messaging SMS console at [https://console.aws.amazon.com/sms-voice/](https://console.aws.amazon.com/sms-voice/).
1. In the navigation pane, under **Configurations**, choose **Registrations**.
1. On the **Registrations** table, you can then view the registration **Status** of each registration.
# Change a registration's name in AWS End User Messaging SMS
To help manage your registrations you should give them a descriptive name. You can add or edit the name of your registration at any time without having to resubmit it. You need to add a tag with the **Key** set to **Name** and the **Value** set to the name to use.
1. Open the AWS End User Messaging SMS console at [https://console.aws.amazon.com/sms-voice/](https://console.aws.amazon.com/sms-voice/).
1. In the navigation pane, under **Configurations**, choose **Registrations**.
1. On the **Registrations** page, choose the registration to add a tag to.
1. On the **Tags** tab, choose **Manage tags**. In **Manage tags** choose **Add new tag**.
1. For **Key** enter **Name** and for **Value** enter a friendly name for the registration.
1. Choose **Save changes**.
# Edit a registration in AWS End User Messaging SMS
After you submit your registration, the **registration status** will display as **Requires Updates** if there is an issue with the registration. In this state, the registration form is editable. Fields that require updates have a warning icon and a brief description of the issue.
**To edit a registration**
1. Open the AWS End User Messaging SMS console at [https://console.aws.amazon.com/sms-voice/](https://console.aws.amazon.com/sms-voice/).
1. In the navigation pane, under **Configurations**, choose **Registrations**.
1. On the **Registrations** table, select the **Registration ID** that you want to edit.
1. Choose **Update registration** to edit the form and correct fields that have a warning icon.
**Note**
If your registration was rejected and requires updates the banner lists the reason the registration was rejected and which fields need to be updated. For more information about registration rejections, see [Toll-free number registration rejection reasons](registrations-tfn-rejection-reason.md) and [Gen-AI Feedback on Registrations (Preview)](registrations-genai-feedback.md).
1. Choose **Submit registration** to resubmit when you're done.
**Important**
Recheck all fields to confirm that they're correct.
# Discard a registration's current version in AWS End User Messaging SMS
You can discard the current version of your registration and make any needed updates. If you find an error in the registration that you have submitted you can use this feature to correct the error and resubmit instead of waiting to have your registration denied and then correct the error. You can only discard the registration if its status is `Submitted`. This will permanently delete the current version of the registration.
**To discard a registration**
1. Open the AWS End User Messaging SMS console at [https://console.aws.amazon.com/sms-voice/](https://console.aws.amazon.com/sms-voice/).
1. In the navigation pane, under **Configurations**, choose **Registrations**.
1. On the **Registrations** table, select the **Registration ID** that you want.
1. Choose **Discard version** and in the window enter **discard**.
1. Choose **Discard version**.
# Delete a registration in AWS End User Messaging SMS
You can delete your registration if it is no longer needed. This will permanently delete the registration.
**To delete a registration**
1. Open the AWS End User Messaging SMS console at [https://console.aws.amazon.com/sms-voice/](https://console.aws.amazon.com/sms-voice/).
1. In the navigation pane, under **Configurations**, choose **Registrations**.
1. On the **Registrations** table, select the **Registration ID** that you want.
1. Choose **Delete registration** and in the window enter **delete**.
1. Choose **Delete registration**.
## Delete a 10DLC campaign registration
You have to delete all phone numbers associated with a 10DLC campaign registration before you can delete the 10DLC campaign registration.
**Important**
When you remove a phone number from a 10DLC campaign, you no longer have access to that phone number. Additionally, deleted 10DLC campaigns can't be restored.
**To delete a 10DLC campaign registration**
1. Open the AWS End User Messaging SMS console at [https://console.aws.amazon.com/sms-voice/](https://console.aws.amazon.com/sms-voice/).
1. In the navigation pane, under **Configurations**, choose **Registrations**.
1. On the **Registrations** table, select the **Registration ID** of the 10DLC campaign.
1. Choose **Associated resources** tab.
1. For more information on releasing phone numbers, see [Release a phone number](phone-numbers-delete.md).
To release a phone number:
1. Choose the phone number and then on the phone number detail's page choose **Release phone number**.
1. On the **Release phone number** window enter **release** and choose **Release phone number**.
1. Once all phone numbers have been released, choose **Delete registration** and in the window enter **delete**.
## Delete a 10DLC brand registration
To delete a 10DLC brand registration you must delete any 10DLC campaigns associated with the 10DLC brand registration. To delete a 10DLC campaign registration you must release all phone numbers associated to the 10DLC campaign registration.
**To delete a 10DLC brand registration**
1. Open the AWS End User Messaging SMS console at [https://console.aws.amazon.com/sms-voice/](https://console.aws.amazon.com/sms-voice/).
1. In the navigation pane, under **Configurations**, choose **Registrations**.
1. On the **Registrations** table, select the **Registration ID** of the 10DLC brand.
1. Choose **Associated resources** tab.
1. For each 10DLC campaign registration follow these directions to [release all phone numbers and delete a 10DLC campaign registration](#registrations-delete-10DLC-campaign).
1. Once all 10DLC campaign registrations are deleted, choose **Delete registration** and in the window enter **delete**.
# View a registration associated resources in AWS End User Messaging SMS
Registrations can have one to many resources associated with them depending on the registration type. You can view any resources associated with a registration on the **Associated resources tab of the registration**.
**Associate registration resources**
1. Open the AWS End User Messaging SMS console at [https://console.aws.amazon.com/sms-voice/](https://console.aws.amazon.com/sms-voice/).
1. In the navigation pane, under **Registrations**, choose a registration from the table.
1. Choose the **Associated resources** tab. Choose a resource to view more information about the resources.