NAV
http

Introduction

The PROOF API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Environments

Environment URL
Staging https://api-staging.proofserve.com/v1/
Production https://api.proofserve.com/v1/

Authentication

Example authenticated request:

curl "<ENDPOINT>"
  -H "Authorization: <API_KEY>"

Make sure to replace <API_KEY> with your API key. You can generate an API key by logging in and going to Billing & Configuration > API.

Authentication to the API is performed via HTTP Basic Auth. Provide your API key as the basic auth username value. You do not need to provide a password. API keys can be generated within the web app in the Billing & Configuration > API page.

Errors

PROOF uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, the request failed, etc.). Codes in the 5xx range indicate an error with PROOF's servers (these are rare).

Rate limit

All accounts start off with a rate limit of 1,200 requests per minute. If you make over 1,200 requests in a given minute, your requests will begin returning 429 status codes. If you need a higher limit, please contact PROOF. A basic technique for integrations to gracefully handle limiting is to watch for 429 status codes and build in a retry mechanism. The retry mechanism should follow an exponential backoff schedule to reduce request volume when necessary.

All API responses will return the following headers that you can use to monitor your rate limit, as well as how many calls you have remaining in the current period before you hit your limit:\ X-RateLimit-Limit: 1200\ X-RateLimit-Remaining: 1185

Attempt Photos

Get attempt photo

Example response:

<image file>

HTTP Request

GET /attempt-photos/{attempt_photo_id}.{ext}

Billing

Get payment methods

Example response:

[
  {
    "id": "card_1FZPO6Hg213tM5vxmGNVNkt2",
    "brand": "American Express",
    "last4": "0005",
    "address_zip": "32423",
    "billing_name": "Martin Wachocki",
    "exp_month": 2,
    "exp_year": 2022,
    "default": true,
    "shared": false,
    "user_id": 2,
    "label": "Marty's AMEX"
  }
]

HTTP Request

GET /billing/payment-methods

Documents

Upload document

Example request body:

"<file>"

Example response:

{
  "title": "",
  "court_name": "",
  "court_address": "",
  "case_number": "",
  "billing_number": "",
  "court_date": "",
  "plaintiffs": [],
  "defendants": [],
  "document": {
    "name": "",
    "filename": "file.pdf",
    "size": 13264,
    "extension": "pdf",
    "law_firm_id": 2,
    "created_by_id": 2,
    "updated_at": 1593129234000,
    "created_at": 1593129234000,
    "id": 549
  },
  "multiple_documents": false,
  "page_count": "1"
}

HTTP Request

POST /documents

In supported states we will attempt to parse and return pertinent information from the PDF file (e.g. document title, court name, plantiffs, etc.). This data should be verified by the user before submitted.

Get document

Example response:

<pdf file>

HTTP Request

GET /documents/{document_id}.{ext}

Export

Export jobs (csv)

Example response:

<csv file>

HTTP Request

GET /export/{start}/{end}/csv

URL Parameters

Parameter Description
start
integer, required
UNIX Timestamp in milliseconds
end
integer, required
UNIX Timestamp in milliseconds

Invoices

Get invoices

Example response:

{
  "current_page": 1,
  "last_page": 4,
  "per_page": 8,
  "total": 25,
  "data": [
    {
      "id": 4,
      "user_id": 2,
      "law_firm_id": 2,
      "job_id": 8,
      "total": "75.0000000000",
      "paid_amount": "75.0000000000",
      "paid": 1,
      "created_at": 1548853797000,
      "updated_at": 1548853797000,
      "deleted_at": null,
      "line_items": [
        {
          "id": 1,
          "invoice_id": 4,
          "name": "Standard Serve (Base Fee)",
          "description": "Servee: John Doe\nCase Number: C12345\nAttempts Made: 2\n",
          "price": "25.0000000000",
          "quantity": 1,
          "total": "25.0000000000",
          "created_at": 1548853846000,
          "updated_at": 1548853846000
        },
        {
          "id": 2,
          "invoice_id": 4,
          "name": "Standard Serve (Bounty)",
          "description": "Serve Date: 02/10/2019",
          "price": "50.0000000000",
          "quantity": 1,
          "total": "50.0000000000",
          "created_at": 1548853846000,
          "updated_at": 1548853846000
        }
      ],
      "user": {
        "id": 2,
        "law_firm_id": 2,
        "type": "FIRM",
        "name": "Marty Wachocki",
        "last_name": "Wachocki",
        "first_name": "Marty",
        "active": 1,
        "email": "firm@proofserve.com",
        "stripe_default_card_id": "card_1FZPO6Hg213tM5vxmGNVNkt2",
        "email_invoices": true,
        "email_notifications": true,
        "email_verified": true,
        "administrator": true,
        "phone_number": "7347304250",
        "address_1": "7154 Eaton Ct",
        "address_2": null,
        "city": "Arvada",
        "state_id": 1,
        "zip": "80003",
        "created_at": 1548158103000,
        "updated_at": 1592352020000,
        "deleted_at": null,
        "email_chat_messages": 1,
        "email_progress_updates": 1,
        "email_reassigned": 1,
        "email_job_completed": 1,
        "notify_hours": 1
      },
      "job": {
        "id": 8,
        "user_id": 2,
        "law_firm_id": 2,
        "server_id": 6,
        "original_job_id": null,
        "new_job_id": 50,
        "status": "IN_PROGRESS",
        "contact_first_name": "",
        "contact_last_name": "",
        "contact_email": "",
        "contact_phone": null,
        "billing_number": "A00012345",
        "court_name": "Jefferson County District Court",
        "case_number": "CL35832",
        "state_id": 1,
        "serve_pricing_id": 1,
        "stripe_card_id": "card_1Dy074Hg213tM5vxjBic4l40",
        "post_serve": false,
        "assign_date": null,
        "created_by_id": 2,
        "attempts_made": 2,
        "last_attempt": "2019-03-27 16:30:34",
        "successful_attempt": false,
        "successful_at": null,
        "completed_at": null,
        "due_date": 1548435181000,
        "originated_at": 1548340763000,
        "subpoena": false,
        "witness_fee": null,
        "authorize_skiptrace": true,
        "review_period_ends": null,
        "created_at": 1548340763000,
        "updated_at": 1590222678000,
        "deleted_at": null,
        "court_date": null,
        "same_address_job_id": null,
        "attorney_name": null,
        "attorney_bar_number": null,
        "court_street_address": null,
        "court_mailing_address": null,
        "court_city": null,
        "court_zip": null,
        "court_branch_name": null,
        "court_address": null,
        "last_status_change": null,
        "signed_affidavit_url": null,
        "servee": {
          "id": 7,
          "type": "INDIVIDUAL",
          "job_id": 8,
          "name": "Jane Smith",
          "registered_agent_name": null,
          "physical_description": true,
          "race": "White",
          "gender": "Male",
          "hair_color": "Brown",
          "marital_status": "Married",
          "eye_glasses": "Yes",
          "height": "5' 9\" to 6'",
          "weight": "160 to 180 lbs",
          "age": 30,
          "notes": "He works from 9-5\nCompany name is Propel Technology",
          "social_links": "https://www.facebook.com/propelitco/",
          "created_at": 1548083163000,
          "updated_at": 1548083163000,
          "deleted_at": null
        }
      }
    }
  ]
}

HTTP Request

GET /invoices

Get invoice

Example response:

