---
title: "Create sharing request"
method: POST
path: "/v1/applications/{applicationId}/sharing-request"
tags: ["Sharing Requests"]
---

# Create sharing request

`POST /v1/applications/{applicationId}/sharing-request`

## Path parameters

- `applicationId` string, required

## Request body

- CreateSharingRequestParams
  - `requested_days` integer, 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_days` integer — 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_uploads` boolean, required — Determines whether the applicant is given the option to supply data manually by uploading PDF documents.
  - `skip_landing_page` boolean — 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_submissions` 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`.
  - `allow_multiple_ob_connections` boolean — 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` SharingRequestInstitutionStub[] — 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_uri` string, 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 `200`

Success

- SharingRequest — You can invite your applicant to provide financial data for their Application by creating a Sharing Request. Each Sharing Request is associated with a specific Application, and you can create multiple Sharing Requests per Application. Using a Sharing Request, you can send your applicant to an Akahu Apply web page where they will be guided through the process of sharing the requested financial data. Any Resources created by the applicant during this process will automatically be attached to the associated Application.
  - `_id` string, required
  - `link` string, uri, required — A URL to the Akahu Apply applicant sharing portal.
  - `created_at` string, date-time, required — The date that this sharing request was created.
  - `expires_at` string, date-time, required — The date that this sharing request will expire.
  - `last_submitted_at` string, date-time — The date that the applicant last submitted data through this sharing request.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `429` — Too Many Requests
- `500` — Internal Server Error

---

[API](https://skmtc.dev/akahu/apis/akahu-enduring-api.md) · [All operations](https://skmtc.dev/akahu/apis/akahu-enduring-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/akahu/akahu-enduring-api/revisions/b2de9915920d/schema)