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

# Create Onramp Auth Intent

> Create a Stripe Link OAuth auth intent for the embedded onramp flow.



## OpenAPI

````yaml https://api.coinvoyage.io/v3/openapi.json post /onramp/auth/intent
openapi: 3.1.0
info:
  title: CoinVoyage API (v3)
  description: >-
    CoinVoyage v3 payment API. Unified Intent envelope, snake_case money via the
    Amount shape, and a single SHA-256 signature scheme.
  version: 3.0.0
servers:
  - url: https://api.coinvoyage.io/v3
security: []
paths:
  /onramp/auth/intent:
    post:
      tags:
        - onramp
      summary: Create Onramp Auth Intent
      description: Create a Stripe Link OAuth auth intent for the embedded onramp flow.
      operationId: createStripeOnrampAuthIntent
      parameters:
        - description: API key for authentication
          in: header
          name: X-API-KEY
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkAuthIntentRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkAuthIntentResponse'
          description: Link auth intent created
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: No active Link account found for the provided email
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Invalid request body or identity value
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Failed to create Stripe Link auth intent
      security:
        - APIKeyHeader: []
components:
  schemas:
    LinkAuthIntentRequest:
      additionalProperties: false
      oneOf:
        - required:
            - email
        - required:
            - hashed_email
      properties:
        email:
          description: Customer email used to start Link OAuth authentication
          example: customer@example.com
          format: email
          type: string
        hashed_email:
          description: >-
            SHA-256 hex digest of the customer's email. Send exactly one of
            email or hashed_email.
          example: b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514
          maxLength: 64
          minLength: 64
          type: string
      type: object
    LinkAuthIntentResponse:
      properties:
        id:
          type: string
        expires_at:
          format: int64
          type: integer
        stripe_publishable_key:
          type: string
      required:
        - id
        - expires_at
        - stripe_publishable_key
      type: object
    ErrorResponse:
      example:
        code: 400
        error: Bad Request
        message: Invalid request parameters
      properties:
        error:
          example: Bad Request
          type: string
        message:
          example: Invalid request parameters
          type: string
        code:
          example: 400
          format: int64
          type: integer
        details:
          anyOf:
            - type: string
            - type: number
            - type: object
      required:
        - error
        - message
        - code
      type: object
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-API-KEY
      type: apiKey

````