API reference
Reviewed Access grants
4 management API operations for Reviewed Access grants.
/v1/institutions/{institution_id}/access-grant-reviewsList exact Access grant reviews and candidates
POST/v1/institutions/{institution_id}/access-grant-reviewsPropose independent review of one Access version
POST/v1/institutions/{institution_id}/access-grant-reviews/{review_id}/approveIndependently approve an exact Access review
POST/v1/institutions/{institution_id}/access-grant-reviews/{review_id}/revokeRevoke a reviewed Access decision
GET/v1/institutions/{institution_id}/access-grant-reviews
List exact Access grant reviews and candidates
Requires a current actual Institution Sponsor or effective administrator with active membership. Current validity and product acknowledgement are read-time facts, not assignment authority.
Authentication Bearer access token with audience taifa-management. Roles and local eligibility are reviewed separately from the OpenAPI bearer scheme.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
institution_id | path | string | Yes |
Request body
This operation has no request body.
Responses
200Successful Response
Content type: application/jsonGrantReviewList
| Field | Type | Required | Description |
|---|---|---|---|
institution | InstitutionDisplay | Yes | |
reviews | GrantReviewRead[] | Yes | |
candidates | GrantCandidate[] | Yes | |
_actions | propose[] | Yes |
Other responses
| Status | Description | Schema |
|---|---|---|
| 422 | Validation Error | HTTPValidationError |
POST/v1/institutions/{institution_id}/access-grant-reviews
Propose independent review of one Access version
A current actual Sponsor proposes the exact active Access version. The accepted receipt records no issuer assignment. Exact idempotency replay returns the original receipt.
Authentication Bearer access token with audience taifa-management. Roles and local eligibility are reviewed separately from the OpenAPI bearer scheme.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
institution_id | path | string | Yes | |
idempotency-key | header | string | Yes |
Request body
application/jsonRequiredGrantProposal
| Field | Type | Required | Description |
|---|---|---|---|
reason | string | Yes | Validation: min length 8; max length 500 |
access_id | string | Yes | Validation: min length 1; max length 200 |
access_version | integer | Yes | Validation: minimum 1; maximum 9223372036854775807 |
Responses
201Successful Response
Content type: application/jsonGrantReceipt
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
status | pending_review | approved | revoked | superseded | Yes | |
access_id | string | Yes | |
access_version | integer | Yes | |
project_id | string | Yes | |
beneficiary_person_id | string | Yes | |
beneficiary_issuer | string | Yes | |
beneficiary_subject | string | Yes | |
beneficiary_person_version | integer | Yes | |
beneficiary_membership_id | string | Yes | |
beneficiary_membership_version | integer | Yes | |
event_id | string | Yes | |
event_sequence | integer | Yes | |
event_digest | string | Yes | |
source_request_id | string | null | Yes | |
sponsor_id | string | Yes | |
sponsor_generation | integer | Yes | |
sponsor_actor | string | Yes | |
sponsor_person_id | string | Yes | |
sponsor_person_version | integer | Yes | |
sponsor_membership_id | string | Yes | |
sponsor_membership_version | integer | Yes | |
sponsor_fingerprint | string | Yes | |
sponsor_audit_id | string | Yes | |
sponsor_operation | string | Yes | |
sponsor_target | string | Yes | |
administrator_proposal_id | string | null | Yes | |
administrator_generation | integer | null | Yes | |
administrator_actor | string | null | Yes | |
administrator_person_id | string | null | Yes | |
administrator_person_version | integer | null | Yes | |
administrator_membership_id | string | null | Yes | |
administrator_membership_version | integer | null | Yes | |
approved_fingerprint | string | null | Yes | |
administrator_audit_id | string | null | Yes | |
administrator_operation | string | null | Yes | |
administrator_target | string | null | Yes | |
created_at | string | Yes | |
expires_at | string | Yes |
Other responses
| Status | Description | Schema |
|---|---|---|
| 422 | Validation Error | HTTPValidationError |
POST/v1/institutions/{institution_id}/access-grant-reviews/{review_id}/approve
Independently approve an exact Access review
A distinct current effective administrator approves the locked Sponsor decision and exact grant Event. Dynamic validity is available from the scoped list.
Authentication Bearer access token with audience taifa-management. Roles and local eligibility are reviewed separately from the OpenAPI bearer scheme.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
institution_id | path | string | Yes | |
review_id | path | string | Yes | |
idempotency-key | header | string | Yes |
Request body
application/jsonRequiredidentity__access_grant_review_router__Reason
| Field | Type | Required | Description |
|---|---|---|---|
reason | string | Yes | Validation: min length 8; max length 500 |
Responses
200Successful Response
Content type: application/jsonGrantReceipt
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
status | pending_review | approved | revoked | superseded | Yes | |
access_id | string | Yes | |
access_version | integer | Yes | |
project_id | string | Yes | |
beneficiary_person_id | string | Yes | |
beneficiary_issuer | string | Yes | |
beneficiary_subject | string | Yes | |
beneficiary_person_version | integer | Yes | |
beneficiary_membership_id | string | Yes | |
beneficiary_membership_version | integer | Yes | |
event_id | string | Yes | |
event_sequence | integer | Yes | |
event_digest | string | Yes | |
source_request_id | string | null | Yes | |
sponsor_id | string | Yes | |
sponsor_generation | integer | Yes | |
sponsor_actor | string | Yes | |
sponsor_person_id | string | Yes | |
sponsor_person_version | integer | Yes | |
sponsor_membership_id | string | Yes | |
sponsor_membership_version | integer | Yes | |
sponsor_fingerprint | string | Yes | |
sponsor_audit_id | string | Yes | |
sponsor_operation | string | Yes | |
sponsor_target | string | Yes | |
administrator_proposal_id | string | null | Yes | |
administrator_generation | integer | null | Yes | |
administrator_actor | string | null | Yes | |
administrator_person_id | string | null | Yes | |
administrator_person_version | integer | null | Yes | |
administrator_membership_id | string | null | Yes | |
administrator_membership_version | integer | null | Yes | |
approved_fingerprint | string | null | Yes | |
administrator_audit_id | string | null | Yes | |
administrator_operation | string | null | Yes | |
administrator_target | string | null | Yes | |
created_at | string | Yes | |
expires_at | string | Yes |
Other responses
| Status | Description | Schema |
|---|---|---|
| 422 | Validation Error | HTTPValidationError |
POST/v1/institutions/{institution_id}/access-grant-reviews/{review_id}/revoke
Revoke a reviewed Access decision
Retains the immutable decision evidence while ending its review authority. It does not change the underlying Access grant.
Authentication Bearer access token with audience taifa-management. Roles and local eligibility are reviewed separately from the OpenAPI bearer scheme.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
institution_id | path | string | Yes | |
review_id | path | string | Yes | |
idempotency-key | header | string | Yes |
Request body
application/jsonRequiredidentity__access_grant_review_router__Reason
| Field | Type | Required | Description |
|---|---|---|---|
reason | string | Yes | Validation: min length 8; max length 500 |
Responses
200Successful Response
Content type: application/jsonGrantReceipt
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
status | pending_review | approved | revoked | superseded | Yes | |
access_id | string | Yes | |
access_version | integer | Yes | |
project_id | string | Yes | |
beneficiary_person_id | string | Yes | |
beneficiary_issuer | string | Yes | |
beneficiary_subject | string | Yes | |
beneficiary_person_version | integer | Yes | |
beneficiary_membership_id | string | Yes | |
beneficiary_membership_version | integer | Yes | |
event_id | string | Yes | |
event_sequence | integer | Yes | |
event_digest | string | Yes | |
source_request_id | string | null | Yes | |
sponsor_id | string | Yes | |
sponsor_generation | integer | Yes | |
sponsor_actor | string | Yes | |
sponsor_person_id | string | Yes | |
sponsor_person_version | integer | Yes | |
sponsor_membership_id | string | Yes | |
sponsor_membership_version | integer | Yes | |
sponsor_fingerprint | string | Yes | |
sponsor_audit_id | string | Yes | |
sponsor_operation | string | Yes | |
sponsor_target | string | Yes | |
administrator_proposal_id | string | null | Yes | |
administrator_generation | integer | null | Yes | |
administrator_actor | string | null | Yes | |
administrator_person_id | string | null | Yes | |
administrator_person_version | integer | null | Yes | |
administrator_membership_id | string | null | Yes | |
administrator_membership_version | integer | null | Yes | |
approved_fingerprint | string | null | Yes | |
administrator_audit_id | string | null | Yes | |
administrator_operation | string | null | Yes | |
administrator_target | string | null | Yes | |
created_at | string | Yes | |
expires_at | string | Yes |
Other responses
| Status | Description | Schema |
|---|---|---|
| 422 | Validation Error | HTTPValidationError |