> ## 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 magic link details

> Returns full details of a specific magic link including pre-filled user data (masked), associated user CIP verification status, and operation summary if a transfer was initiated.



## OpenAPI

````yaml /raas-widgets/openapi.json get /partner/links/{linkId}
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/links/{linkId}:
    get:
      tags:
        - Partner - Magic Links
      summary: Get magic link details
      description: >-
        Returns full details of a specific magic link including pre-filled user
        data (masked), associated user CIP verification status, and operation
        summary if a transfer was initiated.
      operationId: LinksController_getLink
      parameters:
        - name: linkId
          required: true
          in: path
          description: Unique magic link identifier
          schema:
            example: link_acme_a1b2c3d4e5f6
            type: string
      responses:
        '200':
          description: Magic link details retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkDetailResponseDto'
        '401':
          description: Unauthorized — invalid or missing API key / bearer token
        '404':
          description: Magic link not found
      security:
        - api-key: []
components:
  schemas:
    LinkDetailResponseDto:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/LinkDetailDataDto'
      required:
        - success
        - data
    LinkDetailDataDto:
      type: object
      properties:
        linkId:
          type: string
          description: Unique link identifier
          example: link_acme_m2m_a1b2c3d4e5f6
        referenceId:
          type: string
          description: Reference ID in your system
          example: user-12345
        externalId:
          type: string
          description: Partner tracing ID for this link/intent
          example: ORD-2026-001
        status:
          type: string
          description: Current link status
          example: opened
          enum:
            - created
            - opened
            - revoked
        url:
          type: string
          description: Full widget URL
          example: >-
            https://flows.sandbox.raas-widgets.leapfinancial.com/link_acme_m2m_a1b2c3d4e5f6
        flow:
          type: string
          description: Flow slug that determines the widget experience
          example: m2m
        expiresAt:
          type: string
          description: Link expiration timestamp (ISO 8601)
          example: '2026-02-11T12:00:00.000Z'
        createdAt:
          type: string
          description: Link creation timestamp (ISO 8601)
          example: '2026-02-10T12:00:00.000Z'
        openedAt:
          type: string
          description: When the link was first opened (ISO 8601)
          example: '2026-02-10T13:00:00.000Z'
        revokedAt:
          type: string
          description: When the link was revoked (ISO 8601)
        config:
          type: object
          description: >-
            Flow-specific configuration (masked). Shape depends on `flow` (e.g.
            m2m exposes masked userData, flavor, themeMode).
        idImageUrl:
          type: string
          description: Temporary signed URL to the uploaded ID image (m2m)
        userId:
          type: string
          description: M2M user ID
          example: user_acme_x1y2z3
        user:
          description: Associated user CIP/verification details
          allOf:
            - $ref: '#/components/schemas/LinkUserCipDto'
        operation:
          description: Associated operation summary
          allOf:
            - $ref: '#/components/schemas/LinkOperationSummaryDto'
        metadata:
          type: object
          description: Custom metadata provided at link creation
        cipTemplateId:
          type: string
          description: >-
            Per-link Kentucky CIP template ID override used when provisioning
            the CIP ticket for this link.
          example: raas-v1
      required:
        - linkId
        - referenceId
        - status
        - url
        - flow
        - expiresAt
        - createdAt
    LinkUserCipDto:
      type: object
      properties:
        userId:
          type: string
          description: M2M user ID
          example: user_acme_x1y2z3
        status:
          type: string
          description: User lifecycle status
          example: active
        cipStatus:
          type: string
          description: CIP verification status
          example: verified
          enum:
            - pending
            - verified
            - failed
        cipProvider:
          type: string
          description: CIP verification provider
          example: kentucky
        cipVerifiedAt:
          type: string
          description: When CIP was verified (ISO 8601)
          example: '2026-02-10T14:00:00.000Z'
        cipResult:
          type: object
          description: CIP verification result details
        livenessImageUrl:
          type: string
          description: Relative URL to user liveness photo (requires partner auth)
          example: /partner/users/user_acme_x1y2z3/liveness-image
      required:
        - userId
        - status
        - cipStatus
    LinkOperationSummaryDto:
      type: object
      properties:
        operationId:
          type: string
          description: Operation ID
          example: op_acme_abc123
        status:
          type: string
          description: Operation status
          example: completed
          enum:
            - created
            - processing
            - completed
            - failed
            - cancelled
        amount:
          type: object
          description: Transfer amount details
      required:
        - operationId
        - status
  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.

````