company-search · FinBaze for Platforms

Components

Kind: element (inline) · Session key: companySearch · React: <FinBazeCompanySearch />

Create the session#

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

Requirements#

No feature requirements.

Component features#

None.

Options#

Passed to instance.create("company-search", options) or as props.

Option	Type
`country`	`'NL' \| 'GB'`	The register to search: NL (KvK, default) or GB (Companies House).
`label`	`string`	The field label.
`disabled`	`boolean`	Show the field but do not allow changes.

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

Events#

Event	React prop
`ready`	`onReady`
`navigate`	`onNavigate`
`error`	`onError`
`select`	`onSelect`

Use it#

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

<FinBazeCompanySearch />

const component = instance.create("company-search");
component.mount("#finbaze");