AKakahu
Sharing Requests

Get a sharing request

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

Request

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

Path parameters

applicationIdstring required
Example:application_tz4a98xxat96iws9zmbrgj3a
sharingRequestIdstring required
Example:sharing_request_tz4a98xxat96iws9zmbrgj3a

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.