Operations

GET /legaldeliverableoptions

Summary Get list of available legal deliverable options
URL /api/v1/legaldeliverableoptions
Detailed Description

Use this method to determine what options are available to you for each possible legal deliverable type.

Each deliverable type will return with a list of availabilities that can be used to place a legal transcription order with the appropriate deliverable_options section so that you may receive your transcription back exactly when you want it.

Request Headers
  • Authorization - contains client/user API keys
Request Parameters

Calling the /legaldeliverableoptions endpoint requires that you specify the length of the primary file in seconds you are intending to order with as a query parameter.

  • lengthSeconds (required)
    The length of the primary file to be placed, specified in seconds. If your primary file is comprised of files meant to be stitched together sequentially (excluding multichannel), please use the total length in seconds of all the total files to be placed on the order.

Response On success, 200 OK.
On error, 400 Bad Request.
If the user is not a legal transcription customer, 403 Forbidden.
Response Body

On success, a <deliverable_options/> entity with a list of available legal deliverable options. On error, will contain an <error/> entity with more details.

The list of deliverable options will contain the following for each deliverable option:


  • deliverable_type

    Denotes the type of legal deliverable that can be placed with their respective delivery options. The current list of legal deliverable types are as followed:

    • legal_ready_to_certify
    • legal_human_rough_draft
    • legal_ai_rough_draft

  • available

    Denotes whether the associated legal deliverable type is available at the current time. This can be either true or false.


  • delivery_options

    Denotes a list of available options for delivery based on business days from the current time of the request. Note that each legal deliverable type may have different delivery options based on legal account settings. This list may be null if the deliverable type does not require particular business day information or the deliverable option is unavailable.

    Each delivery option will contain the following information:

    • business_days

      Denotes an option for the number of business days the following completed deliverable will be returned back to you by.

    • delivery_date

      Denotes an option for the expected date and time (in UTC) the following completed deliverable will be returned back to you by. This should match with the number of business days specified in the same delivery option.

    • valid_until

      Denotes an expiration date and time (in UTC) for the option where an order can be placed and fulfilled within the given business day time frame.

    Note: while all date times are specified as UTC, business days operate in Eastern time.

  • availability_details

    Denotes a list of details to explain why some delivery options are available or unavailable at the time of the request. The list may be null if the deliverable type is fully available for you and no additional messaging is required.

    Each availability detail will contain the following information:

    • availability_code

      Denotes a special code for why the deliverable type in question is available or unavailable.

    • message

      Denotes a reason for why the deliverable type in question is available or unavailable.

    The following are a complete list of availability codes and corresponding messages:

    Code Message
    1 Legal AI Rough Drafts are always available and will be delivered as soon as possible.
    2 Same-day delivery for this deliverable type cannot be fulfilled at this time.
    3 This deliverable type is not available for this user.
    4 This deliverable type is not available at this time.
Annotated sample response 
{
    /*
        A list of available legal deliverable options.
    */
    "deliverable_options": [
        {
            /*
                The type of legal deliverable that can be ordered.
            */
            "deliverable_type": "legal_ready_to_certify",
            /*
                Whether this legal deliverable type is currently available for ordering.
            */
            "available": true,
            /*
                A list of available options for delivery based on business days from the current time of the request.  
            */
            "delivery_options": [
                {
                    /*
                        An option for the number of business days the following completed deliverable will be returned back to you by.
                    */
                    "business_days": 0,
                    /*
                        An option for the expected date and time (in UTC) the following completed deliverable will be returned back to you by.
                        This should match with the number of business days specified in the same delivery option.
                    */
                    "delivery_date": "2024-07-19T03:59:59Z",
                    /*
                        An expiration date and time (in UTC) for the option where an order can be placed and fulfilled within the 
                        given business day time frame.
                    */
                    "valid_until": "2024-07-18T21:59:59Z"
                },
                {
                    "business_days": 1,
                    "delivery_date": "2024-07-20T03:59:59Z",
                    "valid_until": "2024-07-19T03:59:59Z"
                },
                {
                    "business_days": 2,
                    "delivery_date": "2024-07-23T03:59:59Z",
                    "valid_until": "2024-07-19T03:59:59Z"
                },
                {
                    "business_days": 3,
                    "delivery_date": "2024-07-24T03:59:59Z",
                    "valid_until": "2024-07-19T03:59:59Z"
                },
                {
                    "business_days": 4,
                    "delivery_date": "2024-07-25T03:59:59Z",
                    "valid_until": "2024-07-19T03:59:59Z"
                },
                {
                    "business_days": 5,
                    "delivery_date": "2024-07-26T03:59:59Z",
                    "valid_until": "2024-07-19T03:59:59Z"
                }
            ]
        },
        {
            "deliverable_type": "legal_human_rough_draft",
            "available": false,
            /*
                A list of details to explain why some delivery options are available or unavailable at the time of the request.
            */
            "availability_details": [
                {
                    /*
                        A special code for why the deliverable type in question is available or unavailable.
                    */
                    "availability_code": 3,
                    /*
                        A reason for why the deliverable type in question is available or unavailable.
                    */
                    "message": "This deliverable type is not available for this user."
                }
            ]
        },
        {
            "deliverable_type": "legal_ai_rough_draft",
            "available": true,
            "availability_details": [
                {
                    "availability_code": 1,
                    "message": "Legal AI Rough Drafts are always available and will be delivered as soon as possible."
                }
            ]
        }
    ]
}
                    
