Get a Contract

GET 
/api/v8/partner/contracts/:document_id

Veryfi's Get a Contract endpoint allows you to retrieve a previously processed Contract.

Request

Path Parameters

document_id int64required

The unique identifier of the document.

Query Parameters

bounding_boxes boolean

A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.

confidence_details boolean

A field used to determine whether or not to return the score and ocr_score fields in the Document response.

Responses

200

Returns a processed Contract.

application/json

Schema

Schema

anyOf
API_V8_PARTNER_CONTRACTS_DETAILEDCONTRACT
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)

Example (from schema)

{}

Loading...