Logo
Swift API Sandbox Collections API Documentation

SwiftRef API

Number of APIs: 33


One of SWIFT's latest delivery channels for SWIFTRef reference data are Application Programming Interfaces (APIs). 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.

v4.0.0 Release notes

  • HTTP request header Accept now used for the customer expected format (JSON/XML):
    • it should only be application/json or application/xml;
    • if an unexpected accept header is received, an error 406 is returned. If not sent, the request is accepted and the default (JSON) will be applied.
  • Errors - all the V4 APIs return the error in the same format:
    • a collection, whose structure is [ {errorObject1}, {errorObject2}, ... ];
    • more_info error attribute became optional.
  • All the APIs within the OpenAPI contract have the same version. The version corresponds to the major version of the OpenAPI contract (OpenAPI contract 4.0.0 only contain V4 APIs).
  • Session cookie removed.
  • Header API-Status (API verbose) removed.
  • Response customization (EOL, colons) removed:
    • JSON responses are not returned pretty-printed, but raw.

  • OpenAPI changes

    • standardizations as per Swagger HUB rules
    • RegExp validations for each input field added
    • output format constraints added
    • standardized V4 version for all the APIs
    • 8 new endpoints added:
    • Search for PMI participants: GET /v4/pmis/participants
    • Get PMI participant details: GET /v4/pmis/participants/{participant_record_id}
    • Get PMI structure: GET /v4/pmis/{service_id}/structure
    • Get PMI details: GET /v4/pmis/{service_id}
    • Search for PMI: GET /v4/pmis
    • Get Connected BIC: GET /v4/bics/{bic}/connected_bic
    • Get BBAN elements of an IBAN (IBAN constructor metadata): GET /v4/bbans/elements
    • IBAN constructor (build IBAN): GET /v4/ibans
    • 7 existing endpoints updated:
    • Get SSIs for a BIC: GET /v4/bics/{bic}/connected_bic

    For a given BIC and a given currency code, and optionally an asset category, you can retrieve the Standing Settlement Instructions (SSIs). One or more SSIs can be returned.

    The V4 is based on the SSI Plus V3 directory. The v1.6 was based on SSI Plus V2 directory. Because the structure of SSI Plus V3 differs from the SSI Plus V2, there are several changes in the parameters: * Some request parameters changed name: * currency_code changed to iso_currency_code * ssi_category changed to asset_category * The asset category covers now all asset categories listed in the SSI Plus V3 directory. * Many new response attributes * Check validity of an IBAN (SEPA-only option added): GET /v4/ibans/{iban}/validity

    You can check whether an IBAN is valid, that is its country code, structure, length, and checksum are valid. It also checks that the bank ID exists and that it is allowed for use in the IBANs. If the bank ID is not allowed, then it is listed in the Exclusion List. This list contains bank IDs that must not be used in IBANs.

    This validity call allows for very fast, low overhead checking of the validity of an IBAN. With the new optional request parameter sepa_only, you can validate a SEPA IBAN. * One new request parameter added: sepa_only * Get details for a BIC: GET /v4/bics/{bic}

    For a given BIC, you can retrieve the details of that BIC, that is the bank name or business name, and the address.

    The V4 features ISO 20022-compliant attributes (see https://www.swift.com/resource/structured-ordering-and-beneficiary-customer-data-payments-1). * Get details for a National ID: GET /v4/national_ids/{national_id}

    For a given National ID, you can retrieve the details of that National ID, that is the bank name or business name, and the address. You must provide either a country code, or an indication to which scheme the National ID belongs.

    You can also receive the National ID's data elements (such as the name and address in the local language instead of in English), if you add the URL extension &only_local_language=true. However, the local language elements are available only for a subset of all National IDs.

    The V4 features ISO 20022-compliant attributes (see https://www.swift.com/resource/structured-ordering-and-beneficiary-customer-data-payments-1); all available national ID schemes are now returned (idtype, nationalidtype, isoclctype). * Validate National ID: `GET /v4/nationalids/{national_id}/validity`

    All available national ID schemes are available as input and returned to output (idtype, nationalidtype, isoclctype). * Get BICs of a National ID: `GET /v4/nationalids/{national_id}/bics`

    All available national ID schemes are available as input (idtype, nationalidtype, isoclctype). * Get National IDs of a BIC: `GET /v4/bics/{bic}/nationalids`

    All available national ID schemes are now returned (idtype, nationalidtype, isoclc_type); AN and FN type attribute, previously used to flag items as Alternative National ID Type or Foreign National ID Type, are not returned anymore.

Contact Support: Name: Standards & Developer Hub Email: developer-support@swift.com


1. Success-national ids/{national id} - Get BICs of a National ID.

GET {{baseUrl}}/national_ids/:national_id/bics?country_code=NZ


2. Teardown - Revoke Token

POST https://sandbox.swift.com/oauth2/v1/revoke


3. Success-bbans - Get BBAN elements of an IBAN country.

GET {{baseUrl}}/bbans/elements?country_code=BE


4. Success-leis/{lei} - Get details of a LEI.

GET {{baseUrl}}/leis/:lei

  • FAQs

  • More

    Claim this page

    Report this page

ENDPOINTS