The Trust product exposes subscriptions and documents.
A "subscription" is a document container or group. The purpose may vary by connector, for example to isolate documents linked to a contract. When it is not relevant for a connector, we still simulate a single subscription matching the user account using profile information if available. For bank websites where we can return a RIB and statement documents, we create one subscription per bank account.
"label": "Contrat EZ4225",
"subscriber": "Mr John Doe",
Subscriptions are linked to a connection (they are deleted with the connection).
The subscriptions list reflect the set of subscriptions found when synchronizing with a provider, using a safe archiving rule:
"name": "Facture Acme 023315",
Documents are linked to a subscription (they are deleted with the subscription).
We provide access to raw files of documents with the
urlproperty, when such files are available on the website. The file format depends on the connector: most websites provide PDF files, if they don't we expose HTML files.
You can enable the
force_pdfconfiguration key in your API to always generate a PDF version of files. Please note that this configuration takes effect on synchronization only and is not retroactive: any change will only apply to newly-discovered documents.
Some websites ask for a captcha, especially for bills. Our system is able to resolve them for you automatically, but this feature is disabled by default. You can enable it by setting the
captcha.enabledconfiguration key to 1.
captcha.enabledis set to 0 by default.
If this key is disabled and the website requires captcha resolution, your connection will fall into the
websiteUnavailablestate. Our resolution system may fail to resolve a captcha for various reasons. As a result the connection would also fall into the
websiteUnavailablestate, but our background workers will automatically retry later.
We don’t provide a list of websites asking for a captcha since it is subject to change frequently.