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

# QES Onboarding Get Verification Service

> QES Onboarding Get Verification Service API Documentation

For a usage description of the QES Onboarding Get Verification Service, please refer to the [QES Onboarding](/essentials/qesOnboarding) page.

## Endpoint

**GET** `/onboarding/getVerification/{sessionId}`

## Swagger

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


## OpenAPI

````yaml GET /onboarding/getVerification/{sessionId}
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:
  /onboarding/getVerification/{sessionId}:
    get:
      summary: Get QES Verification Result
      description: >-
        Retrieves identity and signature verification results for a given
        onboarding session ID.
      parameters:
        - name: sessionId
          in: path
          required: true
          schema:
            type: string
          description: ID from the onboarding session.
      responses:
        '200':
          description: Verification result retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerificationResultResponse'
              examples:
                completed:
                  value:
                    status: true
                    data:
                      isVerified: true
                      status: completed
                      message: Verification completed
                      requestId: 64d35e63-fdf4-43f6-8459-1216787fb34e
                      signature:
                        content:
                          - id: e919520e-bb24-41c3-8a7b-88b3c8b0008b
                            method: RemoteSignatureLongLivedDisposableCertificate
                            status: COMPLETED
                            pageMode: headless
                            signedAt: '2025-06-11T11:53:04.107687Z'
                            plainResource:
                              id: 5a28c0e7-a57e-4bb5-88f3-6b6bb47c2cf7
                              name: Document To Sign
                              type: CONTRACT_DOCUMENT
                              family: DOCUMENT_TO_SIGN
                              status: AVAILABLE
                              subType: DOCUMENT_FLATTENED
                              filename: Onboarding_TEST.pdf
                              metadata:
                                sourceTemplateUrl: https://files.example.com/Onboarding_TEST.pdf
                              mimeType: application/pdf
                              sizeBytes: 138763
                              resourceUri: nor://example/resource/5a28c0e7
                              resourceUrl: >-
                                https://example.com/storage/data/Onboarding_TEST.pdf
                              urlValidBefore: '2025-06-16T11:53:34.028Z'
                            signedResource:
                              id: 60ab66ba-3b03-477c-8936-be55b15e890f
                              type: CONTRACT_DOCUMENT
                              family: SIGNED_DOCUMENT
                              status: AVAILABLE
                              filename: Onboarding_TEST.pdf
                              metadata:
                                fileId: 8168e8d7-ab7b-4c6f-b19e-2fe1418da0d1
                                workstep: EXAMPLE_WORKSTEP_ID
                              mimeType: application/pdf
                              sizeBytes: 207066
                              resourceUri: nor://example/resource/60ab66ba
                              resourceUrl: >-
                                https://example.com/storage/data/Onboarding_TEST_signed.pdf
                              urlValidBefore: '2025-06-16T11:53:34.028Z'
                      identification:
                        id: 2b307448-4880-4d3d-b9ab-0a438298c77a
                        actor: userToIdentify
                        idSelf:
                          artifacts:
                            biometry: []
                            document: []
                          biometryCheck:
                            keysWithError: []
                            controlsSummary: 0
                          documentCheck:
                            documentType: PASSPORT
                            documentTypeFamily: IDENTITY_DOCUMENT
                            keysWithError: []
                            controlsSummary: 0
                        source: ID-SELF
                        status: COMPLETED
                        personData:
                          email: max.mustermann@example.com
                          gender: M
                          firstName: Max
                          lastName: Mustermann
                          birthDate: '1971-01-01'
                          birthPlace: Musterstadt
                          nationality: DE
                          phoneNumber: '+491234567890'
                          documentDetails:
                            type: Passport
                            number: X1234567
                            issuedOn: '2016-01-01'
                            expiryDate: '2026-01-01'
                            issuanceCountry: DE
                            issuanceAuthority: Example Authority
                        finalizedAt: '2025-06-11T11:52:29.961249669Z'
                        organizationId: example-org-id
                        validationDetail:
                          email:
                            otpValidated: SKIPPED
                            byRequestInput: OK
                            requestMatched: SKIPPED
                            byIdentificationSource: SKIPPED
                failed:
                  value:
                    status: true
                    data:
                      isVerified: false
                      status: cancelled
                      message: >-
                        Sorry, we were unable to identify you automatically. You
                        can now try again.
                error:
                  value:
                    status: true
                    data:
                      isVerified: false
                      status: error
                      message: Verification error
        '400':
          description: Invalid request payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: Unauthorized request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '404':
          description: Session not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
