Edit End User Information

Private Beta Notice

The Port Orders API endpoints are currently in Private Beta. Some features may change as we receive and incorporate your feedback. To get invited and start testing the beta version, please send an email to support@flowroute.com.

Endpoint

GET /portorders/:id

Most blockers are caused by a mismatch in End User Information between what was submitted to Flowroute and what the current service provider has on file. If this happens Flowroute will ask you to update the End User Information so that we can resubmit the port request to the current service provider.

Path Parameters

    Field Data Type Description
  • id
  • string
  • Unique identifier for the Port Order that you would like to view
  • Body Parameters

      Field Data Type Description
    • numbers
    • Array of Strings
    • Contains numbers you wish to port in E.164 format
    • alias
    • String
    • Friendly name to assign to the Port Order
    • notifications_email
    • Array of Strings
    • Contains email addresses that will be emailed whenever a change is made to the Port Order
    • notifications_url
    • Array of Strings
    • Contains URLs that will be POSTed to whenever a change is made to the Port Order
    • desired_completion_datetime
    • String
    • Date Time of when you would ideally like for the Port Order to complete
    • end_user_information
    • JSON Object
    • Contains fields related to the Current Service Provider and your account with them.
    • current_provider
    • String
    • The company from which you currently purchase telecom services
    • current_provider_account_number
    • String
    • The ID for,your account with the Losing Service Provider
    • authorized_contact
    • String
    • First and last name of the person authorized to make changes on your account with the Losing Service Provider
    • billing_number
    • String
    • Main phone number that represents your account with the Losing Service Provider
    • company_name
    • String
    • Name of the company that has the account with the Losing Service Provider
    • service_address
    • JSON Object
    • Contains fields related to the address that the Losing Service Provider has on file for the porting numbers
    • address
    • String
    • Street address where the Losing Service Provider services the porting numbers. This is often referred to as the Service Address and can be different from the Billing Address
    • address2
    • String
    • Second line of the Address; often contains Unit, Floor, or Suite information
    • city
    • String
    • City where the Losing Service Provider services the porting numbers
    • state
    • String
    • State where the Losing Service Provider services the porting numbers
    • zip
    • String
    • Zip code where the Losing Service Provider services the porting numbers
    • country
    • String
    • Country where the Losing Service Provider services the porting numbers
    • wireless_fields
    • JSON Object
    • Contains fields for additional information often required when porting numbers away from Wireless carriers
    • last_four_ssn
    • Integer
    • The last four digits of the `authorized_contact`'s social security number
    • pin
    • String
    • Pin that the Losing Service Provider requires in order to make changes to your account.

Example Request

curl https://api.flowroute.com/v2/portorders/899015 \
  -u accessKey:secretKey \
  -X PATCH
  -d {"end_user_information": {"current_provider": "Level3"}}

            

Example Response

{
  "data": [
    {
      "links": {
        "self": "https://api.flowroute.com/v2/portorders/899015"
      },
      "type": "portorder",
      "id": "899015",
      "attributes": {
        "alias": "",
        "number_cost": "7.50",
        "total_cost": "7.50",
        "created_at": "2016-10-20T10:15:24Z",
        "updated_at": "2016-10-20T10:24:36Z",
        "notifications_email": [],
        "notifications_url": [],
        "desired_completion_date": "",
        "lsp_requested_completion_date": "",
        "firm_order_completion_date": "",
        "end_user_information": {
          "current_provider": "Level3",
          "current_provider_account_number": "",
          "authorized_contact": "",
          "billing_number": "",
          "company_name": ""
        },
        "service_address": {
          "address": "",
          "address2": "",
          "city": "",
          "state": "",
          "zip": "",
          "country": ""
        },
        "wireless_fields": {
          "last_four_ssn": "",
          "pin": ""
        },
        "loa": {
          "url": "https://api.flowroute.com/accounts/portorders/899015/loa.pdf",
          "esigned": "false",
          "esigned_at": ""
        },
        "uploaded_files": [],
        "recommendations": [],
        "progress": {},
        "relationships": {
          "numbers": {
            "meta": {
              "count": "1",
              "number_type_associated": "long-code"
            },
            "links": {
              "self": "https://api.flowroute.com/v2/portorders/899015/relationships/numbers",
              "related": "https://api.flowroute.com/v2/portorders/899015/numbers"
            },
            "data": [
              {
                "type": "number",
                "id": "12064205780"
              }]}}}}],
  "included": [
    {
      "type": "number",
      "id": "12064205780",
      "links": {
        "self": "https://api.flowroute.com/v2/numbers/12064205780"
      },
      "attributes": {
        "value": "12064205780",
        "cnam_lookups": "disabled",
        "ratecenter": "seattle",
        "state": "wa"
      }}]}