{
  "id": 4,
  "user_id": 2,
  "law_firm_id": 2,
  "job_id": 8,
  "total": "75.0000000000",
  "paid_amount": "75.0000000000",
  "paid": 1,
  "created_at": 1548853797000,
  "updated_at": 1548853797000,
  "deleted_at": null,
  "line_items": [
    {
      "id": 1,
      "invoice_id": 4,
      "name": "Standard Serve (Base Fee)",
      "description": "Servee: John Doe\nCase Number: C12345\nAttempts Made: 2\n",
      "price": "25.0000000000",
      "quantity": 1,
      "total": "25.0000000000",
      "created_at": 1548853846000,
      "updated_at": 1548853846000
    },
    {
      "id": 2,
      "invoice_id": 4,
      "name": "Standard Serve (Bounty)",
      "description": "Serve Date: 02/10/2019",
      "price": "50.0000000000",
      "quantity": 1,
      "total": "50.0000000000",
      "created_at": 1548853846000,
      "updated_at": 1548853846000
    }
  ],
  "user": {
    "id": 2,
    "law_firm_id": 2,
    "type": "FIRM",
    "name": "Marty Wachocki",
    "last_name": "Wachocki",
    "first_name": "Marty",
    "active": 1,
    "email": "firm@proofserve.com",
    "stripe_default_card_id": "card_1FZPO6Hg213tM5vxmGNVNkt2",
    "email_invoices": true,
    "email_notifications": true,
    "email_verified": true,
    "administrator": true,
    "phone_number": "7347304250",
    "address_1": "7154 Eaton Ct",
    "address_2": null,
    "city": "Arvada",
    "state_id": 1,
    "zip": "80003",
    "created_at": 1548158103000,
    "updated_at": 1592352020000,
    "deleted_at": null,
    "email_chat_messages": 1,
    "email_progress_updates": 1,
    "email_reassigned": 1,
    "email_job_completed": 1,
    "notify_hours": 1
  },
  "law_firm": {
    "id": 2,
    "name": "Acme Law Firm",
    "phone_number": "7347304250",
    "email": "marty@wachocki.net",
    "address_1": "8753 Yates Dr",
    "address_2": "#215",
    "city": "Westminster",
    "state_id": 1,
    "zip": "80031",
    "email_invoices_to": null,
    "created_at": 1548272881000,
    "updated_at": 1590996239000,
    "deleted_at": null,
    "free_credits": "75.0000000000",
    "api_enabled": true
  },
  "job": {
    "id": 8,
    "user_id": 2,
    "law_firm_id": 2,
    "server_id": 6,
    "original_job_id": null,
    "new_job_id": 50,
    "status": "IN_PROGRESS",
    "contact_first_name": "",
    "contact_last_name": "",
    "contact_email": "",
    "contact_phone": null,
    "billing_number": "A00012345",
    "court_name": "Jefferson County District Court",
    "case_number": "CL35832",
    "state_id": 1,
    "serve_pricing_id": 1,
    "stripe_card_id": "card_1Dy074Hg213tM5vxjBic4l40",
    "post_serve": false,
    "assign_date": null,
    "created_by_id": 2,
    "attempts_made": 2,
    "last_attempt": "2019-03-27 16:30:34",
    "successful_attempt": false,
    "successful_at": null,
    "completed_at": null,
    "due_date": 1548435181000,
    "originated_at": 1548340763000,
    "subpoena": false,
    "witness_fee": null,
    "authorize_skiptrace": true,
    "review_period_ends": null,
    "created_at": 1548340763000,
    "updated_at": 1590222678000,
    "deleted_at": null,
    "court_date": null,
    "same_address_job_id": null,
    "attorney_name": null,
    "attorney_bar_number": null,
    "court_street_address": null,
    "court_mailing_address": null,
    "court_city": null,
    "court_zip": null,
    "court_branch_name": null,
    "court_address": null,
    "last_status_change": null,
    "signed_affidavit_url": null,
    "servee": {
      "id": 7,
      "type": "INDIVIDUAL",
      "job_id": 8,
      "name": "Jane Smith",
      "registered_agent_name": null,
      "physical_description": true,
      "race": "White",
      "gender": "Male",
      "hair_color": "Brown",
      "marital_status": "Married",
      "eye_glasses": "Yes",
      "height": "5' 9\" to 6'",
      "weight": "160 to 180 lbs",
      "age": 30,
      "notes": "He works from 9-5\nCompany name is Propel Technology",
      "social_links": "https://www.facebook.com/propelitco/",
      "created_at": 1548083163000,
      "updated_at": 1548083163000,
      "deleted_at": null
    }
  },
  "payments": [
    {
      "id": 1,
      "invoice_id": 4,
      "stripe_customer_id": "",
      "stripe_card_id": "",
      "stripe_charge_id": "",
      "type": "STRIPE",
      "card_brand": "Visa",
      "card_name": "Marty's Card",
      "card_last_4": 8030,
      "amount": "75.0000000000",
      "notes": null,
      "created_at": 1550065265000,
      "updated_at": 1550065265000
    }
  ]
}

HTTP Request

GET /invoices/{invoice_id}

Get invoice pdf

Example response:

<pdf file>

HTTP Request

GET /invoices/{invoice_id}/pdf

Jobs

Get all jobs

Example response:

