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

# Start shipping-company self-service registration with an email OTP challenge

> Start shipping-company self-service registration with an email OTP challenge. A shipping company is registered through its own door and recorded in its own table; the two sign-ups do not share a request shape because they do not ask the same questions.



## OpenAPI

````yaml /openapi.yaml post /v2/shipping-company-registrations
openapi: 3.1.0
info:
  title: DropHub External API
  version: v2
  description: >-
    DropHub API v2 for Merchant, shipping-company, shipment, and OAuth 2.0
    integrations.
  contact:
    name: DropHub API Governance
  license:
    name: Proprietary
servers:
  - url: https://api-test.drop-hub.com
    description: Sandbox deployment with isolated data and credentials.
  - url: https://api.drop-hub.com
    description: Production deployment; production credentials only.
security: []
tags:
  - name: Authentication
    description: >-
      Authentication, sessions, the company a principal is, and merchant API
      credentials
  - name: External Price Estimates
    description: OAuth-scoped transient route-distance and tariff calculation
  - name: External Shipments
    description: OAuth-scoped Merchant shipment creation, lookup, and cancellation
  - name: External Tracking
    description: Merchant-authenticated and privacy-minimized public tracking projections
  - name: Sandbox
    description: >-
      Tenant-bound self-service fixture lifecycle, available only on the
      isolated sandbox deployment
  - name: Webhook Endpoints
    description: Merchant webhook subscriptions, lifecycle, and signing-secret rotation
  - name: Webhook Deliveries
    description: Durable webhook delivery history and replay
paths:
  /v2/shipping-company-registrations:
    post:
      tags:
        - Authentication
      summary: >-
        Start shipping-company self-service registration with an email OTP
        challenge
      description: >-
        Start shipping-company self-service registration with an email OTP
        challenge. A shipping company is registered through its own door and
        recorded in its own table; the two sign-ups do not share a request shape
        because they do not ask the same questions.
      operationId: startShippingCompanyRegistration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShippingCompanyRegistrationRequest'
      responses:
        '200':
          description: >-
            Resend cooldown active; the existing pending registration is
            returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistrationAcknowledgement'
        '202':
          description: >-
            Neutral acknowledgement; the OTP challenge bound to the pending
            registration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistrationAcknowledgement'
        '400':
          $ref: '#/components/responses/BadRequest'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
      security: []
components:
  schemas:
    ShippingCompanyRegistrationRequest:
      type: object
      additionalProperties: false
      description: The shipping-company sign-up form, field for field.
      required:
        - email
        - tradeName
        - commercialRegistrationNumber
        - contactName
        - mobileNumber
        - acceptedAgreement
        - deviceReference
      properties:
        email:
          type: string
          maxLength: 254
        tradeName:
          type: string
          minLength: 2
          maxLength: 160
        commercialRegistrationNumber:
          type: string
          pattern: ^[0-9]{10}$
        transportPermitNumber:
          description: Recorded when the company already holds a transport permit.
          type:
            - string
            - 'null'
          maxLength: 32
        contactName:
          type: string
          minLength: 2
          maxLength: 160
        jobTitle:
          type:
            - string
            - 'null'
          maxLength: 120
        mobileNumber:
          type: string
          pattern: ^5[0-9]{8}$
        acceptedAgreement:
          type: object
          additionalProperties: false
          required:
            - agreementCode
            - agreementVersion
            - agreementContentSha256
          properties:
            agreementCode:
              type: string
              pattern: ^[A-Z0-9-]{3,40}$
            agreementVersion:
              type: string
              pattern: ^[A-Z0-9-]{4,40}$
            agreementContentSha256:
              type: string
              pattern: ^[0-9a-f]{64}$
        deviceReference:
          type: string
          format: uuid
    RegistrationAcknowledgement:
      type: object
      additionalProperties: false
      required:
        - registrationId
        - challengeId
        - expiresAt
        - resendAvailableAt
        - cooldown
        - uploadCapability
        - uploadCapabilityExpiresAt
      properties:
        registrationId:
          type: string
          format: uuid
        challengeId:
          type: string
          format: uuid
        expiresAt:
          type: string
          format: date-time
        resendAvailableAt:
          type: string
          format: date-time
        cooldown:
          type: boolean
        uploadCapability:
          type: string
          minLength: 32
          description: >-
            Short-lived opaque capability scoped only to this pending
            registration.
        uploadCapabilityExpiresAt:
          type: string
          format: date-time
    Problem:
      type: object
      description: RFC 9457 Problem Details with stable DropHub extensions
      additionalProperties: true
      required:
        - type
        - title
        - status
        - code
        - timestamp
        - correlationId
        - requestId
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
          maxLength: 128
        status:
          type: integer
          format: int32
          minimum: 400
          maximum: 599
        detail:
          type: string
          maxLength: 512
        instance:
          type: string
          format: uri-reference
        code:
          type: string
          pattern: ^[A-Z][A-Z0-9_]{1,63}$
        timestamp:
          type: string
          format: date-time
        correlationId:
          type: string
          format: uuid
        requestId:
          type: string
          format: uuid
        traceId:
          type: string
          pattern: ^[0-9a-f]{32}$
        violations:
          type: array
          maxItems: 20
          items:
            $ref: '#/components/schemas/Violation'
      example:
        type: https://api.drop-hub.com/problems/access-denied
        title: Access denied
        status: 403
        detail: Access to this resource is denied.
        instance: /v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206
        code: ACCESS_DENIED
        timestamp: '2026-08-22T18:30:00Z'
        correlationId: 018f2d8a-1f00-7000-8000-000000000207
        requestId: 018f2d8a-1f00-7000-8000-000000000208
    Violation:
      type: object
      additionalProperties: false
      required:
        - field
        - code
        - message
      properties:
        field:
          type: string
          maxLength: 128
        code:
          type: string
          maxLength: 64
        message:
          type: string
          maxLength: 256
  responses:
    BadRequest:
      description: >-
        The request syntax, path parameter, query parameter, or JSON document is
        malformed.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    MethodNotAllowed:
      description: The method is not supported for this resource.
      headers:
        Allow:
          description: Methods supported by this resource.
          schema:
            type: string
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    ValidationFailed:
      description: The request fails strict syntax or semantic validation.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    RateLimited:
      description: The security operation is temporarily rate limited.
      headers:
        Retry-After:
          description: Suggested delay in seconds when available.
          schema:
            type: integer
            minimum: 1
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'

````