Files
gru_emoney_token-factory/api/packages/openapi/v1/paths/compliance.yaml
defiQUG 651ff4f7eb Initial project setup: Add contracts, API definitions, tests, and documentation
- Add Foundry project configuration (foundry.toml, foundry.lock)
- Add Solidity contracts (TokenFactory138, BridgeVault138, ComplianceRegistry, etc.)
- Add API definitions (OpenAPI, GraphQL, gRPC, AsyncAPI)
- Add comprehensive test suite (unit, integration, fuzz, invariants)
- Add API services (REST, GraphQL, orchestrator, packet service)
- Add documentation (ISO20022 mapping, runbooks, adapter guides)
- Add development tools (RBC tool, Swagger UI, mock server)
- Update OpenZeppelin submodules to v5.0.0
2025-12-12 10:59:41 -08:00

168 lines
4.8 KiB
YAML

paths:
/compliance/accounts/{accountRefId}:
put:
summary: Set account compliance
description: Set compliance status for an account
operationId: setAccountCompliance
tags:
- Compliance
security:
- oauth2:
- compliance:write
x-roles:
- COMPLIANCE
parameters:
- $ref: '../components/parameters.yaml#/components/parameters/AccountRefId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '../components/schemas.yaml#/components/schemas/SetComplianceRequest'
responses:
'200':
description: Compliance updated
content:
application/json:
schema:
$ref: '../components/schemas.yaml#/components/schemas/ComplianceProfile'
get:
summary: Get account compliance
description: Get compliance profile for an account
operationId: getAccountCompliance
tags:
- Compliance
security:
- oauth2:
- compliance:read
parameters:
- $ref: '../components/parameters.yaml#/components/parameters/AccountRefId'
responses:
'200':
description: Compliance profile
content:
application/json:
schema:
$ref: '../components/schemas.yaml#/components/schemas/ComplianceProfile'
'404':
$ref: '../openapi.yaml#/components/responses/NotFound'
/compliance/wallets/{walletRefId}:
put:
summary: Set wallet compliance
description: Set compliance status for a wallet
operationId: setWalletCompliance
tags:
- Compliance
security:
- oauth2:
- compliance:write
x-roles:
- COMPLIANCE
parameters:
- $ref: '../components/parameters.yaml#/components/parameters/WalletRefId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '../components/schemas.yaml#/components/schemas/SetComplianceRequest'
responses:
'200':
description: Compliance updated
content:
application/json:
schema:
$ref: '../components/schemas.yaml#/components/schemas/ComplianceProfile'
get:
summary: Get wallet compliance
description: Get compliance profile for a wallet
operationId: getWalletCompliance
tags:
- Compliance
security:
- oauth2:
- compliance:read
parameters:
- $ref: '../components/parameters.yaml#/components/parameters/WalletRefId'
responses:
'200':
description: Compliance profile
content:
application/json:
schema:
$ref: '../components/schemas.yaml#/components/schemas/ComplianceProfile'
'404':
$ref: '../openapi.yaml#/components/responses/NotFound'
/compliance/{refId}/freeze:
put:
summary: Freeze or unfreeze
description: Freeze or unfreeze an account or wallet
operationId: setFreeze
tags:
- Compliance
security:
- oauth2:
- compliance:write
x-roles:
- COMPLIANCE
parameters:
- name: refId
in: path
required: true
schema:
type: string
pattern: '^0x[a-fA-F0-9]{64}$'
description: Account or wallet reference identifier
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- frozen
properties:
frozen:
type: boolean
description: true to freeze, false to unfreeze
responses:
'200':
description: Freeze status updated
content:
application/json:
schema:
$ref: '../components/schemas.yaml#/components/schemas/ComplianceProfile'
/compliance/{refId}:
get:
summary: Get compliance profile
description: Get compliance profile by reference ID (account or wallet)
operationId: getCompliance
tags:
- Compliance
security:
- oauth2:
- compliance:read
parameters:
- name: refId
in: path
required: true
schema:
type: string
pattern: '^0x[a-fA-F0-9]{64}$'
description: Account or wallet reference identifier
responses:
'200':
description: Compliance profile
content:
application/json:
schema:
$ref: '../components/schemas.yaml#/components/schemas/ComplianceProfile'
'404':
$ref: '../openapi.yaml#/components/responses/NotFound'