Bank Details Verification Status

Returns whether bank-details verification is enabled for this plan manager (requires an enabled forms_org_admin row with auto_gen_template_metadata.template_id == 'bank_details_form'), and the current verification state for the linked participant/provider.

get/api/v1/cs-forms/bank-details-verification-status

Query parameters

plan_manager_idstring uuid required
participant_idstring uuid nullable
pm_provider_idstring uuid nullable

Response

Successful Response

eligibleboolean required
statusstring required
forms_org_admin_idstring uuid nullable
form_request_idstring uuid nullable
form_urlstring nullable
verified_atstring nullable
bank_change_idstring uuid nullable
bank_change_statusstring nullable
is_connectid_verifiedboolean nullable

Changes

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