API Introduction

---

Introduction

When integrating with the FullCircl systems, we have two environments that we support for helping our customers with their integration journey. This article will briefly describe some of the key concepts around our API, however we do have a full set of developer documentation available that has more information on the structure and precise nature of how to utilise the services and products available via our API.

---

Endpoints

We have two environments available for customers to use, a UAT environment which can be used for development and testing, and a Production environment for final testing and live checks. Usually we keep both of these environments active for our customers, so they can utilise the UAT environment as a test bed when making changes to other parts of their systems. The URLs for each environment are detailed below:

UAT

REST Endpoint: https://api-uat.w2globaldata.com

Portal URL: https://portal-uat.w2globaldata.com

Production

REST Endpoint: https://api.w2globaldata.com

Portal URL: https://portal.w2globaldata.com

If you need an account creating on the portals of either of these environments, please contact our support team

---

Bundles

Within the API system, we utilise bundles to give customers access to the services they have subscribed to. A bundle is simply a collection of one or more services, with an interpretation of the result obtained from the service.

An example of two bundles are below:

Example 1

• Bundle Name: ExampleBundle_KYC_SIS
• Services: Standard International Sanctions (SIS)
• Interpretation:
  
  No matches found = Pass, One or More matches found = Fail.

Example 2

• Bundle Name: ExampleBundle_KYC_005_Watchlist
• Services: UK eKYC (005) and International Watchlist Check

• Interpretation: 

  UK eKYC Result	Watchlist Result	Overall Result
  Pass	No Matches	Pass
  Refer	No Matches	Refer
  Fail	No Matches	Fail
  Pass	One or More Matches	Refer
  Refer/Fail	One of More Matches	Fail

---

Sandbox

In addition to having an environment for test purposes, we also have a Sandbox mode than can be enabled and disabled on a per request basis. When utilising Sandbox mode, you will need to consult the developer documentation to find an example Sandbox case that will work with the service you are testing/integrating.

To enable or disable Sandbox mode, you can include a Query Option, with the key-value pair of "Sandbox" and "true" (or "false" to disable). If you don't include this option, we will default to having sandbox set to false.

The Sandbox cases are set to return a pre-determined result that is static, so you can utilise these for testing having a controlled response to ensure that your system is handling the response from the services correctly.

When using these Sandbox cases, you must ensure that all fields that are present on the documentation are included - if any are missing the Sandbox case will not match and you won't get the desired result.

An example of a Sandbox case for a particular service is shown below: