> ## 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.

# Get current partner profile

> Returns the authenticated partner's profile including name, status, environment, branding configuration, and operational settings such as allowed payment methods.



## OpenAPI

````yaml /raas-widgets/openapi.json get /partner/me
openapi: 3.0.0
info:
  title: RaaS Widgets Partner API
  description: >
    REST API for RaaS Widgets partner integrations. Create magic links for
    embeddable flows, manage end users, track transfer operations, handle CIP
    verification, and configure webhooks for real-time event notifications.


    This specification covers the **Partner-accessible API** only (`X-API-Key`
    against `/partner/*`). Widget and Superadmin APIs are out of scope.


    ## Authentication


    All endpoints require an API key passed in the `X-API-Key` header. Use
    `raas_sandbox_*` keys for the sandbox environment and `raas_live_*` keys for
    production.


    ## Environments


    | Environment | Base URL |

    |---|---|

    | Sandbox | `https://raas-widgets-backend-sandbox.up.railway.app` |
  version: 1.18.0
  contact: {}
servers:
  - url: https://raas-widgets-backend-sandbox.up.railway.app
    description: Sandbox
security: []
tags:
  - name: Partner - Magic Links
    description: Create, list, and manage magic links for flows
  - name: Partner - Flows
    description: List enabled flows and the full flow catalog
  - name: Partner - Users
    description: View and manage end users associated with your partner account
  - name: Partner - Operations
    description: Track money transfer operations and their statuses
  - name: Partner - Requests
    description: List and inspect money-request records
  - name: Partner - Deferred Payouts
    description: List, inspect, and cancel deferred payout remittances
  - name: Partner - CIP
    description: Customer Identification Program (CIP) verification management
  - name: Partner - Data Requests
    description: Fulfill data requests for additional user information
  - name: Partner - Settings
    description: Configure partner-level settings (redirect URLs, logo, etc.)
  - name: Partner - Webhooks
    description: Configure webhook endpoints and inspect delivery history
  - name: Partner - Pricing
    description: >-
      Indicative pre-quote summaries (best / worst / averages) for partner
      integrations
paths:
  /partner/me:
    get:
      tags:
        - Partner - Magic Links
      summary: Get current partner profile
      description: >-
        Returns the authenticated partner's profile including name, status,
        environment, branding configuration, and operational settings such as
        allowed payment methods.
      operationId: LinksController_getProfile
      parameters: []
      responses:
        '200':
          description: Partner profile retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerProfileResponseDto'
        '401':
          description: Unauthorized — invalid or missing API key / bearer token
      security:
        - api-key: []
components:
  schemas:
    PartnerProfileResponseDto:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/PartnerProfileDataDto'
      required:
        - success
        - data
    PartnerProfileDataDto:
      type: object
      properties:
        partnerId:
          type: string
          description: Unique partner identifier
          example: partner_acme_a1b2c3
        name:
          type: string
          description: Partner display name
          example: Acme Corp
        status:
          type: string
          description: Partner status
          example: active
          enum:
            - active
            - suspended
            - inactive
        environment:
          type: string
          description: Current environment
          example: sandbox
          enum:
            - sandbox
            - production
        logoUrl:
          type: string
          description: Partner logo URL
          example: https://cdn.example.com/logo.png
        primaryColor:
          type: string
          description: Primary brand color (hex)
          example: '#1a73e8'
        theme:
          type: string
          description: JSON theme configuration for the widget
        config:
          description: Partner configuration summary
          allOf:
            - $ref: '#/components/schemas/PartnerConfigSummaryDto'
        corridors:
          description: >-
            Effective corridors derived from the catalog (origin/destination +
            funding/payout methods enabled for this partner).
          type: array
          items:
            $ref: '#/components/schemas/WidgetCorridorDto'
        defaultCorridorCode:
          type: string
          description: >-
            Convenience field set when the partner has exactly one effective
            corridor.
        cardPolicy:
          $ref: '#/components/schemas/WidgetCardPolicyDto'
      required:
        - partnerId
        - name
        - status
        - environment
        - config
        - corridors
        - cardPolicy
    PartnerConfigSummaryDto:
      type: object
      properties:
        linkExpirationMinutes:
          type: number
          description: Default link TTL in minutes
          example: 60
        allowedApis:
          description: >-
            Partner-facing API features enabled for this partner. When omitted,
            clients should treat all known features as enabled.
          example:
            - request-money
            - pre-quote-lite
          type: array
          items:
            type: string
        cipTemplateId:
          type: string
          description: >-
            Kentucky CIP template ID used when provisioning CIP tickets for this
            partner. Can be overridden per magic link via `cipTemplateId`.
          example: raas-v1
      required:
        - linkExpirationMinutes
    WidgetCorridorDto:
      type: object
      properties:
        originCountryCode:
          type: string
          description: Origin country code (ISO 3166-1 alpha-2)
          example: US
        destinationCountryCode:
          type: string
          description: Destination country code (ISO 3166-1 alpha-2)
          example: MX
        fundingMethods:
          type: array
          description: >-
            Funding methods enabled for this partner on this (origin,
            destination) route
          example:
            - DEBIT_CARD
            - CREDIT_CARD
          items:
            type: string
            enum:
              - DEBIT_CARD
              - CREDIT_CARD
              - ACH
              - RTP
              - WALLET
              - CASH_DEPOSIT
              - BANK_BALANCE
        payoutMethods:
          type: array
          description: >-
            Payout methods reachable on this (origin, destination) route for
            this partner
          example:
            - BANK_ACCOUNT
          items:
            type: string
            enum:
              - CASH_PICKUP
              - BANK_ACCOUNT
              - PUSH_TO_CARD
              - MOBILE_WALLET
              - HOME_DELIVERY
        destinationCurrencyCodes:
          description: >-
            Destination currency codes (ISO 4217) offered on AVAILABLE
            capabilities for this route
          example:
            - MXN
            - USD
          type: array
          items:
            type: string
      required:
        - originCountryCode
        - destinationCountryCode
        - fundingMethods
        - payoutMethods
    WidgetCardPolicyDto:
      type: object
      properties:
        allowedCardBrands:
          description: Card brands accepted by this partner
          example:
            - visa
            - mastercard
          type: array
          items:
            type: string
        cardOriginPolicy:
          type: string
          description: >-
            Whether the partner accepts only US-issued cards or international
            cards
          enum:
            - us_only
            - international
          example: us_only
      required:
        - allowedCardBrands
        - cardOriginPolicy
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Your partner API key. Use `raas_sandbox_*` keys for the sandbox
        environment and `raas_live_*` keys for production.

````