Ocr Service

This service allows you to perform OCR on financial statements/tax return, enabling the extraction of data from a PDF in the same standard format provided by other Qard data providers.

This provider supports these data types:

• Tax return: to retrieve a list of user tax returns.
• Tax return analysis (Insight): to retrieve a tax return analysis.

Test OcrService integration:

1. Enable OcrService provider:

(PUT) /api/v6/providers/ocr_service

{
  "enable": true
}

2. Settings OcrService provider:

(PUT) /api/v6/providers/ocr_service/settings

{
  "auto_connect": false
}

3. Create OcrService data connection:

(POST) /api/v6/users/{userId}/data-connections

{
  "requested_data_types": ["TAX_RETURN"],
  "provider_name": "ocr_service"
}

4. Add a tax bundle document for OCR processing:

To add a tax bundle document for OCR processing, use the following endpoint:

(POST) /api/v6/input/users/{userId}/tax-returns/ocr-service

{
  "tax_return_id": "string",
  "data": {
    "file": "file (base64)",
    "closing_date": "2021-05-19",
    "closing_year": "string",
    "submitted_date": "2021-05-19",
    "type": "string",
    "duration": 0,
    "privacy": "string"
  }  
}

5. Create a synchronization:

After validating that the data connection status is CONNECTED, you can run a new synchronization.

(POST) /api/v6/users/{userId}/sync

{
  "data_types": ["TAX_RETURN"]
}

To check the status of the OCR process, call the endpoint:

• GET /api/v6/input/users/{userId}/tax-returns

The process_status field indicates whether the OCR process is complete. Once completed, you can resynchronize tax_return to retrieve all the data from tax returns.

Field	Type	Description
id	uuid	Unique identifier (UUID)
tax_return_id	string	Tax return identifier
process_status	string	Processing status (PENDING, IN_PROGRESS, FINISHED, ERROR)
data	Tax Return Data	Tax Return
error_message	string	Error message if process_status is ERROR
created_at	datetime	Record creation timestamp
updated_at	datetime	Last update timestamp

Retrieve all tax returns through:

• GET /api/v6/users/{userId}/tax-returns
• GET /api/v6/users/{userId}/tax-returns/{taxReturnId}
• GET /api/v6/users/{userId}/tax-return-analysis