AKakahu
Sharing Requests

Create sharing request

post/v1/applications/{applicationId}/sharing-request

Request

  • Base URL
    https://api.apply.akahu.nz
  • URL
    https://api.apply.akahu.nz/v1/applications/{applicationId}/sharing-request
  • Auth
    HTTP bearer

Path parameters

applicationIdstring required
Example:application_tz4a98xxat96iws9zmbrgj3a

Request body

requested_daysinteger required

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.

expires_in_daysinteger

The number of days from creation until this sharing request expires. Must be between 7 and 60 days.

Defaults to 30 days when not provided.

allow_manual_uploadsboolean required

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

skip_landing_pageboolean

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.

allow_multiple_submissionsboolean

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.

allow_multiple_ob_connectionsboolean

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_filterSharingRequestInstitutionStub[]

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.

redirect_uristring 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.

Response

Success

_idstring required
linkstring uri required

A URL to the Akahu Apply applicant sharing portal.

created_atstring date-time required

The date that this sharing request was created.

expires_atstring date-time required

The date that this sharing request will expire.

last_submitted_atstring date-time

The date that the applicant last submitted data through this sharing request.

Example response

{
  "_id": "sharing_request_tz4a98xxat96iws9zmbrgj3a"
}

Changes

No recorded changes to this operation across all 1 revision of this API.