API Documentation v4

  1. API
  2. v4

Warning!

This version of the API is actively in development and changes may occur before release. We still recommend using this version as breaking changes are unlikely to occur and new endpoints are the main source of changes.

Introduction

Welcome to the Assure API. Version 4 of the API focuses on the addition of medical record requests.


Timestamps returned by requests are in the 24 hour format and use the current Central timezone (UTC-6 during CST and UTC-5 during CDT).


Authorization

Our API makes use of OAuth 2 using client credentials. If you are interested in using this service, please contact us at api@myassureservices.com. We will need your account login email and a list of endpoints you would like to use.

Example Request

We recommend you use an established OAuth library to authenticate with our API. How ever it is quite simple even with out a library.

1. Make a POST request to https://app.myassureservices.com/oauth/access_token containing the following variables:

  • grant_type = client_credentials
  • client_id = <your client id>
  • client_secret = <your client secret>
2. You will get a response back containing information. If the request failed the reason why will be returned to you. If your credentials are correct you will get a response back containing the following:
  • access_token = <generated access token>
  • token_type = Bearer
  • expires_in = 3600
3. Now that you have an access_token you can make requests to the API. If you wanted to view details for a hearing you send a GET request to the /api/v4/hearing/{hearing id} API endpoint with the following header information:
  • Authorization: Bearer <generated access token>
4. Keep in mind that your access token is only valid for the number of seconds contained in the expires_in variable that is returned to you in your authentication request. Keeping track of when your access_token expires is where a library can come in handy. You can use the same access token for all request until it expires.

Parameter Type Information

boolean: A boolean value will be a 1 or 0. 1 = true, 0 = false. When sending us data you should use a 1 or a 0 to represent boolean values.

association: An association can be an array containing arrays with a data models fields (for example a hearing with multiple notes attached) or a single object containing all data model fields depending on the association. An association may also be an empty value when no association is present.

empty values: A value of "null", "{}", "[]" or an empty string ("") should all be considered as no value(s) present.


Changes from v3

Below is a list of possible breaking changes from v3 of the API. When upgrading to v4 please make the below alterations to your setup.

  • Hearing models now properly return the hearing date field as a single date string instead of an array containing the servers timezone. This was only an issue in v3 of the API, v1 and v2 were unaffected.
  • SSN fields on DocPreHearingInfo, Hearing, and Case models are now string types to avoid possible issues with SSNs that start with a zero.
  • DocType model and endpoints have been renamed to FileType to better represent what they are used for.
  • doc_type_id field has been removed from the File model, use the file_type field instead.
  • Files create endpoint has been removed, to upload files to a hearing use the new upload endpoint on Hearings.
  • Files download endpoint has been changed to no longer require the file_type_id to be provided.
  • The CaseFiles download endpoint no longer supports base64 downloads.
  • Hearing models no longer have the user_advocate_attending field, it has been dropped in favor of the new attending association field that contains the assigned attending attorney's id, external_id, first_name and last_name fields.
  • When a request fails due to validation errors, such as leaving out a required field or providing an invalid value the "failed_rules" array that provides additional information about the rule check that failed will now properly be in the "data" field of the response instead of in the main response. See the Basic Response for more information.

Endpoints

DataTypes

list

Returns the current available data types for all data models in our system. Each model that has fields that have IDs (like status) that get mapped to strings or return a pre-defined list of values are returned in this request. This is a unique endpoint that does not return the standard basic response format and does not require authentication. This endpoint is intended to be used by you to keep an always up to date list of ID to string maps and string data lists that are available for all models that use them.

Return JSON is formatted in the following style:

{
    "DATA_MODEL_NAME": {
        "FIELD_KEY": {
            "FIELD_KEY_VALUE": "FIELD_STRING_VALUE",
            "FIELD_KEY_VALUE": "FIELD_STRING_VALUE",
        },
        "FIELD_KEY": {
            "FIELD_STRING_VALUE",
            "FIELD_STRING_VALUE"
        }
    },
    "DATA_MODEL_NAME": {
        ...
    }
}
  • "DATA_MODEL_NAME" is the name of the model that uses the listed "FIELD_KEY"s. Such as "EreFile".
  • "FIELD_KEY" is the name of the key on the model that uses the listed "FIELD_KEY_VALUE"s or "FIELD_STRING_VALUE"s. Such as the "document_type" field on the "EreFile" model.
  • When a "FIELD_KEY" has "FIELD_KEY_VALUE"s and "FIELD_STRING_VALUE"s it uses an ID as the field value that represents the "FIELD_STRING_VALUE". When "FIELD_KEY" is just a list of "FIELD_STRING_VALUE" then it uses the strings as the field values (such as the "EreFileList" "date_type" field).

A good example of a use case for this endpoint is to make sure you always have an updated list of document types that can be uploaded to the ERE when using the EreFile endpoints. The returned data on the "EreFile" key for this endpoint has the "document_type" key which provides a list of all the document types that can currently be uploaded to the ERE. The ERE will make changes to this list without notification but by checking this endpoint you can be sure you are offering all the latest document types to the user that we support uploading to the ERE without having to manually update your own lists when changes are made.

method GET
endpoint /api/v4/data-types
return View Full JSON Response Here

Attorneys

view

Show details related to an attorney in our system.
method GET
endpoint /api/v4/attorney/{id}
return Attorney Model

list

Returns an array containing available attorneys in our system.
method GET
endpoint /api/v4/attorney
return Attorney Model Collection

Briefs

view

Show details related to a brief request in our system.
method GET
endpoint /api/v4/brief/{id}
return Brief Model

list

Returns an array containing available brief requests in our system.
method GET
endpoint /api/v4/brief
return Brief Model Collection

Filters

Filter Format Example Description Values
page int /api/v4/brief?page=2 Go to a different page of the results.
paginate int /api/v4/brief?paginate=50 Set the number of results returned per page. Default 50. 100 max per page limit.
date_from MM/DD/YYYY /api/v4/brief?date_from=01/01/2019 Filter on a date_type greater than or equal to this date.
date_through MM/DD/YYYY /api/v4/brief?date_through=01/30/2019 Filter on a date_type less than or equal to this date.
date_type string /api/v4/brief?date_type=created_at&date_from=01/01/2019 Set a field to use for the date_from and date_through filter. Toggle Possible Values
ids string /api/v4/brief?ids=1 Filter on a brief ID. Separate multiple values with a comma.
status string /api/v4/brief?status=1 Filter on a brief status ID. Separate multiple values with a comma.
case_id string /api/v4/brief?case_id=1 Filter on a hearing ID. Can be used to find all briefs attached to a case. Separate multiple values with a comma.
hearing_id string /api/v4/brief?hearing_id=1 Filter on a hearing ID. Can be used to find all briefs attached to a hearing. Separate multiple values with a comma.
first_name string /api/v4/brief?first_name=John Filter on the first name on the brief. Case insensitive. This is a partial match search, "John" will match "Johnny", "Fitzjohn", "John", etc.
last_name string /api/v4/brief?last_name=Doe Filter on the last name on the brief. Case insensitive. This is a partial match search, "John" will match "Johnny", "Fitzjohn", "John", etc.
order string /api/v4/brief?order=desc Order results in descending (desc) or ascending (asc) order.
order_by string /api/v4/brief?order_by=created_at Order returned results by a field of the brief. Toggle Possible Values

create

Create a new brief request. Please keep in mind the following when making different types of brief requests.

  • Brief requests have additional fees separate from hearings, the requesting firm should be aware of the costs associated with making brief requests.
  • A brief may be connected to a hearing, case or nothing.
  • A hearing or case may have any number of briefs attached, when creating a brief attached to a hearing or case the Assure portal confirms the user intended to create multiple brief requests. We recommended your implementation does something similar to help prevent duplicate briefs.
  • You can use the list endpoint on briefs with the hearing_id or case_id filter to check if a hearing or case has attached briefs.
  • When making an Appellate (brief_type = 4) brief request, or setting the case_id to a case that is in the State Agency status we will automatically trigger an initial download or update for the All version of an ERE case file if the requester has ERE case file download support enabled. This means requests for these types of briefs may take longer than normal when we have to connect to the ERE. We recommend you set a request timeout to at least 120 seconds when making these types of brief requests and notify the user that there may be longer loads.
When making an Assure responsible brief request (brief_create_type = 1) please keep in mind the following:
  • If the brief request is not connected to a hearing or case you will need to upload files to the brief so Assure can complete the brief. This normally means the requester needs to upload the case file after making the brief request.
  • When connected to a hearing or case Assure will have access to files that have been uploaded to Assure and connected to the hearing or case. This means they do not need to upload files to the brief if they make use of ERE case files or already upload case files to hearings.
  • A brief is not considered complete until it passes review, as such you should only consider the status of Completed (status = 5) as a complete brief that is ready for download.
  • The finished brief file can be downloaded from a brief like other files with the Files download endpoint using the file ID found in brief_files field for the file with a file_type of Hearing Brief (file_type = 14).
When making an firm/requester responsible brief request (brief_create_type = 2) please keep in mind the following:
  • Assure is not involved in completing these briefs and it is the sole responsibility of the requester to manage these briefs however they like.
  • The assigned field will be automatically set to the requester's API account.
  • This type of brief is almost always used in conjuction with Assure's brief tool which is currently only available directly through the Assure portal.
  • When using the brief tool to complete a brief there will be no file attached to the brief because the brief tool uses a dynamic download. The user will have to either transfer the brief outside of the API to your software or be informed they need to upload the file from the brief tool to the brief, case, or hearing when completing a brief via the brief tool.
  • A firm may assign one of their attorneys or case managers on file with Assure to be responsible for the brief by sending the ID in the sub_assigned_id field when creating a brief. This allows the attorney or case manager to use the brief tool feature in the Assure portal to create a brief.
method POST
endpoint /api/v4/brief
return The Brief Model created.

Parameters

upload

Uploads a file and attaches it to a brief request.

  • Briefs only accept a select number of file types, please review the file_type values below for the list of allowed file types.
  • The brief file type (14) can only be uploaded when the brief is a firm/requester responsible brief. Doing so will automatically update the brief request to the completed status.
  • 250MB file size limit.
  • Only .pdf, .doc, .docx, .png, .tiff, .jpg, .txt, .zip, .xls, and .xlsx files are accepted
  • When ever possible we recommend you use the multipart/form-data method of uploading to avoid the slower speeds and overhead required for base64 uploads.
method POST
endpoint /api/v4/brief/upload
return File Model

Parameters

CaseFiles

view

Show details for case files connected to a case. Returns a collection containing both the Exhibited and All version of case files if present.
method GET
endpoint /api/v4/case-file/{case_id}
return A collection of Case File Models or a single Case File Model when a type is provided.

Parameters

download-check

Send a request to check the ERE and download available case files. A case may only have one of each type of case file attached to it. If a case file is already attached you will get an error back, please use the update-check endpoint to check for updates. This API endpoint may have longer response times than usual. Sometimes one or more status reports will have to be downloaded to verify the claimant can be found on the ERE in order to automatically select the correct credentials to use. If you encounter request timeouts please increase your request timeout to 120 or more seconds for these API requests to allow for multiple status reports to be downloaded from the ERE when required.
method POST
endpoint /api/v4/case-file/download-check
return Case File Model

Parameters


Examples

Example of an error where there is already a case file attached to the provided case ID or hearing ID.

Example of an error if you try to download an exhibited case file for a case that is only at the State Agency level.

update-check

Send a request to trigger an update to check the ERE for any changes for a case file. Case files use a queue system and successful responses confirm an update check has been queued. In order to get the results of an update check you will need to subscribe to webhooks or periodically check the status of the case file with the view endpoint.
method POST
endpoint /api/v4/case-file/update-check
return Case File Model

Parameters

download

Send a request to download the file attached to a case file. A file is available for download when the file_id field is set, you should use the view endpoint to check if a case file is available for download. You should verify that the HTTP status code is 200 and that the Content-Type header is not "application/json" to be sure the content of the response is file data. A Content-Type of "application/json" indicates a basic API response, most commonly an error.
method GET
endpoint /api/v4/case-file/download
return 200 HTTP status code with raw file data as the response body and file information in the response headers.
Content-Type header contains the files MIME content type, commonly "application/pdf".
Content-Length header contains the size of the file in bytes.
Content-Disposition header indicates the response is an attachment, followed a semi-colon and the filename parameter: attachment;filename="FILE_NAME_WITH_EXTENSION_HERE"

Parameters


Examples

Example of an error where the case file is still in progress and not available for download yet.

Cases

create

Create a new case that is in the State Agency status. A credential ID is required to be able to pull case files.
method POST
endpoint /api/v4/case
return Case Model

Parameters

update

Update an existing case in our system.
method POST
endpoint /api/v4/case/{id}
return Case Model

Parameters

list

Returns an array containing available cases.
method GET
endpoint /api/v4/case
return A collection of Case Models

Filters

