onfido-python

What's Changed

• Refresh onfido-python after onfido-openapi-spec update (4204f00) by @devops-automation-onfido in https://github.com/onfido/onfido-python/pull/108
  • [CAT-1911] Remove driving licence information properties where not needed by @dvacca-onfido in https://github.com/onfido/onfido-openapi-spec/pull/164
  • [AF-1390] Remove deprecated breakdown.breakdown property by @dvacca-onfido in https://github.com/onfido/onfido-openapi-spec/pull/169
  • [SIG-3390] IDR: change total_number_of_sources and number_of_matches to string by @ygaber in https://github.com/onfido/onfido-openapi-spec/pull/187
  • Add missing tags field for workflow run listing and webhook by @dvacca-onfido in https://github.com/onfido/onfido-openapi-spec/pull/195 (originally by @TSkrebe in https://github.com/onfido/onfido-openapi-spec/pull/186)
  • [STUDIO-5708] Fix workflow_runs date filter parameters format by @dvacca-onfido in https://github.com/onfido/onfido-openapi-spec/pull/202
  • Remove deprecated properties object from device_intelligence_breakdown by @dvacca-onfido in https://github.com/onfido/onfido-openapi-spec/pull/204
  • [STUDIO-5734] Add status to webhook event resource by @dvacca-onfido in https://github.com/onfido/onfido-openapi-spec/pull/207, https://github.com/onfido/onfido-openapi-spec/pull/208, https://github.com/onfido/onfido-openapi-spec/pull/209
  • Bump openapi-generator-cli from v7.11.0 to v7.16.0 by @dvacca-onfido in https://github.com/onfido/onfido-openapi-spec/pull/190

Full Changelog: https://github.com/onfido/onfido-python/compare/v5.7.0...v6.0.0

MIGRATION GUIDE

What's Changed

• Release based on Onfido OpenAPI spec version v5.7.0:
  • [ENT-129] Add new passkey management endpoints by @poryaisfahani in https://github.com/onfido/onfido-openapi-spec/pull/191
  • [ENT-114] Add signing document endpoints by @noahmank in https://github.com/onfido/onfido-openapi-spec/pull/188
  • [ENT-129] Fix passkey typo by @poryaisfahani in https://github.com/onfido/onfido-openapi-spec/pull/196
  • [ENT-114] Fix signing document typo by @poryaisfahani in https://github.com/onfido/onfido-openapi-spec/pull/197
  • Python: solve virtualenv vulnerability by pinning virtualenv lower bound version by @dvacca-onfido in https://github.com/onfido/onfido-openapi-spec/pull/198
  • [DEXTV2-10857] Add valid_from field to open API spec for document report properties by @geromin-entrust in https://github.com/onfido/onfido-openapi-spec/pull/200
• [ENT-114] signing document tests by @poryaisfahani in https://github.com/onfido/onfido-python/pull/100
• [ENT-129] Passkey Management Tests by @poryaisfahani in https://github.com/onfido/onfido-python/pull/103

New Contributors

• @poryaisfahani made their first contribution in https://github.com/onfido/onfido-python/pull/100

Full Changelog: https://github.com/onfido/onfido-python/compare/v5.6.0...v5.7.0

What's Changed

• Release based on Onfido OpenAPI spec version v5.6.0:
  • [SIG-3270] Update document_type supported by PoA by @ygaber in https://github.com/onfido/onfido-openapi-spec/pull/185
  • [DEXTV2-9337] Update list of document subtypes for extraction by @SergioCopetoEntrust in https://github.com/onfido/onfido-openapi-spec/pull/189
  • [STUDIO-5634] Add timeline_file_download_url to the webhook event resource by @RiccardoPetteruti in https://github.com/onfido/onfido-openapi-spec/pull/192

Full Changelog: https://github.com/onfido/onfido-python/compare/v5.5.0...v5.6.0

What's Changed

• Release based on Onfido OpenAPI spec version v5.5.0:
  • [SIG-3128] Add ssn breakdowns to IDR enhanced report by @SofianOnfido in https://github.com/onfido/onfido-openapi-spec/pull/183

• Fix CHANGELOG.md and improve CI by @dvacca-onfido in https://github.com/onfido/onfido-python/pull/92

Full Changelog: https://github.com/onfido/onfido-python/compare/v5.4.0...v5.5.0

