FormatLimits
objectDefault address line count and length limits for the account.
Default maximum address lines.
Example:3
Default maximum characters per line.
Example:35
ChannelProfileSummary
objectSummary entry for a channelProfile in the account profile listing.
Payment delivery channel type.
Allowed values:apifileother
Payment scheme identifier.
Allowed values:SCTSCT_INSTSDD_CORESDD_B2BOCT_INSTCBPRPLUSCHAPST2EURO1FEDWIREOTHER
ISO 20022 scheme version / SR year.
Allowed values:SR2025SR2026
Payment processing direction. OUTBOUND = sending; INBOUND = receiving.
Allowed values:OUTBOUNDINBOUND
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
ProfileResponse
objectAccount-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).
Unique account identifier.
Example:acc_8f2a91bc
Deployment region for data residency (EU-based data centres).
Example:europe_sepa
Account community / tier classification. System-assigned.
Example:premium_tier
Default address line count and length limits for the account.
Show Child Parameters
Summary entry for a channelProfile in the account profile listing.
Show Child Parameters
UpdateProfileRequest
objectPATCH 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.
Deployment region for data residency. One of: europe_sepa, us_east, ap_southeast.
Account-level institutional PSP country fallback (ISO 3166-1 alpha-2).
Match pattern:^[A-Z]{2}$
Account-level institutional timezone fallback. Overridden by channelProfile.
Account-level institutional quality fallback. Overridden by channelProfile.
Allowed values:premiumstandardbasic
Account-level institutional confidence threshold fallback (0.0–1.0).
>= 0<= 1
ProcessPartyAddressRequest
objectEP-01 request. Full ARS AutoCorrect processing on a single party address.
Processing precedence: channelProfile → processingOptions → context.
Name of a registered channelProfile. Loads all channel defaults.
ISO 20022 party name. Used for entity conflict detection and name-in-address detection.
ISO 20022 PostalAddress24 object. All 14 structured fields are supported.
Country is strongly recommended for all submissions.
AddressLine is limited to max 7 elements in schema; practical publishing limits
are governed by OutputMode (EPC=2, CBPR_PLUS=3, MT_LEGACY=2, COMPLIANCE=7).
PMPG non-duplication rule: structured fields (TownName, Country) must NOT also
appear in AddressLine simultaneously.
Show Child Parameters
ISO 20022 XML tag equivalents. Alternative to postalAddress.
Show Child Parameters
Optional party identifiers. Used for entity conflict detection (R-04).
Show Child Parameters
Match pattern:^[A-Z]{2}$
Per-request overrides of the channelProfile configuration. Only fields present
here override the corresponding channelProfile value. Fields absent here fall
through to channelProfile. This is NOT a general-purpose configuration block —
it only overrides values already set in channelProfile.
Show Child Parameters
Analytics/audit passthrough AND processing fallback layer.
Fields labelled “Analytics + Processing fallback” are used as last-resort defaults
when both channelProfile and processingOptions leave a parameter unresolved.
Pure analytics fields are written to the ARS audit log but do not affect processing.
Processing precedence: channelProfile → processingOptions → context.
Show Child Parameters
Optional response enrichment fields.
Allowed values:canonicaltraceabilityactions