Release Notes for Client Expected Activity and Trading Address: 04/11/2026
This release adds expected activity to the Client API. A client can now describe the activity it expects in a period: its turnover, how many transfers it makes, and the currencies and countries involved. Corporate clients can now also have a trading address.
Client API changes:
See the Clients API Guide for full details.
Expected Activity
-
Added expectedActivity to the client. It is accepted by Create a Client (POST /clients) and Update a Client (PATCH /clients/{id}). It is returned by Get a Client (GET /clients/{id}) and List Clients (GET /clients).
expectedActivity has the following fields:
field type description validation period string period that turnoverAmount and transferCount cover the only allowed value is monthly turnoverAmount number expected turnover per period, in turnoverCurrency, e.g. 5000. Used to determine the Railsr expectedVolumeRange (see below). greater than 0 turnoverCurrency string currency of turnoverAmount ISO 4217 transferCount integer expected number of transfers per period, e.g. 10 greater than 0 transferCurrencies string[] currencies the client expects to transfer in ISO 4217 transferInCountries string[] countries the client expects to receive money from ISO 3166-1 alpha-2 transferOutCountries string[] countries the client expects to send money to ISO 3166-1 alpha-2 -
expectedActivity and all of its fields are optional on the Client API. Some service providers require it, so a client connected to one of them must have it:
-
Railsr: requires an expected volume, built from expectedActivity:
-
turnoverAmount determines the expectedVolumeRange. A turnoverAmount on a boundary belongs to the lower range, e.g. 5000 is 0-5000.
client type turnoverAmount expectedVolumeRange individual up to 5000 0-5000 individual over 5000, up to 10000 5001-10000 individual over 10000 10000+ corporate up to 25000 0-25000 corporate over 25000, up to 50000 25000-50000 corporate over 50000, up to 250000 50000-250000 corporate over 250000, up to 1000000 250000-1000000 corporate over 1000000 1000000+ -
period is sent as expectedVolumeType.
-
turnoverCurrency is sent as expectedVolumeCurrency.
-
-
Currencycloud: requires the following for individual and corporate clients. Each field is sent as the Currencycloud customer account data below:
expectedActivity Currencycloud field requirement turnoverAmount expected_monthly_activity_value required, greater than 0 transferCount expected_monthly_activity_volume required, greater than 0 turnoverCurrency expected_transaction_currencies required, sent as the only currency transferInCountries, transferOutCountries expected_transaction_countries at least one country across both lists, sent as distinct values period - when provided, it must be monthly transferCurrencies is not sent to Currencycloud.
-
-
Example Request and Response for Create a Client with expected activity:
{ "workflow": { "code": "direct" }, "data": { "client": { "identity": { "type": "individual", "givenName": "Sherlock", "familyName": "Holmes", "birthDate": "1953-01-06", "country": "GB", "identifications": [ { "type": "identity-card", "identificationNumber": "12345678", "issuingCountry": "GB", "issueDate": "2022-01-01", "expirationDate": "2032-01-01" } ] }, "profile": { "identityType": "individual", "phone": "+441234567890", "email": "[email protected]", "residentialAddress": { "country": "GB", "region": "England", "city": "London", "street": "Baker Street", "houseNumber": "221B", "postalCode": "XYZ ABC", "refinement": "" } }, "expectedActivity": { "period": "monthly", "turnoverAmount": 5000, "turnoverCurrency": "GBP", "transferCount": 10, "transferCurrencies": ["GBP"], "transferInCountries": ["GB", "FR"], "transferOutCountries": ["GB", "FR"] } } }, "connect": {}, "metadata": {} }{ "workflow": { "code": "direct" }, "data": { "client": { "id": "00000000-0000-0000-0000-000000000000", "clientNumber": "23668817", "status": "active", "identity": { "type": "individual", "country": "GB", "identifications": [ { "type": "identity-card", "identificationNumber": "12345678", "issuingCountry": "GB", "issueDate": "2022-01-01", "expirationDate": "2032-01-01" } ], "givenName": "Sherlock", "familyName": "Holmes", "birthDate": "1953-01-06" }, "profile": { "identityType": "individual", "phone": "+441234567890", "email": "[email protected]", "residentialAddress": { "country": "GB", "region": "England", "city": "London", "street": "Baker Street", "postalCode": "XYZ ABC", "houseNumber": "221B" } }, "expectedActivity": { "period": "monthly", "turnoverAmount": 5000, "turnoverCurrency": "GBP", "transferCount": 10, "transferCurrencies": ["GBP"], "transferInCountries": ["GB", "FR"], "transferOutCountries": ["GB", "FR"] }, "fullName": "Sherlock Holmes" } }, "connect": {}, "metadata": {} }Example Request for Update a Client with expected activity:
{ "workflow": { "code": "direct" }, "data": { "client": { "expectedActivity": { "period": "monthly", "turnoverAmount": 5000, "turnoverCurrency": "GBP", "transferCount": 10, "transferCurrencies": ["GBP"], "transferInCountries": ["GB", "FR"], "transferOutCountries": ["GB", "FR"] } } }, "connect": {}, "metadata": {} }
Trading Address
-
Added tradingAddress to the corporate client profile. It is accepted by Create a Client (POST /clients) and Update a Client (PATCH /clients/{id}), and uses the same address structure as registrationAddress.
-
On Update a Client, tradingAddress is patched like registrationAddress: only the fields provided are changed. Updating one of the two addresses no longer removes the other.
-
Get a Client (GET /clients/{id}) returns the trading address when data.client.profile.tradingAddress is included in metadata.include.
Example Request for Create a Client with a trading address:
{ "workflow": { "code": "direct" }, "data": { "client": { "identity": { "type": "corporate", "legalName": "I.F Technology Ltd", "incorporationDate": "1987-01-01", "country": "GB", "corporationType": "ltd" }, "profile": { "identityType": "corporate", "phone": "+441234567890", "email": "[email protected]", "registrationAddress": { "country": "GB", "region": "England", "city": "London", "street": "City Road", "houseNumber": "Epworth House", "postalCode": "EC1Y 1AA", "refinement": "" }, "tradingAddress": { "country": "GB", "region": "England", "city": "Manchester", "street": "Market Street", "houseNumber": "10", "postalCode": "M1 1AA" } } } }, "connect": {}, "metadata": {} }Example Request for Get a Client with the trading address:
GET /clients/{clientId}?metadata.include=data.client.profile.tradingAddress