GSS Sanction Screening API screens payment transactions against a consolidated sanctions list, sourced from numerous global authorities, and returns an alert if there is a match. To learn more about this API, see GSS Sanction Screening API overview. In this section, you will find the technical implementation details on how to integrate with this API.

OpenAPI specifications

GSS sanction screening alerts are delivered either immediately after the request is sent or later through notifications. Refer to the steps below to set up notifications and integrate with this API.

Choose developer tools

Looking for a faster and easier way to integrate? Consider using one of the developer tools designed to simplify the consumption of API-based services available on the Swift platform. Build your application with Swift SDK to help you with lower-level application plumbing, which includes authentication, authorisation, signing and error handling. Alternatively, consider using Swift Microgateway to configure, monitor all API calls you make on Swift and capture inbound API requests. Finally, Swift zero-footprint is an option that provides reference implementations so that you can create your own SDK or utilities.

Not sure which tool is right for you? Try the connectivity option selector to get recommendations from our expert. After you select a tool, try setting it up in the API sandbox (available over the Internet) to quickly get started.

Test GSS Sanction Screening API in the Sandbox

GSS Sanction Screening API sandbox returns static sample responses and does not contain any application logic. This sandbox is recommended for developers who want to learn and understand the authentication method JWT Bearer grant type by testing it out with a self-signed certificate over the Internet. This sandbox also ensures that the application generates valid requests and can consume valid responses conforming to OpenAPI specifications. It is also recommended for developers who are trying to set up the developer tools aimed to make integration easier.

You can view, fork or download the Postman collection which includes authentication API calls and sample GSS Sanction Screening API calls. Also refer to access sandbox where dedicated sandbox credentials are provided. To start testing in the sandbox, create an app and select GSS Sanction Screening API.

Test GSS Sanction Screening API in Pilot

Swift Pilot environment closely resembles the Live environment, and it is intended to fully qualify your API integration. Make sure you are subscribed to GSS on Swift API channel (Test) and Swift Notification Service (Test). Follow the steps below to access the GSS Sanction Screening API Pilot testing environment.

Step 1: Create an app for Pilot

Create a dedicated app for testing in the Pilot environment and select GSS Sanction Screening API from the list of API products. Inside the app are consumer-key and consumer-secret which are the application credentials used to identify the application calling the API. After creating the app, promote the app to the Pilot environment.

Step 2: Create Certificate & assign RBAC role for Pilot

GSS Sanction Screening API supports the use of Business certificates and Channel certificates when signing the JWT in the authorisation API call. After creating the certificate, assign the RBAC role gss.screening.api!p to the certificate.

Step 3: Making your first test API call in the Pilot environment

After completing the steps above, you now have the credentials you need to access the GSS Sanction Screening API in the Pilot environment. Refere to Authentication to learn how to use the credentials you created above to start testing your integration with this API in Pilot.