Integrate with SwiftRef for BIC Validation

The Appian adapter for Swift maintains a local Business Identifier Code (BIC) directory to validate BICs in inbound messages, outbound messages, and Swift Case Management API requests. This page explains how the BIC directory integration works and what to expect during operation.

For configuration steps, see Set up BIC directory integration in the setup guide.

How the BIC directory integration works

The Appian adapter for Swift does not connect directly to SwiftRef. Instead, you configure an SFTP server from which the adapter downloads the monthly SwiftRef BIC reference file.

The integration follows this sequence:

1. Your organization procures the comprehensive BIC file from SwiftRef.
2. You transfer the file to a designated directory on your SFTP server whenever SwiftRef publishes an update monthly.
3. The Appian adapter for Swift connects to the SFTP server on a configured schedule, scans the designated directory, and downloads any unprocessed files.
4. The adapter ingests the file and fully replaces the local BIC directory with the contents of the new file. The adapter expects complete files, not deltas.

File tracking and auditing

The Appian adapter for Swift tracks each file that it processes for auditing purposes. The adapter identifies files by name:

• Processed files: If a file has been processed successfully, future executions skip it. The module does not reprocess a file with the same name.
• Failed files: If a file fails to process correctly, the adapter sends an email notification to the SMM Administrators group. The failed file remains eligible for reprocessing on the next scheduled execution.

BIC validation behavior

After the BIC directory is populated, the Appian adapter for Swift uses it to validate Business Identifier Codes in the following contexts:

• Inbound messages: BICs in incoming MT and MX messages are validated against the local directory when the validateBic parameter is set to true.
• Outbound messages: BICs in outgoing messages are validated before transmission when the validateBic parameter is set to true.
• Swift Case Management requests: BICs in case management API requests are validated when the validateBic parameter is set to true.

If BIC validation is not required or the BIC directory has not been populated, set the validateBic parameter to false in your API requests.

Configuration constants

The following constants control the BIC directory integration behavior. Configure these in Appian Designer after installation. For step-by-step instructions, see Set up BIC directory integration.

Constant	Description
SMM_START_BIC_PROCESS_MODEL	Set to TRUE to enable the scheduled BIC directory refresh.
SMM_BIC_PM_RECURRENCE_INTERVAL_DAYS	Time interval in days between each BIC refresh cycle.
SMM_BIC_PM_RECURRENCE_INTERVAL_TIME	Time of day at which to run the BIC refresh.
SMM_SFTP_SERVER_FILE_PATH	Path to the folder on the SFTP server containing the SwiftRef file.
SMM_SFTP_SCS_EXTERNAL_SYSTEM_KEY	Key for the third-party credential store entry containing the SFTP server credentials.
SMM_SFTP_SERVER_PORT	Port on the SFTP server. Defaults to 22 if not specified.
SMM_SFTP_SERVER_HOSTNAME	Hostname or IP address of the SFTP server.

Next steps

After configuring the SwiftRef integration, verify it is working correctly:

• Test Messages in the Sandbox to run sample messages with BIC validation enabled and confirm that BICs are validated against the local directory.
• View Swift Messages to review processing issues related to BIC validation on live messages.

Feedback