components:
  schemas:
    VerificationResultResponse:
      type: object
      required:
        - status
        - data
      properties:
        status:
          type: boolean
          description: Indicates whether the request succeeded.
        data:
          type: object
          description: Verification payload.
          properties:
            isVerified:
              type: boolean
              description: Whether the verification was successful.
            status:
              type: string
              description: High-level status of the verification.
              enum:
                - completed
                - cancelled
                - error
            message:
              type: string
              description: Status message.
            requestId:
              type: string
              description: Unique ID for the verification request.
            signature:
              type: object
              description: Signature metadata and resources.
              properties:
                content:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                      method:
                        type: string
                      status:
                        type: string
                      pageMode:
                        type: string
                      signedAt:
                        type: string
                        format: date-time
                      plainResource:
                        type: object
                        properties:
                          id:
                            type: string
                          name:
                            type: string
                          type:
                            type: string
                          family:
                            type: string
                          status:
                            type: string
                          subType:
                            type: string
                          filename:
                            type: string
                          metadata:
                            type: object
                            additionalProperties: true
                          mimeType:
                            type: string
                          sizeBytes:
                            type: integer
                          resourceUri:
                            type: string
                          resourceUrl:
                            type: string
                            format: uri
                          urlValidBefore:
                            type: string
                            format: date-time
                        additionalProperties: true
                      signedResource:
                        type: object
                        properties:
                          id:
                            type: string
                          type:
                            type: string
                          family:
                            type: string
                          status:
                            type: string
                          filename:
                            type: string
                          metadata:
                            type: object
                            additionalProperties: true
                          mimeType:
                            type: string
                          sizeBytes:
                            type: integer
                          resourceUri:
                            type: string
                          resourceUrl:
                            type: string
                            format: uri
                          urlValidBefore:
                            type: string
                            format: date-time
                        additionalProperties: true
                    additionalProperties: true
            identification:
              type: object
              description: KYC / identification results.
              properties:
                id:
                  type: string
                actor:
                  type: string
                  description: Role of the actor in session (e.g., userToIdentify).
                idSelf:
                  type: object
                  properties:
                    artifacts:
                      type: object
                      properties:
                        biometry:
                          type: array
                          items:
                            type: object
                        document:
                          type: array
                          items:
                            type: object
                    biometryCheck:
                      type: object
                      properties:
                        keysWithError:
                          type: array
                          items:
                            type: string
                        controlsSummary:
                          type: integer
                    documentCheck:
                      type: object
                      properties:
                        documentType:
                          type: string
                        documentTypeFamily:
                          type: string
                        keysWithError:
                          type: array
                          items:
                            type: string
                        controlsSummary:
                          type: integer
                  additionalProperties: true
                source:
                  type: string
                status:
                  type: string
                personData:
                  type: object
                  properties:
                    email:
                      type: string
                      format: email
                    gender:
                      type: string
                    firstName:
                      type: string
                    lastName:
                      type: string
                    birthDate:
                      type: string
                      pattern: ^\d{4}-\d{2}-\d{2}$
                    birthPlace:
                      type: string
                    nationality:
                      type: string
                    phoneNumber:
                      type: string
                    documentDetails:
                      type: object
                      properties:
                        type:
                          type: string
                        number:
                          type: string
                        issuedOn:
                          type: string
                        expiryDate:
                          type: string
                        issuanceCountry:
                          type: string
                        issuanceAuthority:
                          type: string
                  additionalProperties: true
                finalizedAt:
                  type: string
                  format: date-time
                organizationId:
                  type: string
                validationDetail:
                  type: object
                  description: Per-field validation indicators.
                  additionalProperties:
                    type: object
                    properties:
                      otpValidated:
                        type: string
                      byRequestInput:
                        type: string
                      requestMatched:
                        type: string
                      byIdentificationSource:
                        type: string
                    additionalProperties: true
              additionalProperties: true
          additionalProperties: true
    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
    Error404:
      type: object
      properties:
        message:
          type: string
          example: Journey not found
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Bearer token obtained from POST /auth. Valid for 60 minutes.

````