SharingRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/akahu/main/json-schema/akahu-sharing-request-schema.json",
  "title": "SharingRequest",
  "description": "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.\n\nUsing 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.",
  "x-generated": "2026-10-26",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/akahu-sharing-requests-api-openapi.yml#/components/schemas/SharingRequest",
  "type": "object",
  "properties": {
    "_id": {
      "$ref": "#/$defs/SharingRequestId"
    },
    "link": {
      "type": "string",
      "format": "uri",
      "description": "A URL to the Akahu Apply applicant sharing portal."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date that this sharing request was created."
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date that this sharing request will expire."
    },
    "last_submitted_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date that the applicant last submitted data through this sharing request."
    }
  },
  "required": [
    "_id",
    "link",
    "created_at",
    "expires_at"
  ],
  "$defs": {
    "SharingRequestId": {
      "type": "string",
      "pattern": "^sharing_request_[a-z0-9]{24,27}$"
    }
  }
}