GraphQL API Changes 7.4.0 to 8.0.1

The GraphQL API has been improved and extended in numerous ways. Here, we mainly highlight the changes that could potential be breaking for existing API integrations.

The major version bump to version 8.0.1 signifies our migration to consistent and type-safe support for legal persons throughout the Trpd, Email, and Offline types. This is responsible for the bulk of the breaking changes outlined below.

Support for legal persons was added to the Email and Trpd types, and the already existing legal person types for Offline types brought into consistency with them.

In general, all person types now have a name field that points to a union type where the two options are:

  • A natural name consisting of a first and last name
  • A legal name consisting of a name and a legal ID (typically from a commercial register).

A few Trpd types are exceptions where the legal variant only contains a name, not a legal ID.

Removal of deprecated items

  • The previously deprecated aopdAoppProofs and aopdSatoshiProofs subscriptions have been removed. Please use the aopdProofs subscription instead.

Renames

  • On various types, quickproofUrl was renamed to aoppPortalUrl.
  • The TrpdTxUnion type was renamed to TrpdTxNotification.
  • The OfflineTxCounterpartyVasp was renamed to OfflineCounterpartyVasp.