Skip to main content
GET
Render the recipient-portal login page

Path Parameters

client_id
integer<int64>
required

Client (tenant) the recipient belongs to.

Example:

207

program_id
string
required

Program id, or none/0 for general (non-program-scoped) login.

Example:

"11"

session_id
string
required

Existing Redis recipient-portal session id; when omitted a new one is generated.

Example:

"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2"

Response

200 - application/json

Login page payload + session id.

status
string
Example:

"success"

session_id
string
client_id
integer<int64>
program_id
string
organization
string
logo
string | null
recipient_portal_enabled
boolean
program
object | null