openapi: 3.0.0
info:
  description: 'API for evaluating transactions against direct-to-consumer Beverage Alcohol shipping regulations.


    This API is currently in beta.

    '
  title: Avalara Shipping Verification Age Verification API
  version: 3.1.0
servers:
- url: /
security:
- BasicAuth: []
- Bearer: []
tags:
- name: Age Verification
paths:
  /api/v2/ageverification/verify:
    post:
      description: "The request must meet the following criteria in order to be evaluated:\n* *firstName*, *lastName*, and *address* are required fields.\n* One of the following sets of attributes are required for the *address*:\n  * *line1, city, region*\n  * *line1, postalCode*\n\nOptionally, the transaction and its lines may use the following parameters:\n* A *DOB* (Date of Birth) field. The value should be ISO-8601 compliant (e.g. 2020-07-21).\n* Beyond the required *address* fields above, a *country* field is permitted\n  * The valid values for this attribute are [*US, USA*]\n\n**Security Policies**\nThis API depends on the active subscription *AgeVerification*"
      operationId: verifyAge
      parameters:
      - description: (Optional) The failure code included in the simulated response of the endpoint. Note that this endpoint is only available in Sandbox for testing purposes.
        explode: true
        in: query
        name: simulatedFailureCode
        required: false
        schema:
          $ref: '#/components/schemas/AgeVerifyFailureCode'
        style: form
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgeVerifyRequest'
        description: Information about the individual whose age is being verified.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgeVerifyResult'
          description: An AgeVerificationResult object.
        '400':
          description: Invalid Request Model
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Determines whether an individual meets or exceeds the minimum legal drinking age.
      tags:
      - Age Verification
      x-contentType: application/json
      x-accepts: application/json
components:
  schemas:
    AgeVerifyResult:
      description: The Result of a call to the /ageVerification/verify endpoint.
      example:
        isOfAge: false
        failureCodes:
        - deceased
        - dob_unverifiable
      properties:
        isOfAge:
          description: Describes whether the individual meets or exceeds the minimum legal drinking age.
          type: boolean
        failureCodes:
          description: A list of failure codes describing why a *false* age determination was made.
          items:
            $ref: '#/components/schemas/AgeVerifyResult'
          type: array
      type: object
    AgeVerifyFailureCode:
      enum:
      - not_found
      - dob_unverifiable
      - under_age
      - suspected_fraud
      - deceased
      - unknown_error
      type: string
    AgeVerifyRequest:
      description: The Request for the /ageVerification/verify endpoint. Describes information about the person whose age is being verified.
      example:
        firstName: John
        lastName: Doe
        address:
          line1: 255 S King St
          city: Seattle
          region: WA
          country: US
          postalCode: '98104'
        DOB: 1994-10-01
      properties:
        firstName:
          type: string
        lastName:
          type: string
        address:
          $ref: '#/components/schemas/AgeVerifyRequest_address'
        DOB:
          description: The value should be ISO-8601 compliant (e.g. 2020-07-21).
          type: string
      type: object
    AgeVerifyRequest_address:
      properties:
        line1:
          type: string
        city:
          type: string
        region:
          description: The state code of the address.
          type: string
        country:
          description: The country code of the address.
          enum:
          - US
          - USA
          type: string
        postalCode:
          type: string
      type: object
  securitySchemes:
    BasicAuth:
      scheme: basic
      type: http
    Bearer:
      description: A Bearer token generated by Avalara Identity. Prefix your token with the string \'Bearer \'.
      in: header
      name: Authorization
      type: apiKey
x-provenance:
  first_party: true
  method: harvested
  provider_published: true
  source: https://raw.githubusercontent.com/avadev/Avalara-SDK-Java/HEAD/api/openapi.yaml
  harvested: '2026-08-05'
  note: Published by Avalara in its own Java SDK repository under the avadev GitHub organization. Not offered as a downloadable definition on developer.avalara.com.