Request Bank Details Verification Email

Creates a new forms request (bank_details_form) linked to a participant or provider, then emails a secure link to the requested recipient.

The email HTML template is loaded from Supabase storage bucket html_templates (see Config.BANK_DETAILS_VERIFICATION_EMAIL_TEMPLATE).

post/api/v1/cs-forms/request-bank-details-verification-email

Request body

plan_manager_idstring uuid required
email_tostring email required
participant_idstring uuid nullable
pm_provider_idstring uuid nullable
created_by_user_sidstring nullable
respondent_display_namestring nullable
flow_typestring nullable
is_blockingboolean nullable
requested_on_invoice_idinteger nullable

Response

Successful Response

{"stackTrail":"paths:/api/v1/cs-forms/request-bank-details-verification-email:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

No recorded changes to this endpoint across all 1 revision of this API.