---
title: "POST /v1/whatsapp/signup"
method: POST
path: "/v1/whatsapp/signup"
---

# POST /v1/whatsapp/signup

`POST /v1/whatsapp/signup`

This is only used through the Amazon Web Services console during sign-up to associate your WhatsApp Business Account to your Amazon Web Services account.

## Request body

- object
  - `signupCallback` object — Contains the <code>accessToken</code> provided by Meta during signup.
    - `accessToken` string — The access token for your WhatsApp Business Account. The <code>accessToken</code> value is provided by Meta.
    - `callbackUrl` string — The URL where WhatsApp will send callback notifications for this account.
  - `setupFinalization` object — The details of linking a WhatsApp Business Account to your Amazon Web Services account.
    - `associateInProgressToken` string, password — An Amazon Web Services access token generated by <code>WhatsAppSignupCallback</code> and used by <code>WhatsAppSetupFinalization</code>.
    - `phoneNumbers` WabaPhoneNumberSetupFinalization[] — An array of WabaPhoneNumberSetupFinalization objects containing the details of each phone number associated with the WhatsApp Business Account.
      - `id` string, required — The unique identifier of the originating phone number associated with the media. Phone number identifiers are formatted as <code>phone-number-id-01234567890123456789012345678901</code>. Use the <a href="https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_GetLinkedWhatsAppBusinessAccount.html">GetLinkedWhatsAppBusinessAccount</a> API action to find a phone number's id.
      - `twoFactorPin` string, password, required — The PIN to use for two-step verification. To reset your PIN follow the directions in <a href="https://developers.facebook.com/docs/whatsapp/cloud-api/reference/two-step-verification/#updating-pin">Updating PIN</a> in the <i>WhatsApp Business Platform Cloud API Reference</i>.
      - `dataLocalizationRegion` string — <p>The two letter ISO region for the location of where Meta will store data.</p> <p class="title"> <b>Asia–Pacific (APAC)</b> </p> <ul> <li> <p>Australia <b>AU</b> </p> </li> <li> <p>Indonesia <b>ID</b> </p> </li> <li> <p>India <b>IN</b> </p> </li> <li> <p>Japan <b>JP</b> </p> </li> <li> <p>Singapore <b>SG</b> </p> </li> <li> <p>South Korea <b>KR</b> </p> </li> </ul> <p class="title"> <b>Europe</b> </p> <ul> <li> <p>Germany <b>DE</b> </p> </li> <li> <p>Switzerland <b>CH</b> </p> </li> <li> <p>United Kingdom <b>GB</b> </p> </li> </ul> <p class="title"> <b>Latin America (LATAM)</b> </p> <ul> <li> <p>Brazil <b>BR</b> </p> </li> </ul> <p class="title"> <b>Middle East and Africa (MEA)</b> </p> <ul> <li> <p>Bahrain <b>BH</b> </p> </li> <li> <p>South Africa <b>ZA</b> </p> </li> <li> <p>United Arab Emirates <b>AE</b> </p> </li> </ul> <p class="title"> <b>North America (NORAM)</b> </p> <ul> <li> <p>Canada <b>CA</b> </p> </li> </ul>
      - `tags` Tag[] — An array of key and value pair tags.
        - `key` string, required — The tag key.
        - `value` string — The tag value.
    - `phoneNumberParent` string — Used to add a new phone number to an existing WhatsApp Business Account. This field can't be used when the <code>waba</code> field is present.
    - `waba` object — Used to create a new WhatsApp Business Account and add a phone number. This field can't be used when the <code>phoneNumberParent</code> field is present.
      - `id` string — The ID of the linked WhatsApp Business Account, formatted as <code>waba-01234567890123456789012345678901</code>.
      - `eventDestinations` WhatsAppBusinessAccountEventDestination[] — The event destinations for the linked WhatsApp Business Account.
        - `eventDestinationArn` string, required — The ARN of the event destination.
        - `roleArn` string — The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to import phone numbers and write events.
      - `tags` Tag[] — An array of key and value pair tags.
        - `key` string, required — The tag key.
        - `value` string — The tag value.

## Response `200`

Success

- AssociateWhatsAppBusinessAccountOutput
  - `signupCallbackResult` object — Contains your WhatsApp registration status.
    - `associateInProgressToken` string, password — An Amazon Web Services access token generated by <code>WhatsAppSignupCallback</code> and used by <code>WhatsAppSetupFinalization</code>.
    - `linkedAccountsWithIncompleteSetup` object — A LinkedWhatsAppBusinessAccountIdMetaData object map containing the details of any WhatsAppBusiness accounts that have incomplete setup.
  - `statusCode` integer — The status code for the response.
  - `linkedWhatsAppBusinessAccountId` string — The ID of the WhatsApp Business Account that was linked to your Amazon Web Services account.

## Other responses

- `480` — ValidationException
- `481` — LimitExceededException
- `482` — AccessDeniedException
- `483` — InvalidParametersException
- `484` — ThrottledRequestException
- `485` — DependencyException

---

[API](https://skmtc.net/aws/apis/socialmessaging.md) · [All operations](https://skmtc.net/aws/apis/socialmessaging/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/socialmessaging/revisions/127e73cd9a15/schema)