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

# Finish a sign-up

> Checks the emailed code, creates the company and returns an API key valid for 90 days (source ht_cli). The company address is geocoded before the code is used, so a wrong address doesn't use up a try. A wrong or expired code answers 400 and says how many tries are left. Limited to 30 code checks per IP address an hour (429). No API key needed.



## OpenAPI

````yaml v1/openapi.json POST /signup/verify
openapi: 3.1.0
info:
  title: Hellotracks REST API
  version: '1'
  description: >-
    Plain REST resources over HTTPS, for tools, automations and services. The ht
    command line is built on it.
  contact:
    email: api@hellotracks.com
servers:
  - url: https://api.hellotracks.com/v1
security:
  - ApiKey: []
tags:
  - name: Sign-up and sign-in
    description: >-
      Create a company or get an API key by an emailed code, without a key; and
      check which account a key belongs to.
  - name: Company
    description: The company the API key belongs to, with its settings and teams.
  - name: Members
    description: 'The people in the company: admins, operators and workers.'
  - name: API keys
    description: 'The company''s API keys: list, create, revoke and delete.'
  - name: Jobs
    description: 'Jobs: work at a location on a date, assigned to a member.'
  - name: Places
    description: 'Places: customer sites and other saved locations with a check-in radius.'
  - name: Zones
    description: 'Zones: the company''s geofences.'
  - name: Routing
    description: Route optimization for one member's day.
  - name: ETA pages
    description: >-
      Live ETA pages (eta.page links) that show a job's recipient when the
      worker arrives.
  - name: Maps
    description: Rendered maps as GeoJSON, and public map share links.
  - name: Timesheets
    description: Clock-in and clock-out entries of members, with totals, and editing them.
  - name: Forms
    description: >-
      Form templates, submitted forms, attachments for file and image fields,
      and forms linked to places and jobs.
  - name: Alerts
    description: >-
      Alert rules (configs) that watch members, places and zones, and the alerts
      (instances) they raised.
  - name: Reports
    description: >-
      Reports: the newer reporting API (catalog, preview, run, saved) and the
      older one (types, generate, jobs, uploads, recurring).
  - name: Webhooks
    description: URLs Hellotracks calls when jobs, check-ins, clock-ins or alerts happen.
paths:
  /signup/verify:
    post:
      tags:
        - Sign-up and sign-in
      summary: Finish a sign-up
      description: >-
        Checks the emailed code, creates the company and returns an API key
        valid for 90 days (source ht_cli). The company address is geocoded
        before the code is used, so a wrong address doesn't use up a try. A
        wrong or expired code answers 400 and says how many tries are left.
        Limited to 30 code checks per IP address an hour (429). No API key
        needed.
      operationId: verifySignup
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
                - email
                - code
                - company
              properties:
                email:
                  type: string
                  format: email
                code:
                  type: string
                  pattern: ^[0-9]{6}$
                company:
                  type: object
                  additionalProperties: false
                  required:
                    - name
                  description: address or location is required.
                  properties:
                    name:
                      type: string
                      maxLength: 120
                    address:
                      type: string
                      description: Must be found on the map.
                    location:
                      type: object
                      properties:
                        lat:
                          type: number
                          minimum: -90
                          maximum: 90
                        lng:
                          type: number
                          minimum: -180
                          maximum: 180
                keyLabel:
                  type: string
                  default: ht signup
                  description: Label of the new key.
            example:
              email: alex@example.com
              code: '482913'
              company:
                name: Bay Plumbing Co.
                address: 1 Market St, San Francisco, CA 94105
              keyLabel: laptop
      responses:
        '200':
          description: Company created, key issued.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - error
                  - meta
                properties:
                  data:
                    $ref: '#/components/schemas/SignupKeyIssued'
                  error:
                    type: 'null'
                  meta:
                    $ref: '#/components/schemas/Meta'
              example:
                data:
                  apiKey: k7x2m9qa.0f1e2d3c4b5a69788796a5b4c3d2e1f0
                  apiKeyExpiresAt: 1769756400000
                  accountId: a1b2c3
                  username: alex@example.com
                  companyId: c0c0c0
                  companyName: Bay Plumbing Co.
                error: null
                meta:
                  path: /v1/signup/verify
                  method: POST
        '400':
          $ref: '#/components/responses/BadRequest'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
      security: []
components:
  schemas:
    SignupKeyIssued:
      type: object
      properties:
        apiKey:
          type: string
          description: >-
            The new key, `<keyId>.<secret>`. Shown only here; send it as the
            API-Key header.
        apiKeyExpiresAt:
          type: integer
          format: int64
          description: When the key expires, ms timestamp (90 days from now).
        accountId:
          type: string
          description: Id of the signed-in person.
        username:
          type: string
        companyId:
          type: string
        companyName:
          type: string
    Meta:
      type: object
      properties:
        path:
          type: string
          description: The request path, without /v1.
          example: /jobs
        method:
          type: string
          example: GET
    ErrorEnvelope:
      type: object
      properties:
        data:
          type: 'null'
        error:
          $ref: '#/components/schemas/Error'
        meta:
          $ref: '#/components/schemas/Meta'
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Stable error code for programs.
          enum:
            - invalid_request
            - invalid_format
            - invalid_data
            - invalid_api_key
            - unknown_user
            - authentication_failed
            - forbidden
            - not_found
            - already_exists
            - throttled
            - not_ready
            - clock_invalid
            - force_logout
            - internal_error
            - unknown_error
        message:
          type: string
          description: Why it failed, for people.
  responses:
    BadRequest:
      description: The request is invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            data: null
            error:
              code: invalid_request
              message: date must be YYYY-MM-DD
            meta:
              path: /jobs
              method: GET
    TooManyRequests:
      description: Too many requests; slow down.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            data: null
            error:
              code: throttled
              message: Too many requests.
            meta:
              path: /jobs
              method: GET
    ServerError:
      description: Hellotracks failed; retry later.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            data: null
            error:
              code: internal_error
              message: Hellotracks API is temporarily unavailable.
            meta:
              path: /jobs
              method: GET
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: API-Key
      description: >-
        Your API key, from More → API & Integrations in the dashboard, or from
        ht signup / ht auth login.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.