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

# KYB Search Service

> KYB Search Service API Documentation

For a usage description of the KYB Search Service, please refer to the [KYB](/essentials/kyb) page.

## Endpoint

**POST** `/kyb/search`


## OpenAPI

````yaml POST /kyb/search
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:
  /kyb/search:
    post:
      summary: Search Company
      description: >-
        Search for a legal entity by name (fuzzy) or registration number
        (exact). Exactly one of `name` or `companyNo` must be provided — not
        both. Returns one or more candidate matches, each with a `companyId` and
        `transactionId` to be passed to `/kyb/company/details`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - country
              oneOf:
                - required:
                    - name
                - required:
                    - companyNo
              properties:
                name:
                  type: string
                  description: Company name. Fuzzy matching applied.
                  example: IDCanopy Group Ltd
                companyNo:
                  type: string
                  description: Official registration number. Exact match.
                  example: '16262990'
                country:
                  type: string
                  description: ISO 3166-1 alpha-2 country code.
                  example: GB
                locality:
                  type: string
                  description: City or locality to narrow results.
                  example: London
            examples:
              byName:
                summary: Search by name
                value:
                  name: IDCanopy Group Ltd
                  country: GB
                  locality: London
              byNumber:
                summary: Search by registration number
                value:
                  companyNo: '16262990'
                  country: GB
      responses:
        '200':
          description: One or more matching companies.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: '`true` on success.'
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        transactionId:
                          type: string
                          format: uuid
                          description: Session token — pass to `/kyb/company/details`.
                        companyId:
                          type: string
                          format: uuid
                          description: >-
                            Umbrella company identifier — pass to
                            `/kyb/company/details`.
                        name:
                          type: string
                        status:
                          type: string
                          description: e.g. `active`, `dissolved`
                        registrationNumber:
                          type: string
                        addressLine:
                          type: string
                        country:
                          type: string
              example:
                status: true
                data:
                  - transactionId: a8b89ef3-9d93-4d96-a495-be605fd1b2fe
                    companyId: 223c8dde-9c82-4811-ba3c-4f9fe648c2da
                    name: IDCANOPY GROUP LTD
                    status: active
                    registrationNumber: '16262990'
                    addressLine: >-
                      71-75 Shelton Street, Covent Garden, London, United
                      Kingdom, WC2H 9JQ
                    country: GB
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Bearer token obtained from POST /auth. Valid for 60 minutes.

````