--- title: "MandatePartyAddressRequest" url: "https://dev.ionova.ai/apis/ars-address-resolution-service-4/versions/fdd2c316-7f84-4f04-8bb7-64e9bf97893b/schemas/MandatePartyAddressRequest" --- > Full API specification: https://dev.ionova.ai/apis/ars-address-resolution-service-4/versions/fdd2c316-7f84-4f04-8bb7-64e9bf97893b.md # MandatePartyAddressRequest EP-16 request. Address mandate determination for a single party. Processing precedence: channelProfile → processingOptions → context. ## OpenAPI definition ```yaml openapi: 3.0.3 info: title: ARS — Address Resolution Service version: 4.3.1 servers: - url: https://api-uat.ionova.ai/ars description: UAT (test data only) components: schemas: ProcessingOptions: type: object xml: name: ProcessingOptions description: > 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. properties: scheme: allOf: - $ref: "#/components/schemas/SchemeCode" description: Per-request override of channelProfile.scheme. schemeVersion: allOf: - $ref: "#/components/schemas/SchemeVersion" description: Per-request override of channelProfile.schemeVersion. SR2025 or SR2026. quality: allOf: - $ref: "#/components/schemas/Quality" description: Per-request override of channelProfile.quality. verification: type: boolean description: Per-request override. When false, skips postal DB lookup. Forced false for Basic quality. detectMisplacedIdentifiers: type: boolean description: Per-request override. When true, flags BIC/LEI/IBAN found in AddressLine (R-04). validateNameContent: type: boolean description: Per-request override. When true, checks for party name duplication in address lines (R-05). redaction: type: string enum: - NONE - PARTIAL - FULL description: Per-request override. PII redaction level applied to response address fields. targetFormat: allOf: - $ref: "#/components/schemas/TargetFormat" description: Per-request override of channelProfile default targetFormat. repairConfidenceThreshold: type: number minimum: 0 maximum: 1 description: Per-request override of channelProfile.repairConfidenceThreshold (0.0–1.0). payerPspCountry: type: string pattern: ^[A-Z]{2}$ description: Per-request override of channelProfile.payerPspCountry. ISO 3166-1 alpha-2. payeePspCountry: type: string pattern: ^[A-Z]{2}$ description: Per-request override of channelProfile.payeePspCountry. ISO 3166-1 alpha-2. Context: type: object xml: name: Context description: > 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. properties: name: type: string description: Analytics only. ISO 20022 party name used for entity conflict detection. scheme: allOf: - $ref: "#/components/schemas/SchemeCode" description: Analytics + Processing fallback. Payment scheme. schemeVersion: allOf: - $ref: "#/components/schemas/SchemeVersion" description: Analytics + Processing fallback. SR2025 or SR2026. Controls post-cutover enforcement. executionDatetime: type: string format: date-time description: Analytics + Processing fallback. Payment execution datetime in ISO 8601 UTC. Used for SR2026 cutover enforcement (cutover = 2026-11-22T02:30:00Z). direction: allOf: - $ref: "#/components/schemas/Direction" description: Analytics + Processing fallback. OUTBOUND | INBOUND. partyRole: allOf: - $ref: "#/components/schemas/PartyRole" description: Analytics + Processing fallback. Party role for this request. outputMode: allOf: - $ref: "#/components/schemas/OutputMode" description: Analytics + Processing fallback. Address line rendering constraints. sendingCountry: type: string pattern: ^[A-Z]{2}$ description: Analytics + Processing fallback. Country of the sending PSP (ISO 3166-1 alpha-2). receivingCountry: type: string pattern: ^[A-Z]{2}$ description: Analytics + Processing fallback. Country of the receiving PSP. messageType: allOf: - $ref: "#/components/schemas/MessageType" description: Analytics + Processing fallback. ISO 20022 message type. timezone: type: string description: Analytics + Processing fallback. IANA timezone for executionDatetime evaluation. inputFormat: allOf: - $ref: "#/components/schemas/AddressFormat" description: Analytics only. Format of the originating input. outputFormat: allOf: - $ref: "#/components/schemas/AddressFormat" description: Analytics only. Expected output format. source: type: string description: Analytics only. Sending system identifier (e.g. PAYMENT_HUB, SWIFT_ALLIANCE). sender: type: string description: Analytics only. BIC of the sending institution. receiver: type: string description: Analytics only. BIC of the receiving institution. paymentMethod: type: string description: Analytics only. Payment method for audit reporting. channel: allOf: - $ref: "#/components/schemas/ChannelType" description: Analytics only. Delivery channel for audit. application: type: string description: Analytics only. Caller application identifier. reference: type: string description: Analytics only. Business reference for audit trail (e.g. payment ID, batch ID). partyType: type: string enum: - COMPANY - INDIVIDUAL description: Analytics only. Whether the party is a company or individual. SchemeCode: type: string description: Payment scheme identifier. enum: - SCT - SCT_INST - SDD_CORE - SDD_B2B - OCT_INST - CBPRPLUS - CHAPS - T2 - EURO1 - FEDWIRE - OTHER SchemeVersion: type: string description: ISO 20022 scheme version / SR year. enum: - SR2025 - SR2026 Quality: type: string description: Postal database verification depth. enum: - premium - standard - basic TargetFormat: type: string description: > Target conversion format. `auto` lets ARS select the best achievable format. enum: - auto - FULLY_STRUCTURED - HYBRID - FULLY_UNSTRUCTURED Direction: type: string description: Payment processing direction. OUTBOUND = sending; INBOUND = receiving. enum: - OUTBOUND - INBOUND PartyRole: type: string description: > ISO 20022 party role. Determines the PostalAddress24 XSD variant: - **__2 variant** (ultimate_debtor, ultimate_creditor, initiating_party): TownName AND Country are MANDATORY. FULLY_UNSTRUCTURED is NEVER permitted (REG-05). - **__1 variant** (debtor, creditor): Max 3 AddressLines. FULLY_UNSTRUCTURED is permitted until SR2026 cutover (2026-11-22T02:30:00Z) for INBOUND; banned OUTBOUND post-cutover. enum: - debtor - creditor - ultimate_debtor - ultimate_creditor - initiating_party OutputMode: type: string description: | 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 enum: - EPC - CBPR_PLUS - MT_LEGACY - COMPLIANCE MessageType: type: string description: > ISO 20022 message type. R-transaction types (pain.002, pain.007, pacs.002, pacs.004, camt.029, camt.052, camt.053, camt.054, camt.055, camt.056, camt.058, camt.110, camt.111) must be submitted to R-transaction endpoints only (EP-07, EP-15). Submitting them to Check/Convert endpoints returns HTTP 422 (REG-06). enum: - pain.001 - pain.002 - pain.007 - pain.008 - pacs.002 - pacs.003 - pacs.004 - pacs.008 - pacs.009 - pacs.010 - camt.029 - camt.052 - camt.053 - camt.054 - camt.055 - camt.056 - camt.057 - camt.058 - camt.060 - camt.105 - camt.106 - camt.107 - camt.108 - camt.109 - camt.110 - camt.111 AddressFormat: type: string description: Detected or target address format classification. enum: - FULLY_STRUCTURED - HYBRID - FULLY_UNSTRUCTURED ChannelType: type: string description: Payment delivery channel type. enum: - api - file - other MandatePartyAddressRequest: type: object xml: name: MandatePartyAddressRequest description: | EP-16 request. Address mandate determination for a single party. Processing precedence: channelProfile → processingOptions → context. required: - channelName properties: channelName: type: string description: Required. Name of a registered channelProfile. Loads pspCountry, payerPspCountry, payeePspCountry, scheme, schemeVersion. processingOptions: allOf: - $ref: "#/components/schemas/ProcessingOptions" description: Per-request overrides — scheme, schemeVersion, payerPspCountry, payeePspCountry. context: allOf: - $ref: "#/components/schemas/Context" description: Provide sendingCountry/receivingCountry as fallback for EEA determination. ```