{
  "current_page": 1,
  "last_page": 18,
  "per_page": 8,
  "total": 138,
  "data": [
    {
      "id": 6,
      "user_id": 2,
      "law_firm_id": 2,
      "server_id": 6,
      "original_job_id": null,
      "new_job_id": null,
      "status": "COMPLETED",
      "contact_first_name": "",
      "contact_last_name": "",
      "contact_email": "",
      "contact_phone": null,
      "billing_number": "W00093577",
      "court_name": "Adams County District Court",
      "case_number": "CL35832",
      "state_id": 1,
      "serve_pricing_id": 1,
      "stripe_card_id": "card_1Dy074Hg213tM5vxjBic4l40",
      "post_serve": false,
      "assign_date": null,
      "created_by_id": 2,
      "attempts_made": 1,
      "last_attempt": "2019-01-23 10:17:29",
      "successful_attempt": false,
      "successful_at": null,
      "completed_at": null,
      "due_date": 1549299181000,
      "originated_at": 1547995163000,
      "subpoena": true,
      "witness_fee": "15.0000000000",
      "authorize_skiptrace": true,
      "review_period_ends": null,
      "created_at": 1547995163000,
      "updated_at": 1590222678000,
      "deleted_at": null,
      "court_date": null,
      "same_address_job_id": null,
      "attorney_name": null,
      "attorney_bar_number": null,
      "court_street_address": null,
      "court_mailing_address": null,
      "court_city": null,
      "court_zip": null,
      "court_branch_name": null,
      "court_address": null,
      "last_status_change": null,
      "signed_affidavit_url": "http://localhost:8000/v1/jobs/6/signed-affidavit",
      "server": {
        "id": 6,
        "law_firm_id": null,
        "type": "SERVER",
        "name": "Test Server",
        "last_name": "Server",
        "first_name": "Test",
        "active": 1,
        "email": "server@proofserve.com",
        "administrator": false,
        "phone_number": "7347304250",
        "state_id": 1,
        "created_at": 1548158103000,
        "updated_at": 1592327398000,
        "deleted_at": null
      },
      "servee": {
        "id": 5,
        "type": "INDIVIDUAL",
        "job_id": 6,
        "name": "John Doe",
        "registered_agent_name": null,
        "physical_description": true,
        "race": "White",
        "gender": "Male",
        "hair_color": "Brown",
        "marital_status": "Married",
        "eye_glasses": "Yes",
        "height": "5' 9\" to 6'",
        "weight": "160 to 180 lbs",
        "age": 30,
        "notes": "He works from 9-5\nCompany name is Propel Technology",
        "social_links": "https://www.facebook.com/propelitco/",
        "created_at": 1548083163000,
        "updated_at": 1548083163000,
        "deleted_at": null,
        "servee_addresses": [
          {
            "id": 2,
            "servee_id": 5,
            "type": "HOME",
            "business_name": null,
            "address_1": "7154 Eaton Ct",
            "address_2": "",
            "city": "Arvada",
            "state_id": 1,
            "zip": "80003",
            "primary": true,
            "longitude": -105.0596457,
            "latitude": 39.8252367,
            "county": "Jefferson County",
            "created_at": 1548155651000,
            "updated_at": 1548571137000,
            "deleted_at": null,
            "timezone": "America/Denver",
            "state": {
              "id": 1,
              "name": "Colorado",
              "abbreviation": "CO",
              "allow_jobs": true,
              "allow_residential_sub": true,
              "allow_work_sub": true,
              "created_at": 1562780993000,
              "updated_at": 1562755793000,
              "deleted_at": null,
              "affidavit_service_title": "Affidavit of Service",
              "affidavit_nonservice_title": "Affidavit of Nonservice",
              "requires_notary_service": true,
              "requires_notary_nonservice": true,
              "allow_sunday_serve": 1
            }
          },
          {
            "id": 3,
            "servee_id": 5,
            "type": "WORK",
            "business_name": null,
            "address_1": "8753 Yates Dr",
            "address_2": "#215",
            "city": "Westminster",
            "state_id": 1,
            "zip": "80031",
            "primary": false,
            "longitude": -105.0508555,
            "latitude": 39.8547598,
            "county": "Adams County",
            "created_at": 1548155694000,
            "updated_at": 1548571137000,
            "deleted_at": null,
            "timezone": "America/Denver",
            "state": {
              "id": 1,
              "name": "Colorado",
              "abbreviation": "CO",
              "allow_jobs": true,
              "allow_residential_sub": true,
              "allow_work_sub": true,
              "created_at": 1562780993000,
              "updated_at": 1562755793000,
              "deleted_at": null,
              "affidavit_service_title": "Affidavit of Service",
              "affidavit_nonservice_title": "Affidavit of Nonservice",
              "requires_notary_service": true,
              "requires_notary_nonservice": true,
              "allow_sunday_serve": 1
            }
          },
          {
            "id": 81,
            "servee_id": 5,
            "type": "WORK",
            "business_name": "moe's bagels",
            "address_1": "1003 Broadway",
            "address_2": "",
            "city": "Boulder",
            "state_id": 1,
            "zip": "80302",
            "primary": false,
            "longitude": -105.2808049,
            "latitude": 40.025072,
            "county": "Boulder County",
            "created_at": 1551082989000,
            "updated_at": 1551082989000,
            "deleted_at": null,
            "timezone": "America/Denver",
            "state": {
              "id": 1,
              "name": "Colorado",
              "abbreviation": "CO",
              "allow_jobs": true,
              "allow_residential_sub": true,
              "allow_work_sub": true,
              "created_at": 1562780993000,
              "updated_at": 1562755793000,
              "deleted_at": null,
              "affidavit_service_title": "Affidavit of Service",
              "affidavit_nonservice_title": "Affidavit of Nonservice",
              "requires_notary_service": true,
              "requires_notary_nonservice": true,
              "allow_sunday_serve": 1
            }
          }
        ]
      },
      "state": {
        "id": 1,
        "name": "Colorado",
        "abbreviation": "CO",
        "allow_jobs": true,
        "allow_residential_sub": true,
        "allow_work_sub": true,
        "created_at": 1562780993000,
        "updated_at": 1562755793000,
        "deleted_at": null,
        "affidavit_service_title": "Affidavit of Service",
        "affidavit_nonservice_title": "Affidavit of Nonservice",
        "requires_notary_service": true,
        "requires_notary_nonservice": true,
        "allow_sunday_serve": 1
      },
      "user": {
        "id": 2,
        "law_firm_id": 2,
        "type": "FIRM",
        "name": "Marty Wachocki",
        "last_name": "Wachocki",
        "first_name": "Marty",
        "active": 1,
        "email": "firm@proofserve.com",
        "stripe_default_card_id": "card_1FZPO6Hg213tM5vxmGNVNkt2",
        "email_invoices": true,
        "email_notifications": true,
        "email_verified": true,
        "administrator": true,
        "phone_number": "7347304250",
        "address_1": "7154 Eaton Ct",
        "address_2": null,
        "city": "Arvada",
        "state_id": 1,
        "zip": "80003",
        "created_at": 1548158103000,
        "updated_at": 1592352020000,
        "deleted_at": null,
        "email_chat_messages": 1,
        "email_progress_updates": 1,
        "email_reassigned": 1,
        "email_job_completed": 1,
        "notify_hours": 1
      },
      "law_firm": {
        "id": 2,
        "name": "Acme Law Firm",
        "phone_number": "7347304250",
        "email": "marty@wachocki.net",
        "address_1": "8753 Yates Dr",
        "address_2": "#215",
        "city": "Westminster",
        "state_id": 1,
        "zip": "80031",
        "email_invoices_to": null,
        "created_at": 1548272881000,
        "updated_at": 1590996239000,
        "deleted_at": null,
        "free_credits": "75.0000000000",
        "api_enabled": true
      },
      "serve_pricing": {
        "id": 1,
        "name": "Standard",
        "state_id": 1,
        "base_fee": 25,
        "bounty_fee": 50,
        "diy_price": 75,
        "post_price": 45,
        "post_duration": 172800,
        "initial_duration": 604800,
        "total_duration": 604800,
        "total_attempts": 4,
        "updated_at": 1548331771000,
        "created_at": 1548331771000
      },
      "offered_server": null,
      "same_address_jobs": [],
      "flags": []
    }
  ]
}

HTTP Request

GET /jobs

Create a job

Example request body:

{
  "court_name": "Denver County Court",
  "court_address": "520 W Colfax Ave, Denver, CO 80204",
  "case_number": "CV-12345",
  "court_date": "2020-07-30",
  "contact_first_name": "Marty",
  "contact_last_name": "Wachocki",
  "contact_email": "firm@proofserve.com",
  "contact_phone": "7347304250",
  "state_id": 1,
  "billing_number": "P12345",
  "status": "UNASSIGNED",
  "stripe_card_id": "card_1FZPO6Hg213tM5vxmGNVNkt2",
  "plaintiffs": [
    {
      "name": "John Doe"
    }
  ],
  "defendants": [
    {
      "name": "Jane Smith"
    }
  ],
  "documents": [
    {
      "id": 550,
      "name": "Summons"
    }
  ],
  "servees": [
    {
      "type": "INDIVIDUAL",
      "name": "Jane Smith",
      "physical_description": true,
      "race": "White",
      "gender": "Male",
      "hair_color": "Blonde",
      "marital_status": "Married",
      "eye_glasses": "No",
      "height": "5' 9\" to 6'",
      "weight": "160 lbs to 180 lbs",
      "age": "35",
      "serve_pricing_id": 1,
      "serve_pricing_name": "Standard",
      "notes": "The servee is usually working from 9am to 5pm.",
      "subpoena": false,
      "authorize_skiptrace": false,
      "same_address": false,
      "servee_addresses": [
        {
          "type": "WORK",
          "business_name": "Glade Voogt Lopez Smith",
          "address_1": "1800 N Gaylord St",
          "address_2": "",
          "city": "Denver",
          "state_id": 1,
          "zip": "80206",
          "primary": true
        },
        {
          "type": "HOME",
          "address_1": "1437 Bannock St",
          "address_2": "",
          "city": "Denver",
          "state_id": 1,
          "zip": "80202"
        }
      ],
      "servee_marks": [
        {
          "type": "Tattoo",
          "details": "Large face tattoo"
        }
      ],
      "servee_photos": [
        {
          "id": 138
        }
      ]
    }
  ]
}

Example response:

