> ## 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.

# Identity Verification Service

> Identity Verification Service API Documentation

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

## Endpoint

**POST** `/identity/verify`


## OpenAPI

````yaml POST /identity/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:
  /identity/verify:
    post:
      summary: Verify Identity
      description: >-
        Verify identity information by matching it against external and internal
        databases.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityVerificationRequest'
      responses:
        '200':
          description: Successfully retrieved the verification results.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityVerificationResponse'
        '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:
    IdentityVerificationRequest:
      type: object
      required:
        - identity
        - address
      properties:
        identity:
          type: object
          required:
            - firstName
            - lastName
            - birthDate
          properties:
            firstName:
              type: string
            lastName:
              type: string
            nationalId:
              type: string
            birthDate:
              type: string
              description: Birthdate of the individual in the format YYYY/MM/DD.
              pattern: ^\d{4}\/\d{2}\/\d{2}$
        address:
          type: object
          required:
            - street
            - postalCode
            - city
            - countryCode
          properties:
            street:
              type: string
            houseNumber:
              type: string
            building:
              type: string
            postalCode:
              type: string
            city:
              type: string
            district:
              type: string
            province:
              type: string
            countryCode:
              type: string
        phone:
          type: object
          properties:
            phoneNumber:
              type: string
    IdentityVerificationResponse:
      type: object
      required:
        - globalResult
        - resultDetails
      properties:
        globalResult:
          type: object
          properties:
            totalScore:
              type: integer
              enum:
                - 0
                - 50
                - 75
                - 100
              description: Aggregate verification score.
        resultDetails:
          type: array
          items:
            type: object
            properties:
              datasource:
                type: string
              country:
                type: string
              matches:
                type: array
                items:
                  type: object
                  properties:
                    record:
                      type: string
                    match:
                      type: string
                      enum:
                        - full
                        - partial
                        - not-present
    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.

````