Filter Format Example Description Values
page int /api/v4/case?page=2 Go to a different page of the results.
paginate int /api/v4/case?paginate=100 Set the number of results returned per page. 1000 per page limit.
exhibited_case_file_updates MM/DD/YYYY-MM/DD/YYYY /api/v4/case?exhibited_case_file_updates=01/01/2019-12/31/2019 Filter cases by the exhibited case file's update_completed_at date.
date_from MM/DD/YYYY /api/v4/case?date_from=01/01/2019 Filter on a date_type greater than or equal to this date.
date_through MM/DD/YYYY /api/v4/case?date_through=01/30/2019 Filter on a date_type less than or equal to this date.
date_type string /api/v4/case?date_type=hearing_date&date_from=01/01/2019 Set a field to use for the date_from and date_through filter. Toggle Possible Values
visibility string /api/v4/case?visibility=active,needs_ssn_update Set a visibility filter. You may use multiple options at a time, separate each value with a comma. Toggle Possible Values
case_status string /api/v4/case?case_status=1,2 Set one or more case statuses to filter on. You may use multiple options at a time, separate each value with a comma. Toggle Possible Values
hearing_id string /api/v4/case?hearing_id=1 Filter on a hearing ID. Can be used to find cases that are connected to specified hearings. Separate multiple values with a comma.
id string /api/v4/case?id=1 Filter on a case ID. Separate multiple values with a comma.
ssn string /api/v4/case?ssn=123456789 Filter on SSN. Cases that have not had their SSN updated from the original status report value will have the first five digits of the SSN as zeros, for example 000001234.
name string /api/v4/case?name=Tom Case insensitive search by the clients first or last name. Runs on a partial match, a search for "Tom" will match a first or last name of "atom", "Tommy", "kotomi", etc.
client_first_name string /api/v4/case?client_first_name=Tom Case insensitive search by the clients first name. Runs on a partial match, a search for "Tom" will match "atom", "Tommy", "kotomi", etc.
client_last_name string /api/v4/case?client_last_name=Tom Case insensitive search by the clients last name. Runs on a partial match, a search for "Tom" will match "atom", "Tommy", "kotomi", etc.
name_exact_match bool /api/v4/case?name_exact_match=1 Set all name filters in this request to to require an exact match. Only affects name, client_first_name and client_last_name filters. A search for "Tom" will only match if the field is "Tom".
external_id string /api/v4/case?external_id=ABCD-1 Filter on the external_id field of cases. Returns exact matches only.
status_report_id integer /api/v4/case?status_report_id=1 Filter cases attached to a specific status report. Will often return no results because all active cases are connected to a newer status report.
origin_status_report_id integer /api/v4/case?origin_status_report_id=1 Filter cases attached to a specific origin status report. Will return any cases that were seen on the provided status report ID for the first time. Will return no results if there were no new cases seen on the provided status report ID.
ac_cases bool /api/v4/case?ac_cases=1 Show only Appeals Council level cases. An Appeals Council case has the ac_case field set to 1.
sa_cases bool /api/v4/case?sa_cases=1 Show only State Agency level cases. A State Agency case is a case with a case_status of "State Agency".
ho_cases bool /api/v4/case?ho_cases=1 Show only Hearing level cases. A Hearing level case is a case from the Hearing Office status report that has ac_case set to 0 and is not in the "State Agency" case_status.
active bool /api/v4/case?active=1 Show cases that are considered active. An active case has been seen your most recent successful status report imports.
case_type_id integer /api/v4/case?case_type_id=1 Filter cases to only a specific case type ID. The default case type ID of 0 (for SSD cases) is set by default, provide a different value to see list of other case types.

view

Show details for a case.
method GET
endpoint /api/v4/case/{id}
return Case Model

request-coverage

Requests coverage of a case by creating a Hearing based on the provided case ID and any additional provided data. Additional information is only needed if the case is missing fields that are required to create a hearing (location_id, judge_id, client_ssn). Coverage is only available for cases when they meet the following requirements:

  • Case must be an SSD case (case_type_id of 0)
  • In the Scheduled Hearing (1), Ready To Schedule (2), Pending Folder Assembly (6), Pending ALJ Assignment (8), Folder Assembly (9), Case Workup (18), or Scheduled Case On Hold (22) status.
  • Has a hearing_date set one or more days in the future.
  • Not already connected to an active hearing (hearing_id must be empty or the attached hearing must be cancelled).
  • Does not already have a pending coverage request awaiting review.
  • Has not been previously denied coverage.
Attempting to request coverage for a case that does not meet the required rules for coverage will return a HTTP 422 error with a Basic Response and the reason in the message field.
method POST
endpoint /api/v4/case/request-coverage
return Upon a successful request where we were able to make a hearing immediately you will get successful response back with the newly created Hearing Model in the data field.
In some cases, such as possible duplicates or other conflicts you will get a message back saying your changes will be reviewed and the data field will be null. Once the coverage request has been reviewed by our team it will be accepted or denied. You can subscribe to webhooks for created hearings or for updated cases to be notified if the coverage request was accepted.

Parameters

revisions

Returns a list of changes made to a case since it was first created.
method GET
endpoint /api/v4/case/revisions
return An array of Revision Models

Parameters


Returns

This method returns an array of Revision Models if any changes have been made to this case since it was created. The available key fields are specific to the Case model.

Name Desc Values
id Assure's ID for this revision.
key The key used to identify the field. Toggle Possible Values
key_name The name of the key. Toggle Possible Values
old_value The value this field was before this change.
new_value The value this field was changed to. May be a string, int or float depending on which field key is referencing.

delete

Deletes a State Agency case. A case must meet the following criteria to be deleted:

  • Case is in the State Agency status.
  • Case does not have a completed or in progress Exhibited case file attached.
  • Case does not have a completed or in progress All case file attached.
  • Case does not have any ERE upload files attached.

method DELETE
endpoint /api/v4/case/{id}
return Basic Response with success set to 1 and HTTP code 200.

ContactEmails

create

Create a new contact email.

  • You may only have one primary contact email. Adding a new contact email with is_primary set to true will automatically set the existing contact email's is_primary to false if it exists.

method POST
endpoint /api/v4/contact-email
return ContactEmail Model

Parameters

delete

Deletes a contact email. A contact email must meet the following criteria to be deleted:

  • Must not be the primary contact email. Add a new contact email as a primary email before trying to delete.
  • Must not be the only email or phone number when attached to ERE credentials. Add a new contact email or phone number to the ERE credentials before trying to delete.

method DELETE
endpoint /api/v4/contact-email/{id}
return Basic Response with success set to 1 and HTTP code 200.

ContactNumbers

create

Create a new contact number.

  • You may only have one primary contact number. Adding a new contact number with is_primary set to true will automatically set the existing contact number's is_primary to false if it exists.

method POST
endpoint /api/v4/contact-number
return ContactNumber Model

Parameters

delete

Deletes a contact number. A contact number must meet the following criteria to be deleted:

  • Must not be the primary contact number. Add a new contact number as a primary number before trying to delete.
  • Must not be the only number or email when attached to ERE credentials. Add a new contact number or email to the ERE credentials before trying to delete.

method DELETE
endpoint /api/v4/contact-email/{id}
return Basic Response with success set to 1 and HTTP code 200.

DocPreHearingChecklists

view

Show details related to a pre-hearing checklist in our system.
method GET
endpoint /api/v4/doc-pre-hearing-checklist/{id}
return DocPreHearingChecklist Model

DocPreHearingInfo

create

Submit Pre-Hearing Information for a hearing. All pre-hearing information is connected to a hearing and is used to add additional client and case rep information when a hearing requires it. In the Assure portal the pre-hearing information is displayed with other hearing information and the pre-hearing information contains fields to confirm information on the hearing is accurate. It is recommended that you also display relevant client information from the attached hearing when working with pre-hearing information and offer options for the user to update the attached hearing in the event that some client information (such as a misspelled name) does not match the information they have.
method POST
endpoint /api/v4/doc-pre-hearing-info
return DocPreHearingInfo Model

Parameters

update

Update existing pre-hearing information in our system. The ID provided should be the hearing ID the pre-hearing information is attached to. You may provide all fields with any changes or only the fields you are changing.
method PUT
endpoint /api/v4/doc-pre-hearing-info/{hearing_id}
return DocPreHearingInfo Model

Parameters

view

Show details from the pre-hearing information for a hearing in our system. The ID provided should be the hearing ID the pre-hearing information is attached to.
method GET
endpoint /api/v4/doc-pre-hearing-info/{hearing_id}
return DocPreHearingInfo Model

EreCredentials

create

Create new a set of ERE credentials.
method POST
endpoint /api/v4/ere-credentials
return EreCredentials Model

Parameters

update

Update a set of existing ERE credentials.
method PUT
endpoint /api/v4/ere-credentials/{id}
return EreCredentials Model

Parameters


Examples

Updating credentials that have been marked as outdated (outdated = 1).

Enabling case file imports for a set of credentials.

Unlocking a set of credentials the have been locked out of SSN lookups.

Restricting a set of credentials to only be edited by a specific attorney that works for the firm.

list

Returns an array containing all of a firms ERE credentials.
method GET
endpoint /api/v4/ere-credentials
return A collection of EreCredentials Models

Filters

Filter Format Example Description Values
page int /api/v4/ere-credentials?page=2 Go to a different page of the results.
paginate int /api/v4/ere-credentials?paginate=50 Set the number of results returned per page. Default 50. 1000 max per page limit.
date_from MM/DD/YYYY /api/v4/ere-credentials?date_from=01/01/2022 Filter on a date_type greater than or equal to this date. Defaults to 30 days ago when not set.
date_through MM/DD/YYYY /api/v4/ere-credentials?date_through=01/30/2022 Filter on a date_type less than or equal to this date. Defaults to the last day of the current month when not set.
date_type string /api/v4/ere-credentials?date_type=created_at&date_from=01/01/2022 Set a field to use for the date_from and date_through filter. Defaults to created_at when not set. Toggle Possible Values

view

Show details for a set of ERE credentials.
method GET
endpoint /api/v4/ere-credentials/{id}
return EreCredentials Model

ere-number

Get an existing ERE phone number or create one if none are available. ERE phone numbers belong to a firm and are the connected to a set of credentials to be used on the ERE for that set of connected credentials.
method GET
endpoint /api/v4/ere-credentials/ere-number
return ErePhoneNumber Model

text-messages

Gets the latest text messages sent to the ERE credentials attached ERE phone number.
method GET
endpoint /api/v4/ere-credentials/{id}/text-messages
return EreCredentials Model

EreFileChanges

download

This is a special endpoint that only functions with the associated ERE file change log webhooks. By default you can not download individual ERE files. If you would like to be able to download individual ERE files when they are added during case file updates please contact support. Additional setup steps are required.
Send a request to download an ERE file. A individual ERE file is available for download up to seven days after it is downloaded for a case file update. After seven days the files are deleted. You should verify that the HTTP status code is 200 and that the Content-Type header is not "application/json" to be sure the content of the response is file data. A Content-Type of "application/json" indicates a basic API response, most commonly an error.
method GET
endpoint /api/v4/ere-file-change/download
return 200 HTTP status code with raw file data as the response body and file information in the response headers.
Content-Type header contains the files MIME content type, commonly "application/pdf" or "image/tiff".
Content-Length header contains the size of the file in bytes.
Content-Disposition header indicates the response is an attachment, followed a semi-colon and the filename parameter: attachment;filename="FILE_NAME_WITH_EXTENSION_HERE"

Parameters

EreFileLists

view

View the current list of files that were on the ERE as of the last date the case file attached to the provided case ID was created, updated, or checked for updates. This endpoint will return no data if an All or Exhibited case file has not been created for the provided case ID.
  1. The ERE may re-arrange, edit or remove files at any time, the longer the last_seen date is from the current date the less likely this list is accurate.
  2. This list does not track the history of files, this means if the ERE removes a file then it will be removed from this list when we see that it is gone.
  3. This list provides the state of the files at the time of the last case file creation or update check, not necessarily the state of the files as they currently are on the ERE.
  4. You can get an up to date ERE file list by using the CaseFiles update-check endpoint, Exhibited or All version will get the full list of files from the ERE.
method GET
endpoint /api/v4/ere-file-lists/{case_id}
return An array of ERE File List Models

Parameters

EreFiles

create

Uploads a file to our system, attaches it to a case and puts it in the queue to be uploaded to the ERE. Sending a file with this API endpoint does not guarantee the file will be uploaded to the ERE. You must subscribe to our webhooks or check the file with the view endpoint to see the current status of the file. Most files will be uploaded within a few minutes. When a ERE file has a tracking_number and a status of 4 it can be considered successfully uploaded to the ERE.

File Restrictions:
  • 200MB file size limit.
  • Only wpd, doc, docx, jpg, bmp, txt, rtf, xls, xlsx, pdf, tiff, and tif file formats are accepted.
method POST
endpoint /api/v4/ere-file
return ERE File Model

Parameters

view

Show details for an ERE File.
method GET
endpoint /api/v4/ere-file/{id}
return ERE File Model

list

Returns an array containing ERE file models.
method GET
endpoint /api/v4/ere-file
return A collection of ERE File Models

Filters

Filter Format Example Description Values
page int /api/v4/ere-file?page=2 Go to a different page of the results.
paginate int /api/v4/ere-file?paginate=50 Set the number of results returned per page. Default 50. 1000 max per page limit.
date_from MM/DD/YYYY /api/v4/ere-file?date_from=01/01/2019 Filter on a date_type greater than or equal to this date.
date_through MM/DD/YYYY /api/v4/ere-file?date_through=01/30/2019 Filter on a date_type less than or equal to this date.
date_type string /api/v4/ere-file?date_type=hearing_date&date_from=01/01/2019 Set a field to use for the date_from and date_through filter. Toggle Possible Values

download-confirmation

