Skip to main content

Process a Contract

POST 
/api/v8/partner/contracts

Veryfi's Process a Contract endpoint allows you to submit and extract data from unstructured documents such as Contracts and turn them into valuable business insights. The Process a Contract endpoint enables you to submit the following image formats: .zip,.pdf and retrieve extracted data in JSON format. The max file size is 20mb, min file size is 0.25kb. Rate limit is 20 requests per second.

Request​

Body

    max_pages_to_process (integer | null)

    Possible values: >= 1 and <= 50

    Default value: 50

    Limit processing to number of pages. A page is a pdf page or an image

    auto_delete (boolean | null)

    Default value: false

    Delete this contract from Veryfi after data has been extracted

    file_data (string | null)

    Possible values: non-empty

    The least effective way to submit files. Base64 encoded string, could be raw or datauri https://en.wikipedia.org/wiki/Data_URI_scheme E.g. 'data:application/zip;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII='

    file_url (string | null)

    Possible values: non-empty

    package_path (string | null)

    Possible values: non-empty

    A path to file in S3 bucket, e.g. 'some/contract.pdf

    bucket (string | null)

    Possible values: non-empty

    An S3 bucket for 'package_path', e.g. 'contracts'

    file_name (string | null)

    Possible values: non-empty

    Optional filename, helps to determine file type

Responses​

Returns a processed Contract.

Schema
    anyOf
    meta object
    external_id (string | null)

    Possible values: non-empty

    A custom identification value. Use this if you would like to assign your own ID to documents. This parameter is useful when mapping this document to a service or resource outside Veryfi.

    pages object[]
  • Array [
    • ocr_score (number | null)

    Possible values: <= 1

    The average OCR score of the page.

    width (integer | null)

    The width of the page.

    height (integer | null)

    The height of the page.

  • ]
    • tags string[]

    Possible values: non-empty

    Default value: ``

    Tags associated with the document.

    ocr_score (number | null)

    Possible values: <= 1

    The average OCR score of the whole document.

    model (string | null)

    Possible values: non-empty

    The version of the model used to process the document.

    pdf_url uri

    Possible values: non-empty and <= 2083 characters

    A signed URL to access the auto-generated PDF created from the submitted document. This URL expires 15 minutes after the response object is returned and is resigned during every GET request.

    id integerrequired

    The unique number created to identify the document.

    created_date date-timerequired
    updated_date date-timerequired
    text (string | null)

    The text returned from converting the document into a machine-readable text format.

    contract_name objectrequired
    value (string | null)required
    begin (integer | null)
    end (integer | null)
    score (number | null)
    date objectrequired
    value daterequired
    begin (integer | null)
    end (integer | null)
    score (number | null)
    end_date objectrequired
    value daterequired
    begin (integer | null)
    end (integer | null)
    score (number | null)
    start_date objectrequired
    value daterequired
    begin (integer | null)
    end (integer | null)
    score (number | null)
    parties object[]required
  • Array [
    • value (string | null)required
    begin (integer | null)
    end (integer | null)
    score (number | null)
  • ]
    • term objectrequired
    value (string | null)required
    begin (integer | null)
    end (integer | null)
    score (number | null)
    total objectrequired
    value (number | null)required
    begin (integer | null)
    end (integer | null)
    score (number | null)
    renewal_term objectrequired
    value (string | null)required
    begin (integer | null)
    end (integer | null)
    score (number | null)
    notice_period objectrequired
    value (string | null)required
    begin (integer | null)
    end (integer | null)
    score (number | null)
    termination_for_convenience_period objectrequired
    value (string | null)required
    begin (integer | null)
    end (integer | null)
    score (number | null)
    governing_law objectrequired
    value (string | null)required
    begin (integer | null)
    end (integer | null)
    score (number | null)
    vanity objectrequired
    value (string | null)required
    begin (integer | null)
    end (integer | null)
    score (number | null)
    termination_notice objectrequired
    value (string | null)required
    begin (integer | null)
    end (integer | null)
    score (number | null)
Loading...