API Reference

Create sharing request

post
https://api.apply.akahu.nz/v1/applications//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 applicant. This is applied at the time the applicant completes the request.

boolean
required

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

boolean
Defaults to false

Skips the sharing request landing page and navigates the applicant directly to the open banking flow.

allow_manual_uploads must be set to false to change the default value of this parameter.

boolean

Determines whether the applicant is allowed to submit more data if they return to the sharing request URL after submission.

Defaults to the same value as allow_multiple_ob_connections.

boolean
Defaults to true

Determines whether the applicant is allowed to complete multiple open banking connections as part of this sharing request. If set to false, the sharing request will submit automatically upon successful completion of an open banking connection.

allow_manual_uploads must be set to false to change the default value of this parameter.

ob_connection_filter
array of strings
length between 1 and 1

Optionally restricts which institutions are available for connection via open banking. This setting does not restrict the applicant's ability to upload documents from other institutions using the manual upload feature (if enabled).

Note: This parameter currently accepts only a single value.

ob_connection_filter
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

Updated 8 days ago

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

Updated 8 days ago