ARS — Address Resolution Service

ChannelProfileResponse

object

Full channel profile returned by EP-25 (201), EP-26 (200), and EP-27 (200).

channelNamestring

Example:CBPR_OUTBOUND_US

channelSelectionobject

Channel identification block for channelProfile registration and retrieval.

Show Child Parameters
corridorobject

Default corridor (geographic routing) block for a channelProfile.

Show Child Parameters
preferencesobject

Output and behaviour preference defaults for a channelProfile.

Show Child Parameters
createdAtstring(date-time)

Timestamp when this channel profile was first registered.

updatedAtstring(date-time)

Timestamp when this channel profile was last updated.

Example

FormatLimits

object

Default address line count and length limits for the account.

maxLinesinteger

Default maximum address lines.

Example:3

maxLineLengthinteger

Default maximum characters per line.

Example:35

Example

ChannelProfileSummary

object

Summary entry for a channelProfile in the account profile listing.

channelNamestring
channelstring

Payment delivery channel type.

Allowed values:apifileother

schemestring

Payment scheme identifier.

Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER

schemeVersionstring

ISO 20022 scheme version / SR year.

Allowed values:SR2025SR2026

directionstring

Payment processing direction. OUTBOUND = sending; INBOUND = receiving.

Allowed values:OUTBOUNDINBOUND

outputModestring

Address line rendering constraints applied during output formatting.

  • EPC: 2 lines × 70 chars
  • CBPR_PLUS: 3 lines × 35 chars
  • MT_LEGACY: 2 lines × 35 chars
  • COMPLIANCE: 7 lines × 70 chars

Allowed values:EPCCBPR_PLUSMT_LEGACYCOMPLIANCE

createdAtstring(date-time)
updatedAtstring(date-time)
Example

ProfileResponse

object

Account-level profile. Contains institutional fallback settings and
a listing of all registered channelProfiles.
[v4.3] scheme, schemeVersion, direction, targetFormat, autoRepairMode,
pspCountry, timezone, quality, repairConfidenceThreshold have been moved
to channelProfile. The account profile now retains only institution-level
fallback values (pspCountry, timezone, quality, repairConfidenceThreshold).

account_idstring

Unique account identifier.

Example:acc_8f2a91bc

regionstring

Deployment region for data residency (EU-based data centres).

Example:europe_sepa

communitystring

Account community / tier classification. System-assigned.

Example:premium_tier

formatLimitsobject

Default address line count and length limits for the account.

Show Child Parameters
channelProfilesarray[object]

Summary entry for a channelProfile in the account profile listing.

Show Child Parameters
Example

UpdateProfileRequest

object

PATCH body for EP-23. Only account-level fields are patchable here.
[v4.3] Channel-specific settings (scheme, schemeVersion, direction, outputMode,
autoRepairMode, targetFormat) are now managed via EP-26 channelProfile PATCH.

regionstring

Deployment region for data residency. One of: europe_sepa, us_east, ap_southeast.

pspCountrystring

Account-level institutional PSP country fallback (ISO 3166-1 alpha-2).

Match pattern:^[A-Z]{2}$

timezonestring

Account-level institutional timezone fallback. Overridden by channelProfile.

qualitystring

Account-level institutional quality fallback. Overridden by channelProfile.

Allowed values:premiumstandardbasic

repairConfidenceThresholdnumber

Account-level institutional confidence threshold fallback (0.0–1.0).

>= 0<= 1

Example