Response[WalletActor]

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/axuall/json-schema/axuall-response-wallet-actor-schema.json",
  "title": "Response[WalletActor]",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/axuall-actor-api-openapi.yml#/components/schemas/Response_WalletActor_",
  "properties": {
    "success": {
      "type": "boolean",
      "title": "Success",
      "default": true
    },
    "data": {
      "anyOf": [
        {
          "$ref": "#/$defs/WalletActor"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "type": "object",
  "$defs": {
    "Access": {
      "type": "string",
      "enum": [
        "super_user",
        "integrator",
        "admin",
        "owner",
        "recruiter",
        "operations",
        "medical_service_provider",
        "analyst",
        "recruiter_analyst",
        "owner_analyst",
        "operations_analyst",
        "read_only",
        "read_only_analyst",
        "explore_integrator",
        "explore_confirm_integrator",
        "medical_service_provider_analyst",
        "medical_service_provider_delegate",
        "delegate_only",
        "owner_delegate",
        "recruiter_delegate",
        "operations_delegate",
        "owner_analyst_delegate",
        "operations_analyst_delegate",
        "recruiter_analyst_delegate",
        "medical_service_provider_analyst_delegate"
      ],
      "title": "Access"
    },
    "ActorSettings": {
      "properties": {
        "referrer": {
          "anyOf": [
            {
              "type": "string",
              "format": "uuid4"
            },
            {
              "type": "null"
            }
          ],
          "title": "Referrer",
          "description": "Original referrer of the actor to Axuall"
        },
        "id_verification": {
          "anyOf": [
            {
              "$ref": "#/$defs/IDVerification"
            },
            {
              "type": "null"
            }
          ],
          "description": "ID Verification status for the actor"
        },
        "credential_sets": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Credential Sets",
          "description": "Credential sets associated with the actor"
        }
      },
      "type": "object",
      "title": "ActorSettings"
    },
    "IDVerification": {
      "type": "string",
      "enum": [
        "not_started",
        "pending",
        "finished",
        "invalid"
      ],
      "title": "IDVerification"
    },
    "WalletActor": {
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid4",
          "title": "Id",
          "description": "Actor's id"
        },
        "is_delegate": {
          "type": "boolean",
          "title": "Is Delegate",
          "description": "Whether the actor is a delegate"
        },
        "delegate_kind": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "subscriber",
                "external"
              ]
            },
            {
              "type": "null"
            }
          ],
          "title": "Delegate Kind",
          "description": "Kind of delegate accessing the wallet when ``is_delegate`` is true. ``null`` when the current user is not a delegate. 'subscriber' is the admin/facility delegate flow; 'external' is an external (designated) delegate."
        },
        "access_level": {
          "$ref": "#/$defs/Access",
          "description": "Actor's access level"
        },
        "actions": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Actions",
          "description": "List of actions the actor can take"
        },
        "subscriber_group": {
          "anyOf": [
            {
              "type": "string",
              "format": "uuid4"
            },
            {
              "type": "null"
            }
          ],
          "title": "Subscriber Group",
          "description": "The subscriber group id this actor belongs to"
        },
        "subscriber_group_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Subscriber Group Name",
          "description": "The name of the subscriber group this actor belongs to"
        },
        "settings": {
          "anyOf": [
            {
              "$ref": "#/$defs/ActorSettings"
            },
            {
              "type": "null"
            }
          ],
          "description": "An object of settings this actor has applied",
          "default": {}
        },
        "intercom_user_jwt": {
          "type": "string",
          "title": "Intercom User Jwt",
          "description": "Intercom user JWT token for support integration",
          "default": ""
        }
      },
      "type": "object",
      "required": [
        "id",
        "is_delegate",
        "access_level",
        "actions"
      ],
      "title": "WalletActor"
    }
  }
}