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 stringdeprecated

    Possible values: non-empty

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

    meta object
    external_id stringrequired

    Possible values: non-empty

Responses​

A processed Contract response.

Schema
    meta object
    external_id string

    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.

    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

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

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