Baobyte AML SuiteCompliance intelligence

Sign in Book a demo

Documentation contents

Documentation contents

Reference

Permissions

All 87 permissions in the contract, each with the operations it gates. Generated from the OpenAPI document, so a role's real reach is visible rather than remembered.

Every operation declares the permission it requires, and the router registers each route with the permission declared in the contract. A route with no declared permission fails a test rather than defaulting to open — see the API overview.

analytics

analytics.executive.export1 operation
- GET/v1/metrics/executive/export
analytics.metric.read9 operations

audit

audit.chain.verify1 operation
- GET/v1/audit/chain-integrity
audit.event.read1 operation
- GET/v1/audit/events
audit.retention.propose1 operation
- POST/v1/audit/retention-policies/{resourceType}/proposals
audit.retention.read2 operations
- GET/v1/audit/retention-policies
- GET/v1/audit/retention-policies/{resourceType}/history

authenticated

authenticated1 operation
- GET/v1/me

cases

cases.assignment.write3 operations
cases.case.close1 operation
- POST/v1/cases/{caseID}/close
cases.case.read1 operation
- GET/v1/cases
cases.case.write2 operations
- POST/v1/cases
- POST/v1/cases/{caseID}/notes
cases.case_content.read1 operation
- GET/v1/cases/{caseID}
cases.evidence.read1 operation
- GET/v1/cases/{caseID}/attachments/{attachmentID}/content
cases.evidence.write1 operation
- POST/v1/cases/{caseID}/attachments
cases.routing.manage3 operations

config

config.document.propose1 operation
- POST/v1/config/documents/{key}
config.document.read4 operations

contentpack

contentpack.pack.install1 operation
- POST/v1/content-packs/{packID}/install
contentpack.pack.read3 operations

distribution

distribution.artifact.download1 operation
- GET/v1/report-runs/{runID}/artifact
distribution.schedule.manage5 operations
distribution.schedule.read6 operations

iam

iam.impersonation.read1 operation
- GET/v1/iam/impersonation-grants
iam.impersonation.write2 operations
- POST/v1/iam/impersonation-grants
- POST/v1/iam/impersonation-grants/{grantID}/revoke
iam.orgunit.read1 operation
- GET/v1/iam/org-units
iam.orgunit.write1 operation
- POST/v1/iam/org-units
iam.permission.read1 operation
- GET/v1/iam/permissions
iam.role.read1 operation
- GET/v1/iam/roles
iam.role.write2 operations
- POST/v1/iam/roles
- PATCH/v1/iam/roles/{roleID}
iam.service_account.manage8 operations
iam.user.read1 operation
- GET/v1/iam/users
iam.user.write4 operations

monitoring

monitoring.alert.read3 operations
monitoring.alert.triage2 operations
- POST/v1/alerts/{alertID}/assign
- POST/v1/alerts/{alertID}/close
monitoring.batch.ingest1 operation
- POST/v1/transactions/batch
monitoring.transaction.ingest1 operation
- POST/v1/transactions

onboarding

onboarding.application.decide2 operations
- POST/v1/onboarding/applications/{applicationID}/decision
- POST/v1/onboarding/documents/{documentID}/decision
onboarding.application.review2 operations
- GET/v1/onboarding/applications/{applicationID}
- GET/v1/onboarding/documents/{documentID}/content
onboarding.customer.assign1 operation
- POST/v1/customers/{customerID}/assign
onboarding.customer.edd1 operation
- POST/v1/customers/{customerID}/edd
onboarding.customer.exit1 operation
- POST/v1/customers/{customerID}/exit
onboarding.customer.read5 operations
onboarding.customer.write5 operations
onboarding.identifiers.reveal1 operation
- POST/v1/customers/{customerID}/identifiers/reveal
onboarding.ownership.verify1 operation
- POST/v1/customers/{customerID}/beneficial-owners/verification
onboarding.ownership.write1 operation
- POST/v1/customers/{customerID}/beneficial-owners

platform

platform.commercial.manage6 operations
platform.key_rotation.manage3 operations
platform.usage.read2 operations
- GET/v1/usage
- POST/v1/usage/measurements

privacy

privacy.authority.create1 operation
- POST/v1/privacy/authority-requests
privacy.authority.response_export2 operations
- POST/v1/privacy/authority-requests/{authorityRequestID}/response-exports
- GET/v1/privacy/authority-requests/{authorityRequestID}/response-exports/{exportID}
privacy.erasure.create1 operation
- POST/v1/privacy/erasures
privacy.erasure.execute1 operation
- POST/v1/privacy/erasures/{erasureID}/execute
privacy.legal_hold.release1 operation
- POST/v1/privacy/authority-requests/{authorityRequestID}/release
privacy.request.read5 operations

public

public2 operations
- GET/healthz
- GET/readyz

reporting

reporting.report.file1 operation
- POST/v1/reports/{reportID}/{action}
reporting.report.generate1 operation
- POST/v1/cases/{caseID}/reports
reporting.report.read2 operations
- GET/v1/report-schemas
- GET/v1/reports
reporting.report_content.read4 operations

rules

rules.inventory.read4 operations
rules.inventory.write2 operations
- POST/v1/model-inventory/proposals
- GET/v1/model-inventory/rule-candidates
rules.risk_model.write2 operations
- GET/v1/model-inventory/risk-model-candidates
- POST/v1/risk-models/activation
rules.rule.read5 operations
rules.rule.simulate2 operations
- GET/v1/rule-versions/{versionID}/simulations
- POST/v1/rule-versions/{versionID}/simulations
rules.rule.write3 operations
rules.validation_evidence.download1 operation
- GET/v1/model-validation-evidence/{artifactID}/content
rules.validation_evidence.read3 operations
rules.validation_evidence.recover1 operation
- POST/v1/model-validation-evidence/{artifactID}/recover
rules.validation_evidence.upload1 operation
- POST/v1/model-validation-evidence

screening

screening.hit.decide2 operations
- POST/v1/screening/hits/{hitID}/assign
- POST/v1/screening/hits/{hitID}/decision
screening.hit.read2 operations
- GET/v1/screening/hits
- GET/v1/screening/hits/{hitID}
screening.hit.reopen1 operation
- POST/v1/screening/hits/{hitID}/reopen
screening.match.suppress1 operation
- POST/v1/screening/hits/{hitID}/suppress
screening.run.create1 operation
- POST/v1/screening/runs

tenancy

tenancy.commercial.read2 operations
- GET/v1/commercial/agreements/{agreementID}/history
- GET/v1/commercial/summary
tenancy.tenant.read2 operations
- GET/v1/tenants
- GET/v1/tenants/{tenantID}
tenancy.tenant.write3 operations

watchlists

watchlists.entry.read1 operation
- GET/v1/watchlists/lists/{listKey}/entries
watchlists.list.import3 operations
watchlists.list.publish1 operation
- POST/v1/watchlists/lists/{listKey}/publish
watchlists.list.read1 operation
- GET/v1/watchlists/lists
watchlists.list.write3 operations
watchlists.source.configure2 operations
- PUT/v1/watchlists/sources/{listKey}
- POST/v1/watchlists/sources/{listKey}/refresh
watchlists.source.read1 operation
- GET/v1/watchlists/sources

workflow

workflow.approval.decide3 operations
workflow.approval.read2 operations
- GET/v1/approvals
- GET/v1/approvals/{approvalID}