Download a PDF confirmation file with the data provided from the ERE for this ERE file. You should verify that the HTTP status code is 200 and that the Content-Type header is not "application/pdf" to be sure the content of the response is file data. A Content-Type of "application/json" indicates a basic API response, most commonly an error.
method GET
endpoint /api/v4/ere-file/download-confirmation
return 200 HTTP status code with raw file data as the response body and file information in the response headers.
Content-Type header contains the files MIME content type, "application/pdf" in this case.
Content-Length header contains the size of the file in bytes.
Content-Disposition header indicates the response is an attachment, followed a semi-colon and the filename parameter: attachment;filename="FILE_NAME_WITH_EXTENSION_HERE"

Parameters

download

Download the file that this EreFile model represents. You should verify that the HTTP status code is 200 and that the Content-Type header is not "application/json" to be sure the content of the response is file data. A Content-Type of "application/json" indicates a basic API response, most commonly an error.
method GET
endpoint /api/v4/ere-file/download
return 200 HTTP status code with raw file data as the response body and file information in the response headers.
Content-Type header contains the files MIME content type, commonly "application/pdf".
Content-Length header contains the size of the file in bytes.
Content-Disposition header indicates the response is an attachment, followed a semi-colon and the filename parameter: attachment;filename="FILE_NAME_WITH_EXTENSION_HERE"

Parameters

FhirResources

FHIR Release 4

These endpoints use the FHIR R4 Specification. Below is a list of available resource types.

FileTypes

view

Show details related to a file type in our system.
method GET
endpoint /api/v4/file-type/{id}
return FileType Model

list

Returns an array containing available file types in our system.
method GET
endpoint /api/v4/file-type
return FileType Model Collection

Files

view

Show details related to a file.
method GET
endpoint /api/v4/file/{id}
return File Model

download

Download a file. Files stored on Assure are archived after one year, archived files can not be downloaded over the API. You must manually request the file be removed from the archive in the Assure portal if you need to download files that were created more than a year ago. You should verify that the HTTP status code is 200 and that the Content-Type header is not "application/json" to be sure the content of the response is file data. A Content-Type of "application/json" indicates a basic API response, most commonly an error.
method GET
endpoint /api/v4/file/download
return 200 HTTP status code with raw file data as the response body and file information in the response headers.
Content-Type header contains the files MIME content type, commonly "application/pdf".
Content-Length header contains the size of the file in bytes.
Content-Disposition header indicates the response is an attachment, followed a semi-colon and the filename parameter: attachment;filename="FILE_NAME_WITH_EXTENSION_HERE"

Parameters

HearingNotes

create

Create a new note attached to a hearing. This endpoint is intended for general notes on a hearing, if you are making a hearing note containing a request to make changes to a hearing please use the hearing update endpoint with the "note" and "initials" fields to add your note to a hearing in order for hearing schedulers to review your request. If you add a note requesting changes to a hearing with this endpoint it will not notify hearing schedulers and your request may not be seen.
method POST
endpoint /api/v4/hearing-note
return HearingNote Model

Parameters

list

Returns an array of HearingNote models attached to the provided hearing ID. Hearing notes are sorted by created at in descending order.
method GET
endpoint /api/v4/hearing-note
return HearingNote Model Collection

Parameters


Filters

Filter Format Example Description Values
page int /api/v4/hearing-note?page=2 Go to a different page of the results.
paginate int /api/v4/hearing-note?paginate=100 Set the number of results returned per page. 1000 max per page limit.

Hearings

create

Adds a new hearing to our system.
method POST
endpoint /api/v4/hearing
return Hearing Model

Parameters

update

Update an existing hearing in our system.
method PUT
endpoint /api/v4/hearing/{id}
return Hearing Model

Parameters

view

Show details related to a hearing in our system.
method GET
endpoint /api/v4/hearing/{id}
return Hearing Model

list

Returns an array containing available hearings in our system.
method GET
endpoint /api/v4/hearing
return Hearing Model Collection

Filters

Filter Format Example Description Values
page int /api/v4/hearing?page=2 Go to a different page of the results.
paginate int /api/v4/hearing?paginate=25 Set the number of results returned per page. 1000 per page limit.
client_first_name string /api/v4/hearing?client_first_name=Tom Case insensitive search by the clients first name. Runs on a partial match, a search for "Tom" will match "atom", "Tommy", "kotomi", etc.
client_last_name string /api/v4/hearing?client_last_name=Tom Case insensitive search by the clients last name. Runs on a partial match, a search for "Tom" will match "atom", "Tommy", "kotomi", etc.
date_from M/DD/YYYY /api/v4/hearing?date_from=1/01/2019 Filter on a date_type greater than or equal to this date.
date_through M/DD/YYYY /api/v4/hearing?date_through=1/30/2019 Filter on a date_type less than or equal to this date.
date_type string /api/v4/hearing?date_type=hearing_date&date_from=1/01/2019 Set a field to use for the date_from and date_through filter. Toggle Possible Values
location string /api/v4/hearing?location=1,2 Filter by location ID. Separate multiple values with a comma. Toggle Possible Values
state string /api/v4/hearing?state=WA,TX Filter by state abbreviation. Separate multiple values with a comma. Toggle Possible Values
ids string /api/v4/hearing?ids=1 Filter by hearing IDs. Separate multiple values with a comma.

assign

Make a request to assign an attorney to a hearing. You can get a current list of your available attorneys by using the attorney list endpoint. If there is already an assigned attorney then the current assigned attorney will be removed and the new one provided will be assigned.
method POST
endpoint /api/v4/hearing/assign
return Basic Response

Parameters

unassign

Make a request to unassign an attorney from a hearing.
method POST
endpoint /api/v4/hearing/unassign
return Basic Response

Parameters

upload

Uploads a file and attaches it to a hearing. 250MB file size limit. Only .pdf, .doc, .docx, .png, .tiff, .jpg, .txt, .zip, .xls, and .xlsx files are accepted. We recommend you use the multipart/form-data method of uploading to avoid the slower speeds and overhead required for base64 uploads.
method POST
endpoint /api/v4/hearing/upload
return File Model

Parameters

outstanding-medical-record

Add information about an outstanding medical record request to a hearing. Used by pre-hearing information.
method POST
endpoint /api/v4/hearing/outstanding-medical-record
return OutstandingMedicalRecord Model

Parameters

Judges

view

Show details related to a judge in our system.
method GET
endpoint /api/v4/judge/{id}
return Judge Model

list

Returns an array containing available judges in our system.
method GET
endpoint /api/v4/judge
return Judge Model Collection

Locations

view

Show details related to a location in our system.
method GET
endpoint /api/v4/location/{id}
return Location Model

list

Returns an array containing available locations in our system.
method GET
endpoint /api/v4/location
return Location Model Collection

MedicalProfileConsents

create

Create a new medical profile consent record. Medical profile consent records are required when a Medical Profile is created with a consent_type_id of 1 (Firm Responsible). Completing a consent record is a two step process, first you will need to use this endpoint to complete the initial questionaire fields. A successful call to this create endpoint will return the ID of the created consent record. You will then need to use the upload endpoint to upload a PDF of the signed consent form to the consent record in order to complete consent. When consent is successfully completed a medical profile will automatically continue to the next steps.
method POST
endpoint /api/v4/medical-profile-consent
return MedicalProfileConsent Model

Parameters

upload

Uploads a signed consent file to a medical profile consent record. 250MB file size limit. Only .pdf files are accepted. We recommend you use the multipart/form-data method of uploading to avoid the slower speeds and overhead required for base64 uploads.
method POST
endpoint /api/v4/medical-profile-consent/upload
return File Model

Parameters

MedicalProfiles

create

Create a new medical profile. Medical profiles are unique based on SSN and hold all the required information to collection medical data about a claimant. A MedicalProfileRequest, which is used hold information about an attempt to collect any available medical data will be created automatically upon successful creation of a medical profile. If you attempt to create more than one medical profile per SSN you will get a duplication error. Use the request-update endpoint to request we check for any new available medical information for an existing medical profile, doing so will create a new medical profile request and any applicable fees will apply.
method POST
endpoint /api/v4/medical-profile
return MedicalProfile Model

Parameters

update

Update an existing medical profile in our system. You can not update a medical profile's SSN.
method PUT
endpoint /api/v4/medical-profile/{uid}
return MedicalProfile Model

Parameters

list

Returns an array containing medical profiles. Please note that most associations connected to medical profiles, such as lab data will not be displayed in the listing results due the large result sets many medical profiles contain. Please use the view endpoint to see all available data for a specific medical profile.
method GET
endpoint /api/v4/medical-profile
return A collection of MedicalProfile Models

Filters

Filter Format Example Description Values
page int /api/v4/medical-profile?page=2 Go to a different page of the results.
paginate int /api/v4/medical-profile?paginate=50 Set the number of results returned per page. Default 50. 1000 max per page limit.
date_from MM/DD/YYYY /api/v4/medical-profile?date_from=01/01/2022 Filter on a date_type greater than or equal to this date. Defaults to 30 days ago when not set.
date_through MM/DD/YYYY /api/v4/medical-profile?date_through=01/30/2022 Filter on a date_type less than or equal to this date. Defaults to the last day of the current month when not set.
date_type string /api/v4/medical-profile?date_type=created_at&date_from=01/01/2022 Set a field to use for the date_from and date_through filter. Defaults to created_at when not set. Toggle Possible Values
status string /api/v4/medical-profile?status=1,2 Set one or more statuses to filter on. You may use multiple options at a time, separate each value with a comma. Toggle Possible Values
uid string /api/v4/medical-profile?uid=1 Filter on a UID. Separate multiple values with a comma.
ssn string /api/v4/medical-profile?ssn=123456789 Filter on SSN.
name string /api/v4/medical-profile?name=Tom Case insensitive search by the clients first or last name. Runs on a partial match, a search for "Tom" will match a first or last name of "atom", "Tommy", "kotomi", etc.
first_name string /api/v4/medical-profile?first_name=Tom Case insensitive search by the clients first name. Runs on a partial match, a search for "Tom" will match "atom", "Tommy", "kotomi", etc.
last_name string /api/v4/medical-profile?last_name=Tom Case insensitive search by the clients last name. Runs on a partial match, a search for "Tom" will match "atom", "Tommy", "kotomi", etc.
name_exact_match bool /api/v4/medical-profile?name_exact_match=1 Set all name filters in this request to to require an exact match. Only affects name, first_name and last_name filters. A search for "Tom" will only match if the field is Tom.
external_id string /api/v4/medical-profile?external_id=ABCD-1 Filter on the external_id field of cases. Returns exact matches only.
case_id integer /api/v4/medical-profile?case_id=1 Filter medical profiles attached to a specific case ID.

view

Show details for a medical profile.
method GET
endpoint /api/v4/medical-profile/{uid}
return MedicalProfile Model

resubmit

Submit a request to collect all latest available medical information for an existing medical profile, including any new information that may be available. This will cancel any in progress medical profile requests and create a new request. If you need to make updates the the medical profile please use the edit endpoint before reqesting latest data. Any applicable fees will apply.
method POST
endpoint /api/v4/medical-profile/{uid}/resubmit
return MedicalProfileRequest Model

Parameters

download

Send a request to download the latest complete medical profile PDF. You should verify that the HTTP status code is 200 and that the Content-Type header is not "application/json" to be sure the content of the response is file data. A Content-Type of "application/json" indicates a basic API response, most commonly an error.
method GET
endpoint /api/v4/medical-profile/{uid}/download
return 200 HTTP status code with raw file data as the response body and file information in the response headers.
Content-Type header contains the files MIME content type, commonly "application/pdf".
Content-Length header contains the size of the file in bytes.
Content-Disposition header indicates the response is an attachment, followed a semi-colon and the filename parameter: attachment;filename="FILE_NAME_WITH_EXTENSION_HERE"

download-provider-file

Send a request to download a medical profile provider PDF. You must provide the UID of the medical profile and the ID of the provider file you wish to download. You can find the ID of medical profile provider files when using the view endpoint on a medical profile and looking for the "id" key in the "medical_profile_provider_files" array. You should verify that the HTTP status code is 200 and that the Content-Type header is not "application/json" to be sure the content of the response is file data. A Content-Type of "application/json" indicates a basic API response, most commonly an error.
method GET
endpoint /api/v4/medical-profile/{uid}/download-provider-file/{medical_profile_provider_file_id}
return 200 HTTP status code with raw file data as the response body and file information in the response headers.
Content-Type header contains the files MIME content type, commonly "application/pdf".
Content-Length header contains the size of the file in bytes.
Content-Disposition header indicates the response is an attachment, followed a semi-colon and the filename parameter: attachment;filename="FILE_NAME_WITH_EXTENSION_HERE"

MedicalRecordProviders

list

Returns an array containing known medical record providers. case_id and at least one search filter of the available options (name, address, city, state or zip) are required for all retrieval services. You may provider additional filter options to narrow down results.

When making a request using RP the following rules apply:
  • 50 results per page are returned.
  • Standard totals and paginate options supported.
When making a request using ARC the following rules apply:
  • 100 results per page are returned.
  • There is no total results or total pages option supported by ARC, if you need to view additional results past the 100 returned you will have to increment the page value and then check if results are returned.
method GET
endpoint /api/v4/medical-record-provider
return A collection of Medical Record Provider Models

Parameters


Filters

