Allianz Technology Standards

aid: allianz-technology-standards
url: https://raw.githubusercontent.com/api-evangelist/allianz-technology-standards/refs/heads/main/apis.yml
name: Allianz Technology Standards
tags:
- Best Practices
- Enterprise Architecture
- Guidelines
- Software Development
- Technology Standards
- API Design
- OpenAPI
type: Index
image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg
description: A collection of technology standards and guidelines maintained by Allianz for software development, API design,
  architecture, and engineering practices. Allianz follows API-first development using OpenAPI specifications, Backend for
  Frontends (BFF) architecture, and standardized patterns for pagination, sorting, webhooks, and asynchronous processing.
created: '2024-01-01'
modified: '2026-06-20'
specificationVersion: '0.19'
apis:
- aid: allianz-technology-standards:allianz-trade-api-standards
  name: Allianz Trade API Design Standards
  tags:
  - API Design
  - Guidelines
  - REST API
  - OpenAPI
  properties:
  - url: https://developers.allianz-trade.com/docs/api-design-guidelines
    type: Documentation
  - url: https://developers.allianz-trade.com/
    type: Portal
  - url: overlays/allianz-technology-standards-compliance-overlay.yaml
    type: Overlay
  description: Allianz Trade API design guidelines covering REST API conventions, pagination standards (pageSize, page, totalRequired),
    sorting conventions, asynchronous processing with JobID management, webhook notification patterns, and security requirements
    for API integrations.
  humanURL: https://developers.allianz-trade.com/docs/api-design-guidelines
  baseURL: https://developers.allianz-trade.com
- aid: allianz-technology-standards:allianz-backend-standards
  name: Allianz Backend Development Standards
  tags:
  - Backend
  - Java
  - Kotlin
  - Spring Boot
  - Architecture
  properties:
  - url: https://globaldigitalfactory.allianz.com/blog/finally-talking-about-backend-.html
    type: Documentation
  description: Allianz Global Digital Factory backend development standards. Uses Java and Kotlin with Spring Boot for microservices,
    API-first approach with OpenAPI specifications, Backend for Frontends (BFF) architecture, and comprehensive automated
    testing practices.
  humanURL: https://globaldigitalfactory.allianz.com/blog/finally-talking-about-backend-.html
  baseURL: https://globaldigitalfactory.allianz.com
common:
- type: VulnerabilityDisclosure
  url: security/allianz-technology-standards-vulnerability-disclosure.yml
- type: DomainSecurity
  url: security/allianz-technology-standards-domain-security.yml
- type: Authentication
  url: authentication/allianz-technology-standards-authentication.yml
- type: OAuthScopes
  url: scopes/allianz-technology-standards-scopes.yml
- url: https://github.com/Allianz
  type: GitHubOrganization
- url: https://www.allianz.com/
  type: Website
- url: https://globaldigitalfactory.allianz.com/
  type: Blog
- url: rules/allianz-technology-standards-spectral-rules.yml
  type: SpectralRules
- url: vocabulary/allianz-technology-standards-vocabulary.yaml
  type: Vocabulary
- url: packages/allianz-technology-standards-packages.yml
  type: Packages
- url: well-known/allianz-technology-standards-well-known.yml
  type: WellKnown
- url: mcp/allianz-technology-standards-mcp.yml
  type: MCPServer
- url: llms/allianz-technology-standards-llms.txt
  type: LLMsTxt
- url: conformance/allianz-technology-standards-conformance.yml
  type: Conformance
- url: errors/allianz-technology-standards-problem-types.yml
  type: ErrorCatalog
- url: lifecycle/allianz-technology-standards-lifecycle.yml
  type: Lifecycle
- type: Features
  data:
  - name: API First Development
    description: Allianz mandates API-first design using OpenAPI specifications before implementation, enabling frontend teams
      to work with mock servers independently.
  - name: Pagination Standards
    description: Standardized pagination using pageSize (default 20), page (default 1), and totalRequired parameters with
      Total-Items and Total-Pages response headers.
  - name: Asynchronous Processing Pattern
    description: JobID-based pattern for POST/PATCH/DELETE operations returning a job identifier that clients poll until status
      transitions from pending to processed.
  - name: Webhook Notification Standards
    description: Standardized webhook patterns with technical and functional notification types, HTTPS requirement, IP whitelisting,
      and pre-signed URL support.
  - name: OAuth2 Security Standard
    description: Allianz Trade APIs standardize on OAuth2 client credentials for programmatic API authentication across all
      API products.
  - name: Backend for Frontends Architecture
    description: BFF pattern where each backend service serves a single frontend, enabling clean separation and independent
      product team decisions.
- type: UseCases
  data:
  - name: API Standards Compliance
    description: Verify that Allianz API implementations conform to documented design guidelines for pagination, sorting,
      webhooks, and authentication.
  - name: Developer Onboarding
    description: Guide new developers on Allianz technology conventions for Java/Kotlin backend services, Spring Boot frameworks,
      and OpenAPI documentation.
  - name: Architecture Review
    description: Use BFF and API-first standards as criteria for architecture reviews and technical decision documentation.
- type: Integrations
  data:
  - name: OpenAPI Initiative
    description: Allianz follows the OpenAPI Specification as the standard format for API documentation and developer portal
      integration.
  - name: Swagger UI
    description: Swagger UI used to make API documentation live and executable from OpenAPI specifications.
  - name: Spring Boot
    description: Spring Boot is the standard framework for delivering Allianz backend services with REST, security, caching,
      and logging.
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com