Embedded Components + V1 API

Leveraging the V1 Notabene API to operationalize data captured by embedded components.

V1 - txCreate (withdrawal flow)

Below is a high level withdrawal flow using a non-custodial wallet proof collected via the embedded component.

withdrawalassist + txCreate

  • The completed event returned by withdrawal assist contains a txCreate object. Some of the fields returned in the txCreate object will be need to be reformatted for the txCreate endpoint.
  • A full example of passing the component's txCreate response to the txCreate API endpoint can be found in our recipe linked below:

connectwallet + txCreate

  • The completed event returned by connectwallet contains a proof object. This can be passed to txCreate directly in the beneficiaryProof field.

V1 - txUpdate (post deposit flow)

The embedded components are used post deposit to collect missing TR data. This collection happens after txNotify:

  1. Call txNotify
  2. If data is missing - render embedded components to collect missing data
  3. Pass collected data to Notabene via txUpdate

depositassist + txUpdate

  • The completed event returned by withdrawal assist contains a txUpdate object. Some of the fields returned by the component will be need to be reformatted for the txUpdate endpoint.
  • A full example of passing the component's response to txUpdate can be found in our recipe linked below:

connectwallet + txUpdate

  • The completed event returned by connectwallet contains a proof object. The proof returned by connectwallet can be passed to txUpdate directly in the originatorProof field.


Did this page help you?