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

# Lite Profile

> Basic company details are verified by ordering a Lite Profile. The Lite Profile includes (where present at the registry):

- Company Name
- Company Number
- Registered Address
- Registration or Foundation Date
- Registration Status
- Legal Form
- Company Activity
- Registration Authority



## OpenAPI

````yaml /openapi/company_v2.yaml get /companies/{kyckrId}/lite
openapi: 3.0.3
info:
  title: Kyckr Companies V2 API
  version: '2.0'
  contact:
    url: https://www.kyckr.com
  description: |
    Kyckr Companies V2 API
  license:
    name: Kyckr API License
    url: https://www.kyckr.com/legal
  termsOfService: https://www.kyckr.com/legal
servers:
  - url: https://api.kyckr.com/v2
    description: Production
  - url: https://test-api.kyckr.com/v2
    description: Testing
security:
  - AuthHeader: []
tags:
  - name: Companies
  - name: Orders
  - name: PREVIEW UBO Verify
    description: >-
      Endpoints for analyzing company ownership structure and ultimate
      beneficial owners
paths:
  /companies/{kyckrId}/lite:
    parameters:
      - $ref: '#/components/parameters/kyckrId'
    get:
      tags:
        - Companies
      summary: Lite Profile
      description: "Basic company details are verified by ordering a Lite Profile. The Lite Profile includes (where present at the registry):\r\n\r\n- Company Name\r\n- Company Number\r\n- Registered Address\r\n- Registration or Foundation Date\r\n- Registration Status\r\n- Legal Form\r\n- Company Activity\r\n- Registration Authority"
      operationId: get-companies-kyckrId
      parameters:
        - $ref: '#/components/parameters/customerReference'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/BaseResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/LiteProfile'
              examples:
                Lite Profile (GB):
                  value:
                    correlationId: 455cd440f5ea4b7d940ab38e6ab4c1e1
                    customerReference: ''
                    timeStamp: '2023-04-05T10:27:24.363606Z'
                    details: Success
                    data:
                      activity:
                        - code: '63120'
                          description: Web portals
                          type: Primary
                      address:
                        fullAddress: >-
                          Kemp House, 160 City Road, London, United Kingdom,
                          EC1V 2NX
                        buildingName: Kemp House
                        streetName: 160 City Road
                        city: London
                        postcode: EC1V 2NX
                        country: United Kingdom
                      companyNumber: '11655290'
                      companyName: KYCKR UK LIMITED
                      foundationDate:
                        original: '2018-11-01'
                      legalForm:
                        original: ltd
                      legalStatus:
                        original: active
                      registrationAuthority: Companies House, United Kingdom
        '400':
          $ref: '#/components/responses/400Response'
        '401':
          $ref: '#/components/responses/401Response'
        '403':
          $ref: '#/components/responses/403Response'
        '404':
          $ref: '#/components/responses/404Response'
        '429':
          $ref: '#/components/responses/429Response'
