Create sharing request

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
integer
required
30 to 365

How much historical data (i.e. bank statements) will be requested of the user. This is applied at the time the user completes the request.

boolean
required

Determines whether the user is given the option to supply data manually by uploading PDF documents.

boolean
Defaults to true

Determines whether the user is allowed to submit data multiple times using this sharing link. Defaults to true.

uri

The https uri to redirect to after the sharing request is used. This can contain query parameters, e.g. for passing state.

This is optional and can be used to redirect the user to a specific page after they have successfully connected their accounts. If not provided, the user will be told that they can close the page.

If the user cancels the flow without adding any statements, they will be redirected to this uri with the query parameters applicationId={applicationId}&sharingRequestId={sharingRequestId}&action=cancelled.

If the user adds any statements, they will be redirected to this uri with the query parameters applicationId={applicationId}&sharingRequestId={sharingRequestId}&action=submitted.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json