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

# Register a merchant and its locations

> Issues the merchant key, resolves each location to its boundaries, and reports the governing rule, pending rules and local records per location. Partner key, or admin with partner_id.



## OpenAPI

````yaml /openapi.yaml post /partner/merchants/register
openapi: 3.0.3
info:
  title: Centsless Decision and Evidence Engine API
  version: 3.8.1
  description: >
    Jurisdiction-aware cash rounding compliance for point of sale.


    The engine resolves where a sale happened, finds the rule that governs it on
    that date,

    rounds the cash total by the method the rule prescribes, and seals the
    decision and its

    statutory basis into a tamper-evident hash chain.


    Amounts are integers in cents unless a field says otherwise. Timestamps are
    ISO 8601;

    send the terminal's own UTC offset. Authentication is an API key in the
    `x-api-key` header.
  contact:
    name: Centsless developer support
    email: developers@centsless.org
    url: https://www.centsless.org
  license:
    name: Proprietary
    url: https://www.centsless.org/terms
servers:
  - url: https://api.centsless.org/api/v1
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: System
    description: Health, version and statistics. No key required for health and version.
  - name: Jurisdiction
    description: Which rule governs a location on a date. No key required.
  - name: Transactions
    description: Process a sale and read sealed transactions.
  - name: Receipts
    description: Render a sealed transaction as a receipt.
  - name: Overrides, voids and refunds
    description: Reversals and adjustments, hash-linked to the original.
  - name: Merchant settings
    description: Early adoption, operator choice and local adoption per merchant.
  - name: Tipping
    description: Tips, pools, payouts and compliance checks.
  - name: Partner
    description: Partner-key endpoints for registering and managing merchants.
  - name: Locations
    description: Registered terminal locations, their boundary resolution and review.
  - name: Compliance and fraud
    description: Void analytics, override reports and risk profiles.
  - name: Audit
    description: Audit logs, security incidents and hash chain verification.
  - name: Export
    description: CSV export.
  - name: Admin
    description: Keys, partners, vendors and jurisdiction rules. Admin key required.
  - name: Provisioning
    description: Called by the Centsless portal backend with the internal service key.