components:
  parameters:
    kyckrId:
      name: kyckrId
      in: path
      required: true
      schema:
        type: string
      description: Kyckr company reference, a shared format, usable across our V2 APIs
      example: GB|MTE2NTUyOTA
    customerReference:
      name: customerReference
      in: query
      required: false
      schema:
        type: string
      description: Optional reference supplied by customer for tracking purposes
  schemas:
    BaseResponse:
      title: BaseResponse
      type: object
      properties:
        orderId:
          type: number
          example: 12345
          description: The related orderId.
        correlationId:
          type: string
          description: "The related correlationId to this request, for support purposes. \r\n"
        customerReference:
          type: string
          description: A customer provided reference, which appears in the order list.
        timeStamp:
          type: string
          format: date-time
          description: The UTC time at which the request occurred.
        details:
          type: string
          description: 'The response status details for the current request.  '
        cost:
          $ref: '#/components/schemas/Cost'
        links:
          type: object
          properties:
            self:
              type: string
              format: uri-reference
              example: /orders/12345
      description: ''
    LiteProfile:
      title: Lite Profile
      type: object
      properties:
        activity:
          type: array
          items:
            $ref: '#/components/schemas/Activity'
        address:
          $ref: '#/components/schemas/Address'
        companyNumber:
          type: string
          description: Company registration number issued by the registrationAuthority
        registrationAuthority:
          type: string
          description: Name of registration authority
        registrationAuthorityCode:
          type: string
          description: The registration authority code for the company
        registrationType:
          type: string
          description: >-
            If present, indicates that the original foundational legal entity
            registration  is at another register (the source register).
        registrationTypeDetails:
          type: object
          description: >-
            Additional details in relation to the registration type, if
            registrationType is set.
          properties:
            originalCode:
              type: string
              description: Non standard code for the source registry.
            originalDescription:
              type: string
              description: Description text for the source registry.
            normalizedCode:
              type: string
              description: >-
                ISO code for the country, province or state of the source
                registry.
            normalizedDescription:
              type: string
              description: Country and state description of the foreign registry.
        companyName:
          type: string
          description: Company name as at registry
        englishName:
          type: string
          description: Company name in english, if available
        aliases:
          type: array
          description: Alternative company names
          items:
            $ref: '#/components/schemas/AlternativeNames'
        previousNames:
          type: array
          description: Previous company names
          items:
            $ref: '#/components/schemas/PreviousNames'
        otherIdentifiers:
          type: array
          description: Additional identifiers with their standardized type codes
          items:
            $ref: '#/components/schemas/Identifier'
        taxNumber:
          type: string
          deprecated: true
          description: Deprecated, use otherIdentifiers instead
        foundationDate:
          $ref: '#/components/schemas/NormalizedDate'
        registrationDate:
          $ref: '#/components/schemas/NormalizedDate'
        lastAnnualAccountDate:
          $ref: '#/components/schemas/NormalizedDate'
        legalForm:
          $ref: '#/components/schemas/NormalizedLegalForm'
        legalStatus:
          $ref: '#/components/schemas/NormalizedStatus'
        stateOfIncorporation:
          type: string
          description: State of incorporation (US Only)
        updatedDate:
          $ref: '#/components/schemas/NormalizedDate'
    Cost:
      type: object
      description: Cost of an item
      properties:
        type:
          type: string
          enum:
            - credit
            - lite
          example: credit
        value:
          type: number
          example: 3
    Activity:
      title: Activity
      type: object
      description: >-
        Description of a company's economic activity according to
        internationally defined schemas
      properties:
        code:
          type: string
          description: Activity code
        description:
          type: string
          description: Description of activity
        classificationScheme:
          type: string
          enum:
            - NACE
            - SIC
            - SIC07
            - NAICS
          description: Classification scheme, for example NAICS or NACErev2
        type:
          type: string
          enum:
            - Primary
            - Secondary
          description: Primary or secondary activity
    Address:
      description: Standardised shared model for addresses
      type: object
      title: Address
      properties:
        identifier:
          type: string
          nullable: true
          description: >-
            Stable identifier for this address instance within the profile. Use
            to cross-reference into the additionalInformation.addressInformation
            array.
          example: IE-Wo0Fri41lHuGoElhaChY3-iXz6Gx6h2rHdw7LqC4Tok
        type:
          type: string
          minLength: 1
          description: Type of address, for example "Head Office" or "Registered Address"
        fullAddress:
          type: string
          minLength: 1
          description: The full address as a single string
        rawAddressLines:
          type: array
          description: An array of address lines as retrieved from the registry
          items:
            type: string
        buildingName:
          type: string
          description: Name of building, e.g. "The Chrysler Building"
        streetNumber:
          type: string
          description: Number portion of street address, e.g. "18", "21A"
        streetName:
          type: string
          description: Street name
        city:
          type: string
          minLength: 1
          description: City or town
        postcode:
          type: string
          minLength: 1
          description: Primary postal code
        municipality:
          type: string
          description: Administrative sub-region, for example a French commune or US county
        region:
          type: string
          minLength: 1
          description: Administrative region for example a US state or UK county
        country:
          type: string
          minLength: 1
          description: Country
        isoCode:
          type: string
          description: Jurisdiction code in ISO 3166 alpha-2
          example: GB
        secondaryPostalCode:
          type: string
          description: A secondary postal code, for example a CEDEX
    AlternativeNames:
      title: Alternative Names (Business Name, Trading Name, Doing Business As)
      type: object
      properties:
        name:
          type: string
          description: Alternative company names
        type:
          type: string
          description: Type of name, e.g. Trading Name, Business Name
    PreviousNames:
      title: Previous Names
      type: object
      properties:
        name:
          type: string
          description: Previous company name
        startDate:
          $ref: '#/components/schemas/NormalizedDate'
        endDate:
          $ref: '#/components/schemas/NormalizedDate'
    Identifier:
      title: Identifier
      type: object
      description: A standardized identifier with its type code
      properties:
        value:
          type: string
          description: The identifier value
          example: NA0091712
        type:
          type: string
          description: The standardized type code for this identifier
          example: IT_REA_CD
      x-examples:
        REA Trade Register Number:
          value: NA0091712
          type: IT_REA_CD
        European VAT number:
          value: IT12345678912
          type: IT_VAT_CD
        Tax ID (Codice Fiscale):
          value: 12345678901
          type: IT_TAX_CD
    NormalizedDate:
      title: Normalized Date
      type: object
      description: ''
      properties:
        original:
          type: string
          description: Date as formatted at registry source
        normalized:
          type: string
          format: date
          description: >-
            Date in ISO-8601 format. The precision matches what is available at
            the registry source. Supports both full dates (YYYY-MM-DD) and
            partial dates (YYYY-MM) when only month and year are available.
    NormalizedLegalForm:
      title: Normalized Legal Form
      type: object
      properties:
        original:
          type: string
          description: Legal form as described at source
        normalized:
          type: string
          enum:
            - Private Limited Company
            - Public Limited Company
            - Limited Partnership
            - Limited Liability Partnership
            - General Partnership
            - Cooperative
            - Collective Investment Vehicle
            - Association
            - Sole Proprietor
            - Branch
            - Foreign Registered Body
            - Government or Public Body
            - Foundation
            - Trust
            - Other
          description: >-
            Standard value mapped from the registry's legal form. See
            [Normalised
            values](/documentation/useful-information/normalised-values) for the
            15 possible values and what they mean. **Beta** — first populated
            for HK, CN, and JP in an upcoming release; other jurisdictions will
            follow. Where populated, `Other` is used when no specific value
            fits; the original registry label remains in `original`.
    NormalizedStatus:
      title: Normalized Status
      type: object
      properties:
        original:
          type: string
          description: Legal status as described at source
        normalized:
          type: string
          description: >-
            Legal status mapped to a standard Kyckr value (see Normalised values
            guide)
          enum:
            - Active
            - Inactive
            - Distressed
            - Other
    ProblemDetails:
      title: Problem Details
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        detail:
          type: string
        errors:
          type: array
          items:
            type: string
  responses:
    400Response:
      description: Bad request
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/BaseResponse'
              - type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ProblemDetails'
          examples:
            Missing Parameter:
              value:
                orderId: 12345
                correlationId: string
                customerReference: string
                timeStamp: '2019-08-24T14:15:22Z'
                details: string
                cost:
                  type: credit
                  value: 0
                links:
                  self: ../dictionary
                data:
                  type: https://httpstatuses.com/400
                  title: Missing Parameter
                  detail: The `isoCode` parameter is required
                  errors: []
    401Response:
      description: Unauthorized
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/BaseResponse'
              - type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ProblemDetails'
          examples:
            Unauthorized:
              value:
                orderId: 12345
                correlationId: string
                customerReference: string
                timeStamp: '2019-08-24T14:15:22Z'
                details: string
                cost:
                  type: credit
                  value: 0
                links:
                  self: ../dictionary
                data:
                  type: https://httpstatuses.com/401
                  title: Unauthorized
                  detail: Please authorize before making requests
                  errors: []
    403Response:
      description: Forbidden
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/BaseResponse'
              - type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ProblemDetails'
          examples:
            Forbidden:
              value:
                orderId: 12345
                correlationId: string
                customerReference: string
                timeStamp: '2019-08-24T14:15:22Z'
                details: string
                cost:
                  type: credit
                  value: 0
                links:
                  self: ../dictionary
                data:
                  type: https://httpstatuses.com/403
                  title: Forbidden
                  detail: This feature is not available on this account
                  errors: []
    404Response:
      description: Not Found
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/BaseResponse'
              - type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ProblemDetails'
          examples:
            Not Found:
              value:
                orderId: 12345
                correlationId: string
                customerReference: string
                timeStamp: '2019-08-24T14:15:22Z'
                details: string
                cost:
                  type: credit
                  value: 0
                links:
                  self: ../dictionary
                data:
                  type: https://httpstatuses.com/404
                  title: Not Found
                  detail: This resource could not be found
                  errors: []
    429Response:
      description: Too many requests
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/BaseResponse'
              - type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ProblemDetails'
          examples:
            Rate limit exceeded:
              value:
                orderId: 12345
                correlationId: string
                customerReference: string
                timeStamp: '2019-08-24T14:15:22Z'
                details: string
                cost:
                  type: credit
                  value: 0
                links:
                  self: ../dictionary
                data:
                  type: https://httpstatuses.com/429
                  title: Too Many Requests
                  detail: >-
                    This service only allows 50 requests within a 10 minute
                    period
                  errors: []
  securitySchemes:
    AuthHeader:
      type: http
      scheme: bearer

````