<legal_deliverable_options>
    <!--
        A list of available legal deliverable options.
    -->
    <deliverable_options>
        <!--
            The type of legal deliverable that can be ordered.
        -->
        <deliverable_type>legal_ready_to_certify</deliverable_type>
        <!--
            Whether this legal deliverable type is currently available for ordering.
        -->
        <available>true</available>
        <!--
            A list of available options for delivery based on business days from the current time of the request.
        -->
        <delivery_options>
            <!--
                An option for the number of business days the following completed deliverable will be returned back to you by.
            -->
            <business_days>0</business_days>
            <!--
                An option for the date and time (in UTC) the following completed deliverable will be returned back to you by.
                This should match with the number of business days specified in the same delivery option.
            -->
            <delivery_date>2024-07-19T03:59:59Z</delivery_date>
            <!--
                An expiration date and time (in UTC) for the option where an order can be placed and fulfilled within the 
                given business day time frame.
            -->
            <valid_until>2024-07-18T21:59:59Z</valid_until>
        </delivery_options>
        <delivery_options>
            <business_days>1</business_days>
            <delivery_date>2024-07-20T03:59:59Z</delivery_date>
            <valid_until>2024-07-19T03:59:59Z</valid_until>
        </delivery_options>
        <delivery_options>
            <business_days>2</business_days>
            <delivery_date>2024-07-23T03:59:59Z</delivery_date>
            <valid_until>2024-07-19T03:59:59Z</valid_until>
        </delivery_options>
        <delivery_options>
            <business_days>3</business_days>
            <delivery_date>2024-07-24T03:59:59Z</delivery_date>
            <valid_until>2024-07-19T03:59:59Z</valid_until>
        </delivery_options>
        <delivery_options>
            <business_days>4</business_days>
            <delivery_date>2024-07-25T03:59:59Z</delivery_date>
            <valid_until>2024-07-19T03:59:59Z</valid_until>
        </delivery_options>
        <delivery_options>
            <business_days>5</business_days>
            <delivery_date>2024-07-26T03:59:59Z</delivery_date>
            <valid_until>2024-07-19T03:59:59Z</valid_until>
        </delivery_options>
    </deliverable_options>
    <deliverable_options>
        <deliverable_type>legal_human_rough_draft</deliverable_type>
        <available>false</available>
        <!--
            A list of details to explain why some delivery options are available or unavailable at the time of the request.
        -->
        <availability_details>
            <!--
                A special code for why the deliverable type in question is available or unavailable.
            -->
            <availability_code>3</availability_code>
            <!--
                A reason for why the deliverable type in question is available or unavailable.
            -->
            <message>This deliverable type is not available for this user.</message>
        </availability_details>
    </deliverable_options>
    <deliverable_options>
        <deliverable_type>legal_ai_rough_draft</deliverable_type>
        <available>true</available>
        <availability_details>
            <availability_code>1</availability_code>
            <message>Legal AI Rough Drafts are always available and will be delivered as soon as possible.</message>
        </availability_details>
    </deliverable_options>
</legal_deliverable_options>