Hypamoon Test mode API

openapi: 3.2.0
info:
  title: Hypamoon Test mode API
  version: 1.0.0
  description: 'Hypamoon is the infrastructure a chat or an agent builds on for a business: sites and apps (with server code, sign-in and their own database), data and forms, a media library, domains, email from your own domain, phone numbers with voice AI, SMS and chat, payments (see https://hypamoon.com/docs/payments) and agents. The same project is reachable from a connected chat over MCP and from your own code over this REST API.


    Calls are inbound, plus outbound calls your assistant makes to people who expect them (POST /calls).


    Every request needs an API key: `Authorization: Bearer hm_live_...`, or `hm_test_...` in test mode. Each key has scopes and a rate limit of 120 requests per 60 seconds.


    An OAuth access token (`hm_oat_...`, from connecting an assistant such as Claude.ai or ChatGPT) works on every /api/v1 route as well, with the scopes the user granted on the consent screen. For your own app, create an API key in the portal instead.


    Every error is `application/problem+json` with a `type` URL that explains the fix (`https://hypamoon.com/docs/errors/`). Every response carries an `X-Request-Id` header; include it when you ask us for help.


    Field names are snake_case, except inside a call plan, which is stored exactly as you send it (camelCase). New fields may be added to a response at any time; renaming or removing one requires a new version.'
  contact:
    name: Hypamoon support
    url: https://hypamoon.com/docs
servers:
- url: https://api.hypamoon.com/api/v1
security:
- ApiKey: []
- OAuth2: []
tags:
- name: Test mode
  description: 'Build and test without a real number or real costs: a test key (hm_test_) works on a test project with test numbers and simulated calls.'
