Get Access Request¶

Endpoint: GET /api/access-requests/{id}

Description: Returns a single access request by its unique identifier, including privileges, activity log, comments, response requirements, and related items.

Path Parameters¶

Parameter	Type	Required	Description
`id`	string (GUID)	Yes	The unique identifier of the access request.

Response Attributes¶

Field	Type	Description
`id`	string (GUID)	Unique identifier of the access request.
`kind`	string	Resource type. Always `Access Request`.
`number`	integer	Sequential access request number.
`action`	string	Action type. Values: `Add`, `Change`, `Remove`, `Suspend`, `Restore`.
`status`	string	Current status. Values: `Pending`, `Open`, `Resolved`, `Completed`, `Canceled`, `Scheduled`, `Snoozed`.
`reporter`	object	The user who created the access request.
`reporter.id`	string (GUID)	Reporter identity ID.
`reporter.name`	string	Reporter display name.
`assignee`	object	The identity assigned to fulfill the request. `null` if unassigned.
`assignee.id`	string (GUID)	Assignee identity ID.
`assignee.name`	string	Assignee display name.
`target`	object	The user or group affected by this request.
`target.type`	string	Target type. Values: `User`, `Group`.
`target.name`	string	Target name (user account name or group name).
`target.nomenclature`	string	Group nomenclature. Present only when `target.type` is `Group`.
`target.affectedIdentity`	object	The identity associated with the target. `null` for group targets.
`target.affectedIdentity.id`	string (GUID)	Identity ID.
`target.affectedIdentity.kind`	string	Always `Identity`.
`target.affectedIdentity.firstName`	string	First name.
`target.affectedIdentity.lastName`	string	Last name.
`target.affectedIdentity.emailAddress`	string	Email address.
`target.affectedIdentity.type`	string	Identity type.
`target.affectedIdentity.title`	string	Job title.
`target.affectedIdentity.company`	string	Company name.
`target.affectedIdentity.division`	string	Division name.
`target.affectedIdentity.department`	string	Department name.
`target.affectedIdentity.office`	string	Office location.
`target.affectedIdentity.supervisorName`	string	Supervisor display name.
`target.affectedIdentity.createdDate`	string (ISO 8601)	Source system created date.
`target.affectedIdentity.updatedDate`	string (ISO 8601)	Source system updated date.
`target.affectedIdentity.firstSeenDate`	string (ISO 8601)	First import date.
`target.affectedIdentity.inactivatedDate`	string (ISO 8601)	Inactivation date.
`target.affectedIdentity.status`	string	Identity status.
`target.application`	object	The application this request applies to.
`target.application.id`	string (GUID)	Application ID.
`target.application.kind`	string	Always `Application`.
`target.application.name`	string	Application name.
`target.application.priority`	string	Priority rating.
`target.application.isArchived`	boolean	Whether the application is archived.
`target.application.lastUpdated`	string (ISO 8601)	Application last updated date.
`target.privileges`	array[object]	Privilege details for this request.
`target.privileges[].initialAccess`	string	Access level before the request.
`target.privileges[].requestedAccess`	string	Requested access level.
`target.privileges[].approvedAccess`	string	Approved access level.
`target.privileges[].permission`	object	Permission details.
`target.privileges[].permission.header`	string	Permission header/category.
`target.privileges[].permission.section`	string	Permission section/role.
`target.privileges[].permission.permission`	string	Permission name.
`target.privileges[].permission.description`	string	Permission description.
`target.privileges[].permission.riskRating`	string	Risk rating. Values: `None`, `Low`, `Moderate`, `High`, `Critical`.
`target.privileges[].permission.metadata`	array[object]	Permission metadata key-value pairs.
`target.privileges[].permission.metadata[].key`	string	Metadata key.
`target.privileges[].permission.metadata[].value`	string	Metadata value.
`target.privileges[].permission.value`	string	Raw permission value.
`target.privileges[].sources`	array[string]	Sources of this privilege assignment.
`target.privileges[].origins`	array[string]	Origins of this privilege assignment.
`target.metadata`	array[object]	Request metadata key-value pairs.
`target.metadata[].key`	string	Metadata key.
`target.metadata[].value`	string	Metadata value.
`scheduledStart`	string (ISO 8601)	Scheduled start date. `null` if not scheduled.
`startedOn`	string (ISO 8601)	Date work started. `null` if not started.
`approvedOn`	string (ISO 8601)	Date approved. `null` if not approved.
`resolvedOn`	string (ISO 8601)	Date resolved. `null` if not resolved.
`verifiedOn`	string (ISO 8601)	Date verified. `null` if not verified.
`completedOn`	string (ISO 8601)	Date completed. `null` if not completed.
`canceledOn`	string (ISO 8601)	Date canceled. `null` if not canceled.
`activity`	array[object]	Chronological activity log.
`activity[].createdDate`	string (ISO 8601)	Date of the activity entry.
`activity[].author`	string	Author display name.
`activity[].action`	string	Action description. `null` if not applicable.
`activity[].content`	string	Activity detail text.
`comments`	array[object]	User comments on this request.
`comments[].createdDate`	string (ISO 8601)	Date the comment was posted.
`comments[].author`	string	Comment author display name.
`comments[].content`	string	Comment text.
`relatedItems`	array[object]	Related review items and personnel events.
`relatedItems[].id`	string (GUID)	Related item ID.
`relatedItems[].kind`	string	Related item type. Values: `Review Item`, `Personnel Event`.
`relatedItems[].number`	integer	Related item sequential number.
`relatedItems[].status`	string	Related item status.
`requirements`	array[object]	Response requirements grouped by response type.
`requirements[].type`	string	Response type (e.g., `Approve`, `Resolve`, `Verify`).
`requirements[].description`	string	Description of the response type.
`requirements[].rules`	array[object]	Requirement rules for this response type.
`requirements[].rules[].reason`	string	Reason for the requirement.
`requirements[].rules[].responses`	array[object]	Responders and their responses.
`requirements[].rules[].responses[].reviewer`	object	Reviewer identity reference.
`requirements[].rules[].responses[].reviewer.id`	string (GUID)	Reviewer identity ID.
`requirements[].rules[].responses[].reviewer.name`	string	Reviewer display name.
`requirements[].rules[].responses[].response`	string	Response status. Values: `Pending`, `Approved`, `Rejected`.
`accessModels`	array[object]	Access models associated with this request.
`accessModels[].id`	string (GUID)	Access model ID.
`accessModels[].name`	string	Access model name.
`accessModels[].description`	string	Access model description.
`accessModels[].willBeInEffect`	boolean	Whether this access model will be in effect after the request is fulfilled.