paths:
  /partner/merchants/register:
    post:
      tags:
        - Partner
      summary: Register a merchant and its locations
      description: >-
        Issues the merchant key, resolves each location to its boundaries, and
        reports the governing rule, pending rules and local records per
        location. Partner key, or admin with partner_id.
      parameters:
        - name: partner_id
          in: query
          description: Admin keys only; the partner to act for.
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MerchantRegistration'
      responses:
        '201':
          description: Registered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MerchantRegistrationResponse'
        '400':
          description: Validation failed or a location could not be resolved to a state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    MerchantRegistration:
      type: object
      required:
        - merchant_name
        - external_id
        - locations
      properties:
        merchant_name:
          type: string
          example: Space Coast Hardware
        external_id:
          type: string
          example: SCH-1
        contact_email:
          type: string
          format: email
        locations:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/LocationInput'
        metadata:
          type: object
          additionalProperties: true
    MerchantRegistrationResponse:
      type: object
      properties:
        success:
          type: boolean
        merchant:
          type: object
          properties:
            merchant_id:
              type: string
              format: uuid
            external_id:
              type: string
            merchant_name:
              type: string
            contact_email:
              type: string
              nullable: true
            status:
              type: string
            api_key:
              type: string
              description: Shown once. Store it.
            locations:
              type: array
              items:
                $ref: '#/components/schemas/RegisteredLocation'
            portal_account:
              type: object
              nullable: true
              additionalProperties: true
    Error:
      type: object
      properties:
        error:
          type: string
          example: INVALID_REQUEST
        message:
          type: string
        errors:
          type: array
          items:
            type: string
          description: One entry per validation problem (400 responses).
    LocationInput:
      type: object
      properties:
        location_id:
          type: string
          example: L1
          description: Your identifier for the location.
        location_name:
          type: string
        address:
          oneOf:
            - type: string
            - $ref: '#/components/schemas/AddressObject'
          description: Full street address. Strongly recommended.
        zip_code:
          type: string
        state:
          type: string
        time_zone:
          type: string
          example: America/Chicago
        mobile:
          type: boolean
    RegisteredLocation:
      type: object
      properties:
        location_id:
          type: string
          nullable: true
        internal_location_id:
          type: string
          format: uuid
        zip_code:
          type: string
          nullable: true
        state:
          type: string
        jurisdiction_id:
          type: string
        rounding_method:
          $ref: '#/components/schemas/RoundingMode'
        enforcement:
          type: string
        obligation:
          type: string
          nullable: true
        legislation:
          type: string
          nullable: true
        citation:
          type: string
          nullable: true
        legislation_status:
          type: string
        effective_date:
          type: string
          format: date
          nullable: true
        tiers:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/Tier'
        accepted_transaction_types:
          type: array
          nullable: true
          items:
            type: string
        governing_today:
          type: object
          properties:
            lookup_key:
              type: string
            jurisdiction_level:
              type: string
            activation_state:
              $ref: '#/components/schemas/ActivationState'
            rounding_mode:
              $ref: '#/components/schemas/RoundingMode'
            obligation:
              type: string
              nullable: true
            legislation:
              type: string
              nullable: true
            citation:
              type: string
              nullable: true
            effective_date:
              type: string
              format: date
              nullable: true
            days_until_effective:
              type: integer
              nullable: true
        pending_rules:
          type: array
          items:
            $ref: '#/components/schemas/CountdownItem'
        local_records:
          type: array
          items:
            $ref: '#/components/schemas/LocalRecord'
        resolution:
          $ref: '#/components/schemas/ResolutionSummary'
        status:
          type: string
    AddressObject:
      type: object
      properties:
        street:
          type: string
        city:
          type: string
        state:
          type: string
          minLength: 2
          maxLength: 2
        zip:
          type: string
    RoundingMode:
      type: string
      enum:
        - symmetrical_rounding
        - mandatory_round_down
        - mandatory_round_up
        - operator_choice
        - swedish_rounding
        - nearest_nickel
        - nearest_cent
        - nearest_dime
        - none
    Tier:
      type: object
      properties:
        tier_id:
          type: string
          example: NC-TAX
        tier_name:
          type: string
        transaction_type:
          type: string
          nullable: true
        transaction_types:
          type: array
          nullable: true
          items:
            type: string
        rounding_mode:
          $ref: '#/components/schemas/RoundingMode'
        enforcement:
          type: string
        obligation:
          type: string
          enum:
            - obligates
            - permits
        citation:
          type: string
          nullable: true
        effective_date:
          type: string
          format: date
          nullable: true
        sunset_date:
          type: string
          format: date
          nullable: true
        description:
          type: string
        applies_to:
          type: string
    ActivationState:
      type: string
      enum:
        - in_force
        - default_practice
        - early_adoption_voluntary
        - pending_effective
        - not_binding
        - out_of_scope
        - awaiting_condition
        - expired
        - not_engine_supported
    CountdownItem:
      type: object
      properties:
        lookup_key:
          type: string
          example: OK
        jurisdiction_id:
          type: string
        jurisdiction_level:
          type: string
        legislation:
          type: string
          nullable: true
        citation:
          type: string
          nullable: true
        tier_id:
          type: string
          nullable: true
        tier_name:
          type: string
          nullable: true
        scope:
          type: string
          nullable: true
        obligation:
          type: string
          nullable: true
        event:
          type: string
          nullable: true
          description: >-
            obligation_change when a tier turns from permits to obligates on the
            date.
        rounding_mode:
          $ref: '#/components/schemas/RoundingMode'
        effective_date:
          type: string
          format: date
        days_until_effective:
          type: integer
        as_of_local_date:
          type: string
          format: date
        time_zone:
          type: string
    LocalRecord:
      type: object
      properties:
        level:
          type: string
          enum:
            - tribal
            - city
            - county
        key:
          type: string
          example: FL:BREVARD:TITUSVILLE
        jurisdiction_id:
          type: string
        status:
          type: string
        activation_state:
          $ref: '#/components/schemas/ActivationState'
        engine_supported:
          type: boolean
        instrument:
          type: string
          nullable: true
        evidence_tier:
          type: string
          nullable: true
    ResolutionSummary:
      type: object
      properties:
        method:
          type: string
          enum:
            - address_geocode
            - zip_fallback
            - coordinate_lookup
            - manual
            - unresolved
        confidence:
          type: string
          enum:
            - high
            - medium
            - low
            - none
        source:
          type: string
          nullable: true
        vintage:
          type: string
          nullable: true
        match_type:
          type: string
          nullable: true
        geocoded_at:
          type: string
          format: date-time
          nullable: true
        matched_address:
          type: string
          nullable: true
        latitude:
          type: number
          nullable: true
        longitude:
          type: number
          nullable: true
        state_fips:
          type: string
          nullable: true
        county_geoid:
          type: string
          nullable: true
        county_name:
          type: string
          nullable: true
        place_geoid:
          type: string
          nullable: true
        place_name:
          type: string
          nullable: true
        place_layer:
          type: string
          nullable: true
          description: Incorporated Places or Census Designated Places.
        cousub_geoid:
          type: string
          nullable: true
        aiannh_geoid:
          type: string
          nullable: true
        aiannh_name:
          type: string
          nullable: true
        time_zone:
          type: string
          nullable: true
        mobile:
          type: boolean
        needs_review:
          type: boolean
        zip_cross_check:
          $ref: '#/components/schemas/ZipCrossCheck'
        notes:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                example: zip_mismatch
              detail:
                type: string
    ZipCrossCheck:
      type: object
      nullable: true
      properties:
        registered_zip:
          type: string
        request_zip:
          type: string
          nullable: true
        geocoded_zip:
          type: string
          nullable: true
        agrees:
          type: boolean
        note:
          type: string
          nullable: true
  responses:
    Forbidden:
      description: >-
        The key lacks the permission or the resource belongs to another merchant
        or partner.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Role-scoped API key (admin, partner, merchant, auditor, readonly).

````

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