Filter Format Example Description Values
page int /api/v4/medical-record-provider?page=2 Go to a different page of the results.
name string /api/v4/medical-record-provider?case_id=1&name=John Doe Medical Services The name of the provider.
address string /api/v4/medical-record-provider?case_id=1&address=123 Main St The street address of the provider.
city string /api/v4/medical-record-provider?case_id=1&city=Fort Worth The city of the provider.
state string /api/v4/medical-record-provider?case_id=1&state=TX The two-letter state abbreviation of the provider. Toggle Possible Values
zip 99999 or 99999-9999 /api/v4/medical-record-provider?case_id=1&zip=12345 The ZIP code of the provider.

download-auth

Downloads the the provider specific auth file. You should verify that the HTTP status code is 200 and that the Content-Type header is not "application/json" to be sure the content of the response is file data. A Content-Type of "application/json" indicates a basic API response, most commonly an error.

ReleasePoint ONLY

This endpoint is currently only supported by providers from RP. When running a provider search for a RP medical record request the field named auth_available is provided. When auth_available is set to "1" you may use this endpoint to download the provider specific autho file from RP that is required when making medical record requests for the selected provider. This allows you to create the medical record request with the provider specific autho already completed.
method POST
endpoint /api/v4/medical-record-provider/download-auth
return 200 HTTP status code with raw file data as the response body and file information in the response headers.
Content-Type header contains the files MIME content type, commonly "application/pdf".
Content-Length header contains the size of the file in bytes.
Content-Disposition header indicates the response is an attachment, followed a semi-colon and the filename parameter: attachment;filename="FILE_NAME_WITH_EXTENSION_HERE"

Parameters

MedicalRecordStatusNotes

view

View all status notes attached to a medical record request.
method POST
endpoint /api/v4/medical-record-status-notes/{medical_record_id}
return An array of MedicalRecordStatusNote models.

Parameters

create

Send a new status note to the retrieval service. Used to send customer service requests and responses directly to the retrieval service.
method POST
endpoint /api/v4/medical-record-status-notes
return Basic Response with success set to 1. After a short delay the status note will appear on the retrieval service's main portal and be connected to the provided medical_record_id.

Parameters

Different retrieval services make use of different fields to create requests. We support multiple retrieval services through the same medical record API endpoints. The retrieval service column indicates which retrieval services make use of which fields. An ALL retrieval service indicates that all retrieval services share the field, there may still be specific requirements referenced in the description column that should be reviewed.

All Fields RP Fields ARC Fields

MedicalRecords

create

Create a new Medical Record request that will be sent to a retrieval service. You must first contact Assure and setup at least one retrieval service. We currently support the following retrieval services:
  1. ReleasePoint (RP)
  2. American Retrieval Company (ARC)
Creating a completed medical record request is a multiple step process. Depending on the retrieval service the required fields will differ, please be sure to adjust the fields you send depending on the retrieval service you have selected for the request.
  1. Search for an existing provider with the information you have using the /medical-record-provider endpoint. If a match is found be sure to include the account in the "medical_record_provider" array of the medical record request to avoid possible delays related to matching the correct provider.
  2. Use the /medical-record/create endpoint to attempt to create a new medical record. If successful the created MedicalRecord will be returned.
  3. Use the "id" field of the returned MedicalRecord and the /medical-record/upload endpoint to upload any required files. Use the /medical-record/attach-files endpoint if you have already uploaded files to another request and wish to attach them to these new requests to avoid having to upload duplicate files.
Please be aware that medical record retrieval services such as ReleasePoint often do maintenance making all or parts of their API not available to us. It is recommended that you prepare for temporary errors often from these services or subscribe to their maintenance notifications if they are offered.
method POST
endpoint /api/v4/medical-record
return The MedicalRecord Model created.

Parameters

Different retrieval services make use of different fields to create requests. We support multiple retrieval services through the same medical record API endpoints. The retrieval service column indicates which retrieval services make use of which fields. An ALL retrieval service indicates that all retrieval services share the field, there may still be specific requirements referenced in the description column that should be reviewed.

All Fields RP Fields ARC Fields

Examples

Creating a new MedicalRecord request using RP.

Creating an additional MedicalRecord request for the same patient using RP.

list

Returns an array containing medical record requests. Defaults to return from all retrieval services, use the retrieval_service to only display from a specific retrieval service.
method GET
endpoint /api/v4/medical-record
return A collection of Medical Record Models

Filters

Filter Format Example Description Values
page int /api/v4/medical-record?page=2 Go to a different page of the results.
paginate int /api/v4/medical-record?paginate=50 Set the number of results returned per page. Default 50. 1000 max per page limit.
date_from MM/DD/YYYY /api/v4/medical-record?date_from=01/01/2019 Filter on a date_type greater than or equal to this date.
date_through MM/DD/YYYY /api/v4/medical-record?date_through=01/30/2019 Filter on a date_type less than or equal to this date.
date_type string /api/v4/medical-record?date_type=hearing_date&date_from=01/01/2019 Set a field to use for the date_from and date_through filter. Toggle Possible Values
case_id string /api/v4/medical-record?case_id=1 Filter on a case ID. Can be used to find all medical records attached to a case. Separate multiple values with a comma.
retrieval_service string /api/v4/medical-record?retrieval_service=rp Filter based on the retrieval service used to obtain the medical records. Excluding this filter means all results regardless of retrieval service. Toggle Possible Values

view

Show details for a medical record request.
method GET
endpoint /api/v4/medical-record/{id}
return MedicalRecord Model

Parameters

upload

Uploads a file, attaches it to a medical record request and sends it to the retrieval service. 250MB file size limit. Only pdf and tif files are accepted.
method POST
endpoint /api/v4/medical-record/upload
return MedicalRecordFile Model

Parameters

Different retrieval services make use of different fields to create requests. We support multiple retrieval services through the same medical record API endpoints. The retrieval service column indicates which retrieval services make use of which fields. An ALL retrieval service indicates that all retrieval services share the field, there may still be specific requirements referenced in the description column that should be reviewed.

All Fields RP Fields ARC Fields

attach-files

Attaches one or more files that have already been uploaded to a medical record request and sends it to the retrieval service. This endpoint is used for attaching and sending files to the retrieval service that you have already attached to other medical record requests. This prevents the need to upload the same file multiple times for each provider and allows you to attach existing files to new requests for the same client.
method POST
endpoint /api/v4/medical-record/attach-files
return An array containing the newly created MedicalRecordFile models for each file attached to a medical record.

Parameters

MedicareLeads

create

Create a new medicare referral. Please note that if your medicare referrals are automatically sold there is no confirmation option when creating medicare referrals over the API. If you create your medicare referral over the API with all required fields and it is eligible to be sold it will automatically be sold.
method POST
endpoint /api/v4/medicare-lead
return MedicareLead Model

Parameters

update

Update an existing medicare referral in our system. You may provide all fields with any changes or only the fields you are changing. Please note that if your medicare referrals are automatically sold there is no confirmation option when making updates over the API. If you complete your medicare referral over the API and it is eligible to be sold it will automatically be sold.
method PUT
endpoint /api/v4/medicare-lead/{id}
return MedicareLead Model

Parameters

list

Returns an array containing medicare referrals.
method GET
endpoint /api/v4/medicare-lead
return A collection of MedicareLead Models

Filters

Filter Format Example Description Values
page int /api/v4/medicare-lead?page=2 Go to a different page of the results.
paginate int /api/v4/medicare-lead?paginate=50 Set the number of results returned per page. Default 50. 1000 max per page limit.
date_from MM/DD/YYYY /api/v4/medicare-lead?date_from=01/01/2022 Filter on a date_type greater than or equal to this date. Defaults to 30 days ago when not set.
date_through MM/DD/YYYY /api/v4/medicare-lead?date_through=01/30/2022 Filter on a date_type less than or equal to this date. Defaults to the last day of the current month when not set.
date_type string /api/v4/medicare-lead?date_type=created_at&date_from=01/01/2022 Set a field to use for the date_from and date_through filter. Defaults to created_at when not set. Toggle Possible Values
ids string /api/v4/medicare-lead?ids=1,2 Filter on a one or more Medicare Referral IDs. Separate multiple values with a comma.
status string /api/v4/medicare-lead?status=0,7 Filter on a one or more status IDs. Separate multiple values with a comma.

view

Show details for a medicare referral.
method GET
endpoint /api/v4/medicare-lead/{id}
return MedicareLead Model

OpenHearings

list

Returns an array containing available open hearings as bundles.
method GET
endpoint /api/v4/open-hearing
return A collection of OpenHearingBundle Models

Filters

Filter Format Example Description Values
date_from MM/DD/YYYY /api/v4/open-hearing?date_from=01/01/2019 Filter on a date_type greater than or equal to this date.
date_through MM/DD/YYYY /api/v4/open-hearing?date_through=01/30/2019 Filter on a date_type less than or equal to this date.
date_type string /api/v4/open-hearing?date_type=hearing_date&date_from=01/01/2019 Set a field to use for the date_from and date_through filter. Toggle Possible Values
state string /api/v4/open-hearing?state=WA,CA Filter on the hearing state. Separate multiple values with a comma.
location_id string /api/v4/open-hearing?location_id=565 Filter on the hearing location_id. Separate multiple values with a comma.

request

Put in a request to have an attorney assigned to open hearings.
method POST
endpoint /api/v4/open-hearing/request
return Basic Response with success set to 1 and HTTP code 200.

Parameters

withdraw-request

Withdraw a request to have an attorney assigned to an open hearings.
method POST
endpoint /api/v4/open-hearing/withdraw-request
return Basic Response with success set to 1 and HTTP code 200.

Parameters

ReadyToScheduleData

create

Adds a new ready to schedule hearing to our system. A RTS hearing is a hearing with no location, date or time. If a location, date and time are provided this endpoint will instead create a new hearing request.
method POST
endpoint /api/v4/ready-to-schedule-data
return ReadyToScheduleData Model

Parameters

update

Update an existing ready to schedule hearing in our system.
method PUT
endpoint /api/v4/ready-to-schedule-data/{id}
return ReadyToScheduleData Model

Parameters

StatusReports

create

Create a new status report import request. This will queue up a request to download the status report from the ERE for the provided credentials and then import the status report. This request does not guarantee a status report import will complete. You must subscribe to the updated.status-report webhooks to get progress information or check the status report periodically over the API using the status report view endpoint.
method POST
endpoint /api/v4/status-report
return StatusReport Model

Parameters

view

Show details about a status report import.
method GET
endpoint /api/v4/status-report/{id}
return StatusReport Model

list

Returns an array containing all status reports created in the last 31 days.
method GET
endpoint /api/v4/status-report
return A collection of StatusReport Models

Filters

Filter Format Example Description Values
ere_credentials_id string /api/v4/status-report?ere_credentials_id=1 Filter on a set of ERE credentials.

download

Send a request to download the raw CSV file used for a status report import. A file is available for download when the status report is in the status of 4, 5 or 8. You should use the view endpoint to check the status of the status report import before trying to download. You should verify that the HTTP status code is 200 and that the Content-Type header is not "application/json" to be sure the content of the response is file data. A Content-Type of "application/json" indicates a basic API response, most commonly an error.
method GET
endpoint /api/v4/status-report/download
return 200 HTTP status code with raw file data as the response body and file information in the response headers.
Content-Type header contains the files MIME content type, always "text/csv" when successful in this case.
Content-Length header contains the size of the file in bytes.
Content-Disposition header indicates the response is an attachment, followed a semi-colon and the filename parameter: attachment;filename="FILE_NAME_WITH_EXTENSION_HERE"

Parameters

Data Models

Basic Response

The basic format of a JSON reponse returned by the API. Except when downloading files, all requests returned are in this format with a Content-Type header of "application/json". Successful requests to download files send only file data in the request with a Content-Type header (and other file specific headers) based on the file data.
The data field contains the data specific to the request, such as the returned model or an array of models.

Parameters

Key Type Description Values
success int Returns 1 on a successful call or 0 when we were unable to complete the request.
message string Any additional information about the request, including information about the error that occurred if applicable.
code int The HTTP status code returned. Toggle Possible Values
data mixed Any data the request needs to return. This will be an empty value (type of empty value depends on the endpoint) if the response does not have any data to return. Toggle Possible Values
pagination conditional An array of fields for handling paging results. Only available on list endpoints when multiple results are expected. Toggle Possible Values

Attorney

Base model of an attorney.

Parameters

Key Type Description Values
id int Assure's ID for this attorney.
external_id string If attorney works for your firm, you can provide an external ID for the attorney to make lookups easier on your end. If one of your attorneys is attending the hearing and you have provided an external ID, it will be listed here.
first_name string First name of the attorney attending the hearing.
last_name string Last name of the attorney attending the hearing.
is_active boolean Whether or not the attorney can log into the assure portal.
is_assignable boolean Whether or not the attorney can be assigned to new hearings.

Brief

Base model of a brief.

Parameters

