Skip to main content
POST
Request a recipient-portal verification code by email

Path Parameters

client_id
integer<int64>
required
Example:

207

program_id
string
required
Example:

"11"

session_id
string
required

Body

application/json
email
string<email>
required

Recipient email. Validator rule: required|email.

Example:

"recipient@example.com"

entity_id
integer<int64> | null

Required only on the second submission when the email matched multiple entities. Validator rule: nullable|integer.

Example:

null

Response

Either the verification code was emailed (status=success) or the email matched multiple recipients and the caller must pick one (status=selection_required with entities array).

status
enum<string>
Available options:
success,
selection_required
message
string
entities
object[]