{
  "jobs": [
    {
      "court_name": "Denver County Court",
      "court_address": "520 W Colfax Ave, Denver, CO 80204",
      "case_number": "CV-12345",
      "court_date": "2020-07-30",
      "contact_first_name": "Marty",
      "contact_last_name": "Wachocki",
      "contact_email": "firm@proofserve.com",
      "contact_phone": "7347304250",
      "state_id": 1,
      "billing_number": "P12345",
      "status": "UNASSIGNED",
      "stripe_card_id": "card_1FZPO6Hg213tM5vxmGNVNkt2",
      "originated_at": 1593129247000,
      "serve_pricing_id": 1,
      "authorize_skiptrace": false,
      "post_serve": false,
      "subpoena": false,
      "last_status_change": 1593129247000,
      "user_id": 2,
      "law_firm_id": 2,
      "created_by_id": 2,
      "updated_at": 1593129248000,
      "created_at": 1593129247000,
      "id": 267,
      "signed_affidavit_url": null,
      "servee": {
        "id": 259,
        "type": "INDIVIDUAL",
        "job_id": 267,
        "name": "Jane Smith",
        "registered_agent_name": null,
        "physical_description": true,
        "race": "White",
        "gender": "Male",
        "hair_color": "Blonde",
        "marital_status": "Married",
        "eye_glasses": "No",
        "height": "5' 9\" to 6'",
        "weight": "160 lbs to 180 lbs",
        "age": 35,
        "notes": "The servee is usually working from 9am to 5pm.",
        "social_links": null,
        "created_at": 1593129247000,
        "updated_at": 1593129247000,
        "deleted_at": null,
        "servee_photos": [],
        "servee_addresses": [
          {
            "id": 401,
            "servee_id": 259,
            "type": "WORK",
            "business_name": "Glade Voogt Lopez Smith",
            "address_1": "1800 N Gaylord St",
            "address_2": "",
            "city": "Denver",
            "state_id": 1,
            "zip": "80206",
            "primary": true,
            "longitude": -104.9606913,
            "latitude": 39.7450098,
            "county": "Denver County",
            "created_at": 1593129248000,
            "updated_at": 1593129248000,
            "deleted_at": null,
            "timezone": "America/Denver",
            "state": {
              "id": 1,
              "name": "Colorado",
              "abbreviation": "CO",
              "allow_jobs": true,
              "allow_residential_sub": true,
              "allow_work_sub": true,
              "created_at": 1562780993000,
              "updated_at": 1562755793000,
              "deleted_at": null,
              "affidavit_service_title": "Affidavit of Service",
              "affidavit_nonservice_title": "Affidavit of Nonservice",
              "requires_notary_service": true,
              "requires_notary_nonservice": true,
              "allow_sunday_serve": 1
            }
          },
          {
            "id": 402,
            "servee_id": 259,
            "type": "HOME",
            "business_name": null,
            "address_1": "1437 Bannock St",
            "address_2": "",
            "city": "Denver",
            "state_id": 1,
            "zip": "80202",
            "primary": false,
            "longitude": -104.9910272,
            "latitude": 39.7392435,
            "county": "Denver County",
            "created_at": 1593129248000,
            "updated_at": 1593129248000,
            "deleted_at": null,
            "timezone": "America/Denver"
          }
        ]
      },
      "defendants": [],
      "plaintiffs": []
    }
  ]
}

HTTP Request

POST /jobs

Tips:

Request Parameters

Parameter Description
court_name
string
court_address
string
case_number
string
court_date
string
contact_first_name
string, required
contact_last_name
string, required
contact_phone
string, required
state_id
integer, required
Reference state id from Get All States
billing_number
string, required
This should be a unique internal reference #.
status
string, required
One of: DRAFT, UNASSIGNED
stripe_card_id
string, required
plaintiffs
array
plaintiffs.*.name
string, required
defendants
array
defendants.*.name
string, required
documents
array, required
documents.*.id
integer, required
documents.*.name
string, required
servees
array, required
servees.*.type
string, required
One of: INDIVIDUAL, ENTITY
servees.*.name
string, required
servees.*.physical_description
boolean
Default: false.
servees.*.race
string
If physical_description is false, don't provide.
servees.*.gender
string
If physical_description is false, don't provide.
servees.*.hair_color
string
If physical_description is false, don't provide.
servees.*.marital_status
string
If physical_description is false, don't provide.
servees.*.eye_glasses
string
If physical_description is false, don't provide.
servees.*.height
string
If physical_description is false, don't provide.
servees.*.weight
string
If physical_description is false, don't provide.
servees.*.age
string
If physical_description is false, don't provide.
servees.*.serve_pricing_id
integer, required
References serve pricing id from Get Serve Pricings ID from the state_id.
servees.*.serve_pricing_name
string, required
servees.*.notes
string
servees.*.subpoena
boolean
Default: false
servees.*.authorize_skiptrace
boolean
Default: false
servees.*.same_address
boolean|integer
Default: false. If not false, it should be the index of the parent servee at the same address.
servees.*.servee_addresses
array, required
servees.*.servee_addresses.*.type
string, required
One of: HOME, WORK, REGISTERED_AGENT, ENTITY, OTHER
servees.*.servee_addresses.*.business_name
array
Should be provided if type is one of WORK, REGISTERED_AGENT, ENTITY
servees.*.servee_addresses.*.address_1
string, required
servees.*.servee_addresses.*.address_2
string
servees.*.servee_addresses.*.city
string, required
servees.*.servee_addresses.*.state_id
integer, required
Reference state id from Get All States
servees.*.servee_addresses.*.zip
string, required
servees.*.servee_addresses.*.primary
boolean, required
Only one address should be have primary to true
servees.*.servee_marks
array
servees.*.servee_marks.*.type
string, required
servees.*.servee_marks.*.details
string, required
servees.*.servee_photos
array
servees.*.servee_photos.*.id
integer, required
References servee photo id from Upload Servee Photo.

Get job

Example response:

{
  "id": 160,
  "user_id": 2,
  "law_firm_id": 2,
  "server_id": 14,
  "original_job_id": null,
  "new_job_id": null,
  "status": "PENDING_NOTARY",
  "contact_first_name": "Marty",
  "contact_last_name": "Wachocki",
  "contact_email": "marty@propeltechnology.com",
  "contact_phone": "7347304250",
  "billing_number": "123",
  "court_name": "District Court, County Of Adams, State Of",
  "case_number": "2018CV31346",
  "state_id": 9,
  "serve_pricing_id": 2,
  "stripe_card_id": "card_1Dy074Hg213tM5vxjBic4l40",
  "post_serve": false,
  "assign_date": "2019-04-04 20:05:30",
  "created_by_id": 2,
  "attempts_made": 1,
  "last_attempt": "2019-04-04 20:35:29",
  "successful_attempt": true,
  "successful_at": 1554410129000,
  "completed_at": null,
  "due_date": 1554667530000,
  "originated_at": 1554126237000,
  "subpoena": false,
  "witness_fee": null,
  "authorize_skiptrace": false,
  "review_period_ends": null,
  "created_at": 1554126237000,
  "updated_at": 1590222679000,
  "deleted_at": null,
  "court_date": null,
  "same_address_job_id": null,
  "attorney_name": null,
  "attorney_bar_number": null,
  "court_street_address": null,
  "court_mailing_address": null,
  "court_city": null,
  "court_zip": null,
  "court_branch_name": null,
  "court_address": null,
  "last_status_change": null,
  "signed_affidavit_url": null,
  "servee": {
    "id": 159,
    "type": "INDIVIDUAL",
    "job_id": 160,
    "name": "Test Servee",
    "registered_agent_name": null,
    "physical_description": false,
    "race": null,
    "gender": null,
    "hair_color": null,
    "marital_status": "",
    "eye_glasses": null,
    "height": null,
    "weight": null,
    "age": null,
    "notes": null,
    "social_links": null,
    "created_at": 1554126237000,
    "updated_at": 1554126237000,
    "deleted_at": null,
    "servee_addresses": [
      {
        "id": 209,
        "servee_id": 159,
        "type": "HOME",
        "business_name": null,
        "address_1": "8120 Sheridan Boulevard",
        "address_2": "",
        "city": "Arvada",
        "state_id": 6,
        "zip": "80003",
        "primary": true,
        "longitude": -105.052024,
        "latitude": 39.8437682,
        "county": "Adams County",
        "created_at": 1554126238000,
        "updated_at": 1554126238000,
        "deleted_at": null,
        "timezone": "America/Denver",
        "state": {
          "id": 6,
          "name": "Alabama",
          "abbreviation": "AL",
          "allow_jobs": false,
          "allow_residential_sub": false,
          "allow_work_sub": false,
          "created_at": 1554134363000,
          "updated_at": 1553048780000,
          "deleted_at": null,
          "affidavit_service_title": "Affidavit of Service",
          "affidavit_nonservice_title": "Affidavit of Nonservice",
          "requires_notary_service": false,
          "requires_notary_nonservice": false,
          "allow_sunday_serve": 1
        }
      },
      {
        "id": 210,
        "servee_id": 159,
        "type": "ENTITY",
        "business_name": null,
        "address_1": "7395 S Peoria St",
        "address_2": "# 105",
        "city": "Englewood",
        "state_id": 6,
        "zip": "80112",
        "primary": false,
        "longitude": -104.8460701,
        "latitude": 39.5823553,
        "county": "Arapahoe County",
        "created_at": 1554126238000,
        "updated_at": 1554126238000,
        "deleted_at": null,
        "timezone": "America/Denver",
        "state": {
          "id": 6,
          "name": "Alabama",
          "abbreviation": "AL",
          "allow_jobs": false,
          "allow_residential_sub": false,
          "allow_work_sub": false,
          "created_at": 1554134363000,
          "updated_at": 1553048780000,
          "deleted_at": null,
          "affidavit_service_title": "Affidavit of Service",
          "affidavit_nonservice_title": "Affidavit of Nonservice",
          "requires_notary_service": false,
          "requires_notary_nonservice": false,
          "allow_sunday_serve": 1
        }
      },
      {
        "id": 211,
        "servee_id": 159,
        "type": "HOME",
        "business_name": null,
        "address_1": "9852 W 76th Ave",
        "address_2": "",
        "city": "Arvada",
        "state_id": 6,
        "zip": "80005",
        "primary": false,
        "longitude": -105.1080116,
        "latitude": 39.8340379,
        "county": "Jefferson County",
        "created_at": 1554126239000,
        "updated_at": 1554126239000,
        "deleted_at": null,
        "timezone": "America/Denver",
        "state": {
          "id": 6,
          "name": "Alabama",
          "abbreviation": "AL",
          "allow_jobs": false,
          "allow_residential_sub": false,
          "allow_work_sub": false,
          "created_at": 1554134363000,
          "updated_at": 1553048780000,
          "deleted_at": null,
          "affidavit_service_title": "Affidavit of Service",
          "affidavit_nonservice_title": "Affidavit of Nonservice",
          "requires_notary_service": false,
          "requires_notary_nonservice": false,
          "allow_sunday_serve": 1
        }
      }
    ],
    "servee_marks": [],
    "servee_photos": []
  },
  "invoice": null,
  "line_items": [],
  "flags": [
    {
      "id": 17,
      "job_id": 160,
      "created_by_id": 2,
      "type": "BAD_ADDRESS",
      "description": "The defendant name on the affidavit is misspelled.",
      "resolved": false,
      "resolution_notes": null,
      "resolved_by_id": null,
      "created_at": 1593026116000,
      "updated_at": 1593026116000,
      "resolved_by": null,
      "created_by": {
        "id": 2,
        "law_firm_id": 2,
        "type": "FIRM",
        "name": "Marty Wachocki",
        "last_name": "Wachocki",
        "first_name": "Marty",
        "active": 1,
        "email": "firm@proofserve.com",
        "stripe_default_card_id": "card_1FZPO6Hg213tM5vxmGNVNkt2",
        "email_invoices": true,
        "email_notifications": true,
        "email_verified": true,
        "administrator": true,
        "phone_number": "7347304250",
        "address_1": "7154 Eaton Ct",
        "address_2": null,
        "city": "Arvada",
        "state_id": 1,
        "zip": "80003",
        "created_at": 1548158103000,
        "updated_at": 1592352020000,
        "deleted_at": null,
        "email_chat_messages": 1,
        "email_progress_updates": 1,
        "email_reassigned": 1,
        "email_job_completed": 1,
        "notify_hours": 1
      }
    }
  ],
  "user": {
    "id": 2,
    "law_firm_id": 2,
    "type": "FIRM",
    "name": "Marty Wachocki",
    "last_name": "Wachocki",
    "first_name": "Marty",
    "active": 1,
    "email": "firm@proofserve.com",
    "stripe_default_card_id": "card_1FZPO6Hg213tM5vxmGNVNkt2",
    "email_invoices": true,
    "email_notifications": true,
    "email_verified": true,
    "administrator": true,
    "phone_number": "7347304250",
    "address_1": "7154 Eaton Ct",
    "address_2": null,
    "city": "Arvada",
    "state_id": 1,
    "zip": "80003",
    "created_at": 1548158103000,
    "updated_at": 1592352020000,
    "deleted_at": null,
    "email_chat_messages": 1,
    "email_progress_updates": 1,
    "email_reassigned": 1,
    "email_job_completed": 1,
    "notify_hours": 1
  },
  "law_firm": {
    "id": 2,
    "name": "Acme Law Firm",
    "phone_number": "7347304250",
    "email": "marty@wachocki.net",
    "address_1": "8753 Yates Dr",
    "address_2": "#215",
    "city": "Westminster",
    "state_id": 1,
    "zip": "80031",
    "email_invoices_to": null,
    "created_at": 1548272881000,
    "updated_at": 1590996239000,
    "deleted_at": null,
    "free_credits": "75.0000000000",
    "api_enabled": true
  },
  "state": {
    "id": 9,
    "name": "California",
    "abbreviation": "CA",
    "allow_jobs": false,
    "allow_residential_sub": false,
    "allow_work_sub": false,
    "created_at": 1570134470000,
    "updated_at": 1553048781000,
    "deleted_at": null,
    "affidavit_service_title": "Affidavit of Service",
    "affidavit_nonservice_title": "Affidavit of Nonservice",
    "requires_notary_service": false,
    "requires_notary_nonservice": false,
    "allow_sunday_serve": 1
  },
  "serve_pricing": {
    "id": 2,
    "name": "Expedited",
    "state_id": 1,
    "base_fee": 45,
    "bounty_fee": 80,
    "diy_price": 125,
    "post_price": null,
    "post_duration": null,
    "initial_duration": 259200,
    "total_duration": 259200,
    "total_attempts": 4,
    "updated_at": 1548331771000,
    "created_at": 1548331771000
  },
  "server": {
    "id": 14,
    "law_firm_id": null,
    "type": "SERVER",
    "name": "Mark Kreloff",
    "last_name": "Kreloff",
    "first_name": "Mark",
    "active": 1,
    "email": "mark@proofserve.com",
    "administrator": false,
    "phone_number": "7347304250",
    "state_id": 1,
    "created_at": 1548158103000,
    "updated_at": 1562766592000,
    "deleted_at": null
  },
  "created_by": {
    "id": 2,
    "law_firm_id": 2,
    "type": "FIRM",
    "name": "Marty Wachocki",
    "last_name": "Wachocki",
    "first_name": "Marty",
    "active": 1,
    "email": "firm@proofserve.com",
    "stripe_default_card_id": "card_1FZPO6Hg213tM5vxmGNVNkt2",
    "email_invoices": true,
    "email_notifications": true,
    "email_verified": true,
    "administrator": true,
    "phone_number": "7347304250",
    "address_1": "7154 Eaton Ct",
    "address_2": null,
    "city": "Arvada",
    "state_id": 1,
    "zip": "80003",
    "created_at": 1548158103000,
    "updated_at": 1592352020000,
    "deleted_at": null,
    "email_chat_messages": 1,
    "email_progress_updates": 1,
    "email_reassigned": 1,
    "email_job_completed": 1,
    "notify_hours": 1
  },
  "attempts": [
    {
      "id": 36,
      "job_id": 160,
      "server_id": 14,
      "servee_address_id": 210,
      "success": true,
      "description": "Served.",
      "latitude": 40.0207994301,
      "longitude": -105.2732255464,
      "race": "White",
      "gender": "Female",
      "hair_color": "Other",
      "eye_glasses": "Unknown",
      "height": "4' 9\" to 5'",
      "weight": "180 lbs to 200 lbs",
      "age": 33,
      "service_type": "WORK_SUB",
      "service_type_other": null,
      "substitute_company": null,
      "substitute_name": "Lori Davis",
      "substitute_title": "Chief",
      "attempt_date": 1554435329000,
      "created_at": 1554410129000,
      "updated_at": 1554410129000,
      "deleted_at": null,
      "mailed": false,
      "mailed_from": null,
      "mailed_on": null,
      "mailed_address_id": null,
      "address": {
        "id": 210,
        "servee_id": 159,
        "type": "ENTITY",
        "business_name": null,
        "address_1": "7395 S Peoria St",
        "address_2": "# 105",
        "city": "Englewood",
        "state_id": 6,
        "zip": "80112",
        "primary": false,
        "longitude": -104.8460701,
        "latitude": 39.5823553,
        "county": "Arapahoe County",
        "created_at": 1554126238000,
        "updated_at": 1554126238000,
        "deleted_at": null,
        "timezone": "America/Denver"
      },
      "mailed_address": null,
      "attempt_photos": [
        {
          "id": 37,
          "attempt_id": 36,
          "extension": "jpg",
          "include_in_affidavit": false,
          "created_at": 1554410129000,
          "updated_at": 1570109838000,
          "deleted_at": null
        }
      ],
      "documents": [
        {
          "id": 380,
          "name": "Subpoena",
          "filename": "Martinez Subpoena to Boulder Neurosurgical.pdf",
          "extension": "pdf",
          "size": 41212,
          "law_firm_id": null,
          "created_by_id": 2,
          "created_at": 1554126204000,
          "updated_at": 1554126239000,
          "deleted_at": null,
          "pivot": {
            "attempt_id": 36,
            "document_id": 380
          }
        }
      ]
    }
  ],
  "stripe_card": {
    "id": 2,
    "label": "Marty's Card",
    "stripe_id": "card_1Dy074Hg213tM5vxjBic4l40",
    "user_id": 2,
    "law_firm_id": 2,
    "shared": true,
    "created_at": 1548731467000,
    "updated_at": 1551664188000
  },
  "messages": [
    {
      "id": 1,
      "user_id": 6,
      "job_id": 160,
      "message": "Hi, I went to the address for this job but it seems that it was incorrect. Do you have another one?",
      "read": 0,
      "created_at": 1548071801000,
      "updated_at": 1551110440000,
      "deleted_at": null,
      "user": {
        "id": 6,
        "law_firm_id": null,
        "type": "SERVER",
        "name": "Test Server",
        "last_name": "Server",
        "first_name": "Test",
        "active": 1,
        "email": "server@proofserve.com",
        "administrator": false,
        "phone_number": "7347304250",
        "state_id": 1,
        "created_at": 1548158103000,
        "updated_at": 1592327398000,
        "deleted_at": null
      }
    },
    {
      "id": 180,
      "user_id": 2,
      "job_id": 160,
      "message": "This is an example chat message.",
      "read": 0,
      "created_at": 1593025730000,
      "updated_at": 1593025730000,
      "deleted_at": null,
      "user": {
        "id": 2,
        "law_firm_id": 2,
        "type": "FIRM",
        "name": "Marty Wachocki",
        "last_name": "Wachocki",
        "first_name": "Marty",
        "active": 1,
        "email": "firm@proofserve.com",
        "stripe_default_card_id": "card_1FZPO6Hg213tM5vxmGNVNkt2",
        "email_invoices": true,
        "email_notifications": true,
        "email_verified": true,
        "administrator": true,
        "phone_number": "7347304250",
        "address_1": "7154 Eaton Ct",
        "address_2": null,
        "city": "Arvada",
        "state_id": 1,
        "zip": "80003",
        "created_at": 1548158103000,
        "updated_at": 1592352020000,
        "deleted_at": null,
        "email_chat_messages": 1,
        "email_progress_updates": 1,
        "email_reassigned": 1,
        "email_job_completed": 1,
        "notify_hours": 1
      }
    }
  ],
  "defendants": [
    {
      "id": 186,
      "job_id": 160,
      "name": "Catholic Health Initiatives Colorado D/b/a St. Anthony Hospital North",
      "created_at": 1554126239000,
      "updated_at": 1554126239000,
      "deleted_at": null
    }
  ],
  "documents": [
    {
      "id": 380,
      "name": "Subpoena",
      "filename": "Martinez Subpoena to Boulder Neurosurgical.pdf",
      "extension": "pdf",
      "size": 41212,
      "law_firm_id": null,
      "created_by_id": 2,
      "created_at": 1554126204000,
      "updated_at": 1554126239000,
      "deleted_at": null,
      "pivot": {
        "job_id": 160,
        "document_id": 380
      }
    }
  ],
  "plaintiffs": [
    {
      "id": 128,
      "job_id": 160,
      "name": "Linda Martinez",
      "created_at": 1554126239000,
      "updated_at": 1554126239000,
      "deleted_at": null
    }
  ],
  "original_job": null,
  "new_job": null,
  "same_address_job": null,
  "same_address_jobs": []
}