What's Changed

• Release based on Onfido OpenAPI spec version v5.4.0:
  • [ENT-26] Add AES document download endpoint

• [ENT-26] Add AES documents test by @noahmank in https://github.com/onfido/onfido-python/pull/91
• Fix dependabot error, add support for python 3.13 (and drop 3.8) by @dvacca-onfido in https://github.com/onfido/onfido-python/pull/90

New Contributors

• @noahmank made their first contribution in https://github.com/onfido/onfido-python/pull/91

Full Changelog: https://github.com/onfido/onfido-python/compare/v5.3.0...v5.4.0

What's Changed

• Release based on Onfido OpenAPI spec version v5.3.0:
  • [DEXTV2-9494] Add manual_transmission_restriction to document with driver verification report

Full Changelog: https://github.com/onfido/onfido-python/compare/v5.2.0...v5.3.0

What's Changed

• Release based on Onfido OpenAPI spec version v5.2.0:
  • [BIO-7260] Add report configuration (including use_case) to checks

Full Changelog: https://github.com/onfido/onfido-python/compare/v5.1.0...v5.2.0

What's Changed

• Release based on Onfido OpenAPI spec version v5.1.0:
  • CAT-1760: create get applicant consents endpoint
  • [CAT-1911] Fix document_with_driving_licence_information to be a list of objects
  • [AF-1390] Fix: Device Intelligence Report Schema
  • [CAT-1944] Add OAuth fields for Webhook authentication
  • Fix storage of device_fingerprint_reuse breakdown and properties as float
  • Add .markdownlint.json to templates

Full Changelog: https://github.com/onfido/onfido-python/compare/v5.0.0...v5.1.0

What's Changed

• Release based on Onfido OpenAPI spec version v5.0.0:
  • Add missing type annotations to webhook verifier
  • Denote webhook event payload.object.href as a not required property
  • [CAT-1593] Drop invalid enum value from webhook event type
  • Add applicant_id in GET /workflow_runs
  • [CAT-1694] Define document file type as free text
  • [DOCCAP-2513] Add download-nfc-face endpoint
  • [CAT-1719] Don't impose a type on deprecated records property in watchlist reports
  • Remove documents property for reports where it's not applicable
  • Update openapi generator version to v7.10.0 (was v7.9.0)
  • Update openapi generator version to v7.11.0 (was v7.10.0)
• Add tests for Download NFC Face endpoint
• Migration Guide

New Contributors

• @DiogoAndreBotas made their first contribution in https://github.com/onfido/onfido-python/pull/82

Full Changelog: https://github.com/onfido/onfido-python/compare/v4.6.0...v5.0.0

What's Changed

• Release based on Onfido OpenAPI spec version v4.6.0:
  • (Python) Use Poetry only for dependency management
  • [STUDIO-4308] Add driving_license to id_number enum
  • [CAT-1634] Add proxy configuration support to Java client library
  • Update README files (including templated ones)
  • Add customer_user_id in the webhook event resource
• test: wait for evidence folder to be available

Full Changelog: https://github.com/onfido/onfido-python/compare/v4.5.0...v4.6.0

What's Changed

• Release based on Onfido OpenAPI spec version v4.5.0:
  • [STUDIO-4305] Add download evidence folder path

Full Changelog: https://github.com/onfido/onfido-python/compare/v4.4.0...v4.5.0

What's Changed

• Release based on Onfido OpenAPI spec version v4.4.0:
  • [CAT-1593] Fix missing webhook type and evidence folder webhook
  • [CAT-1590] Allow any type for the workflow task output

Full Changelog: https://github.com/onfido/onfido-python/compare/v4.3.0...v4.4.0

What's Changed

• Release based on Onfido OpenAPI spec version v4.3.0:
  • [CAT-1581] Revert "[CAT-1528] Fix barcode field in document properties object"

Full Changelog: https://github.com/onfido/onfido-python/compare/v4.2.0...v4.3.0

What's Changed

• Release based on Onfido OpenAPI spec version v4.2.0:
  • feat: add new fields to facial similarity report objects
  • [CAT-1552] Add missing document types

Full Changelog: https://github.com/onfido/onfido-python/compare/v4.1.0...v4.2.0

DEPRECATION NOTICE: This release has been deprecated in favour of v4.3.0.

What's Changed

