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
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
Possible values: <= 1
The average OCR score of the page.
width integer
The width of the page.
height integer
The height of the page.
]
tags string[]
Possible values: non-empty
Default value: ``
Tags associated with the document.
ocr_score number
Possible values: <= 1
The average OCR score of the whole document.
model string
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
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

Example (from schema)

{}

Loading...