Blocks
InformationRequestForm
Dynamic response form for a single information request.
Renders supported question types (text and document upload) based on the request's
requiredQuestions payload and submits responses to the Submit information request
endpoint. Use this component directly when you have built your own list or routing
surface and need to host the form — typically inside a modal or page you control.
Requests with unsupported response types (e.g. persona-driven identity verification)
display a guidance message instead of the form; in those cases the user must complete
the request through your own integration with the underlying provider.
Text inputs accept up to 5,000 characters. Document uploads are restricted to JPEG, PNG, or PDF.
Remarks
Events emitted via onEvent:
InformationRequestFormProps
Props for InformationRequestForm.
| Property | Type | Description |
|---|---|---|
companyId | string | The associated company identifier. |
onEvent | OnEventType<EventType, unknown> | Event handler invoked when the form is submitted or cancelled. See the events table in InformationRequestForm. |
requestId | string | The identifier of the information request to respond to. |
dictionary? | Record<"en", DeepPartial<InformationRequestsInformationRequestForm>> | Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details. |
Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.
Events
| Event | Description | Data |
|---|---|---|
informationRequest/form/done | Fired when the form is successfully submitted | The informationRequest field from the Submit information request response |
informationRequest/form/cancel | Fired when the user cancels the form | — |
Endpoints
| Method | Path |
|---|---|
| GET | /v1/companies/:companyUuid/information_requests |
| PUT | /v1/information_requests/:informationRequestUuid/submit |
InformationRequestList
Displays the list of outstanding information requests for a company with a "Respond" CTA on each open request.
Remarks
Renders status badges for each request and an extra "Payroll blocking" badge when the request is currently blocking payroll. Approved requests are filtered out of the list. Used as the top-level surface of InformationRequests.InformationRequestsFlow, but can be rendered directly when you want to host the response form yourself (e.g. in a custom modal or page).
InformationRequestListProps
Props for InformationRequestList.
| Property | Type | Description |
|---|---|---|
companyId | string | The associated company identifier. |
onEvent | OnEventType<EventType, unknown> | Event callback. See the events table on InformationRequestList for emitted events. |
dictionary? | Record<"en", DeepPartial<InformationRequestsInformationRequestList>> | Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details. |
Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.
Events
| Event | Description | Data |
|---|---|---|
informationRequest/respond | Fired when the user clicks "Respond" on an open request | { requestId: string } |
Endpoints
| Method | Path |
|---|---|
| GET | /v1/companies/:companyUuid/information_requests |