HTTP Request

GET /jobs/{job_id}

Cancel job

Example response:

{
  "success": true
}

HTTP Request

POST /jobs/{job_id}/cancel

Extend job deadline

Example request body:

{
  "days": 2
}

Example response:

{
  "due_date": 1554840330000
}

HTTP Request

POST /jobs/{job_id}/extend

Request Parameters

Parameter Description
days
float, required
The number of days to extend the job due_date by. This can include decimal points (e.g. 2.5 days)

Flag a job

Example request body:

{
  "type": "AFFIDAVIT_CHANGES",
  "description": "Could you please make X correction in the affidavit?"
}

Example response:

{
  "type": "AFFIDAVIT_CHANGES",
  "description": "Could you please make X correction in the affidavit?",
  "created_by_id": 13,
  "job_id": 160,
  "updated_at": 1593129246000,
  "created_at": 1593129246000,
  "id": 25,
  "job": {
    "id": 160,
    "user_id": 2,
    "law_firm_id": 2,
    "server_id": 14,
    "original_job_id": null,
    "new_job_id": null,
    "status": "PENDING_NOTARY",
    "contact_first_name": "Marty",
    "contact_last_name": "Wachocki",
    "contact_email": "marty@propeltechnology.com",
    "contact_phone": "7347304250",
    "billing_number": "123",
    "court_name": "District Court, County Of Adams, State Of",
    "case_number": "2018CV31346",
    "state_id": 9,
    "serve_pricing_id": 2,
    "stripe_card_id": "card_1Dy074Hg213tM5vxjBic4l40",
    "post_serve": false,
    "assign_date": "2019-04-04 20:05:30",
    "created_by_id": 2,
    "attempts_made": 1,
    "last_attempt": "2019-04-04 20:35:29",
    "successful_attempt": true,
    "successful_at": 1554410129000,
    "completed_at": null,
    "due_date": 1554667530000,
    "originated_at": 1554126237000,
    "subpoena": false,
    "witness_fee": null,
    "affidavit_approved": false,
    "authorize_skiptrace": false,
    "serve_docs_prints_remaining": 2,
    "affidavit_prints_remaining": 2,
    "print_serve_documents_tracking_number": null,
    "print_affidavit_tracking_number": null,
    "affidavit_certify_county": null,
    "affidavit_certify_state": null,
    "affidavit_certify_name": null,
    "affidavit_certify_date": null,
    "affidavit_extension": null,
    "review_period_ends": null,
    "stripe_auth_charge_id": null,
    "stripe_auth_charge_amount": null,
    "created_at": 1554126237000,
    "updated_at": 1590222679000,
    "deleted_at": null,
    "offered_server_id": null,
    "offered_server_expires": null,
    "offered_count": 0,
    "pickup_latitude": null,
    "pickup_longitude": null,
    "pickup_distance": null,
    "summons_document_id": null,
    "summons_page_start": 1,
    "summons_page_end": 1,
    "court_date": null,
    "same_address_job_id": null,
    "force_notary": 0,
    "attorney_name": null,
    "attorney_bar_number": null,
    "court_street_address": null,
    "court_mailing_address": null,
    "court_city": null,
    "court_zip": null,
    "court_branch_name": null,
    "off_app": false,
    "witness_fee_sent": null,
    "off_app_server_firm": null,
    "off_app_server_name": null,
    "off_app_server_contact_info": null,
    "court_address": null,
    "affidavit_approved_at": null,
    "pending_notary_at": null,
    "last_status_change": null,
    "signed_affidavit_url": null,
    "affidavit_url": "http://localhost:8000/v1/jobs/160/affidavit",
    "law_firm": {
      "id": 2,
      "name": "Acme Law Firm",
      "stripe_customer_id": "cus_EOToODxHjeABPU",
      "phone_number": "7347304250",
      "email": "marty@wachocki.net",
      "address_1": "8753 Yates Dr",
      "address_2": "#215",
      "city": "Westminster",
      "state_id": 1,
      "zip": "80031",
      "allow_post_payment": false,
      "email_invoices_to": null,
      "created_at": 1548272881000,
      "updated_at": 1590996239000,
      "deleted_at": null,
      "coupon_code": null,
      "free_credits": "75.0000000000",
      "collection_firm": true,
      "exempt_witness_fees": false,
      "notary_required": false,
      "api_enabled": true
    }
  }
}