paths:
  /test/calls:
    post:
      operationId: simulateTestCall
      tags:
      - Test mode
      summary: Simulate a call
      description: 'Test mode only: runs a simulated call on one of your test numbers, with a transcript and a summary, and sends the real webhooks (call.completed, and call.summary.ready when there is a summary). A simulated caller talks to your own assistant, which answers with the same instructions, knowledge and tools as on a real call; tools are not executed. caller_goal (optional, at most 300 characters) says what the caller wants; without it the caller asks something that fits the scenario (reservation, callback_request, question). The scenario missed is a call nobody picked up: no transcript, no summary. Nothing reaches the carrier. The first 10 simulated calls per day are free; after that each one is deducted from the prepaid balance of your live project, billed per use (402 test_free_replies_used without balance or saved card). Send it with your test key; a live key gets 403 test_key_required. At most 30 simulated calls per hour per test project.'
      x-hypamoon-scope: calls:read
      security:
      - ApiKey:
        - calls:read
      - OAuth2:
        - calls:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestCallInput'
            example:
              number_id: 0d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6
              scenario: question
              caller_goal: Ask whether you are open on Sunday.
      responses:
        '201':
          description: The simulated call, as GET /calls/{id} returns it.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallDetail'
              example:
                id: 6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d
                direction: inbound
                from: '+447700900456'
                to: '+447700900042'
                status: ai_handled
                created_at: '2026-10-01T09:20:00.000Z'
                started_at: '2026-10-01T09:18:52.000Z'
                answered_at: '2026-10-01T09:18:56.000Z'
                ended_at: '2026-10-01T09:20:00.000Z'
                duration_sec: 64
                hangup_cause: normal_clearing
                has_summary: true
                summary_ready_at: '2026-10-01T09:20:00.000Z'
                test: true
                outbound: null
                transcript: 'Assistant: You are speaking with the digital assistant of Acme Plumbing. How can I help you?

                  Caller: Hello, I have a leak under my kitchen sink and I''d like someone to call me back.

                  Assistant: I''m sorry to hear that. I''ll make sure someone calls you back. What is your name and address?

                  Caller: Tom Baker, 40 Main Street.

                  Assistant: Thank you, Tom. Is the water still running, or have you been able to shut it off?

                  Caller: I closed the tap under the sink, so it''s under control for now.

                  Assistant: Good. I''ve noted a leak under the kitchen sink at 40 Main Street. A colleague will call you back on this number within the hour.'
                summary:
                  text: Tom Baker has a leak under his kitchen sink at 40 Main Street. He has shut off the water himself and asks to be called back.
                  topics:
                  - leak
                  - callback request
                  sentiment: neutral
                  action_items:
                  - Call Tom Baker back within the hour about the leak at 40 Main Street
                  next_step: null
        '400':
          description: 'Bad Request: invalid_json.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          x-hypamoon-errors:
          - invalid_json
          content:
            application/problem+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Problem'
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - https://hypamoon.com/docs/errors/invalid_json
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          description: 'Payment Required: test_free_replies_used.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          x-hypamoon-errors:
          - test_free_replies_used
          content:
            application/problem+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Problem'
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - https://hypamoon.com/docs/errors/test_free_replies_used
        '403':
          description: 'Forbidden: project_not_enabled, key_mode_mismatch, missing_scope, ip_not_allowed, verification_required, test_key_required.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          x-hypamoon-errors:
          - project_not_enabled
          - key_mode_mismatch
          - missing_scope
          - ip_not_allowed
          - verification_required
          - test_key_required
          content:
            application/problem+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Problem'
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - https://hypamoon.com/docs/errors/project_not_enabled
                      - https://hypamoon.com/docs/errors/key_mode_mismatch
                      - https://hypamoon.com/docs/errors/missing_scope
                      - https://hypamoon.com/docs/errors/ip_not_allowed
                      - https://hypamoon.com/docs/errors/verification_required
                      - https://hypamoon.com/docs/errors/test_key_required
        '404':
          description: 'Not Found: not_found.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          x-hypamoon-errors:
          - not_found
          content:
            application/problem+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Problem'
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - https://hypamoon.com/docs/errors/not_found
        '422':
          description: 'Unprocessable Content: validation_failed.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          x-hypamoon-errors:
          - validation_failed
          content:
            application/problem+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Problem'
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - https://hypamoon.com/docs/errors/validation_failed
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  schemas:
    Problem:
      type: object
      properties:
        type:
          type: string
          format: uri
          description: 'A URL that explains the error and the fix: https://hypamoon.com/docs/errors/<slug>.'
        title:
          type: string
          description: The HTTP status in words.
        status:
          type: integer
          description: The HTTP status.
        detail:
          type: string
          description: What went wrong in this request.
        request_id:
          type: string
          description: The id of this request, also in the X-Request-Id header. Mention it when you contact support.
        user_message:
          type: string
          description: One calm sentence in plain English for the end user, without technical terms. A chat or app can show it as it is.
        next_step:
          type: string
          description: 'With some errors: what the chat or agent itself should do next.'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/FieldError'
          description: 'With validation_failed, schema_mismatch and team_targets_not_allowed: every problem.'
        missing:
          type: array
          items:
            type: string
          description: 'With company_details_missing: the missing fields, as paths of PUT /project/company.'
        current_version:
          anyOf:
          - type: integer
          - type: string
          description: 'With version_conflict: the version that is there now (a number on a call plan, a string on a site; send it as if_match_version).'
        spend_cap_eur:
          type: number
          description: 'With billing_blocked: the spending cap per calendar month.'
        spent_eur:
          type: number
          description: 'With billing_blocked: what was spent this calendar month.'
        balance_eur:
          type: number
          description: 'With insufficient_balance: the prepaid balance now.'
        required_eur:
          type: number
          description: 'With insufficient_balance: what this request costs.'
        auto_reload_started:
          type: boolean
          description: 'With insufficient_balance: true when an automatic top-up just started; retry in a minute.'
      required:
      - type
      - title
      - status
      - detail
      - request_id
      - user_message
      description: An error, as application/problem+json (RFC 9457).
    CallDetail:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The id of the call.
        direction:
          type:
          - string
          - 'null'
          enum:
          - inbound
          - outbound
          - null
          description: inbound, or outbound for a call your assistant made with POST /calls.
        from:
          type:
          - string
          - 'null'
          description: The caller, in E.164.
        to:
          type:
          - string
          - 'null'
          description: The number that was called, in E.164.
        status:
          type:
          - string
          - 'null'
          description: 'The status as we track it: ringing, active, completed, missed, failed, voicemail, ai_handled. New values may be added; treat an unknown value like completed.'
        created_at:
          type:
          - string
          - 'null'
          format: date-time
          description: When the call reached us.
        started_at:
          type:
          - string
          - 'null'
          format: date-time
          description: When the call started.
        answered_at:
          type:
          - string
          - 'null'
          format: date-time
          description: When the platform picked up. With a call plan the platform always picks up first, so this does not prove a person answered.
        ended_at:
          type:
          - string
          - 'null'
          format: date-time
          description: When the call ended.
        duration_sec:
          type:
          - integer
          - 'null'
          description: The length of the call in seconds.
        hangup_cause:
          type:
          - string
          - 'null'
          description: Why the call ended, as reported by the carrier, like normal_clearing.
        has_summary:
          type: boolean
          description: Whether the call has a summary. Fetch it with GET /calls/{id}.
        summary_ready_at:
          type:
          - string
          - 'null'
          format: date-time
          description: When the summary of a recorded call was ready. Empty for a call handled by the voice AI; look at has_summary instead.
        test:
          type: boolean
          description: true for a simulated call from POST /test/calls or POST /calls with a test key (test mode). Also in webhooks, so you can keep test traffic apart.
        outbound:
          type:
          - object
          - 'null'
          properties:
            status:
              type: string
              enum:
              - queued
              - ringing
              - in_progress
              - completed
              - failed
              - no_answer
              - busy
              description: 'How the outbound call went: queued (not dialled yet), ringing, in_progress (answered), completed, failed, no_answer or busy. An answering machine counts as no_answer, with answered_by machine. Only moves forward.'
            answered_by:
              type:
              - string
              - 'null'
              enum:
              - human
              - machine
              - null
              description: Who picked up, as far as answering machine detection could tell; null when nobody answered or before it is known.
            voicemail_left:
              type: boolean
              description: Whether the assistant left a message on an answering machine.
            on_voicemail:
              type: string
              enum:
              - hangup
              - leave_message
              description: What you asked the assistant to do when an answering machine picks up.
            max_duration_sec:
              type: integer
              description: The cap on the length of the call you asked for, in seconds.
            reference:
              type:
              - string
              - 'null'
              description: Your own reference from POST /calls.
            metadata:
              type: object
              additionalProperties:
                type: string
              description: Your own metadata from POST /calls.
            error:
              type:
              - string
              - 'null'
              description: 'With status failed: a short code, like carrier_rejected, assistant_start_failed or unallocated_number. Otherwise null.'
            purpose:
              type: string
              enum:
              - transactional
              - marketing
              description: Why the call was made, as sent with POST /calls. A marketing call was only placed on recorded consent.
          required:
          - status
          - answered_by
          - voicemail_left
          - on_voicemail
          - max_duration_sec
          - reference
          - metadata
          - error
          - purpose
          additionalProperties: false
          description: The request behind an outbound call started with POST /calls.
        transcript:
          type:
          - string
          - 'null'
          description: The transcript. Only here, never in a webhook.
        summary:
          anyOf:
          - $ref: '#/components/schemas/Summary'
          - type: 'null'
          description: The summary of a call.
        warnings:
          type: array
          items:
            type: string
          description: 'Only in the response of POST /calls, when something was adjusted: for example an opening without the AI disclosure got a short sentence in front of it. Tell the user.'
      required:
      - id
      - direction
      - from
      - to
      - status
      - created_at
      - started_at
      - answered_at
      - ended_at
      - duration_sec
      - hangup_cause
      - has_summary
      - summary_ready_at
      - test
      - outbound
      - transcript
      - summary
      additionalProperties: false
      description: A call with its transcript and summary.
    Summary:
      type: object
      properties:
        text:
          type:
          - string
          - 'null'
          description: The summary in a few sentences.
        topics:
          type: array
          items:
            type: string
          description: What the call was about.
        sentiment:
          type:
          - string
          - 'null'
          enum:
          - positive
          - neutral
          - negative
          - null
          description: The mood of the caller.
        action_items:
          type: array
          items:
            type: string
          description: What someone has to do after this call.
        next_step:
          type:
          - string
          - 'null'
          description: The agreed next step, if any.
      required:
      - text
      - topics
      - sentiment
      - action_items
      - next_step
      additionalProperties: false
      description: The summary of a call.
    TestCallInput:
      type: object
      properties:
        number_id:
          type: string
          format: uuid
          description: The id of one of your test numbers, from GET /numbers.
        scenario:
          type: string
          enum:
          - reservation
          - callback_request
          - question
          - missed
          description: 'What happens in the call: reservation, callback_request, question, missed. missed has no transcript and no summary, so only call.completed is sent.'
        from:
          type: string
          description: 'Optional: the caller, a fictional number from +447700900000 to +447700900999.'
        caller_goal:
          type: string
          minLength: 1
          maxLength: 300
      required:
      - number_id
      - scenario
      additionalProperties: false
    FieldError:
      type: object
      properties:
        path:
          type: string
          description: Where the problem is, with dots, like address.postal_code. body means the body as a whole.
        message:
          type: string
          description: What is wrong, in English.
      required:
      - path
      - message
      additionalProperties: false
  responses:
    InternalError:
      description: 'Internal Server Error: internal_error.'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
      x-hypamoon-errors:
      - internal_error
      content:
        application/problem+json:
          schema:
            allOf:
            - $ref: '#/components/schemas/Problem'
            - type: object
              properties:
                type:
                  type: string
                  enum:
                  - https://hypamoon.com/docs/errors/internal_error
    Unauthorized:
      description: 'Unauthorized: unauthorized, missing_api_key, invalid_api_key, api_key_revoked, api_key_expired, project_deleted.'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
      x-hypamoon-errors:
      - unauthorized
      - missing_api_key
      - invalid_api_key
      - api_key_revoked
      - api_key_expired
      - project_deleted
      content:
        application/problem+json:
          schema:
            allOf:
            - $ref: '#/components/schemas/Problem'
            - type: object
              properties:
                type:
                  type: string
                  enum:
                  - https://hypamoon.com/docs/errors/unauthorized
                  - https://hypamoon.com/docs/errors/missing_api_key
                  - https://hypamoon.com/docs/errors/invalid_api_key
                  - https://hypamoon.com/docs/errors/api_key_revoked
                  - https://hypamoon.com/docs/errors/api_key_expired
                  - https://hypamoon.com/docs/errors/project_deleted
    ServiceUnavailable:
      description: 'Service Unavailable: service_unavailable.'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
        Retry-After:
          $ref: '#/components/headers/Retry-After'
      x-hypamoon-errors:
      - service_unavailable
      content:
        application/problem+json:
          schema:
            allOf:
            - $ref: '#/components/schemas/Problem'
            - type: object
              properties:
                type:
                  type: string
                  enum:
                  - https://hypamoon.com/docs/errors/service_unavailable
    RateLimited:
      description: 'Too Many Requests: rate_limited.'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
        Retry-After:
          $ref: '#/components/headers/Retry-After'
      x-hypamoon-errors:
      - rate_limited
      content:
        application/problem+json:
          schema:
            allOf:
            - $ref: '#/components/schemas/Problem'
            - type: object
              properties:
                type:
                  type: string
                  enum:
                  - https://hypamoon.com/docs/errors/rate_limited
  headers:
    X-Request-Id:
      schema:
        type: string
      description: The id of this request. Include it when you contact support.
    Retry-After:
      schema:
        type: integer
      description: Seconds to wait before you try again.
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: hm_live_..., hm_test_..., or an OAuth access token hm_oat_...
      description: 'Your API key as a bearer token: `Authorization: Bearer hm_live_...`. Live keys start with hm_live_; test keys start with hm_test_, belong to a test project, never reach the carrier and cost nothing. A key has scopes (project:read, project:write, numbers:read, calls:read, numbers:write, assistant:write, webhooks:write, messages:read, messages:write, calls:write, chat:read, chat:write, sites:read, sites:write, data:read, data:write); each operation names the one it needs in x-hypamoon-scope. Keys are shown only once; store them as a secret, never in a frontend. An OAuth access token (hm_oat_..., see OAuth2) is sent the same way and works on every /api/v1 route.'
    WordPressToken:
      type: http
      scheme: bearer
      bearerFormat: hm_wp_...
      description: Only for the /wordpress routes of the Hypamoon Connect plugin for WordPress. The plugin gets this token once, with POST /wordpress/connect and a one-time code, and sends it with X-Hypamoon-Site (the address of the WordPress site). It can only send this site's inventory and the data the user selected, to one project, for 30 days, and it can be revoked. It is not an API key.
    PublicChatToken:
      type: apiKey
      in: query
      name: token
      description: 'Only for the /public routes of the chat widget. The public chat token (hm_pub_... or hm_pubtest_...) in the query string, from a browser page on one of the token''s allowed origins (the Origin header must match exactly). It is not a secret: it is in the page source of your website. It can only chat, only from those origins, with a bot check and its own limits, and you can revoke it. Create one with POST /chat-tokens or in the portal. Never send your API key from a browser.'
    OAuth2:
      type: oauth2
      description: For assistants that connect by URL (Claude.ai, ChatGPT, Grok). Authorization code with PKCE (S256 only); register a client with dynamic client registration at https://api.hypamoon.com/oauth/register. Send resource=https://api.hypamoon.com/api/v1/mcp. The user picks the project (test or live) and the scopes on the consent screen. The access token (hm_oat_...) works on every /api/v1 route, not only /mcp; refresh it with the refresh token. The user can revoke a connection in the portal under Koppelingen.
      flows:
        authorizationCode:
          authorizationUrl: https://app.hypamoon.com/oauth/authorize
          tokenUrl: https://api.hypamoon.com/oauth/token
          refreshUrl: https://api.hypamoon.com/oauth/token
          scopes:
            project:read: 'Read the project: its name, whether it is in test mode or live, and what still needs to be done'
            project:write: Fill in the project's company or personal details, manage agents and request secrets for other services
            numbers:read: Read the numbers and their call plans
            calls:read: Read calls, with transcript and summary
            numbers:write: Order numbers and change call plans
            assistant:write: Configure the voice AI assistant
            webhooks:write: Create, test and delete webhooks
            messages:read: Read the text messages and emails the project sent, with their status
            messages:write: Send text messages (SMS) and emails on behalf of the project
            calls:write: Let the assistant call people on behalf of the project
            chat:read: Read the chat conversations with the assistant, with messages and summary
            chat:write: Start chat conversations with the assistant and send customer messages
            sites:read: Read the project's sites, apps and domains
            sites:write: Publish sites and apps on <slug>.hypamoon.app, change and delete them, and manage domains
            data:read: Read the project's collections and their documents, and the business processes (brain)
            data:write: Create, change and delete collections and their documents, and the business processes (brain)
            clients:read: 'As an agency: list your client projects, read their usage and activity, and read inside a client project with the Hypamoon-Project header'
            clients:write: 'As an agency: set up client projects, ask clients for access, invite owners, and build inside a client project with the Hypamoon-Project header'
