Skip to main content

Download document of agreement

GET 
/v2/agreements/:id/documents/download

Download document of agreement

Request​

Path Parameters

    id stringrequired

Query Parameters

    version string

    Default value: latest

    The version of the document to download. Acceptable values are 'earliest' and 'latest'. Default is 'latest'.

    combine boolean

    Flag indicating whether to combine multiple parts of the document into a single file. Default is 'false'.

    type string

    Default value: agreement

    Type of document to download. Acceptable values are 'all', 'certificate', 'agreement', and 'history'. Default is 'agreement'.

Responses​

OK

Schema

    download_url string

    URL where the document can be downloaded.

    thumbnail_url string

    URL of the document's thumbnail image.

    file_name string

    Name of the file including the extension.

    size int32

    Size of the document in bytes.

    has_schema boolean

    Flag indicating whether the document is generate document

Loading...