Key Type Description Values
id int Assure's ID for the brief.
owner association The brief owner's information.
claimant_firstname string The brief claimant's first name. Only required when no hearing_id or case_id is provided. When providing the hearing_id or case_id field the first and last name on the case or hearing will be used.
claimant_lastname string The brief claimant's last name. Only required when no hearing_id or case_id is provided. When providing the hearing_id or case_id field the first and last name on the case or hearing will be used.
status_name string The brief's status name.
assigned association The assigned user information. Will be empty when is_assure_assigned is true.
sub_assigned association The sub assigned user information. Will be empty when is_assure_assigned is true.
brief_files association Files uploaded to the brief.
due_at string The date the brief is due. Due dates can not fall on Saturday, Sunday or any goverment holidays, an error will be returned when attempting to set the due date to a restricted date. Briefs created with a due date that are 5 or less days away may be subject to an additional rush fee. Accepts MM/DD/YYYY, e.g. 4/04/2022, 12/12/2022. Returns YYYY-MM-DD 00:00:00.
completed_at string If the brief was completed this field contains the date and time it was completed at. YYYY-MM-DD HH:MM:SS.
brief_type int The type of brief. Toggle Possible Values
brief_create_type int The brief request type, used to determine who should be responsible to managing and completing the brief. Only used during the creation of new briefs, it will not be present after creation. Instead review then is_assure_assigned to determine if Assure is responsible for this brief or not. Toggle Possible Values
status int The brief's status ID. Toggle Possible Values
hearing_id int The ID of the hearing this brief is attached to.
case_id int The ID of the case this brief is attached to.
hearing_date int The date of hearing. Only required for Pre-hearing (brief_type = 1) briefs not connected to a case or hearing (no hearing_id or case_id provided). Accepts MM/DD/YYYY, e.g. 4/04/2022, 12/12/2022. Returns YYYY-MM-DD HH:MM:SS.
hearing_time int The time the hearing takes place. Only required for Pre-hearing (brief_type = 1) briefs not connected to a case or hearing (no hearing_id or case_id provided). 12 hour format HH:MM AM/PM, e.g. 9:05 AM, 1:15 PM.
location_id int The location ID of the hearing. Can be found by searching the Location list endpoint. Only required for Pre-hearing (brief_type = 1) briefs not connected to a case or hearing (no hearing_id or case_id provided).
is_assure_assigned bool Determines if Assure is currently responsible for handling this brief.
use_legacy_tool bool Determines if this brief should use the legacy brief tool if a request is made to create this brief with the brief tool. The requester must be allowed to make legacy brief tool requests in order to change this field.
special_instructions string Any additional instructions or information for this brief.
updated_at string The date a change was last made to any field on this model, including fields that may not be displayed. YYYY-MM-DD HH:MM:SS.
created_at string The date the brief was created/requested. YYYY-MM-DD HH:MM:SS.

Case

Base model of a case.

Parameters

Key Type Description Values
id int Assure's ID for this case.
hearing_id int Assure's hearing ID that this case is attached to.
first_name string First name of the claimant.
middle_name string Middle name or initial of the claimant.
last_name string Last name of the claimant
client_ssn string SSN of the claimant. Only the first 5 digits provided will be used when updating, any formatting will be stripped. The last four of the SSN that originate from the status report can not be changed for cases that are on a status report. When creating or updating State Agency cases or Non-SSD cases the full SSN will be updated. Required when creating a new case.
owner_firm association The owning firm's information.
hearing_date string Date of the hearing. YYYY-MM-DD 00:00:00.
hearing_time string Time of the hearing local to hearing location and hearing date. H:MM AM/PM in 5 minute increments from 7:00 AM to 5:00 PM. 7:00 AM, 7:05 AM, 12:30 PM, 12:35 PM, etc.
hearing_timezone string The timezone of the hearing location.
location_id int Hearing location id.
location association Case location information. Uses the Location model.
case_status string The current status of the case. Toggle Possible Values
case_status_date string Date of the last status change. YYYY-MM-DD HH:MM:SS.
claim_type int The type of claim for this case. Toggle Possible Values
judge_id int The ALJ's ID for the case.
judge association The judge's information.
require_ve boolean Whether or not a vocational expert is required for this case.
require_me boolean Whether or not a medical expert is required for this case.
t2_decision string The T2 decision for this case. Toggle Possible Values
t16_decision string The T16 decision for this case. Toggle Possible Values
ssn_updated boolean Whether or not the case's full SSN has been set.
case_file_exhibited association The attached Exhibited CaseFile if available.
case_file_all association The attached All CaseFile if available.
created_at string The date the case was created. YYYY-MM-DD HH:MM:SS.
external_id string A custom ID you can set to identifiy this case in external applications. Maximum 255 characters.
case_status_id integer The ID the case_status is mapped to. Toggle Possible Values
ac_case bool Determines if this is an Appeals Council case or not.
ac_case_id integer The ID the case this AC case is attached to if present.
hearing_office_with_jurisdiction string The raw value of the "Hearing Office with Jurisdiction" field on the hearing status report or the raw value of "Appeals Office with Jurisdiction" when the case is an AC case.
claim_type_name string The raw value of the "Claim Type" field on the status report.
electronic_folder string The value of the "Electronic Folder" field on the status report as a "1" for "Yes" or "0" for "No".
expedited_case string The value of the "Expedited Case" field on the status report as a "1" for "Yes" or "0" for "No".
hearing_request_date string The raw value of the "Hearing Request Date" field on the status report.
claimant_location string The raw value of the "Claimant Location" field on the status report.
representative_location string The raw value of the "Representative Location" field on the status report.
alj_location string The raw value of the "ALJ Location" field on the status report.
alj_last_name string The raw value of the "ALJ Last Name" field on the status report.
alj_first_name string The raw value of the "ALJ First Name" field on the status report.
medical_expert string The raw value of the "Medical Expert" field on the status report.
vocational_expert string The raw value of the "Vocational Expert" field on the status report.
hearing_held_date string The raw value of the "Hearing Held Date" field on the status report.
fee_agreement string The value of the "Fee Agreement" field on the status report as a "1" for "Yes" or "0" for "No".
fee_petition string The value of the "Fee Petition" field on the status report as a "1" for "Yes" or "0" for "No".
transfer_info_to string The raw value of the "Transfer Information To" field on the AC status report. Not available on the hearing status report.
transfer_info_from string The raw value of the "Transfer Information From" field on the AC status report. Not available on the hearing status report.
request_date string The raw value of the "Request Date" field on the AC status report. Not available on the hearing status report.
row_id integer The row number of this case on the status report it was last seen on.
status_report_id integer The ID of the status report this case was last seen on.
origin_status_report_id integer The ID of the status report we first saw this case on.
last_seen_at string The date we last saw the case on the a status report. YYYY-MM-DD HH:MM:SS 24 hour format Central timezone.
last_changed_at string The date we last saw a changed value on the status report for this case. YYYY-MM-DD HH:MM:SS 24 hour format Central timezone.
case_level string The Case Level field for cases from the IC status report, when the case is not on the IC status report then the case level is determined by the type of the status report the case was last seen on. Toggle Possible Values
closure_date string The Closure Date field for cases from the IC status report. Returns YYYY-MM-DD 00:00:00 format.
date_fqr_starts string The Date FQR Starts field for cases from the IC status report. Returns YYYY-MM-DD 00:00:00 format.
on_last_import bool Indicates if we saw this case on the latest successful status report import.
case_type_id integer The ID of the type of case this is. When not provided cases default to 0 for SSD cases. Toggle Possible Values
updated_at string The date a change was last made to any field on this case, even non status report fields. YYYY-MM-DD HH:MM:SS 24 hour format Central timezone.

CaseFile

Base model of a case file. Case files are generated PDF files created from files on the ERE. A CaseFile model holds information used for generating the PDFs and tracking progress, it is not an indication of an actual downloadable file existing. If there is an actual file available for this case file it is linked by the file_id field. Also known as ERE Case Files.

Parameters

Key Type Description Values
id int Assure's ID for this ERE file.
case_id int The ID of the case this file will be attached to. Required if hearing_id is empty.
hearing_id int The ID of the case this file will be attached to. Required if case_id is empty.
file_id int The ID of the file connected to this case file.
ere_credentials_id int The ID of the ERE credentials this case file is connected to.
type int The case file type ID. Toggle Possible Values
status int The status ID. Toggle Possible Values
status_message string The status message related to the current status.
update_completed_at string The last time we completed downloading new updates to this case file. YYYY-MM-DD HH:MM:SS.
last_update_check string The date we last checked the ERE to see if an updated file was available. YYYY-MM-DD HH:MM:SS.
last_change string The day of the last time a change was made to this case file on the ERE. YYYY-MM-DD 00:00:00.
created_at string The date the case file was first created. YYYY-MM-DD HH:MM:SS.
file_count int The number of individual files used to create this case file.
page_count int The total number of pages in this case file.
level string The Level from the ERE of the attached case. Empty when not set by the ERE. Updates on case file creation, update or update check. Toggle Possible Values
aod string The Alleged Onset Date from the ERE of the attached case. Empty when not set by the ERE. Updates on case file creation, update or update check. YYYY-MM-DD 00:00:00.
application_date string The Application Date from the ERE of the attached case. Empty when not set by the ERE. Updates on case file creation, update or update check. YYYY-MM-DD 00:00:00.
last_insured string The Last Insured Date from the ERE of the attached case. Empty when not set by the ERE. Updates on case file creation, update or update check. YYYY-MM-DD 00:00:00.
last_insured_blind string The Last Insured Blind Date from the ERE of the attached case. Empty when not set by the ERE. Updates on case file creation, update or update check. YYYY-MM-DD 00:00:00.

ContactEmail

Base model of a contact email for a user.

Parameters

Key Type Description Values
id int Assure's ID for this contact email.
ere_credentials_id int The ID of the ERE credentials this contact email is connected to. Required when type is 5, otherwise empty.
email string The email address.
name string The name of the owner of this email.
type int The type ID. Toggle Possible Values
is_primary bool If this is the primary contact email or not.

ContactNumber

Base model of a contact phone number for a user.

Parameters

Key Type Description Values
id int Assure's ID for this contact number.
ere_credentials_id int The ID of the ERE credentials this contact number is connected to. Required when number_type is 6, otherwise empty.
contact_number string The phone number.
extension string The extension for this phone number.
number_type int The number type ID. Toggle Possible Values
is_primary bool If this is the primary contact email or not.

DocPreHearingChecklist

Base model of a pre-hearing checklist. The ID provided should be the hearing ID the pre-hearing checklist is attached to.

Parameters

Key Type Description Values
id int Assure's ID for this pre-hearing checklist.
created_at date The date the pre-hearing checklist was created. YYYY-MM-DD HH:MM:SS.
hearing_id int The ID of the hearing this pre-hearing checklist belongs to.
did_contact bool The answer to the question "Were you able to contact the claimant for a pre-hearing conference?".
contact_checklist string A comma seperated list of values identifying responses to common questions asked during the pre-hearing conference if did_contact is Yes. Required when did_contact is Yes. Toggle Possible Values
is_treating_sources bool The response to the question "Were there additional treating sources?" if did_contact is Yes. Defaults to No.
is_issues bool The Yes or No answer to the question "After speaking with the Claimant, are there any issues that the Firm needs to know about before the hearing?". Required when did_contact is Yes.
issues_description string A description of issues if any were mentioned. Required when is_issues is Yes.

DocPreHearingInfo

Base model for pre-hearing info.

Parameters

Key Type Description Values
id int Assure's ID for this pre-hearing info.
hearing_id int Assure's hearing ID that this pre-hearing info is for.
hearing_type int The type of hearing taking place. Toggle Possible Values
case_type int The case/claim type. Toggle Possible Values
is_client_spelling_correct int A confirmation field required to verify the client name and SSN on file for the attached hearing match the Notice of Hearing you have.
hearing_details_match int A confirmation field confirming all details of the attached hearing match the Notice of Hearing you have. If the hearing details do not match you will need to update the hearing via the hearing endpoints first before creating pre-hearing info. You are responsible for properly confirming all hearing details are correct when using the API. Toggle Possible Values
client_phone_home string The home phone number of the client. 10 digit string, numbers only. Required if no client_phone_mobile is provided.
client_phone_mobile string The mobile phone number of the client. 10 digit string, numbers only. Required if no client_phone_home is provided.
client_email string The email of the client. Must be a valid email format if provided.
client_street string The street part of the clients address.
client_city string The city part of the clients address.
client_state string The two-letter state abbreviation of the clients address.
client_zip string The zip code part of the clients address. Five digits or nine digits with a hypen. "99999" or "99999-9999".
is_outstanding_records boolean If there are any outstanding medical records. If you are going to provide a value of "1" (for yes) you must make a call to the hearing outstanding-medical-record endpoint to create an entry for an OutstandingMedicalRecord on the hearing before saving the pre-hearing information.
special_client_circumstances string Any additional information for Attending Attorney e.g., does not speak English, currently hospitalized/incarcerated, etc..
case_rep_first_name string The first name of the case rep.
case_rep_last_name string The last name of the case rep.
case_rep_phone string The phone number of the case rep.
case_rep_ext string The phone number extension of the case rep. Max 10 characters.
case_rep_email string The email of the case rep. Must be a valid email format if provided. Use a semi-colon (;) to seperate multiple e-mail addresses. When reading this field be sure to check for semi-colons to determine if it contains more than one email.
created_at date The date the pre-hearing info was created. YYYY-MM-DD HH:MM:SS.
outstanding_medical_records association An array containing one or more OutstandingMedicalRecord models that are attached to the hearing.

EreCredentials

Base model of credentials use to access the ERE.

Parameters

