> ## Documentation Index
> Fetch the complete documentation index at: https://docs.leapfinancial.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Explore our API endpoints

Welcome to the RaaS Partner API Reference. Our platform provides a robust set of tools for integrating financial services, including:

* **Authentication & Security**: Secure access via API keys and user-specific tokens.
* **Funding & Accounts**: Support for multiple funding sources, including bank accounts and cards.
* **Operations & Network**: Real-time money transfers, currency exchange, and network corridor management.

For **sandbox base URLs**, **tokenized test card examples**, and **UBN** testing notes, see [Testing & sandbox](/raas/guides/testing-sandbox).

## mTLS Connection

It is also possible to connect to the RaaS Partner services through mutual TLS (mTLS). For mTLS connections, the base URL changes from:

`https://raas-partner-cv.nomas.cash/v1`

to:

`https://mtls-partner-cv.nomas.cash/v1`

When making calls to the mTLS base URL, you must include the certificate data in the header of the service call.

### Practical example

Below is an example demonstrating an API call using the mTLS endpoint and providing the certificate data in the request headers.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://mtls-partner-cv.nomas.cash/v1/some-endpoint" \
    -H "api_key: <API_KEY>" \
    --cert-type P12 \
    --cert ./raas-partner.p12 \
    --data '<ENDPOINT_BODY>'
  ```

  ```python Python theme={null}
  import subprocess

  subprocess.run(
      [
          "curl",
          "-X",
          "GET",
          "https://mtls-partner-cv.nomas.cash/v1/some-endpoint",
          "-H",
          "api_key: <API_KEY>",
          "--cert-type",
          "P12",
          "--cert",
          "./raas-partner.p12",
          "--data",
          "<ENDPOINT_BODY>",
      ],
      check=True,
  )
  ```

  ```javascript Node.js theme={null}
  // Prefer your HTTP client’s native TLS/mTLS options; shown for parity with cURL.
  import { execFile } from "node:child_process";

  await new Promise((resolve, reject) => {
    execFile(
      "curl",
      [
        "-X",
        "GET",
        "https://mtls-partner-cv.nomas.cash/v1/some-endpoint",
        "-H",
        "api_key: <API_KEY>",
        "--cert-type",
        "P12",
        "--cert",
        "./raas-partner.p12",
        "--data",
        "<ENDPOINT_BODY>",
      ],
      (err) => (err ? reject(err) : resolve())
    );
  });
  ```
</CodeGroup>

## Happy Path Integration

This section outlines the standard ASK workflow for a successful integration.

1. **Obtain User Token**: Use `getUserTokenV2` to resolve the RaaS `userId` for an existing user (email or phone).
2. **User Registration (Optional)**: If the user does not exist, use `registerUserV2` to create a new profile.
3. **Create Contact**: Establish a funder contact using `createContact`.
4. **Add Receiving Method**: Securely link a card via `addCard` or UBN via `addUBN`.
5. **Execute Request**: Initiate the final transaction or request using `requestV2`.

## Integration Sequence Diagram

The following diagram illustrates the typical interaction between your system and the RaaS API.

```mermaid theme={null}
sequenceDiagram
    participant Partner as Partner Backend
    participant API as RaaS API

    Partner->>API: getUserTokenV2 (Credentials)
    Note right of API: Check if user exists
    API-->>Partner: userToken (Success)

    alt User Not Found
        Partner->>API: registerUserV2 (Identity Data)
        API-->>Partner: userToken (Created)
    end

    Partner->>API: createContact (userToken, Contact Data)
    API-->>Partner: contactCreated

    Partner->>API: addCard (userToken, Card Data)
    API-->>Partner: cardLinked

    Partner->>API: requestV2 (userToken, Operation Data)
    API-->>Partner: operationSuccess
```

Some operations in the **API Reference** tabs include example request or response JSON to speed up integration; shapes follow the published OpenAPI schemas.