document-requests · FinBaze for Platforms

Components

Kind: view (fills its container) · Session key: documentRequests · React: <FinBazeDocumentRequests />

Create the session#

mutation {
  createEmbedSession(input: {
    companyId: "…"
    user: { externalUserId: "…" }
    components: { documentRequests: { enabled: true } }
  }) { clientSecret }
}

Requirements#

The company must have these features effective: document_requests. A hidden feature makes createEmbedSession fail with FEATURE_DISABLED.

Component features#

Switch these off per session with components.documentRequests.features.

Feature	Default
`respond`	on
`upload`	on

Options#

Passed to instance.create("document-requests", options) or as props.

Option	Type
`requestId`	`string`	Open this request instead of the list.

Every component also takes appearance and navigation ("internal" or "external").

Events#

Event	React prop
`ready`	`onReady`
`navigate`	`onNavigate`
`error`	`onError`
`document_request.answered`	`onDocumentRequestAnswered`

Use it#

import { FinBazeDocumentRequests } from "@finbaze/embed-react";

<FinBazeDocumentRequests />

const component = instance.create("document-requests");
component.mount("#finbaze");