Key Type Description Values
id int The user's client ID for API access.
attorney_name string The name of the attorney these credentials belong to.
ssn_failed_count int The current number of failed SSN lookup errors we've seen up to 24 hours after ssn_failed_first_date. When this value reaches 5 within 24 hours of ssn_failed_first_date then ssn_lookup_locked is set to 1, resulting in a soft lock of the credentials on our end, requiring the firm to unlock them. Resets to zero when a firm removes the soft lock.
ssn_failed_count_total int The total number of failed SSN lookup errors we've seen up to 24 hours after ssn_failed_first_date. Resets to 1 when the current date is more than 24 hours after ssn_failed_first_date and we see an SSN lookup error. If this value is 10 then we've seen every failed SSN lookup in the last 24 hours and know that the ERE has locked the users ERE credentials and they are required to contact the ERE to reset.
ssn_failed_first_date string The date we saw the first SSN lookup error in the last 24 hours. YYYY-MM-DD HH:MM:SS.
ssn_lookup_locked bool When we trigger 5 failed SSN lookups within 24 hours the credentials are soft locked by us, preventing further usage for SSN lookups. The user must review a warning that further SSN lookups may cause their credentials to be locked by the ERE and must trigger an unlock request to continue using the credentials.
ssn_lookup_locked_date string The last date these credentials were locked out of SSN lookups. YYYY-MM-DD HH:MM:SS.
outdated bool When we are unable to login with the ERE credentials they will be marked as outdated. The user must review and update the credentials with new information. This is triggered from errors like password change required, invalid passwords, failed logins, etc.
outdated_date string The date these credentials were last set as outdated. YYYY-MM-DD HH:MM:SS.
ere_phone_number association The ERE phone number that these credentials use on the ERE for 2FA.
forward_numbers association The contact numbers that these credentials forward 2FA codes to.
forward_emails association The contact emails that these credentials forward 2FA codes to.
users association An array of objects with basic user information (ID, First Name, Last Name) of the Attorneys and Case Managers that work for the firm that owns these credentials that are allowed to make updates and view text messages. When empty only the owner can update the credentials. Required when restricted_user_access is set to 1.
restricted_user_access bool Restrict access to editing and updating these credentials to specific Attorneys or Case Managers, when set to 1 at least one user ID must be provided in the "users" field. When set to 0 all users will be removed.
updated_at string The date a change was last made to any field on this model, including fields that may not be displayed. YYYY-MM-DD HH:MM:SS.
created_at string The date the ERE credentials were created. YYYY-MM-DD HH:MM:SS.

EreFile

Base model of an ERE file. ERE files hold information about a real file uploaded to the ERE through Assure. ERE files can be linked to existing files by the file_id field. If the file was uploaded by a user to specifically be sent to the ERE then this model will contain all the file information and can be downloaded by ID using the EreFile download endpoint.

Parameters

Key Type Description Values
id int Assure's ID for this ERE file.
case_id int The ID of the case this file is attached to.
document_type string The ERE document type ID. Toggle Possible Values
treatment_source string The treatment source of the document. Required when document_type is 0001 or 3157. 57 character limit, only accepts "a-Z", "0-9", "-", ".", ",", "(", ")", "/" and spaces.
from_date string The from date of the document. Required when document_type is 0001 or 3157. Accepts M/DD/YYYY no leading zeros. Returns YYYY-MM-DD HH:MM:SS.
to_date string The from date of the document. Required when document_type is 0001 or 3157. Accepts M/DD/YYYY no leading zeros. Returns YYYY-MM-DD HH:MM:SS.
document_date string The date of the document. Required when document_type is anything other than 0001 or 3157 when uploading to "Hearing" or "Appeals Council" level case. When uploading to a "Initial" or "Reconsideration" level case this field is not required for any document type. Accepts M/DD/YYYY no leading zeros. Returns YYYY-MM-DD HH:MM:SS.
notes string Notes about the document. 40 character limit when uploading to a to "Hearing" or "Appeals Council" level case. When uploading to a case at the "Initial" or "Reconsideration" case level this field acts as the ERE's "comments" field and accepts up to 16,000 characters. Only accepts "a-Z", "0-9", "-", ".", ",", "(", ")", "/" and spaces.
name string The unique generated file name.
name_original string The original name provided for the file.
status int The current status ID of the file upload to the ERE. Toggle Possible Values
status_message string The status message related to the upload of the file to the ERE. Please review the possible values for some examples of errors that may occur from the ERE and are out of our control. Toggle Possible Values
state string The state from the ERE for the uploaded file.
destination string The destination from the ERE for the uploaded file.
client_ssn string The client SSN from the ERE for the uploaded file.
rf string The RF from the ERE for the uploaded file.
dr string The DR from the ERE for the uploaded file.
tracking_number string The tracking number from the ERE for the uploaded file.
ere_submit_date string The date and time the file was uploaded to the ERE. YYYY-MM-DD HH:MM:SS.
file_id int The ID of the file this ERE file is connected to. This field is only present when an existing file on Assure was sent to the ERE without reuploading.
size int Size of the file in bytes.
created_at string Date the file was uploaded to Assure before being sent to the ERE. YYYY-MM-DD HH:MM:SS.

EreFileList

Base model of an ERE file list item.

Parameters

Key Type Description Values
id int Assure's ID for this ERE file.
case_id int The ID of the case this ERE file is be attached to.
exhibit_number string The exhibit number assigned to this file by the ERE. Empty for files that have not been exhibited.
file_title string The file title.
file_name string The name of the file.
pages int The number of pages in the file. This will often be zero if the ERE has not reviewed the file yet. It is often incorrect as well and should not be considered 100% accurate.
date_from string The from date when date_type is "Tmt. Dt.". Considered the decision date when date_type is "Dec. Dt.". Considered the document date when date_type is "Doc. Dt.".
date_to string The to date when date_type is "Tmt. Dt.". Currently empty otherwise.
date_type string The type of date for date_from when date_from is provided. Toggle Possible Values
date_title string The full title of the expected date_type for this type of file. May be present even when no date has been set for date_from and/or no date_type is set. Toggle Possible Values
source string The treatment source.
ef_receive_date string The date the ERE received the file. If ef_receive_type is present then ef_receive_date will be empty, when the ERE exhibits a file it is assigned an ef_receive_type and the ef_receive_date is no longer present. YYYY-MM-DD HH:MM:SS 24 hour format Eastern timezone when a date is present.
ef_receive_type int The receive type the ERE assigned to an exhibited file. Toggle Possible Values
file_size int The size of the file in bytes. Will only be greater than 0 if we have downloaded the file in some form.
section_name string The name of the section this file belongs in.
last_seen string The date we last saw this file on the ERE. YYYY-MM-DD HH:MM:SS 24 hour format.
exhibited_on string The date we saw this file was exhibited on. Requires that we had seen it unexhibited in a prior update check. Not to be considered 100% accurate, the ERE may exhibit a file long before we check the ERE. YYYY-MM-DD HH:MM:SS 24 hour format.
created_at string The date we first saw this file on the ERE. The file may have been added long before we checked the ERE and this date should not be mistaken as the actual date the file was added to the case on the ERE. YYYY-MM-DD HH:MM:SS 24 hour format.

ErePhoneNumber

Base model of a ERE phone number used by a set of ERE credentials.

Parameters

Key Type Description Values
id int Assure's ID for this ERE phone number.
ere_credentials_id int The ID of the ERE credentials this phone number is connected to.
number string The 10 digit number.
created_at string The date the entry was created. YYYY-MM-DD HH:MM:SS.

File

Base model of a file.

Parameters

Key Type Description Values
id int Assure's ID for this file.
file_type int The file type ID for this file. Toggle Possible Values
size int Size of the file in bytes.
created_at date Date the file was uploaded.
name string The generated name of the file.
name_original string The original name provided for the file.
desc string Additional information about this file.

FileType

Base model of a file type used by File models.

Parameters

Key Type Description Values
id int Assure's ID for this file type.
name string The name of this file type.
description string The description of this file type.

Firm

Base model of a firm user account.

Parameters

Key Type Description Values
id int Assure's ID for this firm.
user association The associated User model.
firm_name string The name of the firm.
legal_firm_name string The legal name of the firm.
address_street_1 string Street address of the firm's main office.
address_street_2 string Building number, suite, floor, etc. of the firm's main office address.
address_city string City of the firm's main office address.
address_state string The two-letter state abbreviation of the firm's main office address.
address_zip string ZIP code of the firm's main office address.
website string The URL to the firm's website.
ein string The firm's EIN. Nine digits only.
type_id int The type of this firm account. Determines default enabled permissions and features. Toggle Possible Values
created_at string The date the firm user account was created. YYYY-MM-DD HH:MM:SS.

Hearing

Base model of a hearing.

Parameters

Key Type Description Values
id int Assure's ID for this hearing.
client_first_name string First name of the claimant.
client_last_name string Last name of the claimant
client_ssn string SSN of the claimant. Nine digits only.
hearing_date string Date of the hearing. MM/DD/YYYY.
hearing_time string Time of the hearing local to hearing location and hearing date. H:MM AM/PM in 5 minute increments from 7:00 AM to 5:00 PM. 7:00 AM, 7:05 AM, 12:30 PM, 12:35 PM, etc.
owner_firm association The owning firm's information.
location_id int Hearing location id.
location association Hearing location information. Uses the location model.
suggested_attendee string The suggested attendee to attend this hearing.
judge_id int The ALJ's ID for the hearing.
judge association The judge's information.
require_ve boolean Whether or not a vocational expert is required for this hearing.
require_me boolean Whether or not a medical expert is required for this hearing.
require_vtc boolean Whether or not this hearing is over video teleconference.
hearing_outcome int The final outcome of the hearing. 1 = Unfavorable Hearing Outcome, 2 = Partially Favorable Hearing Outcome, 3 = Favorable Hearing Outcome
note string Add a new note to this hearing.
initials string Initials if a note is being added with this hearing.
cancelled_at string If the hearing was cancelled this field contains the date and time it was cancelled at. YYYY-MM-DD HH:MM:SS. You may request that the hearing be cancelled by sending this field when the hearing is not already cancelled.
hearing_files association Files uploaded to the hearing.
doc_pre_hearing_checklist association Pre-hearing checklist attached to the hearing.
doc_medical_records association Outstanding medical record information attached to the hearing. These are created when a hearing is scheduled but more medical records are expected according to the person who completed the Pre-hearing Information. These are not actual medical record requests that are collected by a medical record provider within Assure.
contact_attempts association Contact attempts attached to the hearing.
candidates association An array containing prefered attorneys. Each entry should include the keys "user_id" (same as attorney) and "score" ranging from 0-100 representing a preference order.
external_id string If you have an external indentifier you'd like to keep track of for this hearing you can use this field.
firm_source string The name and symbol of the firm source.
attending association The assigned attending attorney's user data.
case_rep association The assigned case representative's user data.
attendance_type int The ID of the attendance type for this hearing. Defaults to 0 for Not Set, highly recommended to include the correct attendance type when creating a new hearing. Toggle Possible Values
hearing_type int The ID of the hearing type for this hearing. Defaults to 0 when not provided, highly recommended to include the correct hearing type when creating a new hearing. Toggle Possible Values
updated_at string The date a change was last made to any field on this model, including fields that may not be displayed. YYYY-MM-DD HH:MM:SS 24 hour format.
created_at string The date this model was created. YYYY-MM-DD HH:MM:SS 24 hour format.

HearingCandidate

Base model of a hearing candidate relation.

Parameters

Key Type Description Values
user_id string The user/attorneys ID.
score int The score representing a preference order.

HearingNote

Base model of a hearing note.

Parameters

Key Type Description Values
id int Assure's ID for this hearing note.
hearing_id int Assure's ID for the hearing this note is attached to.
content string The content of the note.
initials string The initials provided by the user that created this note.
created_at string Date the note was added. YYYY-MM-DD HH:MM:SS.

Judge

Base model of a hearing judge.

Parameters

Key Type Description Values
id int Assure's ID for this judge.
first_name string First name of the judge.
last_name string Last name of the judge.
region string The region this judge is in.
office string The office this judge works from.

Location

Base model of a hearing location.

Parameters

Key Type Description Values
id int Assure's ID for the location.
address_street_1 string Street address of the hearing location.
address_street_2 string Building number, suite, floor, etc. of the hearing location.
address_city string City of the hearing location.
address_state string State of the hearing location.
address_zip string Zip code of the hearing location.
utc_offset int UTC offset of the city where the hearing takes place. This is the offset without daylight savings in affect. e.g. -6
special string Any special information about this location, such as SSA OFFICE, DDS Office, Veteran's Affairs, or other location information.
timezone_abbr string The timezone information used for this location.
latitude string The latitude of this location if available.
longitude string The longitude of this location if available.

MedicalProfile

Base model of a medical profile. A medical profile holds all required information about a claimant that is required to make medical profile requests. A medical profile may have many medical profile requests attached to it over time. When a new medical profile is created an initial medical profile request is automatically created and connected to the medical profile.

Parameters

