v1

latestOpenAPI 3.1.02026-07-2483219318.4 KB

Sharing Requests

Get a sharing request

get/v1/applications/{applicationId}/sharing-request/{sharingRequestId}

applicationIdstring required

Example:application_tz4a98xxat96iws9zmbrgj3a

sharingRequestIdstring required

Example:sharing_request_tz4a98xxat96iws9zmbrgj3a

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.

{
  "_id": "sharing_request_tz4a98xxat96iws9zmbrgj3a"
}