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

# Create company verification

> Create a company verification session and receive a hosted link for the authorised representative. The returned `verificationId` is the public company verification identifier. The hosted `processId` inside the link is the internal company verification record ID.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/company-verifications
openapi: 3.0.0
info:
  title: Helium Id Public API v1
  version: 1.0.0
  description: API reference for Helium ID public verification endpoints.
servers:
  - url: https://server.heliumid.io/api
security:
  - ApiKeyAuth: []
paths:
  /v1/company-verifications:
    post:
      summary: Create company verification
      description: >-
        Create a company verification session and receive a hosted link for the
        authorised representative. The returned `verificationId` is the public
        company verification identifier. The hosted `processId` inside the link
        is the internal company verification record ID.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyVerificationCreateRequest'
            example:
              vendorData: business_12345
              meta:
                applicationId: app_67890
              campaignId: cmp_64ff2f3f4f31d4d5f2ab1234
      responses:
        '200':
          description: Company verification created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessEnvelopeCreateCompanyVerification'
              example:
                status: true
                message: Created company verification
                data:
                  link: >-
                    https://verify.heliumid.io/company?processId=69d4f7657bcbe3b58b96b2f7&hostedToken=eyJleGFtcGxlIjoidG9rZW4ifQ
                  verificationId: cv_0b5f6f4e0aab25d8c130ab21
                  campaignId: cmp_64ff2f3f4f31d4d5f2ab1234
                  campaignVersion: 3
                  expiresAt: '2026-08-25T12:00:00.000Z'
                code: 200
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    CompanyVerificationCreateRequest:
      type: object
      properties:
        vendorData:
          type: string
          description: Optional correlation identifier from your system.
        meta:
          type: object
          description: Optional metadata to store alongside the company verification.
          additionalProperties: true
        campaignId:
          type: string
          pattern: ^cmp_[a-f0-9]{24}$
          description: Optional company-verification campaign identifier.
    SuccessEnvelopeCreateCompanyVerification:
      type: object
      properties:
        status:
          type: boolean
          example: true
        message:
          type: string
          example: Created company verification
        data:
          type: object
          properties:
            link:
              type: string
              format: uri
            verificationId:
              type: string
              description: Public company verification identifier (`externalId`).
            campaignId:
              type: string
            campaignVersion:
              type: integer
            expiresAt:
              type: string
              format: date-time
        code:
          type: integer
          example: 200
    ErrorResponse:
      type: object
      properties:
        status:
          type: boolean
          example: false
        message:
          type: string
        error:
          type: object
          nullable: true
          additionalProperties: true
        data:
          nullable: true
        code:
          type: integer
  responses:
    BadRequest:
      description: The request payload, identifier, or state transition is invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            status: false
            message: Verification not found or has been deleted
            code: 400
    Unauthorized:
      description: The request could not be authenticated with the supplied API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            status: false
            message: Unauthorized
            code: 401
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Your Helium ID API key.

````