Getting startedRelease notes

API - May 19, 2026

Changed

Recipient format validation errors now include regex pattern

When registering a Recipient or validating user data in advance, the INVALID_FORMAT error type now includes the regex pattern used.

The message now returns, for example: Regex validation: ^\\d{8}$

API response - HTTP 400
1{
2 "Id": "1a8bff3c-37a4-4a1a-9219-d00a5fd19865",
3 "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
4 "Type": "param_error",
5 "Date": 1779197001,
6 "Errors": {
7 "IndividualRecipient.Address.PostalCode": "LENGTH_MORE_THAN_MAX",
8 "LocalBankTransfer.GBP.AccountNumber": "INVALID_FORMAT. Regex validation: ^\\d{8}$",
9 "LocalBankTransfer.GBP.SortCode": "INVALID_FORMAT. Regex validation: ^\\d{6}$"
10 }
11}

This change impacts the following endpoints:

Returning the regex directly in the error message allows your platform to more efficiently resolve the issue in the user’s data.

The regex patterns applicable are available on demand from the GET View the schema for a Recipient endpoint.

Best practice – Retrieve schema and validate data before creation

Your platform is strongly recommended to dynamically retrieve the schema and validate the user’s data before creating the Recipient.