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

# Address Verification Service

> Address Verification Service API Documentation

For a usage description of the Address Verification Service, please refer to the [Address Verification](/essentials/addressVerification) page.

## Endpoint

**POST** `/address/verify`

## Swagger

<a href="/public/downloads/swagger/addreessVerification/AddressVerify.postman_collection.json" download="AddressVerify.postman_collection.json">
  <button>⬇️ Download OpenAPI YAML</button>
</a>


## OpenAPI

````yaml POST /address/verify
openapi: 3.1.0
info:
  title: Umbrella API
  version: 1.0.0
  description: >-
    API documentation for Umbrella services including KYB, KYC, AML, payments,
    phone intelligence, onboarding, and address verification.
servers:
  - url: https://api-umbrella.io/api/services
    description: Production
  - url: https://sandbox-umbrella-api.azurewebsites.net/api/services
    description: Sandbox
security:
  - bearerAuth: []
paths:
  /address/verify:
    post:
      summary: Verify Address
      description: >-
        Verifies if an individual can be matched to a given address, including
        validation, a match quality score, and potential corrections.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddressVerificationRequest'
      responses:
        '200':
          description: Successfully verified address.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressVerificationResponse'
        '400':
          description: Invalid request provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: Authorization information is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
components:
  schemas:
    AddressVerificationRequest:
      type: object
      required:
        - country
        - address
        - identity
      properties:
        country:
          type: string
          description: ISO 3166-1 Alpha-2/Alpha-3 country code (e.g., DE, AT, ES).
          minLength: 2
          maxLength: 3
        address:
          type: object
          required:
            - street
            - number
            - zip
            - city
          properties:
            street:
              type: string
              description: Street name.
            number:
              type: string
              description: House or building number.
            zip:
              type: string
              description: Zip or post code.
            city:
              type: string
              description: Town or city name.
            province:
              type:
                - string
                - 'null'
              description: District, province, or state.
        identity:
          type: object
          required:
            - firstname
            - lastname
            - dob
          properties:
            firstname:
              type: string
              description: First name of the person.
            lastname:
              type: string
              description: Last name of the person.
            dob:
              type: string
              description: Date of birth in the format YYYY-MM-DD.
              pattern: ^\d{4}-\d{2}-\d{2}$
              example: '1970-12-01'
    AddressVerificationResponse:
      type: object
      required:
        - finalAddress
        - addressStatus
        - matchQuality
        - score
        - globalResult
      properties:
        inputAddress:
          type: string
          description: Raw address provided.
        correctedAddress:
          type: string
          description: Corrected version of the address.
        finalAddress:
          type: string
          description: Final confirmed address.
        addressStatus:
          type: string
          description: Status after verification.
          enum:
            - corrected
            - unchanged
        addressComponents:
          type: object
          description: Detailed components of the final address.
          properties:
            street:
              type:
                - string
                - 'null'
            number:
              type:
                - string
                - 'null'
            zip:
              type:
                - string
                - 'null'
            city:
              type:
                - string
                - 'null'
            province:
              type:
                - string
                - 'null'
            country:
              type:
                - string
                - 'null'
          additionalProperties: false
        matchQuality:
          type: string
          description: Match level.
          enum:
            - EXACT
            - HOUSEHOLD_MATCH
            - PARTIAL_MATCH
            - HOUSENUMBER_MATCH
            - STREET_MATCH
            - CITY_MATCH
            - IDENTITY_MISMATCH
            - NO_MATCH
        score:
          type: integer
          format: int32
          minimum: 0
          maximum: 100
          description: Confidence score (0-100).
        globalResult:
          type: object
          required:
            - overall
          properties:
            overall:
              type: string
              enum:
                - OK
                - NOK
                - REVIEW
                - ERROR
              description: Overall operation status.
            totalScore:
              type: integer
              format: int32
              minimum: 0
              maximum: 100
              description: Optional repetition of score for compatibility.
        identity:
          type: object
          description: Details of the identity as found in the search.
          properties:
            fullName:
              type: string
            dob:
              type: string
              pattern: ^\d{4}\/\d{2}\/\d{2}$
          additionalProperties: true
        extendedMessage:
          type: string
          description: Detailed feedback.
          enum:
            - addressCorrected
            - postCodeMatch
            - localityMatch
            - cityMatch
            - districtMatch
            - NoCity
            - NoStreet
            - NoPostCode
            - previousAddress
            - incorrectAddress
            - addressFound
            - identityNotFound
            - deceased
            - addressFakeSuspicion
            - noMatch
            - skippedDOB
            - dobPartial
            - dobFailedFull
            - lastNameOnly
            - firstNameOnly
    Error400:
      required:
        - message
      type: object
      properties:
        message:
          type: string
          example: Invalid request payload
    Error401:
      required:
        - message
      type: object
      properties:
        message:
          type: string
          example: Unauthorized request
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Bearer token obtained from POST /auth. Valid for 60 minutes.

````