v1

latestOpenAPI 3.0.02026-07-241220330.3 KB

Evaluations

Update Partial Audit Access for Evaluation

Updates the partial audit access permissions for an evaluation. This endpoint allows child customers in an Embedded Finance setup to grant partial audit access to parent organizations.

Partial audit access enables parent organizations to view specific evaluations without having full access to all data in the child account. This is useful for compliance, monitoring, and oversight purposes while maintaining appropriate data boundaries between organizations.

Important Notes:

This endpoint can only be called by child customers in an Embedded Finance relationship.
Only parent organizations with partial_audit access type can be granted access via this endpoint.
The request must include the alloy-audit-account-slugs header with comma-separated organization slugs.
Access is managed at the evaluation, entity, and related resource (e.g., bank accounts) level.
Previously granted access can be revoked by omitting the organization slug from subsequent requests.

patch/evaluations/{evaluation_token}/auditAccess

Headers

alloy-audit-account-slugsstring required

Comma-separated list of parent organization slugs to grant partial audit access. Only organizations with partial_audit access type in the Embedded Finance relationship can be included. To revoke access, omit the organization slug from this header in subsequent requests.

Request body

identifiersobject

Identifiers object (can be empty for this endpoint)

Example request

{
  "identifiers": {}
}

Response

Audit access successfully updated

status_codeinteger

{"stackTrail":"paths:/evaluations/{evaluation_token}/auditAccess:patch:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown","example":null,"nullable":true}

timestampinteger

Unix timestamp in milliseconds

Example response

{
  "status_code": 200,
  "timestamp": 1700000000000
}