Sample Response¶

{
  "id": "a2b3c4d5-e6f7-8901-2345-6789abcdef01",
  "kind": "Access Request",
  "number": 1042,
  "action": "Remove",
  "status": "Open",
  "reporter": {
    "id": "c4d5e6f7-a8b9-0123-4567-89abcdef0123",
    "name": "Permission Assist"
  },
  "assignee": {
    "id": "e6f7a8b9-c0d1-2345-6789-abcdef012345",
    "name": "Williams, James"
  },
  "target": {
    "type": "User",
    "name": "rjohnson",
    "affectedIdentity": {
      "id": "d4a7e2b1-3f5c-4a8d-9e6b-1c2d3e4f5a6b",
      "kind": "Identity",
      "firstName": "Rachel",
      "lastName": "Johnson",
      "emailAddress": "rjohnson@firstbankofvalkyrie.com",
      "type": "Employee",
      "title": "Teller",
      "company": "First Bank of Valkyrie",
      "division": "Retail Banking",
      "department": "Branch Operations",
      "office": "Uptown Branch",
      "supervisorName": "Davis, Michelle",
      "createdDate": "2022-06-10T12:00:00Z",
      "updatedDate": "2025-10-15T16:30:00Z",
      "firstSeenDate": "2022-06-11T02:00:00Z",
      "inactivatedDate": null,
      "status": "Active"
    },
    "application": {
      "id": "b8c1d2e3-4f5a-6b7c-8d9e-0f1a2b3c4d5e",
      "kind": "Application",
      "name": "Jack Henry Symitar",
      "priority": "Critical",
      "isArchived": false,
      "lastUpdated": "2025-12-01T08:45:00Z"
    },
    "privileges": [
      {
        "initialAccess": "Unrestricted",
        "requestedAccess": "None",
        "approvedAccess": "None",
        "permission": {
          "header": "Teller Operations",
          "section": "Cash Management",
          "permission": "Process Cash Advance",
          "description": "Allows processing cash advances against credit lines",
          "riskRating": "High",
          "metadata": [
            {
              "key": "Limit",
              "value": "$10,000"
            }
          ],
          "value": "CASH_ADVANCE_PROCESS"
        },
        "sources": ["Direct Assignment"],
        "origins": ["Import #47"]
      }
    ],
    "metadata": [
      {
        "key": "Full Name",
        "value": "Rachel Johnson"
      },
      {
        "key": "Department",
        "value": "Branch Operations"
      }
    ]
  },
  "scheduledStart": null,
  "startedOn": "2025-12-02T10:00:00Z",
  "approvedOn": "2025-12-02T09:45:00Z",
  "resolvedOn": null,
  "verifiedOn": null,
  "completedOn": null,
  "canceledOn": null,
  "activity": [
    {
      "createdDate": "2025-12-01T14:30:00Z",
      "author": "Permission Assist",
      "action": "Created",
      "content": "Access request created from review finding"
    },
    {
      "createdDate": "2025-12-02T09:45:00Z",
      "author": "Davis, Michelle",
      "action": "Approved",
      "content": "Supervisor approved removal of excess permissions"
    }
  ],
  "comments": [
    {
      "createdDate": "2025-12-02T10:15:00Z",
      "author": "Williams, James",
      "content": "Removing cash advance access per review finding. Employee transferred to loan processing."
    }
  ],
  "relatedItems": [
    {
      "id": "b3c4d5e6-f7a8-9012-3456-789abcdef012",
      "kind": "Review Item",
      "number": 5421,
      "status": "Flagged"
    }
  ],
  "requirements": [
    {
      "type": "Approve",
      "description": "Approval is required before work can begin",
      "rules": [
        {
          "reason": "Supervisor approval required",
          "responses": [
            {
              "reviewer": {
                "id": "f7a8b9c0-d1e2-3456-7890-abcdef012345",
                "name": "Davis, Michelle"
              },
              "response": "Approved"
            }
          ]
        }
      ]
    }
  ],
  "accessModels": [
    {
      "id": "c5d6e7f8-a9b0-1234-5678-9abcdef01234",
      "name": "Loan Processing Officer",
      "description": "Standard access for loan processing staff",
      "willBeInEffect": true
    }
  ]
}

Error Response (404)¶

{
  "error": "not_found",
  "message": "AccessRequest with id a2b3c4d5-e6f7-8901-2345-6789abcdef01 not found",
  "correlationId": "a1b2c3d4e5f6789012345678abcdef01"
}