# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Reference Enrichment API
  version: 1.0.0
extends: openapi/canopy-enrichment-api-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/teams/{teamId}/enrich/propertyData'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up property data for an address
      effect: read
      questions:
      - How can I get property details for a home address?
      - What property information can I pull just from a street address?
      - Is ad-hoc property data lookup available on every plan?
      instructions:
      - text: Look up property data for {address} on team {team}.
        slots:
          address: query.address
          team: path.teamId
      - text: Get the property details for the home at {address}.
        slots:
          address: query.address
      method: generated
      generated: '2026-10-01'
- target: $.paths['/teams/{teamId}/enrich/driverLicense'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a person's driver's license
      effect: read
      questions:
      - How do I find someone's driver's license number from their name, birth date and address?
      - What permissible DPPA purpose do I have to give for a driver's license lookup?
      instructions:
      - text: Look up the driver's license for {first} {last}, born {dob}, at {address}, for purpose {purpose}.
        slots:
          first: query.first_name
          last: query.last_name
          dob: query.date_of_birth_str
          address: query.address
          purpose: query.purpose
      - text: On team {team}, find the license of {first} {last} born {dob} living at {address}, requested by {employee} ({job}) for {purpose}.
        slots:
          team: path.teamId
          first: query.first_name
          last: query.last_name
          dob: query.date_of_birth_str
          address: query.address
          employee: query.employee_name
          job: query.employee_job_function
          purpose: query.purpose
      method: generated
      generated: '2026-10-01'
- target: $.paths['/teams/{teamId}/enrich/drivingRecordIq'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a person's driving record
      effect: read
      questions:
      - How can I check a driver's history of violations and incidents before quoting auto insurance?
      - Can I pull a driving record with a license number instead of a date of birth?
      - Why does the driving record lookup ask who in my company is making the inquiry?
      instructions:
      - text: Pull the driving record for {first} {last} at {address} using license {license} from {state}, for purpose {purpose}.
        slots:
          first: query.first_name
          last: query.last_name
          address: query.address
          license: query.drivers_license
          state: query.drivers_license_state
          purpose: query.purpose
      - text: On team {team}, get the driving record of {first} {last} born {dob} at {address}, requested by {employee} ({job}) for {purpose}.
        slots:
          team: path.teamId
          first: query.first_name
          last: query.last_name
          dob: query.date_of_birth_str
          address: query.address
          employee: query.employee_name
          job: query.employee_job_function
          purpose: query.purpose
      method: generated
      generated: '2026-10-01'
- target: $.paths['/teams/{teamId}/enrich/household'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a person's household members and vehicles
      effect: read
      questions:
      - How do I find the other drivers living in a person's household?
      - Can a household lookup also return the vehicles registered at that address?
      instructions:
      - text: 'Find the household of {first} {last} at {address} and include vehicles: {vehicles}, for purpose {purpose}.'
        slots:
          first: query.first_name
          last: query.last_name
          address: query.address
          vehicles: query.lookup_vehicles
          purpose: query.purpose
      - text: On team {team}, look up who lives with {first} {last} born {dob} at {address}, requested by {employee} ({job}) for {purpose}.
        slots:
          team: path.teamId
          first: query.first_name
          last: query.last_name
          dob: query.date_of_birth_str
          address: query.address
          employee: query.employee_name
          job: query.employee_job_function
          purpose: query.purpose
      method: generated
      generated: '2026-10-01'