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

# Search for companies

> Search companies using company name or registration number. You must provide one of `name` or `companyNumber`.

With an `isoCode`, a search will be performed directly at the registry for that jurisdiction.

Without an `isoCode`, Kyckr will perform a global search across all jurisdictions. It is important to remember that the Global Search uses stored data. Once you have found the correct jurisdiction, you should then use Kyckr's search by Name or Number API with the specific jurisdiction to confirm that the entity is still active on the register.



## OpenAPI

````yaml /openapi/company_v2.yaml get /companies
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:
    get:
      tags:
        - Companies
      summary: Search for companies
      description: >-
        Search companies using company name or registration number. You must
        provide one of `name` or `companyNumber`.


        With an `isoCode`, a search will be performed directly at the registry
        for that jurisdiction.


        Without an `isoCode`, Kyckr will perform a global search across all
        jurisdictions. It is important to remember that the Global Search uses
        stored data. Once you have found the correct jurisdiction, you should
        then use Kyckr's search by Name or Number API with the specific
        jurisdiction to confirm that the entity is still active on the register.
      operationId: get-companies
      parameters:
        - $ref: '#/components/parameters/isoCode'
        - schema:
            type: string
          in: query
          name: name
          description: Company Name
          example: Kyckr
        - schema:
            type: string
          in: query
          name: companyNumber
          description: Company Registration Number
          example: '11655290'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/BaseResponse'
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/SearchResult'
              examples:
                Single Search Result (GB):
                  value:
                    correlationId: 8df02c1f6a2b4c2980992bf24daad522
                    customerReference: ''
                    timeStamp: '2023-04-06T07:23:36.9353291Z'
                    details: Success
                    data:
                      - id: GB|MTE2NTUyOTA
                        companyName: KYCKR UK LIMITED
                        companyNumber: '11655290'
                        address: >-
                          Kemp House, 160 City Road, London, United Kingdom,
                          EC1V 2NX
                        status: active
                        type: ltd
                        startDate: '2018-11-01'
                Multiple Search Results (AU):
                  value:
                    correlationId: a7d84f0116a047e5bddb6ad6b9d28568
                    customerReference: ''
                    timeStamp: '2023-04-06T07:24:52.5152243Z'
                    details: Success
                    data:
                      - id: >-
                          AU|MTE1ODM5NTg4X1dJU0UgVEVDSCBQVFkgTElNSVRFRHxBdXN0cmFsaWFuIFNlY3VyaXRpZXMgYW5kIEludmVzdG1lbnRzIENvbW1pc3Npb24
                        companyName: WISE TECH PTY LIMITED
                        companyNumber: 115839588_WISE TECH PTY LIMITED
                        status: DRGD
                        type: APTY
                      - id: >-
                          AU|MTM2ODg4NDM4X1dJU0VURUNIIFBUWSBMVER8QXVzdHJhbGlhbiBTZWN1cml0aWVzIGFuZCBJbnZlc3RtZW50cyBDb21taXNzaW9u
                        companyName: WISETECH PTY LTD
                        companyNumber: 136888438_WISETECH PTY LTD
                        status: DRGD
                        type: APTY
                      - id: >-
                          AU|MTU2MjEwODU2X1dJU0VURUNIIFBUWSBMVER8QXVzdHJhbGlhbiBTZWN1cml0aWVzIGFuZCBJbnZlc3RtZW50cyBDb21taXNzaW9u
                        companyName: WISETECH PTY LTD
                        companyNumber: 156210856_WISETECH PTY LTD
                        address: BURSWOOD, WA, 6100
                        status: REGD
                        type: APTY
                      - id: >-
                          AU|NjMyNTg3NzQzX1dJU0VURUNIIEFDQURFTVkgUFRZIExURHxBdXN0cmFsaWFuIFNlY3VyaXRpZXMgYW5kIEludmVzdG1lbnRzIENvbW1pc3Npb24
                        companyName: WISETECH ACADEMY PTY LTD
                        companyNumber: 632587743_WISETECH ACADEMY PTY LTD
                        address: ALEXANDRIA, NSW, 2015
                        status: REGD
                        type: APTY
                      - id: >-
                          AU|MDg3NDM3NTcyX1dJU0VURUNIIENPTlNVTFRJTkcgUFRZIExURHxBdXN0cmFsaWFuIFNlY3VyaXRpZXMgYW5kIEludmVzdG1lbnRzIENvbW1pc3Npb24
                        companyName: WISETECH CONSULTING PTY LTD
                        companyNumber: 087437572_WISETECH CONSULTING PTY LTD
                        status: DRGD
                        type: APTY
                Multiple Search Results (GB):
                  value:
                    correlationId: b88d0458a4ec40989bf291f0d8a64977
                    customerReference: ''
                    timeStamp: '2023-04-06T07:26:15.076971Z'
                    details: Success
                    data:
                      - id: GB|MDY2OTQ4MTA
                        companyName: FLOWERS LTD
                        companyNumber: '06694810'
                        address: 337  Moorside Road, Swinton, Manchster, M27 9PN
                        status: dissolved
                        type: ltd
                      - id: GB|U0M3NDgwMDk
                        companyName: ALL THINGS FLORAL LTD
                        companyNumber: SC748009
                        address: >-
                          The Melting Pot, 15 Calton Road, Edinburgh, Scotland,
                          EH8 8DL
                        status: active
                        type: ltd
                        startDate: '2022-10-21'
                      - id: GB|MDY4Njk1MTM
                        companyName: BY...SP LTD
                        companyNumber: '06869513'
                        address: 5 The Broadway, Broadstairs, CT10 2AD
                        status: active
                        type: ltd
                        startDate: '2009-04-03'
                      - id: GB|MTM1MDQzNzE
                        companyName: FLOWERS ABBEYGAIL DESIGNS LIMITED
                        companyNumber: '13504371'
                        address: 93 Garron Lane, South Ockendon, England, RM15 5JQ
                        status: dissolved
                        type: ltd
                      - id: GB|MTI4ODQ4MzI
                        companyName: FLOWERS ACADEMIA LIMITED
                        companyNumber: '12884832'
                        address: >-
                          4 Floor, Fairgate House, 78 New Oxford Street, London,
                          United Kingdom, WC1A 1HB
                        status: active
                        type: ltd
                        startDate: '2020-09-16'
        '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:
    isoCode:
      name: isoCode
      in: query
      schema:
        type: string
      description: Jurisdiction code in ISO 3166 alpha-2
      example: GB
  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: ''
    SearchResult:
      title: Search Result
      type: object
      description: Single search result
      properties:
        id:
          type: string
          description: >-
            The KyckrId of the company representing a unique identifier for
            ordering profiles and documents.
        companyName:
          type: string
          description: The name of the company.
        englishName:
          type: string
          description: "In some jurisdictions, an englishName is additionally provided for the company name.\r\n"
        companyNumber:
          type: string
          description: An identifier representing the company.
        address:
          type: string
          description: The address of the company
        status:
          type: string
          description: >-
            The status of the company, for example whether or not the company is
            currently active.
        type:
          type: string
          description: >-
            The type of company, e.g. "LTD".   Allowed values will vary by
            jurisdiction.
        startDate:
          type: string
          format: date
          description: The start date of the company.
        links:
          type: object
          properties:
            self:
              type: string
              format: uri-reference
        registrationAuthority:
          type: string
          description: >-
            The Registration Authority Code is a unique identifier provided by
            some registries to specify the registration authority responsible
            for maintaining the company's records.
        otherIdentifiers:
          type: array
          description: Additional identifiers with their standardized type codes
          items:
            $ref: '#/components/schemas/Identifier'
        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.
        isPreviousName:
          type: boolean
          description: >-
            Returns whether the search result corresponds to a previous name of
            the company. Only relevant for name searches.
    Cost:
      type: object
      description: Cost of an item
      properties:
        type:
          type: string
          enum:
            - credit
            - lite
          example: credit
        value:
          type: number
          example: 3
    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
    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

````