x-hypamoon-error-docs: https://hypamoon.com/docs/errors/
x-hypamoon-error-types:
- slug: bad_request
  status:
  - 400
  type: https://hypamoon.com/docs/errors/bad_request
- slug: unauthorized
  status:
  - 401
  type: https://hypamoon.com/docs/errors/unauthorized
- slug: payment_required
  status:
  - 402
  type: https://hypamoon.com/docs/errors/payment_required
- slug: forbidden
  status:
  - 403
  type: https://hypamoon.com/docs/errors/forbidden
- slug: not_found
  status:
  - 404
  type: https://hypamoon.com/docs/errors/not_found
- slug: method_not_allowed
  status:
  - 405
  type: https://hypamoon.com/docs/errors/method_not_allowed
- slug: conflict
  status:
  - 409
  type: https://hypamoon.com/docs/errors/conflict
- slug: version_conflict
  status:
  - 409
  - 412
  type: https://hypamoon.com/docs/errors/version_conflict
- slug: confirmation_required
  status:
  - 409
  type: https://hypamoon.com/docs/errors/confirmation_required
- slug: validation_failed
  status:
  - 422
  type: https://hypamoon.com/docs/errors/validation_failed
- slug: rate_limited
  status:
  - 429
  type: https://hypamoon.com/docs/errors/rate_limited
