Skip to main content

Update a Contract

PUT 
/api/v8/partner/contracts/:document_id

Veryfi's Update a Document by ID endpoint allows you to change a Document that Veryfi's Machine Learning models have already processed. This feature will enable users to update Documents previously processed by Veryfi to ensure data extraction accuracy. Updating a Document is especially useful for correcting mistakes and updating information over time. By changing a processed Document, Veryfi's Machine Learning models can re-learn the updated information, allowing them to stay accurate and up-to-date.

Request​

Path Parameters

    document_id int64required

    The unique identifier of the document.

Body

    external_id (string | null)deprecated

    Possible values: non-empty

    Deprecated 2025-01-09, use meta.external_id instead.

    meta PutMeta
    external_id (string | null)

    Possible values: non-empty

    tags string[]

    Possible values: non-empty

    Default value: ``

Responses​

A processed Contract response.

Schema
    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...