Summary of the released API updates 2026-08

We’re excited to share some updates on our API collection.

Driver license is now supported during onboarding

Driver license as acceptable ID document type is introduced to BaaS APIs. Your clients can now submit a driver’s license as a valid identity document across our onboarding flows. To be accepted, the driver’s license must meet the following criteria:

  • Issue Country: Must be issued within an EEA (European Economic Area) country. This is controlled by ConnectPay configuration or by asking such configuration at your own provider
  • Issue Date: Must be issued on or after January 19, 2013.  Documents older than this date will be automatically declined with an OldTypeDocument error reason
  • API Schema Updates: person.citizenshipCountryCode becomes conditionally mandatory field in Personal Onboarding API. Because driver’s licenses do not always contain citizenship data, citizenship must now be collected as self-declared information. Previously, for personal customers it was received from Initiate IDV API, this old logic remains supported until January 31st, 2027, for new personal clients Personal onboarding API can be used from August 11th, 2026. Business onboarding API remains same – with citizenship field mandatory all times
  • Providers. Both ConnectPay’s IDV provider and Ondato IDV provider responses regarding driver license are supported as long as citizenship information is collected
  • Error Handling: If person.citizenshipCountryCode is not provided when submitting a driver’s license, the API will return a new error message: “Missing person.
    citizenshipCountryCode, field is mandatory when documentType DriverLicense is used”     
  • You can understand driver license is used by receiving response from GET IDV Status API – new parameter identityDocument.type. New field will return such possible values: Passport, NationalId, ResidencePermit, DriverLicense
  • When an already onboarded customer renews their IDV using a driver’s license and the result is approved, we will not automatically update their citizenship field from the IDV vendor (as it may be null or incorrect).

Action Required

If you plan to allow your users to submit driver’s licenses for identification, please ensure your user interface and API requests are updated to collect and map the person.citizenshipCountryCode field correctly. Also, if you are using Ondato as IDV provider, contact Ondato support to configure driver license for EEA countries.

Please feel free to reach out to our support team at [email protected] if you have any questions or require further technical assistance regarding these updates.

New APIs introduced

3 new APIs in onboarding are now developed for partners:

  • GET IDV persons API – Retrieve a paginated list of persons that were submitted for identity verification, with optional filtering and sorting. Use it to track the identity verification progress of onboarded persons.
  • Get personal applications API – Retrieve a paginated list of personal onboarding applications, with optional filtering and sorting. Use it to track the progress of personal onboarding applications.
  • Get business applications API – Retrieve a paginated list of business onboarding applications, with optional filtering and sorting. Use it to track the progress of business onboarding applications.

Important! New APIs return enum values in PascalCase format

Mandatory BaaS API Migrations

These updates introduce structural optimizations and standardized formatting to better support multi-currency structures and ease reconciliation. Migrating to the latest versions is mandatory. Due to the breaking nature of these updates, we have extended the migration window. The legacy versions outlined below will be permanently decommissioned and will no longer be supported after November 30, 2026.

EndpointChange DescriptionNew VersionDecommissioned VersionDecommission Date
Get Account Transactions APINew version (v4) created – breaking changes.

Updates made:
Header update: the custom request identifier header X-Request-ID is removed and replaced with x-connectpay-requestid.
Pagination: the legacy _links object has been deprecated. 
It is replaced with a new structured page block (returning pageNo, pageSize, and totalElements).
Data limit: an API error is now triggered if the total query count (totalElements) exceeds 100,000 entries.
Timestamp formatting: transaction creation dates and timestamps are now returned strictly in the UTC0 timezone with millisecond precision (e.g., 2026-01-27T16:45:36.000Z).
Operation types: standardized and updated the proprietaryBankTransactionCode values for more accurate transaction categorization.
Payment identifiers: deprecated the legacy paymentID parameter. The unique identifier for a transaction is now exclusively mapped to the paymentOrderNo parameter.
External references: introduced the externalReference parameter in the response body to improve reconciliation capabilities.
Currency exchange details: the currencyExchange block is expanded to return three distinct amount objects containing both currency and value fields:
sourceAmount;
targetAmount;
instructedAmount.
Card transaction information: for card payments, the previously omitted remittanceInformationUnstructured field is now fully returned, and paymentOrderNo is populated with the card transaction reference.
Fee entries formatting:
–remittance info: structured and unstructured fee details are consolidated; they are now cleanly returned inside remittanceInformationUnstructured (e.g., "Outgoing payment service charge");
–Ultimate debtor field: The ultimateDebtor field is no longer copied from the parent payment entry; it will now strictly return null for all fee entries.		v4v1; v2; v3November 30, 2026
Get BaaS Client Accounts APINew version (v2) created – breaking changes.

Updates made:
Hierarchical structure: shifts from a flat list to a nested model with parent “Aggregation” accounts and currency-specific subAccounts.
Data location & IDs: balances and currencies are relocated inside the nested subAccounts array; the top-level accountId now represents the parent aggregation account (e.g., ending in -XXX).
Value casing: the status field is updated from lowercase ("enabled") to title case ("Enabled").		v2v1November 30, 2026

More details here

Scroll to Top