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.
API URLs
| Environment | URL |
|---|---|
| Staging | https://api.staging.proofserve.com/v1/ |
| Trunk | https://api.trunk.proofserve.com/v1/ |
| Production | https://api.proofserve.com/v1/ |
Authentication
Example authenticated request:
# With http, you can just pass the correct header with each 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,800 requests per minute. If you make over 1,800 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.
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": 1,
"brand": "Visa",
"last4": "4242",
"address_zip": "12321",
"billing_name": "Martin",
"exp_month": 4,
"exp_year": 2024,
"default": true,
"shared": false,
"user_id": 2,
"label": "Abc",
"stripe_id": "card_1Hz7FKHg213tM5vxSS07Qj5Q",
"type": "CARD",
"status": "CONFIRMED"
}
]
HTTP Request
GET /billing/payment-methods
Documents
Upload document
Example request body:
"<file>"
Example response:
{
"document": {
"filename": "file.pdf",
"size": 13264,
"page_count": "1",
"extension": "pdf",
"law_firm_id": 2,
"created_by_id": 2,
"updated_at": 1625161312000,
"created_at": 1625161312000,
"id": 893
},
"title": null,
"court_name": null,
"court_address": null,
"case_number": null,
"billing_number": null,
"court_date": null,
"plaintiffs": null,
"defendants": null,
"multiple_documents": null,
"page_count": null
}
HTTP Request
POST /documents
File should be sent as multipart/form-data with the file sent under the file key.
In supported states we will attempt to parse and return pertinent information from the PDF file (e.g. document title, court name, plaintiffs, 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 |
|---|---|
startinteger, required |
UNIX Timestamp in milliseconds |
endinteger, required |
UNIX Timestamp in milliseconds |
Invoices
Get invoices
Example response:
{
"current_page": 1,
"last_page": 3,
"per_page": 10,
"total": 25,
"data": [
{
"id": 4,
"user_id": 2,
"law_firm_id": 2,
"job_id": 8,
"total": 75,
"paid_amount": 75,
"paid": true,
"created_at": 1548853797000,
"updated_at": 1548853797000,
"deleted_at": null,
"balance": 0,
"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,
"quantity": 1,
"total": "25.0000000000",
"created_at": 1548853846000,
"updated_at": 1548853846000,
"deleted_at": null
},
{
"id": 2,
"invoice_id": 4,
"name": "Standard Serve (Bounty)",
"description": "Serve Date: 02/10/2019",
"price": 50,
"quantity": 1,
"total": "50.0000000000",
"created_at": 1548853846000,
"updated_at": 1548853846000,
"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_1Hz7FKHg213tM5vxSS07Qj5Q",
"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": 1608152958000,
"deleted_at": null,
"new_user": 0,
"rating_count": 0,
"email_chat_messages": 1,
"email_progress_updates": 1,
"email_reassigned": 1,
"email_job_completed": 1,
"notify_hours": 1,
"total_job_count": 0,
"total_job_count_5_stars": 0,
"table_style": "DEFAULT",
"coupon_code": null,
"last_cdp_update": null,
"email_affidavits": false
},
"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,
"affidavit_extension": "pdf",
"review_period_ends": null,
"created_at": 1548340763000,
"updated_at": 1581529725000,
"deleted_at": 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,
"court_date": null,
"affidavit_status": "PENDING_TM_REVIEW",
"cancel_job_reason": null,
"affidavit_uploaded_at": "2020-10-04 01:07:06",
"salesforce_id": null,
"archived": false,
"off_app_assigned_to": "NOT_ASSIGNED",
"salesforce_user_id": "",
"affidavit_due_at": null,
"affidavit_reminders_sent": 0,
"last_affidavit_reminder_sent_at": null,
"attempt_reminders_sent": 0,
"last_attempt_reminder_sent_at": null,
"signed_affidavit_url": null,
"base_fee": 25,
"bounty": 50,
"post_price": 45,
"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,
"primary_address": {
"id": 18,
"servee_id": 7,
"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": 1548345974000,
"updated_at": 1558672808000,
"deleted_at": null,
"timezone": "America/Denver"
}
},
"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,
"creditor_only": 0,
"collection_only": 0
},
"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_1Hz7FKHg213tM5vxSS07Qj5Q",
"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": 1608152958000,
"deleted_at": null,
"new_user": 0,
"rating_count": 0,
"email_chat_messages": 1,
"email_progress_updates": 1,
"email_reassigned": 1,
"email_job_completed": 1,
"notify_hours": 1,
"total_job_count": 0,
"total_job_count_5_stars": 0,
"table_style": "DEFAULT",
"coupon_code": null,
"last_cdp_update": null,
"email_affidavits": false
}
}
}
]
}
HTTP Request
GET /invoices
Get invoice
Example response:
{
"id": 4,
"user_id": 2,
"law_firm_id": 2,
"job_id": 8,
"total": 75,
"paid_amount": 75,
"paid": true,
"created_at": 1548853797000,
"updated_at": 1548853797000,
"deleted_at": null,
"balance": 0,
"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,
"quantity": 1,
"total": "25.0000000000",
"created_at": 1548853846000,
"updated_at": 1548853846000,
"deleted_at": null
},
{
"id": 2,
"invoice_id": 4,
"name": "Standard Serve (Bounty)",
"description": "Serve Date: 02/10/2019",
"price": 50,
"quantity": 1,
"total": "50.0000000000",
"created_at": 1548853846000,
"updated_at": 1548853846000,
"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_1Hz7FKHg213tM5vxSS07Qj5Q",
"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": 1608152958000,
"deleted_at": null,
"new_user": 0,
"rating_count": 0,
"email_chat_messages": 1,
"email_progress_updates": 1,
"email_reassigned": 1,
"email_job_completed": 1,
"notify_hours": 1,
"total_job_count": 0,
"total_job_count_5_stars": 0,
"table_style": "DEFAULT",
"coupon_code": null,
"last_cdp_update": null,
"email_affidavits": false
},
"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",
"created_at": 1548272881000,
"updated_at": 1607363359000,
"deleted_at": null,
"email_invoices_to": null,
"free_credits": "475.0000000000",
"api_enabled": true,
"private_jobs": false,
"salesforce_connected": 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,
"affidavit_extension": "pdf",
"review_period_ends": null,
"created_at": 1548340763000,
"updated_at": 1581529725000,
"deleted_at": 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,
"court_date": null,
"affidavit_status": "PENDING_TM_REVIEW",
"cancel_job_reason": null,
"affidavit_uploaded_at": "2020-10-04 01:07:06",
"salesforce_id": null,
"archived": false,
"off_app_assigned_to": "NOT_ASSIGNED",
"salesforce_user_id": "",
"affidavit_due_at": null,
"affidavit_reminders_sent": 0,
"last_affidavit_reminder_sent_at": null,
"attempt_reminders_sent": 0,
"last_attempt_reminder_sent_at": null,
"signed_affidavit_url": null,
"base_fee": 25,
"bounty": 50,
"post_price": 45,
"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,
"primary_address": {
"id": 18,
"servee_id": 7,
"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": 1548345974000,
"updated_at": 1558672808000,
"deleted_at": null,
"timezone": "America/Denver"
}
},
"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,
"creditor_only": 0,
"collection_only": 0
},
"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_1Hz7FKHg213tM5vxSS07Qj5Q",
"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": 1608152958000,
"deleted_at": null,
"new_user": 0,
"rating_count": 0,
"email_chat_messages": 1,
"email_progress_updates": 1,
"email_reassigned": 1,
"email_job_completed": 1,
"notify_hours": 1,
"total_job_count": 0,
"total_job_count_5_stars": 0,
"table_style": "DEFAULT",
"coupon_code": null,
"last_cdp_update": null,
"email_affidavits": false
}
},
"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,
"notes": null,
"created_at": 1550065265000,
"updated_at": 1550065265000,
"deleted_at": null
}
]
}
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": 16,
"per_page": 10,
"total": 153,
"data": [
{
"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,
"affidavit_extension": "pdf",
"review_period_ends": null,
"created_at": 1548340763000,
"updated_at": 1581529725000,
"deleted_at": 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,
"court_date": null,
"affidavit_status": "PENDING_TM_REVIEW",
"cancel_job_reason": null,
"affidavit_uploaded_at": "2020-10-04 01:07:06",
"salesforce_id": null,
"archived": false,
"off_app_assigned_to": "NOT_ASSIGNED",
"salesforce_user_id": "",
"affidavit_due_at": null,
"affidavit_reminders_sent": 0,
"last_affidavit_reminder_sent_at": null,
"attempt_reminders_sent": 0,
"last_attempt_reminder_sent_at": null,
"signed_affidavit_url": null,
"base_fee": 25,
"bounty": 50,
"post_price": 45,
"starred": false,
"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": 1602128137000,
"deleted_at": null,
"total_job_count": 13,
"total_job_count_5_stars": 1,
"coupon_code": null,
"last_cdp_update": null,
"email_affidavits": false,
"state": {
"id": 1,
"name": "Colorado",
"abbreviation": "CO",
"allow_jobs": true,
"allow_residential_sub": true,
"allow_work_sub": true,
"created_at": 1596844801000,
"updated_at": 1596844801000,
"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,
"average_server_rating": 5,
"summons_serve_stamp": false,
"attach_summons_position": "PREPENDED",
"show_prior_attempts_posting": 0
}
},
"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,
"servee_addresses": [
{
"id": 18,
"servee_id": 7,
"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": 1548345974000,
"updated_at": 1558672808000,
"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": 1596844801000,
"updated_at": 1596844801000,
"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,
"average_server_rating": 5,
"summons_serve_stamp": false,
"attach_summons_position": "PREPENDED",
"show_prior_attempts_posting": 0
}
},
{
"id": 206,
"servee_id": 7,
"type": "HOME",
"business_name": null,
"address_1": "7156 Eaton Ct",
"address_2": "",
"city": "Arvada",
"state_id": 1,
"zip": "80003",
"primary": false,
"longitude": null,
"latitude": null,
"county": null,
"created_at": 1553704234000,
"updated_at": 1558672808000,
"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": 1596844801000,
"updated_at": 1596844801000,
"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,
"average_server_rating": 5,
"summons_serve_stamp": false,
"attach_summons_position": "PREPENDED",
"show_prior_attempts_posting": 0
}
}
],
"primary_address": {
"id": 18,
"servee_id": 7,
"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": 1548345974000,
"updated_at": 1558672808000,
"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": 1596844801000,
"updated_at": 1596844801000,
"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,
"average_server_rating": 5,
"summons_serve_stamp": false,
"attach_summons_position": "PREPENDED",
"show_prior_attempts_posting": 0
}
}
},
"state": {
"id": 1,
"name": "Colorado",
"abbreviation": "CO",
"allow_jobs": true,
"allow_residential_sub": true,
"allow_work_sub": true,
"created_at": 1596844801000,
"updated_at": 1596844801000,
"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,
"average_server_rating": 5,
"summons_serve_stamp": false,
"attach_summons_position": "PREPENDED",
"show_prior_attempts_posting": 0
},
"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_1Hz7FKHg213tM5vxSS07Qj5Q",
"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": 1608152958000,
"deleted_at": null,
"new_user": 0,
"rating_count": 0,
"email_chat_messages": 1,
"email_progress_updates": 1,
"email_reassigned": 1,
"email_job_completed": 1,
"notify_hours": 1,
"total_job_count": 0,
"total_job_count_5_stars": 0,
"table_style": "DEFAULT",
"coupon_code": null,
"last_cdp_update": null,
"email_affidavits": false
},
"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",
"created_at": 1548272881000,
"updated_at": 1607363359000,
"deleted_at": null,
"email_invoices_to": null,
"free_credits": "475.0000000000",
"api_enabled": true,
"private_jobs": false,
"salesforce_connected": 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,
"creditor_only": 0,
"collection_only": 0
},
"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",
"user_id": 2,
"state_id": 1,
"post_serve": false,
"billing_number": "P12345",
"status": "UNASSIGNED",
"stripe_card_id": "card_1Dy074Hg213tM5vxjBic4l40",
"payment_method_id": 1,
"plaintiffs": [
{
"name": "John Doe"
}
],
"defendants": [
{
"name": "Jane Smith"
}
],
"documents": [
{
"id": 894,
"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,
"documents": [
894
],
"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_photos": [
{
"id": 155
}
]
}
],
"special_requirements": [
{
"id": 18,
"title": "Already existing requirement",
"created_at": "2022-09-14T13:23:55.19456Z",
"is_default": true,
"updated_at": "2022-09-20T18:32:41.295653Z",
"instructions": "Please do this additional task"
},
{
"title":"I am a new SOM requirement that will be saved for use again",
"is_default": true,
"is_internal": true,
"save_for_later": true,
"instructions": "have a good day"
},
]
}
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",
"user_id": 2,
"state_id": 1,
"billing_number": "P12345",
"status": "UNASSIGNED",
"stripe_card_id": "card_1Dy074Hg213tM5vxjBic4l40",
"originated_at": 1625161317000,
"serve_pricing_id": 1,
"authorize_skiptrace": false,
"post_serve": false,
"subpoena": false,
"last_status_change": 1625161317000,
"law_firm_id": 2,
"created_by_id": 2,
"updated_at": 1625161317000,
"created_at": 1625161317000,
"id": 256,
"signed_affidavit_url": null,
"base_fee": 25,
"bounty": 50,
"post_price": 45,
"servee": {
"id": 255,
"type": "INDIVIDUAL",
"job_id": 256,
"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": 1625161317000,
"updated_at": 1625161317000,
"deleted_at": null,
"servee_photos": [
{
"id": 155,
"servee_id": 255,
"filename": "file.png",
"extension": "png",
"access_key": "wA4ze91k2pIbOLFUsTWd9ZxvftRLFR4E",
"created_at": 1625161317000,
"updated_at": 1625161318000,
"deleted_at": null,
"created_by_id": 2,
"law_firm_id": 2
}
],
"servee_addresses": [
{
"id": 398,
"servee_id": 255,
"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": 1625161317000,
"updated_at": 1625161318000,
"deleted_at": null,
"timezone": "America/Denver"
},
{
"id": 399,
"servee_id": 255,
"type": "HOME",
"business_name": null,
"address_1": "1437 Bannock St",
"address_2": "",
"city": "Denver",
"state_id": 1,
"zip": "80202",
"primary": false,
"longitude": -104.9907968,
"latitude": 39.7392296,
"county": "Denver County",
"created_at": 1625161318000,
"updated_at": 1625161318000,
"deleted_at": null,
"timezone": "America/Denver"
}
],
"primary_address": {
"id": 398,
"servee_id": 255,
"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": 1625161317000,
"updated_at": 1625161318000,
"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": 1596844801000,
"updated_at": 1596844801000,
"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,
"average_server_rating": 5,
"summons_serve_stamp": false,
"attach_summons_position": "PREPENDED",
"show_prior_attempts_posting": 0
},
"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,
"creditor_only": 0,
"collection_only": 0
},
"defendants": [],
"plaintiffs": [],
"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_1Hz7FKHg213tM5vxSS07Qj5Q",
"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": 1608152958000,
"deleted_at": null,
"new_user": 0,
"rating_count": 0,
"email_chat_messages": 1,
"email_progress_updates": 1,
"email_reassigned": 1,
"email_job_completed": 1,
"notify_hours": 1,
"total_job_count": 0,
"total_job_count_5_stars": 0,
"table_style": "DEFAULT",
"coupon_code": null,
"last_cdp_update": null,
"email_affidavits": false
}
}
]
}
HTTP Request
POST /jobs
Tips:
- Documents should be uploaded beforehand using the Upload Document endpoint.
- Servee photos should be uploaded beforehand using the Upload Servee Photo endpoint.
Request Parameters
| Parameter | Description |
|---|---|
court_namestring |
|
court_addressstring |
|
case_numberstring |
|
court_datestring |
|
user_idint, required |
References a user's id |
state_idinteger, required |
Reference state id from Get All States |
billing_numberstring, required |
This should be a unique internal reference #. |
statusstring, required |
One of: DRAFT, UNASSIGNED |
stripe_card_idstring, required |
DEPRECATED: see payment_method_id |
post_serveboolean |
Default: false |
payment_method_idint, required |
Reference id from Get payment methods. Used in place of stripe_card_id. |
plaintiffsarray |
|
plaintiffs.*.namestring, required |
|
defendantsarray |
|
defendants.*.namestring, required |
|
documentsarray, required |
|
documents.*.idinteger, required |
Reference previously uploaded document id from Upload Document |
documents.*.namestring, required |
|
serveesarray, required |
|
servees.*.typestring, required |
One of: INDIVIDUAL, ENTITY |
servees.*.namestring, required |
|
servees.*.physical_descriptionboolean |
Default: false |
servees.*.racestring |
If physical_description is false, don't provide. |
servees.*.genderstring |
If physical_description is false, don't provide. |
servees.*.hair_colorstring |
If physical_description is false, don't provide. |
servees.*.marital_statusstring |
If physical_description is false, don't provide. |
servees.*.eye_glassesstring |
If physical_description is false, don't provide. |
servees.*.heightstring |
If physical_description is false, don't provide. |
servees.*.weightstring |
If physical_description is false, don't provide. |
servees.*.agestring |
If physical_description is false, don't provide. |
servees.*.serve_pricing_idinteger, required |
References serve pricing id from Get Serve Pricings ID from the state_id. |
servees.*.serve_pricing_namestring, required |
|
servees.*.notesstring |
|
servees.*.subpoenaboolean |
Default: false |
servees.*.authorize_skiptraceboolean |
Default: false |
servees.*.same_addressboolean|integer |
Default: false. If not false, it should be the index of the parent servee at the same address. |
servees.*.documentsarray, required |
|
servees.*.documents.*integer, required |
Reference previously uploaded document id from Upload Document |
servees.*.servee_addressesarray, required |
|
servees.*.servee_addresses.*.typestring, required |
One of: HOME, WORK, REGISTERED_AGENT, ENTITY, OTHER |
servees.*.servee_addresses.*.business_namearray |
Should be provided if type is one of WORK, REGISTERED_AGENT, ENTITY |
servees.*.servee_addresses.*.address_1string, required |
|
servees.*.servee_addresses.*.address_2string |
|
servees.*.servee_addresses.*.citystring, required |
|
servees.*.servee_addresses.*.state_idinteger, required |
Reference state id from Get All States |
servees.*.servee_addresses.*.zipstring, required |
|
servees.*.servee_addresses.*.primaryboolean, required |
Only one address should be have primary to true |
servees.*.servee_photosarray |
|
servees.*.servee_photos.*.idinteger, required |
References servee photo id from Upload Servee Photo. |
special_requirementsarray SpecialRequirement, Max 8 |
JSON object from Get special requirements |
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": 1,
"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,
"affidavit_extension": null,
"review_period_ends": null,
"created_at": 1554126237000,
"updated_at": 1625156672000,
"deleted_at": 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,
"court_date": null,
"affidavit_status": "PENDING_TM_REVIEW",
"cancel_job_reason": null,
"affidavit_uploaded_at": "2020-09-29 05:45:04",
"salesforce_id": null,
"archived": false,
"off_app_assigned_to": "NOT_ASSIGNED",
"salesforce_user_id": "",
"affidavit_due_at": "2021-07-02 04:24:32",
"affidavit_reminders_sent": 0,
"last_affidavit_reminder_sent_at": null,
"attempt_reminders_sent": 0,
"last_attempt_reminder_sent_at": null,
"signed_affidavit_url": null,
"base_fee": 45,
"bounty": 80,
"post_price": 0,
"starred": false,
"territory_manager": 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": 1558672808000,
"deleted_at": null,
"timezone": "America/Denver",
"state": {
"id": 6,
"name": "Alabama",
"abbreviation": "AL",
"allow_jobs": true,
"allow_residential_sub": false,
"allow_work_sub": false,
"created_at": 1557771726000,
"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,
"average_server_rating": 0,
"summons_serve_stamp": false,
"attach_summons_position": "PREPENDED",
"show_prior_attempts_posting": 0
}
},
{
"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": 1558672808000,
"deleted_at": null,
"timezone": "America/Denver",
"state": {
"id": 6,
"name": "Alabama",
"abbreviation": "AL",
"allow_jobs": true,
"allow_residential_sub": false,
"allow_work_sub": false,
"created_at": 1557771726000,
"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,
"average_server_rating": 0,
"summons_serve_stamp": false,
"attach_summons_position": "PREPENDED",
"show_prior_attempts_posting": 0
}
},
{
"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": 1558672808000,
"deleted_at": null,
"timezone": "America/Denver",
"state": {
"id": 6,
"name": "Alabama",
"abbreviation": "AL",
"allow_jobs": true,
"allow_residential_sub": false,
"allow_work_sub": false,
"created_at": 1557771726000,
"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,
"average_server_rating": 0,
"summons_serve_stamp": false,
"attach_summons_position": "PREPENDED",
"show_prior_attempts_posting": 0
}
}
],
"servee_marks": [],
"servee_photos": [],
"primary_address": {
"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": 1558672808000,
"deleted_at": null,
"timezone": "America/Denver"
}
},
"invoice": null,
"line_items": [],
"flags": [],
"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_1Hz7FKHg213tM5vxSS07Qj5Q",
"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": 1608152958000,
"deleted_at": null,
"new_user": 0,
"rating_count": 0,
"email_chat_messages": 1,
"email_progress_updates": 1,
"email_reassigned": 1,
"email_job_completed": 1,
"notify_hours": 1,
"total_job_count": 0,
"total_job_count_5_stars": 0,
"table_style": "DEFAULT",
"coupon_code": null,
"last_cdp_update": null,
"email_affidavits": false,
"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",
"created_at": 1548272881000,
"updated_at": 1607363359000,
"deleted_at": null,
"email_invoices_to": null,
"free_credits": "475.0000000000",
"api_enabled": true,
"private_jobs": false,
"salesforce_connected": true
}
},
"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",
"created_at": 1548272881000,
"updated_at": 1607363359000,
"deleted_at": null,
"email_invoices_to": null,
"free_credits": "475.0000000000",
"api_enabled": true,
"private_jobs": false,
"salesforce_connected": true
},
"state": {
"id": 1,
"name": "Colorado",
"abbreviation": "CO",
"allow_jobs": true,
"allow_residential_sub": true,
"allow_work_sub": true,
"created_at": 1596844801000,
"updated_at": 1596844801000,
"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,
"average_server_rating": 5,
"summons_serve_stamp": false,
"attach_summons_position": "PREPENDED",
"show_prior_attempts_posting": 0
},
"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,
"creditor_only": 0,
"collection_only": 0
},
"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": "6477676186",
"state_id": 46,
"created_at": 1548158103000,
"updated_at": 1607926553000,
"deleted_at": null,
"total_job_count": 51,
"total_job_count_5_stars": 5,
"coupon_code": null,
"last_cdp_update": null,
"email_affidavits": false,
"state": {
"id": 46,
"name": "Tennessee",
"abbreviation": "TN",
"allow_jobs": true,
"allow_residential_sub": false,
"allow_work_sub": false,
"created_at": 1596844801000,
"updated_at": 1596844801000,
"deleted_at": null,
"affidavit_service_title": "Return of Service",
"affidavit_nonservice_title": "Return of Nonservice",
"requires_notary_service": true,
"requires_notary_nonservice": true,
"allow_sunday_serve": 0,
"average_server_rating": 5,
"summons_serve_stamp": false,
"attach_summons_position": "PREPENDED",
"show_prior_attempts_posting": 0
}
},
"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_1Hz7FKHg213tM5vxSS07Qj5Q",
"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": 1608152958000,
"deleted_at": null,
"new_user": 0,
"rating_count": 0,
"email_chat_messages": 1,
"email_progress_updates": 1,
"email_reassigned": 1,
"email_job_completed": 1,
"notify_hours": 1,
"total_job_count": 0,
"total_job_count_5_stars": 0,
"table_style": "DEFAULT",
"coupon_code": null,
"last_cdp_update": null,
"email_affidavits": false
},
"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,
"bad_address": false,
"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": 1558672808000,
"deleted_at": null,
"timezone": "America/Denver",
"state": {
"id": 6,
"name": "Alabama",
"abbreviation": "AL",
"allow_jobs": true,
"allow_residential_sub": false,
"allow_work_sub": false,
"created_at": 1557771726000,
"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,
"average_server_rating": 0,
"summons_serve_stamp": false,
"attach_summons_position": "PREPENDED",
"show_prior_attempts_posting": 0
}
},
"mailed_address": null,
"attempt_photos": [
{
"id": 37,
"attempt_id": 36,
"extension": "jpg",
"include_in_affidavit": true,
"created_at": 1554410129000,
"updated_at": 1554410129000,
"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,
"page_count": 0,
"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": 212,
"user_id": 13,
"job_id": 160,
"message": "Hello",
"read": 0,
"created_at": 1625159254000,
"updated_at": 1625159254000,
"deleted_at": null,
"system": false,
"user": {
"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": 1602128130000,
"deleted_at": null,
"total_job_count": 0,
"total_job_count_5_stars": 0,
"coupon_code": null,
"last_cdp_update": null,
"email_affidavits": false
}
}
],
"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,
"page_count": 0,
"pivot": {
"job_id": 160,
"document_id": 380,
"name": "Subpoena"
}
}
],
"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 |
|---|---|
daysfloat, 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": 1625161316000,
"created_at": 1625161316000,
"id": 61
}
HTTP Request
POST /jobs/{job_id}/flag
Request Parameters
| Parameter | Description |
|---|---|
typestring, required |
One of: BAD_ADDRESS, MISSING_INFORMATION, AFFIDAVIT_CHANGES, OTHER |
descriptionstring, required |
Resolve a flag
Example request body:
{
"resolution_notes": "We have updated the address."
}
Example response:
{
"id": 62,
"job_id": 160,
"created_by_id": 13,
"type": "AFFIDAVIT_CHANGES",
"description": "Could you please make X correction in the affidavit?",
"resolved": true,
"resolution_notes": "We have updated the address.",
"resolved_by_id": 13,
"created_at": 1625161316000,
"updated_at": 1625161316000
}
HTTP Request
POST /jobs/{job_id}/flag/{flag_id}/resolve
Request Parameters
| Parameter | Description |
|---|---|
resolution_notesstring |
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": 1625161314000,
"created_at": 1625161314000,
"id": 223
}
HTTP Request
POST /jobs/{job_id}/messages
Request Parameters
| Parameter | Description |
|---|---|
messagestring, required |
Get chat messages
Example response:
[
{
"id": 212,
"user_id": 13,
"job_id": 160,
"message": "Hello",
"read": 0,
"created_at": 1625159254000,
"updated_at": 1625159254000,
"deleted_at": null,
"system": false,
"user": {
"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": 1602128130000,
"deleted_at": null,
"total_job_count": 0,
"total_job_count_5_stars": 0,
"coupon_code": null,
"last_cdp_update": null,
"email_affidavits": false,
"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.7811727,
"longitude": -104.9133288,
"timezone": "America/Denver",
"updated_at": 1625161315000,
"created_at": 1625161315000,
"id": 395,
"state": {
"id": 1,
"name": "Colorado",
"abbreviation": "CO",
"allow_jobs": true,
"allow_residential_sub": true,
"allow_work_sub": true,
"requires_server_identification": false,
"created_at": 1596844801000,
"updated_at": 1596844801000,
"deleted_at": null,
"hide_caption": 0,
"caption_id": "co",
"affidavit_service_title": "Affidavit of Service",
"affidavit_nonservice_title": "Affidavit of Nonservice",
"show_prior_attempts": 0,
"requires_notary_service": true,
"requires_notary_nonservice": true,
"attach_summons": false,
"proof_percent": "0.4500000000",
"show_photos": 1,
"custom_affidavit": 0,
"allow_sunday_serve": 1,
"average_server_rating": 5,
"summons_serve_stamp": false,
"attach_summons_position": "PREPENDED",
"show_prior_attempts_posting": 0
}
}
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",
"created_at": 1548272881000,
"updated_at": 1607363359000,
"deleted_at": null,
"email_invoices_to": null,
"free_credits": "475.0000000000",
"api_enabled": true,
"private_jobs": false,
"salesforce_connected": true,
"primary_billing_contact_email": "user@email.com",
"consolidate_invoice_line_items": true,
"prefix_billing_number_filenames": true,
"notary_required": false,
"exempt_witness_fees": false,
"allow_post_payment": false,
"collection_firm": true,
"creditor_firm": true,
"efile_enabled": true,
"notary_override": true,
"automated_statement_emails": true,
"affidavit_add_all_attempts": true,
"automated_statement_recipients": "user@email.com",
}
HTTP Request
GET /law-firms/current
Get special requirements
Example response:
[
{
"id": 134,
"title": "aaaaa",
"instructions": "123",
"is_default": true,
"law_firm_id": 2,
"last_updated_by": {
"id": 199,
"law_firm_id": 2,
"type": "FIRM",
"name": "User",
"last_name": "User",
"first_name": "User",
"email": "user@email.com",
"stripe_default_payment_method_id": null,
"email_verified": true,
"phone_number": "111-111-1111",
"address_1": "1802 N Gaylord St",
"address_2": "",
"city": "Denver",
"state_id": 1,
"zip": "80206",
"created_at": 1660062112023,
"updated_at": 1683913724176,
"new_user": true,
"notes": null,
"notify_hours": 1,
"email_affidavits": true,
"active": true,
"email_chat_messages": true,
"email_progress_updates": true,
"email_reassigned": true,
"email_job_completed": true,
"email_job_pending_firm_action": true,
"email_invoices": true,
"email_notifications": true,
"administrator": false,
},
"created_at": "2023-04-06T12:37:18.084663Z",
"updated_at": "2023-04-06T12:37:18.084663Z"
}
]
HTTP Request
GET /law-firms/{law-firm-id}/special-requirement
Create a special requirement
Special requirements are used to add additional requirements for the Server Ops Manager or Server to a job.
Example request body:
{
"title": "Back door check",
"instructions": "please check the back door",
"is_default": true,
"is_internal": false,
"states":[1,2]
}
Example response:
{
"id": 133,
"instructions": "new requirement",
"is_default": true,
"is_internal": true,
"last_updated_by_id": 162,
"law_firm_id": 2,
"title": "My New Req",
"created_at": "2023-10-03T14:40:58.507102923Z",
"updated_at": "2023-10-03T14:40:58.507103173Z",
"deleted_at": null
}
HTTP Request
POST /law-firms/{law-firm-id}/special-requirement
Notifications
Get notifications
Example response:
[
{
"id": 327,
"user_id": 2,
"job_id": 160,
"type": "MESSAGE",
"author_id": 13,
"action": null,
"message": "Hello",
"message_2": null,
"emailed": 0,
"read": false,
"created_at": 1625159254000,
"updated_at": 1625159254000,
"message_id": 212,
"author_system": 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": 1602128130000,
"deleted_at": null,
"total_job_count": 0,
"total_job_count_5_stars": 0,
"coupon_code": null,
"last_cdp_update": null,
"email_affidavits": false
},
"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": 1,
"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,
"affidavit_extension": null,
"review_period_ends": null,
"created_at": 1554126237000,
"updated_at": 1625156672000,
"deleted_at": 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,
"court_date": null,
"affidavit_status": "PENDING_TM_REVIEW",
"cancel_job_reason": null,
"affidavit_uploaded_at": "2020-09-29 05:45:04",
"salesforce_id": null,
"archived": false,
"off_app_assigned_to": "NOT_ASSIGNED",
"salesforce_user_id": "",
"affidavit_due_at": "2021-07-02 04:24:32",
"affidavit_reminders_sent": 0,
"last_affidavit_reminder_sent_at": null,
"attempt_reminders_sent": 0,
"last_attempt_reminder_sent_at": null,
"signed_affidavit_url": null,
"base_fee": 45,
"bounty": 80,
"post_price": 0,
"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,
"primary_address": {
"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": 1558672808000,
"deleted_at": null,
"timezone": "America/Denver"
}
},
"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,
"creditor_only": 0,
"collection_only": 0
},
"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_1Hz7FKHg213tM5vxSS07Qj5Q",
"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": 1608152958000,
"deleted_at": null,
"new_user": 0,
"rating_count": 0,
"email_chat_messages": 1,
"email_progress_updates": 1,
"email_reassigned": 1,
"email_job_completed": 1,
"notify_hours": 1,
"total_job_count": 0,
"total_job_count_5_stars": 0,
"table_style": "DEFAULT",
"coupon_code": null,
"last_cdp_update": null,
"email_affidavits": false,
"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",
"created_at": 1548272881000,
"updated_at": 1607363359000,
"deleted_at": null,
"email_invoices_to": null,
"free_credits": "475.0000000000",
"api_enabled": true,
"private_jobs": false,
"salesforce_connected": true
}
}
}
}
]
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,
"creditor_only": 0,
"collection_only": 0
}
]
HTTP Request
GET /serve-pricings/{state_id}
Get serve pricings by address
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,
"creditor_only": 0,
"collection_only": 0
}
]
HTTP Request
GET /serve-pricings/address?address_1=1800+N+Gaylord+St&city=Denver&state_id=1&zip=80206&job_type=SERVE
job_type: SERVE | SITE_VISIT
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": "sVUoraXLtzAGtB1NTI3yE7R3QPBCKKx9",
"updated_at": 1625161318000,
"created_at": 1625161318000,
"id": 156
}
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": true,
"allow_residential_sub": false,
"allow_work_sub": false,
"created_at": 1557771726000,
"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,
"average_server_rating": 0,
"summons_serve_stamp": false,
"attach_summons_position": "PREPENDED",
"show_prior_attempts_posting": 0,
"serve_pricings": [
{
"id": 21,
"name": "Standard",
"state_id": 6,
"base_fee": 35,
"bounty_fee": 40,
"diy_price": 75,
"post_price": 45,
"post_duration": 172800,
"initial_duration": 604800,
"total_duration": 604800,
"total_attempts": 4,
"updated_at": 1548331771000,
"created_at": 1548331771000,
"creditor_only": 0,
"collection_only": 0
},
{
"id": 22,
"name": "Expedited",
"state_id": 6,
"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,
"creditor_only": 0,
"collection_only": 0
},
{
"id": 23,
"name": "Same Day",
"state_id": 6,
"base_fee": 75,
"bounty_fee": 150,
"diy_price": 225,
"post_price": null,
"post_duration": null,
"initial_duration": 86400,
"total_duration": 86400,
"total_attempts": 4,
"updated_at": 1548331771000,
"created_at": 1548331771000,
"creditor_only": 0,
"collection_only": 0
},
{
"id": 231,
"name": "Garnishment",
"state_id": 6,
"base_fee": 40,
"bounty_fee": 0,
"diy_price": 0,
"post_price": 0,
"post_duration": 0,
"initial_duration": 604800,
"total_duration": 604800,
"total_attempts": 2,
"updated_at": 1612845039000,
"created_at": 1612845039000,
"creditor_only": 0,
"collection_only": 1
}
],
"supplementary_pricings": [
{
"id": 19,
"state_id": 6,
"name": "Skip Trace",
"price": "$75",
"description": "Find updated address(es) for servee.",
"server_cut": false,
"server_price": "$41.25",
"created_at": null,
"updated_at": null
},
{
"id": 79,
"state_id": 6,
"name": "Extended Travel Areas",
"price": "$50+",
"description": "A server may charge an additional fee for rural or other areas requiring additional travel time or costs to reach areas.",
"server_cut": false,
"server_price": "$27.5+",
"created_at": null,
"updated_at": null
},
{
"id": 80,
"state_id": 6,
"name": "Witness Fee Convenience Charge",
"price": "10%",
"description": "10% of the witness fee amount will be charged for printing & delivery of check. $2 min / $25 max.",
"server_cut": false,
"server_price": null,
"created_at": null,
"updated_at": null
},
{
"id": 81,
"state_id": 6,
"name": "Additional Serve at Same Address",
"price": "50% reduction",
"description": "Each Additional Serve at Same Address. 50% reduction in payout on each additional serve at the same address.",
"server_cut": true,
"server_price": "50% reduction",
"created_at": null,
"updated_at": null
},
{
"id": 82,
"state_id": 6,
"name": "Military Base and Jail/Prison Serve",
"price": "$75",
"description": "Additional payout for serves at military bases and jails/prisons.",
"server_cut": true,
"server_price": "$13.75",
"created_at": null,
"updated_at": null
},
{
"id": 83,
"state_id": 6,
"name": "On-demand Surveillance",
"price": "Up to $75/hour",
"description": "As needed survelliance for evasive servees. 2 hour minimum.",
"server_cut": false,
"server_price": "Up to $41.25/hour",
"created_at": null,
"updated_at": null
},
{
"id": 84,
"state_id": 6,
"name": "Additional Addresses",
"price": "$35 - $75",
"description": "If a serve address is updated after a server has made any or all 4 attempts on the original address. The payout is based on the base payout for the type of serve (as listed above).",
"server_cut": true,
"server_price": "$16.50 - $41.25",
"created_at": null,
"updated_at": null
},
{
"id": 85,
"state_id": 6,
"name": "Document Printing",
"price": "10\u00a2",
"description": "A fee of 10\u00a2 per page may be added for jobs with more than 100 printed pages.",
"server_cut": false,
"server_price": null,
"created_at": null,
"updated_at": null
}
]
}
]
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 |
|---|---|
startinteger, required |
UNIX Timestamp in milliseconds |
endinteger, required |
UNIX Timestamp in milliseconds |
Export statement (pdf)
Example response:
<pdf file>
HTTP Request
GET /statements/{start}/{end}/pdf
URL Parameters
| Parameter | Description |
|---|---|
startinteger, required |
UNIX Timestamp in milliseconds |
endinteger, 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_1Hz7FKHg213tM5vxSS07Qj5Q",
"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": 1608152958000,
"deleted_at": null,
"new_user": 0,
"rating_count": 0,
"email_chat_messages": 1,
"email_progress_updates": 1,
"email_reassigned": 1,
"email_job_completed": 1,
"notify_hours": 1,
"total_job_count": 0,
"total_job_count_5_stars": 0,
"table_style": "DEFAULT",
"coupon_code": null,
"last_cdp_update": null,
"email_affidavits": false,
"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",
"created_at": 1548272881000,
"updated_at": 1607363359000,
"deleted_at": null,
"email_invoices_to": null,
"free_credits": "475.0000000000",
"api_enabled": true,
"private_jobs": false,
"salesforce_connected": true
},
"state": {
"id": 1,
"name": "Colorado",
"abbreviation": "CO",
"allow_jobs": true,
"allow_residential_sub": true,
"allow_work_sub": true,
"created_at": 1596844801000,
"updated_at": 1596844801000,
"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,
"average_server_rating": 5,
"summons_serve_stamp": false,
"attach_summons_position": "PREPENDED",
"show_prior_attempts_posting": 0
},
"states": []
}
HTTP Request
GET /users/current
Webhooks
Create webhook endpoint
Example response:
{
"url": "https://example.com/webhook",
"enabled": true,
"version": 1,
"law_firm_id": 2,
"updated_at": 1625161320000,
"created_at": 1625161320000,
"id": 50
}
HTTP Request
POST /webhooks
Get webhook endpoints
Example response:
[
{
"id": 51,
"law_firm_id": 2,
"url": "https://example.com/webhook",
"version": 1,
"enabled": 1,
"event_job_status_change": 0,
"event_job_deleted": 0,
"event_job_extended": 0,
"event_job_attempt_created": 0,
"event_job_attempt_updated": 0,
"event_job_attempt_deleted": 0,
"event_job_flag_created": 0,
"event_job_flag_resolved": 0,
"event_job_chat_message": 0,
"created_at": 1625161320000,
"updated_at": 1625161320000
}
]
HTTP Request
GET /webhooks
Get webhook calls
Example response:
{
"current_page": 1,
"data": [
{
"id": 5,
"webhook_endpoint_id": 52,
"law_firm_id": 2,
"endpoint_url": "https://example.com/webhook",
"successful": 1,
"request_body": "{}",
"response_body": "{}",
"response_status_code": 200,
"attempts": 1,
"last_attempt": "2021-07-01 17:42:00",
"created_at": 1625161320000,
"updated_at": 1625161320000,
"event": "JOB_STATUS_CHANGE"
}
],
"first_page_url": "http://localhost:3000/v1/webhooks/calls?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost:3000/v1/webhooks/calls?page=1",
"links": [
{
"url": null,
"label": "pagination.previous",
"active": false
},
{
"url": "http://localhost:3000/v1/webhooks/calls?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "pagination.next",
"active": false
}
],
"next_page_url": null,
"path": "http://localhost:3000/v1/webhooks/calls",
"per_page": 10,
"prev_page_url": null,
"to": 1,
"total": 1
}
HTTP Request
GET /webhooks/calls
Webhook Events
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 examples
Example JOB_STATUS_CHANGE payload:
{
"event": "JOB_STATUS_CHANGE",
"created_at": 1696337002725,
"data": {
"job_id": 3146,
"old_status": "UNASSIGNED",
"new_status": "ASSIGNED"
}
}
Example JOB_DELETED payload:
{
"event": "JOB_DELETED",
"created_at": 1696339533678,
"data": {
"job_id": 3146
}
}
Example JOB_EXTENDED payload:
{
"event": "JOB_EXTENDED",
"created_at": 1696340853704,
"data": {
"job_id": 3145,
"days_extended": 7,
"old_due_date": "2023-10-13T12:37:16.458259Z",
"new_due_date": "2023-10-20T12:37:16.458259Z"
}
}
Example JOB_ATTEMPT_CREATED payload:
{
"event": "JOB_ATTEMPT_CREATED",
"created_at": 1696337321265,
"data": {
"job_id": 3146,
"attempt_id": 994,
"type": true
}
}
Example JOB_ATTEMPT_UPDATED payload:
{
"event": "JOB_ATTEMPT_UPDATED",
"created_at": 1696339428638,
"data": {
"job_id": 3146,
"attempt_id": 994,
"type": true
}
}
Example JOB_ATTEMPT_DELETED payload:
{
"event": "JOB_ATTEMPT_DELETED",
"created_at": 1696339533678,
"data": {
"job_id": 3146,
"attempt_id": 994
}
}
Example JOB_FLAG_CREATED payload:
{
"event": "JOB_FLAG_CREATED",
"created_at": 1696341106559,
"data": {
"job_id": 3145,
"flag_id": 412,
"type": "BAD_ADDRESS",
"description": "No house on site.",
"created_by_id": 13,
"created_by_name": "John Doe",
"created_by_type": "SERVER"
}
}
Example JOB_FLAG_RESOLVED payload:
{
"event": "JOB_FLAG_RESOLVED",
"created_at": 1696341195035,
"data": {
"job_id": 3145,
"flag_id": 412,
"type": "BAD_ADDRESS",
"description": "Ok",
"ResolvedByID": 14,
"ResolvedByName": "Jane Doe",
"ResolvedByType": "PROOF"
}
}
Example JOB_CHAT_MESSAGE payload:
{
"event": "JOB_CHAT_MESSAGE",
"created_at": 1696339851387,
"data": {
"job_id": 3146,
"user_name": "John Doe",
"user_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 service called Request Bin, which allows you to inspect arbitrary webhook requests.
If a JOB_STATUS_CHANGE events new_status field is REASSIGNED, an additional field called new_job_id will be present in the data. This is the job ID of the newly created job.