Search
K
ARS — Address Resolution Service

Corridor

object

Default corridor (geographic routing) block for a channelProfile.

sendingCountrystring

Default sending PSP country (ISO 3166-1 alpha-2).

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

receivingCountrystring

Default receiving PSP country (ISO 3166-1 alpha-2).

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

currencystring

Default transaction currency (ISO 4217, e.g. EUR, GBP, USD).

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

Example

ChannelPreferences

object

Output and behaviour preference defaults for a channelProfile.

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

autoRepairModestring

ARS AutoCorrect repair aggressiveness level.

Allowed values:CONSERVATIVESTANDARDAGGRESSIVE

enforcePostNovember2026boolean

When true, force SR2026 rules even if schemeVersion=SR2025.

targetFormatstring

Target conversion format. auto lets ARS select the best achievable format.

Allowed values:autoFULLY_STRUCTUREDHYBRIDFULLY_UNSTRUCTURED

qualitystring

Postal database verification depth.

Allowed values:premiumstandardbasic

repairConfidenceThresholdnumber

Default minimum confidence score for REPAIRED classification (0.0–1.0).

>= 0<= 1

Example

CreateChannelProfileRequest

object

Request body for EP-25 — Register Channel Profile.

channelNamestringrequired

Unique name for this channel profile. Must be unique per account. Use DELETE + POST to rename.

Example:CBPR_OUTBOUND_US

channelSelectionobjectrequired

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
Example

UpdateChannelProfileRequest

object

Request body for EP-26 — Update Channel Profile (PATCH semantics).
Only fields provided are updated. channelName cannot be changed via PATCH.

channelSelectionobject

PATCH of channelSelection block. Only provided sub-fields are updated.

Show Child Parameters
corridorobject
Show Child Parameters
preferencesobject
Show Child Parameters
Example

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