Skip to navigation

How to read this reference

The four calls of a widget session, in the order you make them
View as Markdown

Every page under this heading is generated from the running service. What a generated page cannot tell you is which call comes first — so this one does, in about a minute.


The happy path

1

Create the session

Create Session from your backend, with your application secret. You get a session_id and the URL to open.

2

Send your customer to the widget

They consent, identify themselves and wait — the journey is the widget’s job, not yours. Redirects & Completion covers where they land when it is over.

3

Wait for something to happen

Register a webhook and we tell you when consent is signed, when a source answers late and when the session ends; or ask for the session state.

4

Read what came back

Session Results carries the structured records, and Download Attachments the official documents exactly as the administration issued them.


Two things worth knowing before you build