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

# Get Tenant

> Retrieves the complete Tenant profile, including personal details,
verification statuses, forensic results, and financial information.

This endpoint acts as the **single source of truth** for the tenant’s
current state and aggregated data collected across KYC, document analysis,
forensic processing, and banking integrations.




## OpenAPI

````yaml /api-reference/openapi.yaml get /tenants/get-tenant/{tenantId}
openapi: 3.1.0
info:
  title: SKOR Modular API
  version: 1.0.0
  description: >
    ## Overview

    This is the SKOR Modular API v1. It provides access to tenant

    workflows, API keys, webhooks, document processing, identity

    verification, banking connectivity, and forensic analysis.


    ## Error Statuses


    The API uses standard HTTP status codes to indicate the success

    or failure of requests. Each error response provides guidance

    to help identify the issue and take corrective action.


    ### Success — `200 OK`

    The request was processed successfully and the expected response

    data is returned.


    ### Validation Error — `400 Bad Request`

    The request is invalid due to missing, malformed, or incorrect

    parameters.


    **Common causes:**

    - Required fields are missing from the request.

    - Invalid data formats or unsupported values are provided.

    - File size or payload limits are exceeded.


    **How to resolve:**

    - Verify all required parameters are present.

    - Ensure the request payload matches the documented schema.

    - Validate data formats and constraints before retrying.


    ### Unauthorized — `401 Unauthorized`

    Authentication failed or the provided token is missing or invalid.


    **Common causes:**

    - The `Authorization` header is missing.

    - An invalid or expired bearer token is provided.


    **How to resolve:**

    - Ensure the token is included in the request as an `Authorization: Bearer
    <token>` header.

    - Verify the token is valid and has not expired.

    - Generate a new token if required.


    ### Not Found — `404 Not Found`

    The requested resource does not exist or is not accessible.


    **Common causes:**

    - An invalid or non-existent resource identifier.

    - The resource has not been created or has been deleted.


    **How to resolve:**

    - Confirm the resource identifier is correct.

    - Ensure the resource exists before accessing it.


    ### Server Error — `500 Internal Server Error`

    An unexpected error occurred on the server while processing the request.


    **How to resolve:**

    - Retry the request after a short delay.

    - If the issue persists, **[contact us](mailto:info@skortorent.com)** with
    relevant request details.


    ### Need Help?

    If you encounter unexpected behavior,

    please **[contact us](mailto:info@skortorent.com)** for assistance.
servers:
  - url: https://api.skortorent.com/api/v1
    description: Live
  - url: https://dev-api.skortorent.com/api/v1
    description: Sandbox
security:
  - BearerAuth: []
paths:
  /tenants/get-tenant/{tenantId}:
    get:
      tags:
        - Tenants
      summary: Get Tenant
      description: >
        Retrieves the complete Tenant profile, including personal details,

        verification statuses, forensic results, and financial information.


        This endpoint acts as the **single source of truth** for the tenant’s

        current state and aggregated data collected across KYC, document
        analysis,

        forensic processing, and banking integrations.
      parameters:
        - $ref: '#/components/parameters/TenantIdParam'
      responses:
        '200':
          description: Tenant details retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - success
                  message:
                    type: string
                  data:
                    type: object
                    description: Aggregated tenant profile and analysis data.
                    properties:
                      id:
                        type: string
                        description: Unique identifier of the tenant.
                      email:
                        type: string
                        format: email
                        description: Tenant's email address.
                      fname:
                        type: string
                        description: Tenant's first name.
                      lname:
                        type: string
                        description: Tenant's last name.
                      phone_number:
                        type: string
                        description: Tenant's phone number.
                      post_code:
                        type: string
                        description: Tenant's postal code.
                      dob:
                        type: string
                        format: date-time
                        description: Tenant's date of birth.
                      employment_status:
                        type: string
                        description: Current employment status of the tenant.
                      employment_category:
                        type: string
                        description: Employment category of the tenant.
                      current_annual_income:
                        type: number
                        description: Declared annual income of the tenant.
                      currency:
                        type: string
                        description: Currency of the declared income.
                      protected_housing:
                        type: boolean
                        description: >-
                          Indicates whether the tenant is associated with
                          protected housing.
                      about_me:
                        type: string
                        description: Additional information provided by the tenant.
                      kyc_success:
                        type: boolean
                        description: >-
                          Indicates whether KYC verification was completed
                          successfully.
                      kyc_data:
                        type: object
                        description: |
                          Raw and processed KYC verification data of KYC.
                        properties:
                          kyc_user:
                            type: object
                            description: >
                              Contains extracted data submitted by the user
                              during the KYC process.
                          kyc_doc:
                            type: object
                            description: >
                              Data related to documents uploaded by the tenant
                              during the

                              KYC flow (for example, identity documents
                              submitted for verification).
                          kyc_doc_data:
                            type: object
                            description: >
                              Detailed document data returned after processing
                              the uploaded

                              documents.
                          kyc_workflow_res:
                            type: object
                            description: >
                              Workflow execution results, representing the
                              outcome

                              of the configured KYC workflow and associated
                              checks.
                          kyc_error:
                            type: object
                            nullable: true
                            description: >
                              Error information returned in case the KYC process
                              fails

                              or encounters issues during verification.
                          kyc_status:
                            type: string
                            description: |
                              Current KYC status.
                      financial_info_errors:
                        type: object
                        nullable: true
                        description: |
                          Contains error details related to banking or financial
                          analysis (for example, Financial analysis failures).
                      extra_data:
                        type: object
                        description: Aggregated data generated from multiple SKOR services.
                        properties:
                          public_housing_docs:
                            type: array
                            description: >-
                              Documents provided to validate public or protected
                              housing status.
                            items:
                              type: string
                          profile_summary:
                            type: object
                            description: >-
                              High-level tenant profile summary generated by
                              SKOR Lite.
                          document_analysis:
                            type: object
                            description: >-
                              Results of document analysis performed by SKOR
                              Lite.
                          experian_json:
                            type: object
                            description: >
                              Data received from Experian, used to evaluate
                              defaulter

                              status.
                          forensic_analysis:
                            type: object
                            description: |
                              Forensic analysis results generated by SKOR Lite.
                      bank_data:
                        type: object
                        description: Banking and financial analysis data for the tenant.
                        properties:
                          bank_data:
                            type: object
                            description: Raw banking data.
                          financial_data:
                            type: object
                            description: >
                              Financial analysis data generated after processing
                              Bank data.
        '400':
          $ref: '#/components/responses/ErrorResponse'
        '401':
          $ref: '#/components/responses/ErrorResponse'
        '404':
          $ref: '#/components/responses/ErrorResponse'
        '500':
          $ref: '#/components/responses/ErrorResponse'
components:
  parameters:
    TenantIdParam:
      name: tenantId
      in: path
      required: true
      schema:
        type: string
  responses:
    ErrorResponse:
      description: Error response
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                enum:
                  - error
              message:
                type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: |
        HTTP Bearer Authentication. Pass the token generated via
        `/keys/generate-token` as `Authorization: Bearer <token>`.

````