Key Type Description Values
uid string Assure's UID for this medical profile.
case_id int Assure's ID for the case this medical profile is linked to.
first_name string Primary first name of the patient.
middle_name string Primary middle name or initial of the patient.
last_name string Primary last name of the patient.
ssn string SSN of the patient. 9 digits, no formatting.
phone_number_1 string The primary phone number of the patient. Cell phone prefered. 10 digits only, no formatting.
email string Primary email of the patient.
address_street string Street address of the patient.
address_city string City of the patient.
address_state string State of the patient.
address_zip string ZIP code of the patient.
sex_id int The ID of the sex of the patient. Toggle Possible Values
dob string Date of birth. Accepts MM/DD/YYYY (1/01/1950). Returns YYYY-MM-DD.
weight_lb int The weight of the patient in pounds.
height_feet int The feet measurement portion of the patients height.
height_inch int The inch measurement portion of the patients height.
last_status_id int The current status of the newest medical profile request attached to this medical profile. Toggle Possible Values
external_id string The external ID of the patient.
is_test bool Determine if this is a test request. A test request will not be sent for data collection when created. It will instead mimic the process of collecting a medical profile and move the request through all the statuses over 30 seconds until completed with a test file being attached. All webhooks and events will trigger.
consent_type_id int The ID of the type of consent this medical profile will use. When the firm is responsible for consent a new medical profile will be put into a waiting for consent status until consent is provided by the firm. For more information on providing consent for a medical profile please review the MedicalProfileConsents endpoints. Defaults to 0 for Assure Responsible. Toggle Possible Values
assigned_user_id int The ID of the user assigned to this medical profile.
medical_profile_requests association An array containing some information about any medical profile requests attached to this medical profile. Each attached medical profile request contains the following keys: id, external_id, status_id, last_status_at, completed_at, created_at.
files association An array containing some information about any files attached to this medical profile. Each attached file contains the following keys: id, file_type, name, size, desc, created_at.
cases association An array containing some information about any cases attached to this medical profile. Each attached case contains the following keys: id, first_name, last_name, case_status, case_status_date.
last_completed_at string Date of the newest attached medical profile request was considered complete. YYYY-MM-DD HH:MM:SS.
last_status_at string Date of the last status change. YYYY-MM-DD HH:MM:SS.
medical_profile_addresses association An array containing all MedicalProfileAddress models attached to this medical profile.
medical_profile_diagnoses association An array containing all MedicalProfileDiagnosis models attached to this medical profile.
medical_profile_emails association An array containing all MedicalProfileEmail models attached to this medical profile.
medical_profile_labs association An array containing all MedicalProfileLab models attached to this medical profile.
medical_profile_medications association An array containing all MedicalProfileMedication models attached to this medical profile.
medical_profile_procedures association An array containing all MedicalProfileProcedure models attached to this medical profile.
medical_profile_providers association An array containing all MedicalProfileProvider models attached to this medical profile.
medical_profile_provider_files association An array containing information about any medical profile provider files attached to this medical profile. Each attached file contains the following keys: id, file_type, provider_name, size, file_start_date, file_end_date, created_at.
medical_profile_names association An array containing all MedicalProfileName models attached to this medical profile. These are any additional non-primary names used by the client.
medical_profile_phone_numbers association An array containing all MedicalProfilePhoneNumber models attached to this medical profile. These are any additional non-primary phone numbers used by the client.
medical_profile_consents association An array containing all MedicalProfileConsent models attached to this medical profile. Medical profile consent data will become available after the profile has been created and the consent process has begun. You can be notified when a consent enrollment URL has become available by subscribing to the updated.medical-profile webhook and listening for the status_id field to change to 6 (Awaiting Client Consent). At this point this array will contain a MedicalProfileConsent model that has an enrollment URL available.
updated_at string The date a change was last made to any field on this model, including fields that may not be displayed. YYYY-MM-DD HH:MM:SS.
created_at string Date the medical profile was created. YYYY-MM-DD HH:MM:SS.

MedicalProfileAddress

Base model of a medical profile address. These are any additional addresses available for a medical profile.

Parameters

Key Type Description Values
address_street string Street information for this address.
address_street_2 string Building number, suite, floor, etc. of the address.
address_city string City of the address.
address_state string The two-letter state abbreviation of the address.
address_zip string ZIP code of the address.
address_country string Country of the address.
started_at string Date this address was active at. YYYY-MM-DD HH:MM:SS.
ended_at string Date this address was no longer active at. YYYY-MM-DD HH:MM:SS.
updated_at string The date a change was last made to any field on this model, including fields that may not be displayed. YYYY-MM-DD HH:MM:SS.
created_at string Date the model was created. YYYY-MM-DD HH:MM:SS.

MedicalProfileConsent

Base model of an consent for a medical profile.

Parameters

Key Type Description Values
id int Assure's ID for this consent record.
enrollment_url string The URL of the digital consent document for the patient to sign. Only available when Assure is handling consent.
file_id string ID of the attached signed consent file. Only present when a consent file was provided.
chronic_medical bool The response to the assessment question "Do you have any chronic medical conditions?". Only present when the firm is handling consent.
chronic_medication bool The response to the assessment question "Are you taking any medications or supplements for chronic conditions?". Only present when the firm is handling consent.
pain_discomfort bool The response to the assessment question "Are you experiencing any pain or discomfort?". Only present when the firm is handling consent.
daily_living bool The response to the assessment question "Have your medical conditions affected your activities of daily living?". Only present when the firm is handling consent.
valid_until_date string Date the provided consent file is valid until. Only present when the firm is handling consent. Accepts MM/DD/YYYY (1/01/2024). Returns YYYY-MM-DD 00:00:00.
consent_date string Date the provided consent file was signed. Only present when the firm is handling consent. Accepts MM/DD/YYYY (1/01/2024). Returns YYYY-MM-DD 00:00:00.
updated_at string The date a change was last made to any field on this model, including fields that may not be displayed. Returns YYYY-MM-DD HH:MM:SS.
created_at string Date the model was created. Returns YYYY-MM-DD HH:MM:SS.

MedicalProfileDiagnosis

Base model of a medical profile diagnosis.

Parameters

Key Type Description Values
description string Description of the diagnosis.
type string Type of the diagnosis.
doctor string The Doctor who gave the diagnosis.
status string Status of the diagnosis.
snomed string The SNOMED CT of the diagnosis.
icd10cm string The ICD-10-CM of the diagnosis.
started_at string Start date of the diagnosis. YYYY-MM-DD HH:MM:SS.
ended_at string End date of the diagnosis. YYYY-MM-DD HH:MM:SS.
updated_at string The date a change was last made to any field on this model, including fields that may not be displayed. YYYY-MM-DD HH:MM:SS.
created_at string Date the model was created. YYYY-MM-DD HH:MM:SS.

MedicalProfileEmail

Base model of a medical profile email.

Parameters

Key Type Description Values
email string Email address.
updated_at string Date the model was last updated. YYYY-MM-DD HH:MM:SS.
created_at string Date the model was created. YYYY-MM-DD HH:MM:SS.

MedicalProfileLab

Base model of a medical profile lab.

Parameters

Key Type Description Values
org string The organization of the lab.
name string Name of the lab.
medical_profile_lab_items association An array containing all items of this lab.
reported_at string Reported date of the lab. YYYY-MM-DD HH:MM:SS.
collected_at string Collected date of the lab. YYYY-MM-DD HH:MM:SS.
updated_at string The date a change was last made to any field on this model, including fields that may not be displayed. YYYY-MM-DD HH:MM:SS.
created_at string Date the model was created. YYYY-MM-DD HH:MM:SS.

MedicalProfileLabItem

Base model of a medical profile lab item.

Parameters

Key Type Description Values
test_name string The test name for this lab item.
note string Note for this lab item.
in_range string The in range for this lab item.
out_range string The out range for this lab item.
out_range_status_id int Additional information about the out range as an ID mapped to a value. N/A, High, Low, etc. Toggle Possible Values
reference_range string The reference range for this lab item.
reference_range_low string The low end of the reference range. This value is programmatically processed from reference_range to aid in processing and should only be used for informational purposes. Please use reference_range as the absolute truth.
reference_range_high string The high end of the reference range. This value is programmatically processed from reference_range to aid in processing and should only be used for informational purposes. Please use reference_range as the absolute truth.
reference_range_measurement string The measurement used in the reference range. This value is programmatically processed from reference_range to aid in processing and should only be used for informational purposes. Please use reference_range as the absolute truth.
updated_at string The date a change was last made to any field on this model, including fields that may not be displayed. YYYY-MM-DD HH:MM:SS.
created_at string Date the model was created. YYYY-MM-DD HH:MM:SS.

MedicalProfileMedication

Base model of a medical profile medication.

Parameters

Key Type Description Values
doctor string The doctor for this medication.
status string Status for this medication.
quantity string The in range for this medication.
indication string The indication/reason for this medication.
medication string The medication information.
instruction string The instructions for this medication.
started_at string Start date of the medication. YYYY-MM-DD HH:MM:SS.
stopped_at string Stop date of the medication. YYYY-MM-DD HH:MM:SS.
updated_at string The date a change was last made to any field on this model, including fields that may not be displayed. YYYY-MM-DD HH:MM:SS.
created_at string Date the model was created. YYYY-MM-DD HH:MM:SS.

MedicalProfileName

Base model of an additional name of the client.

Parameters

Key Type Description Values
first_name string An additional first name of the client.
middle_name string An additional middle name of the client.
last_name string An additional last name of the client.
updated_at string The date a change was last made to any field on this model, including fields that may not be displayed. YYYY-MM-DD HH:MM:SS.
created_at string Date the model was created. YYYY-MM-DD HH:MM:SS.

MedicalProfilePhoneNumber

Base model of an additional phone number for the client.

Parameters

Key Type Description Values
phone_number string An additional phone number for the client.
updated_at string The date a change was last made to any field on this model, including fields that may not be displayed. YYYY-MM-DD HH:MM:SS.
created_at string Date the model was created. YYYY-MM-DD HH:MM:SS.

MedicalProfileProcedure

Base model of a medical profile procedure.

Parameters

Key Type Description Values
doctor string The doctor for this procedure.
status string Status for this procedure.
procedure string Information for this procedure.
note string Notes for this procedure.
indication string The indication/reason for this procedure.
procedure_at string Date of the procedure. YYYY-MM-DD HH:MM:SS.
updated_at string The date a change was last made to any field on this model, including fields that may not be displayed. YYYY-MM-DD HH:MM:SS.
created_at string Date the model was created. YYYY-MM-DD HH:MM:SS.

MedicalProfileProvider

Base model of a medical profile provider.

Parameters

Key Type Description Values
name string The doctor for this provider.
provider_type_id int Type for this provider. Toggle Possible Values
phone_number_1 string The first phone number for this provider.
phone_number_2 string The second phone number for this provider.
fax_number_1 string The first fax number for this provider.
fax_number_2 string The second fax number for this provider.
address_street string Street information for this provider.
address_street_2 string Building number, suite, floor, etc. of the provider.
address_city string City of the provider.
address_state string The two-letter state abbreviation of the provider.
address_zip string ZIP code of the provider.
updated_at string The date a change was last made to any field on this model, including fields that may not be displayed. YYYY-MM-DD HH:MM:SS.
created_at string Date the model was created. YYYY-MM-DD HH:MM:SS.

MedicalProfileProviderFile

Base model of a medical profile provider file. A provider file is a PDF of all the files from the same provider grouped together and bookmarked.

Parameters

Key Type Description Values
id int Assure's ID for this file.
file_type int The file type id for this file.
provider_name string Name of the provider these files belong to.
page_count int Number of pages of the PDF.
size int Size of the file in bytes.
file_start_date string Date of the earliest record available from this provider.
file_end_date string Date of the newest record available from this provider.
created_at string Date the file was created.

MedicalProfileRequest

Base model of a medical profile request. Medical profile requests hold information about a request to collect all available medical information for the attached medical profile. A medical profile request is always attached to a medical profile.

Parameters

Key Type Description Values
uid string Assure's UID for this medical profile request.
medical_profile_uid string Assure's UID for the medical profile this medical profile request is linked to.
status_id int The current status of the medical profile request. Toggle Possible Values
external_id int The external ID of the medical profile request.
file_id int The file ID of the attached medical profile PDF. Available when a request is completed and can be downloaded using the file download endpoint.
completed_at string Date of the medical profile request was considered complete. YYYY-MM-DD HH:MM:SS.
last_status_at string Date of the last status change. YYYY-MM-DD HH:MM:SS.
updated_at string The date a change was last made to any field on this model, including fields that may not be displayed. YYYY-MM-DD HH:MM:SS.
created_at string Date the medical profile request was created. YYYY-MM-DD HH:MM:SS.

MedicalRecord

Base model of a medical record request.

Parameters

Different retrieval services make use of different fields when making requests. The retrieval_service field on the main MedicalRecord request indicates which retrieval service the request was sent to. The retrieval service column in the below table indicates which retrieval services makes use of the field. Fields a retrieval service does not use will not be included with the model. An ALL retrieval service indicates that all retrieval services share the field.

Key Type Retrieval Service Description Values
id int ALL Assure's ID for this Medical Record request.
case_id int ALL The ID of the case this request will be attached to.
retrieval_service string ALL The retrieval service for this medical record request. Toggle Possible Values
web_order_id int RP The Web Order ID of this request. Created by requests succesfully sent to ReleasePoint.
rp_id int RP The RP ID of this request. Created by requests succesfully sent to ReleasePoint.
work_order_id int ARC The work order ID of this request. Created by requests succesfully sent to ARC.
carrier_code string RP The carrier code from ReleasePoint to use for the request.
source_code string RP The source code from ReleasePoint to use for the request.
hearing_date string ALL The date of the hearing if one is scheduled. M/DD/YYYY (1/01/2021) format, no leading zero on the month.
med_rec_number string ALL The Policy/Claim/PID #.
special_attention string RP Any additional attention information or special instructions. 1000 character limit.
get_all_records bool RP Get all available records from the provider.
get_records_to_present bool RP Get all available records from date_from to present day.
date_from string ALL Get records starting from this date. Accepts M/DD/YYYY (1/01/2021) format, no leading zero on the month.
When making a request using RP the following rules apply:
  • Required if get_all_records is 0
  • If get_all_records is set then this field is ignored.