HTTP Request

POST /jobs/{job_id}/flag

Request Parameters

Parameter Description
type
string, required
One of: BAD_ADDRESS, MISSING_INFORMATION, AFFIDAVIT_CHANGES, OTHER
description
string, required

Resolve a flag

Example request body:

{
  "resolution_notes": "We have updated the address."
}

Example response:

{
  "id": 17,
  "job_id": 160,
  "created_by_id": 2,
  "type": "BAD_ADDRESS",
  "description": "The defendant name on the affidavit is misspelled.",
  "resolved": true,
  "resolution_notes": "We have updated the address.",
  "resolved_by_id": 13,
  "created_at": 1593026116000,
  "updated_at": 1593129246000
}

HTTP Request

POST /jobs/{job_id}/flag/{flag_id}/resolve

Request Parameters

Parameter Description
resolution_notes
string

Send chat message

Example request body:

{
  "message": "This is an example chat message."
}

Example response:

{
  "message": "This is an example chat message.",
  "job_id": 160,
  "user_id": 2,
  "updated_at": 1593129239000,
  "created_at": 1593129239000,
  "id": 192
}

HTTP Request

POST /jobs/{job_id}/messages

Request Parameters

Parameter Description
message
string, required

Get chat messages

Example response:

[
  {
    "id": 1,
    "user_id": 6,
    "job_id": 160,
    "message": "Hi, I went to the address for this job but it seems that it was incorrect. Do you have another one?",
    "read": 0,
    "created_at": 1548071801000,
    "updated_at": 1551110440000,
    "deleted_at": null,
    "user": {
      "id": 6,
      "law_firm_id": null,
      "type": "SERVER",
      "name": "Test Server",
      "last_name": "Server",
      "first_name": "Test",
      "active": 1,
      "email": "server@proofserve.com",
      "administrator": false,
      "phone_number": "7347304250",
      "state_id": 1,
      "created_at": 1548158103000,
      "updated_at": 1592327398000,
      "deleted_at": null,
      "law_firm": null
    }
  }
]

HTTP Request

GET /jobs/{job_id}/messages

Mark messages as read

Example response:

{
  "success": true
}

HTTP Request

POST /jobs/{job_id}/messages/{message_id}/read

Mark a given message as read, as well as all messages sent previous to that message.

Add an address

Example request body:

{
  "type": "WORK",
  "business_name": "Acme Corp, Inc.",
  "address_1": "12345 Some St.",
  "address_2": null,
  "city": "Denver",
  "state_id": 1,
  "zip": "80014",
  "primary": true
}

Example response:

{
  "type": "WORK",
  "business_name": "Acme Corp, Inc.",
  "address_1": "12345 Some St.",
  "address_2": null,
  "city": "Denver",
  "state_id": 1,
  "zip": "80014",
  "primary": true,
  "servee_id": 159,
  "county": "Denver County",
  "latitude": 39.7809649,
  "longitude": -104.9139516,
  "timezone": "America/Denver",
  "updated_at": 1593129243000,
  "created_at": 1593129243000,
  "id": 398,
  "state": {
    "id": 1,
    "name": "Colorado",
    "abbreviation": "CO",
    "allow_jobs": true,
    "law_firm_free_credits": 7500,
    "allow_residential_sub": true,
    "allow_work_sub": true,
    "requires_server_identification": false,
    "created_at": 1562780993000,
    "updated_at": 1562755793000,
    "deleted_at": null,
    "hide_caption": 0,
    "caption_id": "co",
    "affidavit_service_title": "Affidavit of Service",
    "affidavit_nonservice_title": "Affidavit of Nonservice",
    "requires_notary_service": true,
    "requires_notary_nonservice": true,
    "show_prior_attempts": 0,
    "attach_summons": false,
    "proof_percent": "0.3333333333",
    "show_photos": 1,
    "custom_affidavit": 0,
    "allow_sunday_serve": 1
  }
}

HTTP Request

POST /jobs/{job_id}/servees/{servee_id}/addresses

Delete an address

Example response:

{
  "success": true
}

HTTP Request

DELETE /jobs/{job_id}/servees/{servee_id}/addresses/{address_id}

Law Firms

Get current law firm

Example response:

{
  "id": 2,
  "name": "Acme Law Firm",
  "phone_number": "7347304250",
  "email": "marty@wachocki.net",
  "address_1": "8753 Yates Dr",
  "address_2": "#215",
  "city": "Westminster",
  "state_id": 1,
  "zip": "80031",
  "email_invoices_to": null,
  "created_at": 1548272881000,
  "updated_at": 1590996239000,
  "deleted_at": null,
  "free_credits": "75.0000000000",
  "api_enabled": true
}

HTTP Request

GET /law-firms/current

Notifications

Get payment methods

Example response:

[
  {
    "id": 245,
    "user_id": 2,
    "job_id": 8,
    "type": "MESSAGE",
    "author_id": 13,
    "action": null,
    "message": "test",
    "message_2": null,
    "read": false,
    "created_at": 1592325965000,
    "updated_at": 1592325965000,
    "message_id": 171,
    "emailed": 0,
    "author": {
      "id": 13,
      "law_firm_id": null,
      "type": "PROOF",
      "name": "Admin Wachocki",
      "last_name": "Wachocki",
      "first_name": "Admin",
      "active": 1,
      "email": "admin@proofserve.com",
      "administrator": false,
      "phone_number": null,
      "state_id": 1,
      "created_at": 1550875352000,
      "updated_at": 1592115126000,
      "deleted_at": null
    },
    "job": {
      "id": 8,
      "user_id": 2,
      "law_firm_id": 2,
      "server_id": 6,
      "original_job_id": null,
      "new_job_id": 50,
      "status": "IN_PROGRESS",
      "contact_first_name": "",
      "contact_last_name": "",
      "contact_email": "",
      "contact_phone": null,
      "billing_number": "A00012345",
      "court_name": "Jefferson County District Court",
      "case_number": "CL35832",
      "state_id": 1,
      "serve_pricing_id": 1,
      "stripe_card_id": "card_1Dy074Hg213tM5vxjBic4l40",
      "post_serve": false,
      "assign_date": null,
      "created_by_id": 2,
      "attempts_made": 2,
      "last_attempt": "2019-03-27 16:30:34",
      "successful_attempt": false,
      "successful_at": null,
      "completed_at": null,
      "due_date": 1548435181000,
      "originated_at": 1548340763000,
      "subpoena": false,
      "witness_fee": null,
      "authorize_skiptrace": true,
      "review_period_ends": null,
      "created_at": 1548340763000,
      "updated_at": 1590222678000,
      "deleted_at": null,
      "court_date": null,
      "same_address_job_id": null,
      "attorney_name": null,
      "attorney_bar_number": null,
      "court_street_address": null,
      "court_mailing_address": null,
      "court_city": null,
      "court_zip": null,
      "court_branch_name": null,
      "court_address": null,
      "last_status_change": null,
      "signed_affidavit_url": null,
      "servee": {
        "id": 7,
        "type": "INDIVIDUAL",
        "job_id": 8,
        "name": "Jane Smith",
        "registered_agent_name": null,
        "physical_description": true,
        "race": "White",
        "gender": "Male",
        "hair_color": "Brown",
        "marital_status": "Married",
        "eye_glasses": "Yes",
        "height": "5' 9\" to 6'",
        "weight": "160 to 180 lbs",
        "age": 30,
        "notes": "He works from 9-5\nCompany name is Propel Technology",
        "social_links": "https://www.facebook.com/propelitco/",
        "created_at": 1548083163000,
        "updated_at": 1548083163000,
        "deleted_at": null
      }
    }
  }
]

