# Introduction to Transparent API

## GSMA specification v3.2

The Transparent APIs are all part of the GSMA specification version 3.2.

{% hint style="warning" %}
The KPN RSP Gateway has not implemented all GSMA SGP.02 v3.2 API calls. Upon request more API calls can be implemented. Please contact [support](/kpn-things/rsp/help/support.md) for more information.
{% endhint %}

On the website of GSMA the complete [Remote Provisioning Architecture for Embedded UICC Technical Specification (SGP.02 v3.2)](https://www.gsma.com/newsroom/resources/sgp-02-v3-2-remote-provisioning-architecture-for-embedded-uicc-technical-specification/) has been published.

## About the Transparent APIs

We identify three types of interface for the Transparent APIs of the KPN RSP Gateway. These three types are explained in the table below.

|                                                                              | Function call  | Callback | Notification |
| ---------------------------------------------------------------------------- | -------------- | -------- | ------------ |
| *Icon*                                                                       | 💠             |          | 🔔           |
| *Interaction type*                                                           | Function calls | Outbound | Outbound     |
| [*mTLS*](/kpn-things/rsp/transparent-api/introduction.md#mtls)               | ✅              | ✅        | ✅            |
| [*WS-Security*](/kpn-things/rsp/transparent-api/introduction.md#ws-security) | ✅\*            | ❌        | ❌            |

*\*) optional, but advised by KPN.*

The following diagram illustrates the type of interactions between you and the KPN RSP Gateway.

![](/files/-MLmRfQ3mQjo8PxkQdko)

### SOAP

The Transparent APIs are all SOAP APIs. 

{% embed url="<https://www.soapui.org/learn/api/soap-vs-rest-api/>" %}

### mTLS

mTLS, short for *mutual TLS authentication*, is the **mandatory** authentication method for all incoming and outgoing connections of the Transparent API. [Learn more about mTLS](/kpn-things/rsp/transparent-api/mtls.md).

### WS-Security

WS-Security is an optional additional authentication method for incoming connections. We implemented the UsernameTokenProfile as prescribed by the GSMA specifications.

{% code title="Example from SGP.02\_v3.2 page 276" %}

```markup
<S11:Envelope xmlns:S11="..." xmlns:wsse="...">
  <S11:Header>
  …
  <wsse:Security>
    <wsse:UsernameToken>
      <wsse:Username>MyUsername</wsse:Username>
      <wsse:Password>MyPassword</wsse:Password>
    </wsse:UsernameToken>
    …
  </wsse:Security>
  …
```

{% endcode %}

Learn more about [UsernameTokenProfile from the official specification](http://docs.oasis-open.org/wss/v1.1/wss-v1.1-spec-os-UsernameTokenProfile.pdf).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.kpnthings.com/kpn-things/rsp/transparent-api/introduction.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.