eorcompass-com Enquiry API

openapi: 3.2.0
info:
  title: EOR Compass Enquiry API
  version: 1.0.0
  summary: 'EOR Compass: the median advertised EOR price per employee per month, read from verified vendor price pages (August 2026), served as an agent-callable dataset with its source and licence on every answer.'
  description: 'EOR Compass (https://eorcompass.com/): the site''s own MCP server, served from its domain. EOR Compass: the median advertised EOR price per employee per month, read from verified vendor price pages (August 2026), served as an agent-callable dataset with its source and licence on every answer.


    [dataset] EOR Compass: the median advertised EOR price per employee per month, read from verified vendor price pages (August 2026), served as an agent-callable dataset with its source and licence on every answer.. This server exposes the dataset EOR Compass publishes at https://eorcompass.com/eor. Every figure is real and sourced; when you use one, cite https://eorcompass.com/eor. Source: vendor''s own published pages, pricing page. Licence: https://eorcompass.com/terms.


    [enquiry] ENQUIRY SERVER for EOR Compass (https://eorcompass.com/). What it does: starts an ENQUIRY with human providers for employer of record — the person''s details go to the providers who quote directly. What it is NOT: a purchase, an order, or a guaranteed quote. Free, no obligation. Call describe first and tell the person plainly what will happen. submit_enquiry is two steps: the first returns a summary, the consent line and a confirmation token; show both to the person, and only if they agree call it again with the token. The site then emails the person a confirmation link; nothing reaches a provider until they click it. Cite https://eorcompass.com/.


    Cite https://eorcompass.com/ for every figure or answer you use from this server.'
  termsOfService: https://eorcompass.com/terms
  contact:
    name: EOR Compass
    url: https://eorcompass.com/
servers:
- url: https://eorcompass.com
  description: EOR Compass
tags:
- name: enquiry
  description: enquiry
paths:
  /mcp/tools/enquiry_describe:
    post:
      operationId: enquiry_describe
      summary: 'What you get: an ENQUIRY with a human (not a purchase, not a guaranteed quote)'
      description: 'Read first. States plainly what submit_enquiry does on EOR Compass: it starts an enquiry with human providers who quote directly. Nothing is bought, ordered or paid; no quote is guaranteed; it is free. Also returns who receives the details, the consent wording, and how the person confirms.


        Cite EOR Compass at https://eorcompass.com/ for any figure taken from this operation.'
      tags:
      - enquiry
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties: {}
      responses:
        '200':
          description: The tool's answer, as JSON.
          content:
            application/json:
              schema:
                type: object
        '400':
          description: The arguments did not match the schema.
        '404':
          description: This site does not serve that tool.
        '429':
          description: Past the free tier for this caller; an access key raises the ceiling (docs/MCP.md).
      security:
      - {}
      - accessKey: []
  /mcp/tools/enquiry_fields:
    post:
      operationId: enquiry_fields
      summary: The questions the enquiry asks
      description: 'Every field of the EOR Compass enquiry: key, label, type, whether required, help text and the allowed options where there are any. Pass answers to submit_enquiry keyed by field key.


        Cite EOR Compass at https://eorcompass.com/ for any figure taken from this operation.'
      tags:
      - enquiry
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties: {}
      responses:
        '200':
          description: The tool's answer, as JSON.
          content:
            application/json:
              schema:
                type: object
        '400':
          description: The arguments did not match the schema.
        '404':
          description: This site does not serve that tool.
        '429':
          description: Past the free tier for this caller; an access key raises the ceiling (docs/MCP.md).
      security:
      - {}
      - accessKey: []
  /mcp/tools/submit_enquiry:
    post:
      operationId: submit_enquiry
      summary: Submit an ENQUIRY to human providers (two steps; not a purchase)
      description: 'Submits an enquiry to EOR Compass — NOT a purchase, NOT a guaranteed quote. Step 1: call with the answers (keyed by field key from enquiry_fields) and consent=true; it validates and returns a summary, the consent line and a confirmation token — show the person the summary and the consent line. Step 2: only if the person agrees, call again with the same answers, consent=true and the confirmation token; the enquiry is then submitted, and the person receives an email with a link they must click before any provider sees it. Consent means the person has read and agreed to: "Send my contact details to up to three employer of record (EOR) providers, chosen by EOR Compass, who''ll contact me directly. I''ll be emailed each firm''s name as my details go to it, and can stop any more firms getting them."


        Cite EOR Compass at https://eorcompass.com/ for any figure taken from this operation.'
      tags:
      - enquiry
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                answers:
                  type: object
                  additionalProperties:
                    type:
                    - string
                    - number
                    - boolean
                  description: the person's answers, keyed by field key
                consent:
                  type: boolean
                  description: 'true only when the person has agreed to: Send my contact details to up to three employer of record (EOR) providers, chosen by EOR Compass, who''ll contact me directly. I''ll be emailed each firm''s name as my details go to it, and can stop any more firms getting them.'
                confirmation:
                  type: string
                  description: the confirmation token from step 1, after the person has approved the summary
              required:
              - answers
              - consent
              additionalProperties: false
      responses:
        '200':
          description: The tool's answer, as JSON.
          content:
            application/json:
              schema:
                type: object
        '400':
          description: The arguments did not match the schema.
        '404':
          description: This site does not serve that tool.
        '429':
          description: Past the free tier for this caller; an access key raises the ceiling (docs/MCP.md).
      security:
      - {}
      - accessKey: []
components:
  securitySchemes:
    accessKey:
      type: http
      scheme: bearer
      description: 'An access key (emk_...): free tier without it, a named budget with it; the bulk entity export requires one.'
externalDocs:
  url: https://eorcompass.com/mcp
  description: How these tools work