When making a request using ARC the following rules apply:
  • If record_type_id is 4, 5, or 9 this field is required.
date_to string ALL Get records ending at this date. Accepts M/DD/YYYY (1/01/2021) format, no leading zero on the month.
When making a request using RP the following rules apply:
  • If date_from is provided and date_to is not then get_records_to_present will be assumed.
  • If get_all_records is set then this field is ignored.
When making a request using ARC the following rules apply:
  • If record_type_id is 4, 5, or 9 this field is required.
rush_order bool RP Whether this is a rush order or not.
record_type_id int ARC The type of records to retrieve. Toggle Possible Values
service_type_id int ARC The type of service for this request. Toggle Possible Values
please_specify string ARC Specify any additional request information, such as only needing records pertaining to specific body part, or all films. Required when record_type_id is 5. 2000 character limit.
please_specify_other string ARC Specify any other request information. Required when record_type_id is 7. 2000 character limit.
status int ALL The status ID. Toggle Possible Values
status_name string ALL The status name related to the current status.
medical_record_patient association ALL The attached MedicalRecordPatient information. When creating a new MedicalRecord you may send just the "id" field if you are making an additional request for an existing patient, otherwise "first_name", "last_name", "date_of_birth" and "client_ssn" fields are required.
medical_record_provider association ALL The attached MedicalRecordProvider information. When creating a new MedicalRecord the "name", "address", "city", "state", and "zip" fields are required.
medical_record_files array ALL An array containing all attached MedicalRecordFiles. These are files the medical record retrieval service requires in order to collect medical records, such as special authorizations.
files array ALL An array containing all attached Files. These are files the medical record retrieval service has attached to the medical record request. Most often the medical records with a file_type_id of 41, but may also be other file types such as 56 or 57 if this is an ARC request.
completed_at string ALL The date the request was completed. YYYY-MM-DD HH:MM:SS.
last_status_change string ALL The date we last saw the status of the request change. YYYY-MM-DD HH:MM:SS.
created_by association ALL Assure's user association of the user that created this request. An array containing id, first_name and last_name keys.
created_at string ALL The date the request was created. YYYY-MM-DD HH:MM:SS.
updated_at string ALL The date a change was last made to any field on this model, including fields that may not be displayed. YYYY-MM-DD HH:MM:SS 24 hour format.

MedicalRecordFile

Base model of a file uploaded for a medical record request. These are files the medical record retrieval service requires in order to collect medical records. We recommend you use the multipart/form-data method of uploading to avoid the slower speeds and overhead required for base64 uploads.

Parameters

Different retrieval services make use of different fields when making requests. The retrieval_service field on the main MedicalRecord request indicates which retrieval service the request was sent to. The retrieval service column in the below table indicates which retrieval services makes use of the field. Fields a retrieval service does not use will not be included with the model. An ALL retrieval service indicates that all retrieval services share the field.

Key Type Retrieval Service Description Values
id int ALL Assure's ID for this medical record file.
medical_record_id int ALL The ID of the attached medical record.
doc_type int RP The ReleasePoint doc type ID for this medical record file. Toggle Possible Values
auth_type int RP The ReleasePoint auth type ID for this medical record file. Required when doc_type is equal to 0. Toggle Possible Values
name string ALL The unique generated file name.
name_original string ALL The original name provided for the file.
size int ALL Size of the medical record file in bytes.
created_at string ALL Date the medical record file was uploaded.

MedicalRecordPatient

Base model of a medical record patient. Used by medical record requests to send patient data with requests.

Parameters

Different retrieval services make use of different fields when making requests. The retrieval_service field on the main MedicalRecord request indicates which retrieval service the request was sent to. The retrieval service column in the below table indicates which retrieval services makes use of the field. Fields a retrieval service does not use will not be included with the model. An ALL retrieval service indicates that all retrieval services share the field.

Key Type Retrieval Service Description Values
id int ALL Assure's ID for this Medical Record Patient.
case_id int ALL The ID of the case the patient is attached to.
first_name string ALL The first name of the patient.
middle_initial string ALL The middle initial of the patient.
last_name string ALL The last name of the patient.
date_of_birth string ALL The date of birth of the patient. M/DD/YYYY (1/01/2021) format, no leading zero on the month.
client_ssn string ALL The Social Security Number of the patient. Nine digits only.
created_at string ALL The date the patient was created. YYYY-MM-DD HH:MM:SS.

MedicalRecordProvider

Base model of a medical record provider. Used by medical record requests to send provider data with requests.

Parameters

Different retrieval services make use of different fields when making requests. The retrieval_service field on the main MedicalRecord request indicates which retrieval service the request was sent to. The retrieval service column in the below table indicates which retrieval services makes use of the field. Fields a retrieval service does not use will not be included with the model. An ALL retrieval service indicates that all retrieval services share the field.

Key Type Retrieval Service Description Values
account string ALL The account ID of the provider when matched to a provider the retrieval service has a record of. If you were not able to match a provider then send an empty string.
name string ALL The name of the provider. Required when account is not provided.
address string ALL The street address of the provider. Provide if available when account is not provided.
address2 string ALL The street address 2 data of the provider.
city string ALL The city address data of the provider. Provide if available when account is not provided.
state string ALL The state address data of the provider. Provide if available when account is not provided.
zip string ALL The ZIP code address data of the provider. Accepts "XXXXX" or "XXXXX-XXX" formatted ZIP codes. Provide if available when account is not provided.
phone string ALL The phone number of the provider. Accepts "(XXX) XXX-XXXX" formatted phone numbers. Provide if available when account is not provided.
phone_ext string ARC The phone number extension of the provider.
fax string ALL The fax number of the provider. Accepts "(XXX) XXX-XXXX" formatted fax numbers. Provide if available when account is not provided.
auth_available bool RP If the provider has a provider specific autho on file that is required and available for download. 1 for yes and 0 for no. Only used during provider search, not used when creating a medical record.

MedicalRecordStatusNote

Base model of a status note for a medical record request.

Parameters

Different retrieval services make use of different fields when making requests. The retrieval_service field on the main MedicalRecord request indicates which retrieval service the request was sent to. The retrieval service column in the below table indicates which retrieval services makes use of the field. Fields a retrieval service does not use will not be included with the model. An ALL retrieval service indicates that all retrieval services share the field.

Key Type Retrieval Service Description Values
note string ALL The note content from ReleasePoint.
created_at string ALL Date the status note was created as YYYY-MM-DD HH:MM:SS, central timezone.

MedicareLead

Base model of a medicare referral.

Parameters

Key Type Description Values
id int Assure's ID for this Medicare Referral.
status int The status ID of the Medicare Referral. User's may only set a leads status to 2 or 3. Toggle Possible Values
first_name string The first name of the claimant.
middle_name string The middle name of the claimant.
last_name string The last name of the claimant.
date_of_birth string The date of birth of the claimant. M/DD/YYYY (1/01/2021) format, no leading zero on the month. Returns then same format.
ssn string The Social Security Number of the claimant. Nine digits only.
eod string The EOD (Onset Date) of the claimant. M/DD/YYYY (1/01/2021) format, no leading zero on the month. Returns then same format.
nod string The NOD (Award Date) of the claimant. M/DD/YYYY (1/01/2021) format, no leading zero on the month. Returns then same format.
eligibility_date string The eligibility date (Eligibility Month/Year) of the claimant. M/YYYY (1/2021) format, no leading zero on the month. Returns then same format.
address_street string Street address of the claimant.
address_street_2 string Building number, suite, floor, etc. of the claimant's address.
address_city string City of the claimant's address.
address_state string The two-letter state abbreviation of the claimant's address.
address_zip string ZIP code of the claimant's address.
phone_number string The primary phone number of the claimant.
phone_number_secondary string The secondary phone number of the claimant.
phone_number_3 string An additional phone number that can be used to contact the claimant.
phone_number_4 string An additional phone number that can be used to contact the claimant.
email string The email that can be used to contact the claimant.
firm_obtained_consent_id int Identities if consent to disclosures was obtained. Toggle Possible Values
firm_obtained_consent_at string The date of when obtained_consent_id was first set. Automatically set when firm_obtained_consent_id is provided. YYYY-MM-DD HH:MM:SS.
notes association An array of attached Note models. Toggle Possible Values
created_at string The date the medicare referral was created. YYYY-MM-DD HH:MM:SS.

Note

Base model of a note.

Parameters

Key Type Description Values
id int Assure's ID for this note.
note_text string The content of the note.
initials string The initials of the user that created the note.
created_at string The date the note was created. YYYY-MM-DD HH:MM:SS.

OAuthClient

Base model of a user's oAuth API information.

Parameters

Key Type Description Values
client_id string The user's client ID for API access.
client_secret string The user's client secret for API access.

OpenHearing

Base model of an open hearing. An open hearing is a limited version of a hearing that is used in open hearing bundles by firms to allow other users to request coverage of their hearings.

Parameters

Key Type Description Values
hearing_date string The date of the open hearing. M/DD/YYYY format, 1/01/2020.
hearing_time string Time of the open hearing local to location and hearing date. H:MM AM/PM in 5 minute increments from 7:00 AM to 5:00 PM. 7:00 AM, 7:05 AM, 12:30 PM, 12:35 PM, etc.
hearing_city string The name of the city the open hearing is in.
hearing_state string The two-letter state abbreviation of the state the open hearing is in.
judge_id int The ALJ's ID for the open hearing.
attendance_type int The ID of the attendance type for this open hearing. Toggle Possible Values
owner_firm_name int The name of the firm that owns this open hearing.

OpenHearingBundle

Base model of a bundle of open hearings. An open hearing bundle is a group of open hearings that occur on the same date in the same location.

Parameters

Key Type Description Values
bundle_ids array An array of IDs of every open hearing currently in this bundle.
bundle_hearing_date string The date of the open hearing(s) in this bundle. M/DD/YYYY format, 1/01/2020.
bundle_hearing_location string The name of the location of the open hearing(s) in this bundle.
bundle_requested bool A bool indicating whether you have made a request for this bundle or not.
bundle_hearings association A collection of attached OpenHearing models that belong to this bundle.

OutstandingMedicalRecord

Base model of a outstanding medical record on a hearing.

Parameters

Key Type Description Values
id int Assure's ID for this note.
hearing_id int The ID of the attached hearing.
record_provider string The name of the medical record provider.
anticipated_records string The anticipated records.
date_records_requested string The date the records were requested. Accepts M/DD/YYYY, no leading zero on the month. Returns YYYY-MM-DD HH:MM:SS.
followup_action_performed string Notes about any followup actions performed.
created_at string The date the outstanding medical record entry was created. YYYY-MM-DD HH:MM:SS.

ReadyToScheduleData

Base model of a ready to schedule hearing data.

Parameters

Key Type Description Values
id int Assure's id for this RTS data.
first_name string Client's first name.
last_name string Client's last name.
middle_name string Client's middle name.
hearing_request_date string The prefered hearing date if available. YYYY-MM-DD format.
hearing_time string The prefered localized hearing time if available. 11:30 AM, 2:15 PM, etc. Hearing times are only accepted in 15 min intervals from 7:00 AM to 5:00 PM
claim_type string The type. "TITLE 2 - DISABILITY", "TITLE 16 - DISABILITY" or "TITLE 2 AND TITLE 16 - DISABILITY" are allowed.
medical_expert string Whether or not a medical expert is needed. True/false or name accepted.
vocational_expert string Whether or not a medical expert is needed. True/false or name accepted
location_id int Hearing location id.
judge_id int The ALJ's (judge) ID.
external_id string If you have an external indentifier you'd like to keep track of for this hearing you can use this field.
external_firm_id string If you have an external indentifier for the firm this hearing will belong to you can use this field.
candidates association An array containing prefered attorneys. Each entry should include the keys "user_id" (same as attorney) and "score" ranging from 0-100 representing a preference order.

Revision

Base model of a Revision item.

Parameters

Key Type Description Values
id int Assure's ID for this revision.
key string The key used to identify the field.
key_name string The name of the key.
old_value mixed The value this field was before this change.
new_value mixed The value this field was changed to. May be a string, int or float depending on which field key is referencing.

StatusReport

Base model of a ERE status report import.

Parameters

Key Type Description Values
id int Assure's ID for this ERE phone number.
ere_credentials_id int The ID of the ERE credentials this report is connected to.
total_rows int The total number of rows on the report.
total int The total number of unique cases found on the report. Updates as import progresses until complete.
failed int The number of rows that failed to import.
skipped int The number of rows that were skipped and not imported.
in_crq int The number or cases created or changed that went to the change request queue.
moved int The number or cases moved from this status report to another.
status int The status ID. Toggle Possible Values
ac_report bool If this is a Appeals Council status report import or not.
ic_report bool If this is a Initial and Reconsideration status report import or not.
started_by int The ID of the user that started this status report import. 0 when started by automation.
started_at string The date the status report import started importing. YYYY-MM-DD HH:MM:SS.
completed_at string The date the status report import completed. YYYY-MM-DD HH:MM:SS.
updated_at string The date a change was last made to any field on this model, including fields that may not be displayed. YYYY-MM-DD HH:MM:SS.
created_at string The date the status report import was created and put into the queue. YYYY-MM-DD HH:MM:SS.

User

Base model of a user account.

Parameters

Key Type Description Values
id int Assure's ID for this user.
email string The email address used to login.
first_name string The first name of the user.
last_name string The last name of the user.
created_at string The date the user account was created. YYYY-MM-DD HH:MM:SS.