- slug: internal_error
  status:
  - 500
  type: https://hypamoon.com/docs/errors/internal_error
- slug: upstream_error
  status:
  - 502
  type: https://hypamoon.com/docs/errors/upstream_error
- slug: service_unavailable
  status:
  - 503
  type: https://hypamoon.com/docs/errors/service_unavailable
- slug: invalid_json
  status:
  - 400
  type: https://hypamoon.com/docs/errors/invalid_json
- slug: invalid_parameter
  status:
  - 400
  type: https://hypamoon.com/docs/errors/invalid_parameter
- slug: missing_api_key
  status:
  - 401
  type: https://hypamoon.com/docs/errors/missing_api_key
- slug: invalid_api_key
  status:
  - 401
  type: https://hypamoon.com/docs/errors/invalid_api_key
- slug: api_key_revoked
  status:
  - 401
  type: https://hypamoon.com/docs/errors/api_key_revoked
- slug: api_key_expired
  status:
  - 401
  type: https://hypamoon.com/docs/errors/api_key_expired
- slug: project_deleted
  status:
  - 401
  type: https://hypamoon.com/docs/errors/project_deleted
- slug: project_not_enabled
  status:
  - 403
  type: https://hypamoon.com/docs/errors/project_not_enabled
- slug: missing_scope
  status:
  - 403
  type: https://hypamoon.com/docs/errors/missing_scope
