---

SwiftRef APIs offer financial institutions, corporates and third-party Service Providers an automated data look-up service for real-time identification and validation of critical payments reference data within the SwiftRef utility. To learn more about this API, see SwiftRef API Overview. In this section, you will find information on how to integrate, test and go live with SwiftRef API.

OpenAPI specification and technical specifications

Refer to the SwiftRef API Reference and the Technical Specifications to help you integrate this API. You will find all the API versions that are available in the Live environment as well as the future version, the implementation of which is still underway. Published OpenAPI specifications are final, so you can start your integration at any time.

Test SwiftRef API in the Sandbox

We recommend that you test your integration with SwiftRef API in the sandbox before going Live. The SwiftRef API sandbox behaves exactly the same as Live environment. You can use it to fully test your application. To start testing in the sandbox, follow the steps below.

1Create an app and select SwiftRef API. 2Find dedicated sandbox credentials for password grant type security scheme. 3Click the "Run in Postman" button to view, fork or download the Postman collection which includes authentication API calls and sample SwiftRef API calls.

Rate limit

The limit for SwiftRef API Sandbox is 500 calls per developer per month, however this limit is NOT applicable for SwiftRef API Live environment.

The limit for SwiftRef API Live is 200 calls per app per second for v5 and 100 calls per app per second for v4.

Order SwiftRef API

After successfully testing your application integration with SwiftRef API sandbox, and if you want to use this API in Live, refer to How to get this API and submit your SwiftRef API order. If you are not sure which SwiftRef product to order, then find out which APIs are included in which products here.

Go Live

After the creation of your SwiftRef API contract, you can follow these steps below to gain access to the Live APIs.

Step 1: Create a dedicated account for SwiftRef APIs on Swift.com

Use a generic e-mail address from your organisation as the dedicated swift.com account for SwiftRef API. Create this dedicated account on swift.com by following the Registration Guide to ensure it is linked to your institution.

Step 2: Grant access to SwiftRef API on Swift.com

As a SwiftRef User Administrator, follow the applicable steps below to grant access to the dedicated account that will call the SwiftRef API.

1Grant Access to the Contract For Swift Essentials customers going Live with SwiftRef Identifiers API, this is the only required access to grant.

2Grant Access to the Daily Update This step is required if you have a SwiftRef product with Daily Update and Download Automation and you want to use the SwiftRef API entitlement of this product.

3Grant Access to the Download Automation This step is required if you have a SwiftRef product with Daily Update and Download Automation and you want to use the SwiftRef API entitlement of this product.

Step 3: Create License ID and License Secret

1As a Swift.com Admin for your institution, set up your Swift API Administrators. 2As Swift API Administrator for your institution, create a License ID and Secret for your contract.

Step 4: Create an app with the dedicated e-mail and promote the app

1Use the dedicated account for SwiftRef to log in to Swift Developer Portal through the option Sign in via Swift.com. 2Create an app with SwiftRef API. 3From My Apps, select the app you created. 4Click the Promote app button. 5Confirm the details in the pop up. 6Submit the request by clicking Promote.

Step 5: Submit your customer number

Step 5: Calling SwiftRef API in live

Refer to Authentication to use the credentials created above to access SwiftRef API in Live.