---
title: "PORT_DATA_SUCCEEDED"
method: POST
path: "port_data_succeeded"
---

# PORT_DATA_SUCCEEDED

`POST port_data_succeeded` (webhook)

Fired when the information required to port a user's phone number to another carrier has been successfully retrieved from their merchant account.

## Payload

- PortDataSucceededWebhook
  - `event` string: Name of the webhook event.
  - `session_id` string: Unique identifier for the session.
  - `task_id` integer: Unique identifier for the task.
  - `external_user_id` string: Unique identifier for the user.
  - `merchant` object
    - `id` integer: Unique identifier for the merchant.
    - `name` string: Name of the merchant.
    - `logo` string: Logo URL for the merchant.
  - `data` object
    - `user` object, nullable: Account holder details on file with the carrier.
      - `name` object, nullable
        - `first_name` string, nullable: First name of the account holder.
        - `last_name` string, nullable: Last name of the account holder.
      - `address` object, nullable: Address of the account holder on file with the carrier.
        - `street` string, nullable: First line of the address.
        - `street2` string, nullable: Second line of the address.
        - `city` string, nullable: City portion of the address.
        - `region` string, nullable: Region portion of the address, usually a state abbreviation. Must be an ISO 3166-2 sub-division code.
        - `postal_code` string, nullable: Postal code of the address.
        - `country` string, nullable: Country portion of the address. Must be an ISO 3166-1 alpha-2 code.
      - `phone_number` string, nullable: Phone number to be ported to another carrier, in E.164 format.
    - `account_number` string, nullable: Account number for the user's phone plan with the carrier.
    - `transfer_pin` object, nullable: PIN that authorizes porting the phone number to another carrier.
      - `pin` string, nullable: PIN issued by the carrier. Also referred to as a number transfer PIN or port-out PIN.
      - `expires_at` string, date-time, nullable: ISO timestamp when the PIN expires. `null` if the carrier does not publish an expiration.
    - `metadata` object, nullable: Custom key-value pairs provided during session creation or SDK invocation. Only present if metadata was provided.
  - `timestamp` integer: Unix timestamp of the webhook event in UTC.

---

[API](https://skmtc.dev/knotapi/apis/knot-api.md) - [All operations](https://skmtc.dev/knotapi/apis/knot-api/llms.txt) - [OpenAPI document](https://skmtc.dev/knotapi/apis/knot-api/revisions/f10ecfa12c00?raw)