- slug: ip_not_allowed
  status:
  - 403
  type: https://hypamoon.com/docs/errors/ip_not_allowed
- slug: invalid_chat_token
  status:
  - 401
  type: https://hypamoon.com/docs/errors/invalid_chat_token
- slug: chat_token_revoked
  status:
  - 401
  - 409
  type: https://hypamoon.com/docs/errors/chat_token_revoked
- slug: origin_not_allowed
  status:
  - 403
  type: https://hypamoon.com/docs/errors/origin_not_allowed
- slug: turnstile_failed
  status:
  - 403
  type: https://hypamoon.com/docs/errors/turnstile_failed
- slug: invalid_conversation_token
  status:
  - 401
  type: https://hypamoon.com/docs/errors/invalid_conversation_token
- slug: public_chat_limit_reached
  status:
  - 429
  type: https://hypamoon.com/docs/errors/public_chat_limit_reached
- slug: chat_unavailable
  status:
  - 503
  type: https://hypamoon.com/docs/errors/chat_unavailable
- slug: vat_number_invalid
  status:
  - 422
  type: https://hypamoon.com/docs/errors/vat_number_invalid
- slug: country_not_supported
  status:
  - 422
  type: https://hypamoon.com/docs/errors/country_not_supported
- slug: key_mode_mismatch
  status:
  - 403
  type: https://hypamoon.com/docs/errors/key_mode_mismatch
