API Reference

Create a Join session

get
https://api.derapi.com/join/flows//authorize

Create a Join session, and redirect to a vendor's authorization page to allow the system owner to provide their consent.

This endpoint may be accessed without Derapi authentication, since it is intended to be usable by frontend code running in system owners' browsers.

Path Params
string
required

The Join flow ID to use for the resulting session.

Query Params
string

A opaque client-supplied token which may be used to maintain state between this request and the resulting redirect to the flow's redirect URI upon authorization completion, as in OAuth 2.0.

The client should use a high-entropy random string for this value, e.g. one returned by crypto.randomUUID(). The same state parameter will be included as a query string parameter when redirecting to the flow's redirect URI.

string
required

The vendor to authorize with. Must be one of the vendors supplied when the session was created.

Headers
string
enum
Defaults to application/problem+json

Generated from available response content types

Allowed:
Responses

Updated 8 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/problem+json

Updated 8 months ago