• Release based on Onfido OpenAPI spec version v4.1.0:
  • [CAT-1528] Fix barcode field in document properties object

Full Changelog: https://github.com/onfido/onfido-python/compare/v4.0.0...v4.1.0

DEPRECATION NOTICE: This release has been deprecated in favour of v4.3.0.

What's Changed

• Release based on Onfido OpenAPI spec version v4.0.0:
  • [CAT-1379] Add a few missing properties
  • [CAT-1447] Fix applicant consents
  • [CAT-1379] Fix check creation, remove some deprecated properties and deprecate others
  • Use document-type enum for document upload
  • [CAT-1306] Add webhooks event resource
  • Upgrade OpenAPI generator to v7.9.0 (was v7.6.0)
  • Migration Guide

Full Changelog: https://github.com/onfido/onfido-python/compare/v3.5.0...v4.0.0

What's Changed

• Release based on Onfido OpenAPI spec version v3.5.0:
  • [CAT-1376] Add record item object definition for watchlist enhanced properties field

Full Changelog: https://github.com/onfido/onfido-python/compare/v3.4.0...v3.5.0

What's Changed

• Release based on Onfido OpenAPI spec version v3.3.0:
  • Expose customer_user_id in workflow_runs
  • Add sdk_token to workflow run schema

Full Changelog: https://github.com/onfido/onfido-python/compare/v3.3.0...v3.4.0

What's Changed

• Release based on Onfido OpenAPI spec version v3.2.0:
  • [CAT-1289] Document report's properties: Add middle name
  • chore(qes): add documents endpoint
  • [CAT-1297] Webhook Event: remove uuid format from object.id
  • fix(qes): fix download document http method
  • Add started_at_iso8601 field in webhook event
  • add jpeg file type for documents

Full Changelog: https://github.com/onfido/onfido-python/compare/v3.2.0...v3.3.0

What's Changed

• Release based on Onfido OpenAPI spec version v3.1.0:
  • Add missing fields in document report's properties

New Contributors

• @dvacca-onfido made their first contribution in https://github.com/onfido/onfido-python/pull/63

Full Changelog: https://github.com/onfido/onfido-python/compare/v3.1.0...v3.2.0

What's Changed

• Library has been rebuilt from scratch and automatically generated from Onfido OpenAPI Spec (release v3.0.0)
• Additional integration tests coverage
  • test: add tests for onfido-python library by @sofia-gomes-onfido in https://github.com/onfido/onfido-python/pull/54
  • Tests id_photos endpoints by @andremendes2 in https://github.com/onfido/onfido-python/pull/58
  • test: add timeline file and webhook tests by @sofia-gomes-onfido in https://github.com/onfido/onfido-python/pull/59

New Contributors

• @devops-automation-onfido made their first contribution in https://github.com/onfido/onfido-python/pull/51
• @sofia-gomes-onfido made their first contribution in https://github.com/onfido/onfido-python/pull/54
• @andremendes2 made their first contribution in https://github.com/onfido/onfido-python/pull/58
• @dvacca-onfido made their first contribution in https://github.com/onfido/onfido-python/pull/63

Full Changelog: https://github.com/onfido/onfido-python/compare/v2.10.1...v3.1.1

• Fixes a bug that happens using the async interface on HTTP 422 status only

• Added core methods for WorkflowRuns

• Added signed_evidence_file method for WorkflowRuns

• Allow to async-iterate upload files.

• Support asyncio API
• Handle filenames with a uppercase file extension
• Replace pkg_resources

• Update to use API v3.6, for more details please see our release notes
• Added Watchlist monitors
• Handle filenames with a uppercase file extension
• Bump certifi from 2020.6.20 to 2022.12.7
• Add support for python 3.10

• Add Motion support

• Update to use API v3.5, for more details please see our release notes

• Update to use API v3.4, for more details please see our release notes

• Improve error handling for 422 errors

• Update to use API v3.3

• Update to use API v3.2

• support for API v3.1
• base_url parameter has become region, which takes one of Region.EU, Region.US or Region.CA and no longer has a default value
• added support for 'Download check' endpoint

• Updates README.

Marks Resource methods private

Added ability to set timeout for requests globally in API constructor.

• fixed minor bug in /extractions endpoint

Adds support for /v3/extractions

First public release of onfido-python

• Beta version released