- slug: test_key_required
  status:
  - 403
  type: https://hypamoon.com/docs/errors/test_key_required
- slug: test_number_limit_reached
  status:
  - 422
  type: https://hypamoon.com/docs/errors/test_number_limit_reached
- slug: company_details_missing
  status:
  - 422
  type: https://hypamoon.com/docs/errors/company_details_missing
- slug: business_required
  status:
  - 422
  type: https://hypamoon.com/docs/errors/business_required
- slug: account_type_change_blocked
  status:
  - 422
  type: https://hypamoon.com/docs/errors/account_type_change_blocked
- slug: spend_cap_missing
  status:
  - 422
  type: https://hypamoon.com/docs/errors/spend_cap_missing
- slug: payment_mandate_missing
  status:
  - 402
  type: https://hypamoon.com/docs/errors/payment_mandate_missing
- slug: billing_blocked
  status:
  - 402
  type: https://hypamoon.com/docs/errors/billing_blocked
- slug: insufficient_balance
  status:
  - 402
  type: https://hypamoon.com/docs/errors/insufficient_balance
- slug: regulatory_documents_missing
  status:
  - 422
  type: https://hypamoon.com/docs/errors/regulatory_documents_missing
- slug: verification_required
  status:
  - 403
  type: https://hypamoon.com/docs/errors/verification_required
- slug: number_unavailable
  status:
  - 409
  type: https://hypamoon.com/docs/errors/number_unavailable


# --- truncated at 32 KB (53 KB total) ---
# Full source: https://artifacts.apis.io/hypamoon-com/openapi/hypamoon-com-test-mode-api-openapi.yml