---
title: "Create Onramp Auth Intent"
method: POST
path: "/onramp/auth/intent"
tags: ["onramp"]
---

# Create Onramp Auth Intent

`POST /onramp/auth/intent`

## Request

- Base URL: `https://api.coinvoyage.io/v3`
- URL: `https://api.coinvoyage.io/v3/onramp/auth/intent`
- Auth: API key in header `X-API-KEY`
- TypeScript: <https://skmtc.dev/coinvoyage/apis/coinvoyage-api-v3/docs/onramp/auth/intent/post.ts> (a function with typed inputs; its response is checked against the schema)

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

## Headers

- `X-API-KEY` string, required

## Request body

- union
  - object
    - `email` string, email, required: Customer email used to start Link OAuth authentication
    - `hashed_email` string: SHA-256 hex digest of the customer's email. Send exactly one of email or hashed_email.
  - object
    - `email` string, email: Customer email used to start Link OAuth authentication
    - `hashed_email` string, required: SHA-256 hex digest of the customer's email. Send exactly one of email or hashed_email.

## Response `201`

Link auth intent created

- LinkAuthIntentResponse
  - `id` string, required
  - `expires_at` integer, required
  - `stripe_publishable_key` string, required

## Other responses

- `401`: Unauthorized
- `404`: No active Link account found for the provided email
- `422`: Invalid request body or identity value
- `500`: Failed to create Stripe Link auth intent

---

[API](https://skmtc.dev/coinvoyage/apis/coinvoyage-api-v3.md) - [All operations](https://skmtc.dev/coinvoyage/apis/coinvoyage-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/coinvoyage/apis/coinvoyage-api-v3/revisions/3535f46f4c27?raw)