Create a sign-in window session

Issue a short-lived URL for the HEVN sign-in window. Open it in a popup from your page: link lets the account holder connect their account and returns a code for POST /clients/link, sign lets the holder of a connected account approve one payout that waits for their signature. The result comes back on redirectUri with state.

POST /connect/sessions

Create a sign-in window session

cURL

curl --request POST \
  --url https://api.example.com/connect/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "redirectUri": "<string>"
}
'

201

{
  "url": "<string>",
  "state": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Hevn-Account · string | null

The client account to act for, as a cl_… id. Omit it to act as yourself.

Example:

"cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

Body

application/json

action · enum<string> · required

link asks the account holder to connect their account, sign to approve one payout.

Available options: link, sign

redirectUri · string · required

Page the sign-in window returns to with the result and state. Its origin must be one of the allowed origins in the sign-in window settings.

Required string length: 1 - 2048

payoutId · string | null

The payout the account holder approves. Required for sign, not accepted for link.

Pattern: ^(?:po_)?[A-Za-z0-9._:\-]{1,216}$

Example:

"po_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

Response

201

application/json

Successful Response

url · string · required

Open this URL in the sign-in window. It works once per result and expires.

state · string · required

Comes back as state on the redirect URI; match it before trusting the result.

expiresAt · string<date-time> · required

When the session URL stops working.