Launch a user into the app
⚠️ Different host. Unlike every other endpoint in this reference,
/auth/launchlives on the app host (app.etherfuse.com/sandbox.etherfuse.com), not the API host (api.etherfuse.com). It is a browser-facing page, not a JSON API.
Drops one of your users into the Etherfuse app with an authenticated session. Use it for browser flows, such as sending a user into KYB. Your server POSTs an HTML form (or redirects the browser) to this URL; the app establishes the session and redirects the user to target. To embed the flow in an iframe or popup instead, use the postMessage variant.
Targets
target must be one of Etherfuse’s allowed app paths (optionally with a query string such as ?org=<org_id>); any other path is rejected with invalid_target.
| Target | Lands the user in |
|---|---|
/kyb | Business Onboarding (KYB). Append ?org=<org_id> to pick which organization to verify; without it, the app uses their current org or prompts them to create a business. |
The JWT’s sub is strongly recommended to be a UUID identifying the person signing in (see Sign a user JWT for how sub relates to the Ramp API customerId for individuals vs businesses), and its scope follows the same rules as /auth/token. The endpoint is unauthenticated: the JWT or refresh token is the credential.
Body
urn:ietf:params:oauth:grant-type:jwt-bearer, refresh_token App path to land the user on after sign-in. Must be an allowed target (see the endpoint description); today /kyb, optionally with ?org=<org_id>. Any other path is rejected.
"/kyb"
The partner-signed JWT. Required when grant_type is urn:ietf:params:oauth:grant-type:jwt-bearer.
A refresh_token from a prior POST /auth/token exchange. Required when grant_type is refresh_token.
Optional URL to return the user to when they leave the app.
Response
An HTML page that establishes the session and redirects the browser to target.