openapi: 3.0.3
info:
  title: Allianz API Connect Certificates Policy Details API
  description: Allianz API Connect provides partner APIs for embedding Australian insurance products including home and contents, landlord, and comprehensive car insurance. Enables price estimation, quoting, lead referral, and certificate retrieval within partner digital journeys.
  version: 1.0.0
  contact:
    name: Allianz Partners Support
    url: https://www.allianz.com.au/about-us/work-with-us/partners/api-connect.html
  x-generated-from: documentation
servers:
- url: https://api.allianz.com.au/v1
  description: Allianz Australia API Connect production server
security:
- OAuth2: []
tags:
- name: Policy Details
  description: Operations for retrieving and completing insurance policy details
paths:
  /policy-details/assisted:
    post:
      operationId: getPolicyDetailsAssisted
      summary: Allianz API Connect Get Policy Details Assisted
      description: Enable sales staff to complete insurance quotes on customers' behalves through a staff-assisted workflow, taking full control of the insurance journey.
      tags:
      - Policy Details
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolicyDetailsAssistedRequest'
            examples:
              GetPolicyDetailsAssistedRequestExample:
                summary: Default getPolicyDetailsAssisted request
                x-microcks-default: true
                value:
                  estimate_id: est-500123
                  customer_id: '500123'
                  payment_frequency: monthly
      responses:
        '200':
          description: Policy details retrieved and quote completed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyDetailsResponse'
              examples:
                GetPolicyDetailsAssisted200Example:
                  summary: Default getPolicyDetailsAssisted 200 response
                  x-microcks-default: true
                  value:
                    quote_id: quote-500567
                    policy_number: ALZ-2026-500567
                    status: ready_to_bind
                    product_type: home
                    annual_premium: 1250.0
                    currency: AUD
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /policy-details/self-service:
    post:
      operationId: createPolicyDetailsSelfService
      summary: Allianz API Connect Create Policy Details Self Service
      description: Empower customers with direct access to complete insurance quotes via internet banking or partner digital platforms without staff assistance.
      tags:
      - Policy Details
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolicyDetailsSelfServiceRequest'
            examples:
              CreatePolicyDetailsSelfServiceRequestExample:
                summary: Default createPolicyDetailsSelfService request
                x-microcks-default: true
                value:
                  estimate_id: est-500789
                  redirect_url: https://portal.example.com/insurance/complete
      responses:
        '200':
          description: Self-service policy details session created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelfServiceSessionResponse'
              examples:
                CreatePolicyDetailsSelfService200Example:
                  summary: Default createPolicyDetailsSelfService 200 response
                  x-microcks-default: true
                  value:
                    session_id: ses-500891
                    session_url: https://apply.allianz.com.au/session/ses-500891
                    expires_at: '2026-04-19T22:30:00Z'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    PolicyDetailsSelfServiceRequest:
      title: PolicyDetailsSelfServiceRequest
      type: object
      description: Request body for creating a self-service policy completion session
      required:
      - estimate_id
      properties:
        estimate_id:
          type: string
          description: Unique identifier of the price estimate to complete
          example: est-500789
        redirect_url:
          type: string
          format: uri
          description: URL to redirect customer back to after completing the policy
          example: https://portal.example.com/insurance/complete
    ErrorResponse:
      title: ErrorResponse
      type: object
      description: Standard error response
      properties:
        error:
          type: string
          description: Error code identifying the type of error
          example: invalid_request
        message:
          type: string
          description: Human-readable description of the error
          example: The provided estimate_id does not exist
        request_id:
          type: string
          description: Unique identifier for the failed request for support reference
          example: req-500999
    PolicyDetailsAssistedRequest:
      title: PolicyDetailsAssistedRequest
      type: object
      description: Request body for staff-assisted policy details completion
      required:
      - estimate_id
      - customer_id
      properties:
        estimate_id:
          type: string
          description: Unique identifier of the price estimate to convert
          example: est-500123
        customer_id:
          type: string
          description: Unique identifier of the customer
          example: '500123'
        payment_frequency:
          type: string
          description: Preferred payment frequency for the policy
          enum:
          - annual
          - monthly
          example: monthly
    PolicyDetailsResponse:
      title: PolicyDetailsResponse
      type: object
      description: Policy details and quote ready for binding
      properties:
        quote_id:
          type: string
          description: Unique identifier for the completed quote
          example: quote-500567
        policy_number:
          type: string
          description: Assigned policy number
          example: ALZ-2026-500567
        status:
          type: string
          description: Status of the policy quote
          enum:
          - ready_to_bind
          - pending
          - bound
          example: ready_to_bind
        product_type:
          type: string
          description: Insurance product type
          example: home
        annual_premium:
          type: number
          format: double
          description: Annual premium for the policy
          example: 1250.0
        currency:
          type: string
          description: Currency code
          example: AUD
    SelfServiceSessionResponse:
      title: SelfServiceSessionResponse
      type: object
      description: Self-service session URL for customer to complete policy details
      properties:
        session_id:
          type: string
          description: Unique identifier for the self-service session
          example: ses-500891
        session_url:
          type: string
          format: uri
          description: URL for the customer to complete their policy application
          example: https://apply.allianz.com.au/session/ses-500891
        expires_at:
          type: string
          format: date-time
          description: Timestamp when the session expires
          example: '2026-04-19T22:30:00Z'
  securitySchemes:
    OAuth2:
      type: oauth2
      description: OAuth2 client credentials flow for partner API access
      flows:
        clientCredentials:
          tokenUrl: https://api.allianz.com.au/oauth2/token
          scopes:
            price_estimate: Access to price estimation APIs
            lead_referral: Access to lead referral APIs
            policy_details: Access to policy detail APIs
            certificates: Access to certificate retrieval APIs