> ## Documentation Index
> Fetch the complete documentation index at: https://docs.korint.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Suggest addresses

> Autocomplete addresses from a partial query



## OpenAPI

````yaml /openapi.json get /address-autocomplete/suggest
openapi: 3.0.0
info:
  title: Korint API
  description: >-
    Quoting, policy issuance, billing, claims, documents and compliance for
    insurance distribution.
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.korint.io
    description: Production
  - url: https://api.sandbox.korint.io
    description: Sandbox
security:
  - oauth2: []
  - bearerAuth: []
tags: []
paths:
  /address-autocomplete/suggest:
    get:
      tags:
        - lookups
      summary: Suggest addresses
      description: Autocomplete addresses from a partial query
      operationId: AddressAutocompleteController_suggest
      parameters:
        - name: q
          required: true
          in: query
          description: Partial address typed by the user
          schema:
            type: string
        - name: searchSessionId
          required: true
          in: query
          description: >-
            Client-generated id grouping one search (maps to the provider
            billing session)
          schema:
            type: string
        - name: language
          required: false
          in: query
          description: UI language (ISO 639-1); clamped to the provider set
          schema:
            type: string
        - name: country
          required: false
          in: query
          description: >-
            Restrict results to this country (ISO 3166-1 alpha-2). Empty =
            worldwide
          schema:
            type: string
        - name: part
          required: false
          in: query
          description: >-
            Address part this field represents; scopes suggestions to the
            matching feature types
          schema:
            type: string
            enum:
              - address
              - postalCode
              - city
              - country
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressAutocompleteSuggestOutput'
components:
  schemas:
    AddressAutocompleteSuggestOutput:
      type: object
      properties:
        data:
          description: Address suggestions
          type: array
          items:
            $ref: '#/components/schemas/AddressSuggestion'
      required:
        - data
    AddressSuggestion:
      type: object
      properties:
        label:
          type: string
          description: Formatted address, shown in the dropdown
        streetAddress:
          type: string
          description: Street number + name
        locality:
          type: string
          description: City / locality
        administrativeArea:
          type: string
          description: Region / state / department
        postalCode:
          type: string
          description: Postal code
        country:
          type: string
          description: Country name, localized to the requested language
        countryCode:
          type: string
          description: Country code (ISO 3166-1 alpha-2), locale-independent
      required:
        - label
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://korint-tenant.auth.eu-west-3.amazoncognito.com/oauth2/token
          scopes:
            korint.io/account: Read account information
            korint.io/analytics: Access analytics endpoints
            korint.io/assets: Access asset endpoints
            korint.io/billing: Access billing endpoints
            korint.io/branches: Access branch endpoints
            korint.io/broker: Access broker endpoints
            korint.io/claims: Access claim endpoints
            korint.io/comments: Access comment endpoints
            korint.io/customers: Access customer endpoints
            korint.io/derogations: Access derogation endpoints
            korint.io/documents: Access document endpoints
            korint.io/external: Access external lookup endpoints
            korint.io/external-claims: Declare claims from an external system
            korint.io/internal-notes: Access internal note endpoints
            korint.io/invitations: Access invitation endpoints
            korint.io/payments: Access payment endpoints
            korint.io/permissions: Access permission management endpoints
            korint.io/policies: Access policy endpoints
            korint.io/quotes: Access quote endpoints
            korint.io/reportings: Access reporting endpoints
            korint.io/signature: Access signature endpoints
      description: >-
        Machine-to-machine clients use the OAuth 2.0 client credentials grant.
        Each tenant has its own authorization server: in the token URL below,
        replace `tenant` with your tenant identifier.
    bearerAuth:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: An access token obtained from your tenant authorization server.

````