Skip to main content
POST
Verify the recipient-portal login code

Path Parameters

client_id
integer<int64>
required
Example:

207

Body

application/json
email
string<email>
required

Validator rule: required|email.

Example:

"recipient@example.com"

entity_id
integer<int64>
required

Validator rule: required|integer.

Example:

4711

verification_code
string
required

Six-digit numeric code from the verification email. Submit it as a string so leading zeros are preserved. Validator rule: required|string|size:6|regex:/^[0-9]{6}$/.

Required string length: 6
Pattern: ^[0-9]{6}$
Example:

"012345"

Response

Verification succeeded; session is now logged-in.

status
string
Example:

"success"

session_id
string

Redis session id to send on subsequent recipient-portal requests.

recipient
object
client
object
program
object | null