HTTP Request

GET /notifications

Mark notifications as read

Example request body:

{
  "ids": [
    1,
    2,
    3
  ]
}

Example response:

{
  "success": true
}

HTTP Request

POST /notifications/read

Serve Pricings

Get serve pricings

Example response:

[
  {
    "id": 1,
    "name": "Standard",
    "state_id": 1,
    "base_fee": 25,
    "bounty_fee": 50,
    "diy_price": 75,
    "post_price": 45,
    "post_duration": 172800,
    "initial_duration": 604800,
    "total_duration": 604800,
    "total_attempts": 4,
    "updated_at": 1548331771000,
    "created_at": 1548331771000
  }
]

HTTP Request

GET /serve-pricings/{state_id}

Servee Photos

Upload servee photo

Example request body:

"<file>"

Example response:

{
  "filename": "file.png",
  "extension": "png",
  "law_firm_id": 2,
  "created_by_id": 2,
  "access_key": "8z3pYaMqLBHcraKfVyl0DH4ikkGHhTbJ",
  "updated_at": 1593129249000,
  "created_at": 1593129249000,
  "id": 139
}

HTTP Request

POST /servee-photos

Get servee photo

Example response:

<image file>

HTTP Request

GET /servee-photos/{servee_photo_id}.{ext}

States

Get all states

Example response:

[
  {
    "id": 6,
    "name": "Alabama",
    "abbreviation": "AL",
    "allow_jobs": false,
    "allow_residential_sub": false,
    "allow_work_sub": false,
    "created_at": 1554134363000,
    "updated_at": 1553048780000,
    "deleted_at": null,
    "affidavit_service_title": "Affidavit of Service",
    "affidavit_nonservice_title": "Affidavit of Nonservice",
    "requires_notary_service": false,
    "requires_notary_nonservice": false,
    "allow_sunday_serve": 1,
    "serve_pricings": [],
    "supplementary_pricings": []
  }
]

HTTP Request

GET /states

Get state rules

Example response:

[
  {
    "id": 1,
    "state_id": 1,
    "rule": "Test rule #1",
    "created_at": null,
    "updated_at": null
  }
]

HTTP Request

GET /states/{state_id}/rules

Statements

Export statement (csv)

Example response:

<csv file>

HTTP Request

GET /statements/{start}/{end}/csv

URL Parameters

Parameter Description
start
integer, required
UNIX Timestamp in milliseconds
end
integer, required
UNIX Timestamp in milliseconds

Export statement (pdf)

Example response:

<pdf file>

HTTP Request

GET /statements/{start}/{end}/pdf

URL Parameters

Parameter Description
start
integer, required
UNIX Timestamp in milliseconds
end
integer, required
UNIX Timestamp in milliseconds

Users

Get current user

Example response:

{
  "id": 2,
  "law_firm_id": 2,
  "type": "FIRM",
  "name": "Marty Wachocki",
  "last_name": "Wachocki",
  "first_name": "Marty",
  "active": 1,
  "email": "firm@proofserve.com",
  "stripe_default_card_id": "card_1FZPO6Hg213tM5vxmGNVNkt2",
  "email_invoices": true,
  "email_notifications": true,
  "email_verified": true,
  "administrator": true,
  "phone_number": "7347304250",
  "address_1": "7154 Eaton Ct",
  "address_2": null,
  "city": "Arvada",
  "state_id": 1,
  "zip": "80003",
  "created_at": 1548158103000,
  "updated_at": 1592352020000,
  "deleted_at": null,
  "email_chat_messages": 1,
  "email_progress_updates": 1,
  "email_reassigned": 1,
  "email_job_completed": 1,
  "notify_hours": 1,
  "law_firm": {
    "id": 2,
    "name": "Acme Law Firm",
    "phone_number": "7347304250",
    "email": "marty@wachocki.net",
    "address_1": "8753 Yates Dr",
    "address_2": "#215",
    "city": "Westminster",
    "state_id": 1,
    "zip": "80031",
    "email_invoices_to": null,
    "created_at": 1548272881000,
    "updated_at": 1590996239000,
    "deleted_at": null,
    "free_credits": "75.0000000000",
    "api_enabled": true
  },
  "state": {
    "id": 1,
    "name": "Colorado",
    "abbreviation": "CO",
    "allow_jobs": true,
    "allow_residential_sub": true,
    "allow_work_sub": true,
    "created_at": 1562780993000,
    "updated_at": 1562755793000,
    "deleted_at": null,
    "affidavit_service_title": "Affidavit of Service",
    "affidavit_nonservice_title": "Affidavit of Nonservice",
    "requires_notary_service": true,
    "requires_notary_nonservice": true,
    "allow_sunday_serve": 1
  },
  "states": [],
  "starred_jobs": []
}

HTTP Request

GET /users/current

Webhooks

Get webhook endpoints

Example response:

[
  {
    "id": 1,
    "law_firm_id": 2,
    "url": "https://example.com/webhook",
    "version": 1,
    "enabled": 1,
    "event_job_status_change": 1,
    "event_job_deleted": 1,
    "event_job_extended": 1,
    "event_job_attempt_created": 1,
    "event_job_attempt_updated": 1,
    "event_job_attempt_deleted": 1,
    "event_job_flag_created": 1,
    "event_job_flag_resolved": 1,
    "event_job_chat_message": 1,
    "created_at": 1593026611000,
    "updated_at": 1593026611000
  }
]

HTTP Request

GET /webhooks

Get webhook calls

Example response:

{
  "current_page": 1,
  "data": [],
  "first_page_url": "http://localhost:3000/v1/webhooks/calls?page=1",
  "from": null,
  "last_page": 1,
  "last_page_url": "http://localhost:3000/v1/webhooks/calls?page=1",
  "next_page_url": null,
  "path": "http://localhost:3000/v1/webhooks/calls",
  "per_page": 10,
  "prev_page_url": null,
  "to": null,
  "total": 0
}

HTTP Request

GET /webhooks/calls

Webhooks (Setup)

Webhook endpoints are configured through the web interface in the Billing & Configuration > API page.

In the API page, click Add endpoint to reveal a form to add a new endpoint for receiving events. You can enter any URL as the destination for events. You can choose to be notified of all event types, or only specific ones. You can find a full list of all event types below.

Event types

Event ID Description
JOB_STATUS_CHANGE When a job's status changes (e.g. In Progress -> Pending Notary)
JOB_DELETED When a job is deleted
JOB_EXTENDED When a job's deadline is extended
JOB_ATTEMPT_CREATED When an attempt is created on a given job
JOB_ATTEMPT_UPDATED When an attempt is updated on a given job
JOB_ATTEMPT_DELETED When an attempt is deleted on a given job
JOB_FLAG_CREATED When a job is flagged for any reason (e.g. bad address)
JOB_FLAG_RESOLVED When a job flag is resolved
JOB_CHAT_MESSAGE When a new chat message is received on a job

Webhook payload example

Example webhook payload:

{
  "event": "JOB_CHAT_MESSAGE",
  "data": {
    "job_id": 123,
    "author_id": 456,
    "author_name": "John Doe",
    "author_type": "Server",
    "message": "Hello, how are you?"
  }
}

Each webhook request will include the following attributes:

Attribute Description
event The event type that triggered the event
data Data object containing information specific to the event

For testing webhooks, we recommend a useful (and free) service called Request Bin, which allows you to inspect arbitrary webhook requests.