com.gigs.porting.completed

Name
object
Type
string
required
Description
Type of object is always event.
Name
id
Type
string
required
Description
Unique identifier for the event.
Example: evt_0SNlurA049MEWV5gNTcQ5A07h3Ol
Name
data
Type
object
required
Description
Name
object
Type
string
required
Description
Type of object is always porting.
Name
id
Type
string
required
Description
Unique identifier for the porting.
Example: prt_0SNlurA049MEWV39s2kSYqaat7ZS
Name
accountNumber
Type
nullable string
required
Description
The account number on the donor service provider.
Example: 123456789
Name
accountPinExists
Type
boolean
required
Description
Whether the account PIN has been provided.
Example: true
Name
address
Type
nullable object
required
Description
The address of the account holder on the donor service provider.
Name
birthday
Type
nullable string
required
Description
The birthday of the account holder on the donor service provider.
Example: 2017-07-21
Name
declinedAttempts
Type
integer
required
Description
The number of declined porting attempts so far.
Example: 0
>= 0
Name
declinedCode
Type
nullable string
PREVIEW
required
Description
The code reason for the declined porting.
Example: portingPhoneNumberPortProtected
Name
declinedMessage
Type
nullable string
PREVIEW
required
Description
The reason description for the declined porting.
Example: The phone number has port protection on the provider.
Name
donorProvider
Type
nullable object
required
Description
The service provider from whom the number is ported.
Name
donorProviderApproval
Type
nullable boolean
required
Description
Whether the donor provider has approved or not the porting.
Example: true
Name
firstName
Type
nullable string
required
Description
The first name of the account holder on the donor service provider.
Example: Jerry
Name
lastName
Type
nullable string
required
Description
The last name of the account holder on the donor service provider.
Example: Seinfeld
Name
phoneNumber
Type
string
required
Description
The phone number to port in E.164 format.
Example: +19591234567
Name
provider
Type
string
required
Description
The ID of the recipient network provider.
Example: p9
Name
recipientProvider
Type
object
required
Description
The service provider to whom the number is ported.
Name
required
Type
array
required
Description
List of fields required for the porting to be processable. The fields depend on the donor and recipient providers.
Example: accountNumber,accountPin,address,birthday,donorProvider,donorProviderApproval,firstName,lastName
Name
status
Type
string
required
Description
The current status of the porting.
Allowed values: draft, pending, informationRequired, requested, declined, completed, canceled, expired
Name
subscription
Type
nullable string
required
Description
Unique identifier for the porting subscription.
Example: sub_0SNlurA049MEWV2gSfSxi00xlPIi
Name
user
Type
string
required
Description
Unique identifier for the user this porting is for.
Example: usr_0SNlurA049MEWV4OpCwsNyC9Kn2d
Name
canceledAt
Type
nullable string
required
Description
Time when the porting was canceled.
Example: 2021-01-21T19:39:53Z
Name
completedAt
Type
nullable string
required
Description
Time when the porting was completed.
Example: 2021-01-21T19:36:57Z
Name
createdAt
Type
string
required
Description
Time when the porting was created.
Example: 2021-01-21T19:12:28Z
Name
expiredAt
Type
nullable string
required
Description
Time when the porting was expired.
Example: 2021-01-21T19:39:53Z
Name
lastDeclinedAt
Type
nullable string
required
Description
Time when the porting was last declined.
Example: 2021-01-21T19:31:13Z
Name
lastRequestedAt
Type
nullable string
required
Description
Time when the porting was last requested.
Example: 2021-01-21T19:22:31Z
Name
datacontenttype
Type
string
required
Description
The RFC 2046 content-type.
Example: application/json
Default: application/json
Name
project
Type
string
required
Description
Unique identifier for the project where the event occurred.
Example: gigs
Name
source
Type
string
required
Description
URI identifying the event source.
Example: https://api.gigs.com
Default: https://api.gigs.com
Name
specversion
Type
string
required
Description
The CloudEvents spec version.
Example: 1.0
Default: 1.0
Name
time
Type
string
required
Description
Time when the event occurred.
Example: 2022-03-16T14:12:42Z
Name
type
Type
string
required
Description
Type is always com.gigs.porting.completed.
Name
version
Type
string
required
Description
API version used to serialize the data and the event itself.
Default: 2024-08-29

Example

{
  "object": "event",
  "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
  "data": {
    "object": "porting",
    "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
    "accountNumber": "123456789",
    "accountPinExists": true,
    "address": {
      "city": "New York City",
      "country": "US",
      "line1": "129 West 81st Street",
      "line2": "Apartment 5A",
      "postalCode": "10024",
      "state": "NY"
    },
    "birthday": "2017-07-21",
    "declinedCode": "portingPhoneNumberPortProtected",
    "declinedMessage": "The phone number has port protection on the provider.",
    "donorProvider": {
      "object": "serviceProvider",
      "id": "svp_0SNlurA01K6GY5L0XJffY8",
      "name": "AT&T",
      "recipientProviders": [
        "p3"
      ]
    },
    "donorProviderApproval": true,
    "firstName": "Jerry",
    "lastName": "Seinfeld",
    "phoneNumber": "+19591234567",
    "provider": "p9",
    "recipientProvider": {
      "object": "serviceProvider",
      "id": "svp_0SNlurA01K6GY5L0XJffY8",
      "name": "AT&T",
      "recipientProviders": [
        "p3"
      ]
    },
    "required": [
      "accountNumber",
      "accountPin",
      "address",
      "birthday",
      "donorProvider",
      "donorProviderApproval",
      "firstName",
      "lastName"
    ],
    "status": "draft",
    "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
    "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
    "canceledAt": "2021-01-21T19:39:53Z",
    "completedAt": "2021-01-21T19:36:57Z",
    "createdAt": "2021-01-21T19:12:28Z",
    "expiredAt": "2021-01-21T19:39:53Z",
    "lastDeclinedAt": "2021-01-21T19:31:13Z",
    "lastRequestedAt": "2021-01-21T19:22:31Z"
  },
  "datacontenttype": "application/json",
  "project": "gigs",
  "source": "https://api.gigs.com",
  "specversion": "1.0",
  "time": "2022-03-16T14:12:42Z",
  "type": "com.gigs.porting.completed",
  "version": "2024-08-29"
}