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

# Check CIP readiness for a link

> Checks whether a magic link has enough user data to run CIP (Customer Identification Program) verification. This is a read-only check that does not create tickets or log activity. Use this before calling the create ticket endpoint to ensure all required fields are present.



## OpenAPI

````yaml /m2m/openapi.json get /partner/cip/readiness/{linkId}
openapi: 3.0.0
info:
  title: M2M Partner API
  description: >
    REST API for M2M partner integrations. Create magic links to enable
    cross-border money transfers, manage end users, track transfer operations,
    handle CIP verification, and configure webhooks for real-time event
    notifications.


    ## Authentication


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


    ## Environments


    | Environment | Base URL |

    |---|---|

    | Sandbox | `https://m2m-backend-qa.up.railway.app` |
  version: 0.5.3
  contact: {}
servers:
  - url: https://m2m-backend-qa.up.railway.app
    description: Sandbox
security: []
tags:
  - name: Partner - Magic Links
    description: Create, list, and manage magic links for money transfers
  - 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 - 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, etc.)
  - name: Partner - Webhooks
    description: Configure webhook endpoints and inspect delivery history
paths:
  /partner/cip/readiness/{linkId}:
    get:
      tags:
        - Partner - CIP
      summary: Check CIP readiness for a link
      description: >-
        Checks whether a magic link has enough user data to run CIP (Customer
        Identification Program) verification. This is a read-only check that
        does not create tickets or log activity. Use this before calling the
        create ticket endpoint to ensure all required fields are present.
      operationId: CipController_checkReadiness
      parameters:
        - name: linkId
          required: true
          in: path
          description: Unique magic link identifier to check readiness for
          schema:
            example: link_acme_a1b2c3d4e5f6
            type: string
      responses:
        '200':
          description: CIP readiness status retrieved
        '401':
          description: Unauthorized — invalid or missing API key / bearer token
        '404':
          description: Magic link not found
      security:
        - bearer: []
        - api-key: []
components:
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your partner API key. Use `m2m_test_*` keys for the sandbox environment.

````