Upload File

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.

This endpoint is designed to allow users to upload documents to a Port Order in order to either verify ownership of a number or resolve a blocker. By default we will make the file_name the same as it was when uploaded. However, you may also specify a different file name. Certain blockers will require you to submit supporting documentation to Flowroute. This is often a recent bill from your current service provider, a CSR (Customer Service Record), or another document provided by your current service provider. In order to upload a document to the Port Order, please PATCH the file to this end point.

Endpoint

PATCH /portorders/:id/uploaded_files

Example Request

curl https://api.flowroute.com/v2/portorders/899015/loa \
    -u accessKey:secretKey \
    -X PATCH
    -F 'file=@/path/to/bill_copy.pdf'

                        

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-21T13:18:20Z",
      "notifications_email": [],
      "notifications_url": [],
      "desired_completion_date": "",
      "lsp_requested_completion_date": "",
      "firm_order_completion_date": "",
      "end_user_information": {}, "//...JSON condensed for readability...//"
      "service_address": {}, "//...JSON condensed for readability...//"
      "wireless_fields": {
        "last_four_ssn": "",
        "pin": ""
      },
      "loa": {}, "//...JSON condensed for readability...//"
      "uploaded_files": [
        {
          "file_id": "dfjbgp985bdf",
          "file_name": "bill_copy.pdf",
          "url": "https://api.flowroute.com/accounts/portorders/899011/bill_copy.pdf",
          "uploaded_at": "2016-10-21T13:18:20Z",
          "detected_mimetype": "pdf",
          "file_size": "840"
        }
      ],
      "recommendations": [],
      "progress": {}, "//...JSON condensed for readability...//"
      "relationships": {
        "numbers": {} "//...JSON condensed for readability...//"
      }}},
  "included": [
    {
      "type": "number",
      "id": "12064205780",
      "links": {},
      "attributes": {} "//...JSON condensed for readability...//"
    }]}