Skip to main content
A Verification checks a document against everything in your workspace’s data room and reports back a list of issues — unsupported numbers, stale figures, mismatches between documents, and more. Create one from a workspace with workspace.verifications.new(...), run it, then review the issues it returns. List a workspace’s past verifications with workspace.verifications.list() and re-open one with workspace.verifications.fetch(id).

​
Running a check

​
run

Verification.run(updated_main_file: Optional[FileArg] = None, source_files: Optional[list[FileArg]] = None, formatting_conventions: Optional[dict] = None, enabled_checks: Optional[list[Any]] = None) -> None
Kick off a verification run. Returns immediately (no poll). Parameters
​
updated_main_file
Optional[FileArg]
default:"None"
​
source_files
Optional[list[FileArg]]
default:"None"
​
formatting_conventions
Optional[dict]
default:"None"
​
enabled_checks
Optional[list[Any]]
default:"None"

​
run_and_wait

Verification.run_and_wait(updated_main_file: Optional[FileArg] = None, source_files: Optional[list[FileArg]] = None, formatting_conventions: Optional[dict] = None, enabled_checks: Optional[list[Any]] = None, poll_interval: float = 15.0, timeout: float = 1800.0, on_status: Optional[Callable[[VerificationStatus], None]] = None) -> VerificationRunSummary
Kick off a run, then poll until COMPLETED (or fail/timeout). Parameters
​
updated_main_file
Optional[FileArg]
default:"None"
​
source_files
Optional[list[FileArg]]
default:"None"
​
formatting_conventions
Optional[dict]
default:"None"
​
enabled_checks
Optional[list[Any]]
default:"None"
​
poll_interval
float
default:"15.0"
​
timeout
float
default:"1800.0"
​
on_status
Optional[Callable[[VerificationStatus], None]]
default:"None"
See VerificationStatus.
Returns
​
returns
VerificationRunSummary
See VerificationRunSummary.

​
Reviewing issues

​
issues

Verification.issues(severity: Optional[list[Any]] = None, category: Optional[list[Any]] = None, status: Optional[list[Any]] = None, slide: Optional[int] = None, offset: int = 0, limit: int = 50, sort_by: Optional[str] = None) -> "list[VerificationIssue]"
Fetch a page of issues for this verification. Parameters
​
severity
Optional[list[Any]]
default:"None"
​
category
Optional[list[Any]]
default:"None"
​
status
Optional[list[Any]]
default:"None"
​
slide
Optional[int]
default:"None"
​
offset
int
default:"0"
​
limit
int
default:"50"
​
sort_by
Optional[str]
default:"None"
Returns
​
returns
list[VerificationIssue]

​
Status

​
refresh

Verification.refresh() -> Verification
Re-read status and counts via GET /verification?id=. Returns
​
returns
Verification

​
Lifecycle

​
delete

Verification.delete() -> None

​
Types

Configuration objects, response shapes, and enums used by the methods above.

​
CheckType

A kind of check a verification can run against a document. Members
  • PRIMARY_SOURCE = "PRIMARY_SOURCE"
  • PROVENANCE = "PROVENANCE"
  • CROSS_DOCUMENT = "CROSS_DOCUMENT"
  • COHERENCE = "COHERENCE"
  • STALENESS = "STALENESS"
  • VERSION_DELTA = "VERSION_DELTA"
  • STRATEGIC_ALIGNMENT = "STRATEGIC_ALIGNMENT"
  • REFERENCES = "REFERENCES"
  • UI_ISSUE = "UI_ISSUE"
  • TABLE_SOURCE = "TABLE_SOURCE"
  • SOURCES = "SOURCES"

​
CheckResult

The outcome of a single check: pass, fail, needs review, or not found. Members
  • PASS = "CHECK_PASS"
  • FAIL = "CHECK_FAIL"
  • REVIEW_NEEDED = "CHECK_REVIEW_NEEDED"
  • NOT_FOUND = "CHECK_NOT_FOUND"

​
VerificationStatus

The status of a verification run, from pending through completed or failed. Members
  • PENDING = "VERIFICATION_PENDING"
  • PARSING = "VERIFICATION_PARSING"
  • DISCOVERING = "VERIFICATION_DISCOVERING"
  • VERIFYING = "VERIFICATION_VERIFYING"
  • COMPLETED = "VERIFICATION_COMPLETED"
  • FAILED = "VERIFICATION_FAILED"

​
VerificationType

What a verification looks for: a full check or just citation discovery. Members
  • FULL = "VERIFICATION_FULL"
  • FIND_CITATIONS = "VERIFICATION_FIND_CITATIONS"

​
VerificationRunSummary

Fields
​
total_issues
int
required
​
categories
list[CategorySummary]
required
​
version
str
required
​
status
<enum VerificationStatus>
required

​
CheckSummary

Fields
​
check_type
str
required
​
result
str
required
​
summary
str
required
​
data
Any
required

​
CategorySummary

Fields
​
category
<enum IssueCategory>
required
​
verified
int
required
​
review_needed
int
required
​
errors
int
required
​
not_found
int
required

​
VersionSummary

Fields
​
version
str
required
​
total_issues
int
required
​
resolved_issues
int
required
​
created_at
str
required
​
status
<enum VerificationStatus>
required