Migration Guide Contract Detection V1 to V2
1. Overview
With the new Contract Detection V2, contract recognition is significantly improved. While previously only certain contract types such as insurance, loans, gas, electricity, and telecommunications contracts were supported, the new version now recognizes all contract types. In addition, the recognition quality has been greatly enhanced: both general contract detection and the identification of contract numbers and customer numbers are now much more precise and reliable.
2. What changes?
Improved Contract Detection
Contract Detection V2 now recognizes all contract types, not just specific industries.
This means that more contracts are automatically identified (such as streaming subscriptions, gym memberships, or magazine subscriptions, etc.). Furthermore, significantly more contract numbers and customer numbers are detected.
Unified Contracts Report
Instead of several separate reports (e.g., Insurance Contract Report, Loan Contract Report, etc.), there is now a single, comprehensive Contracts Report that consolidates all contracts into one result. This simplifies evaluation and reduces integration effort.
API-Changes
The previous endpoints of Version 1 are replaced by new V2 endpoints.
Complete API schema:
Create a contract report: https://docs.finapi.io/?product=di#post-/cases/-caseId-/report/contract
Get a contract report: https://docs.finapi.io/?product=di#post-/cases/-caseId-/reports/contract/-reportId-
3. API Usage
In the new Contract Report, you can filter by specific labels.
To obtain the same results as in Contract V1, you can filter by the following labels:
Contract Report V1 | Contract V2 with following labels |
|---|---|
Insurance Contract Report | INSURANCE |
Loan Contract Report | LOANANDINTEREST |
Gas Contract Report | GAS |
Electricity Contract Report | ELECTRICITY |
Telecommunication Contract Report | TELECOMMUNICATION |