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

# Invite a broker

> Sends the broker an email inviting them to join the brokerage firm.



## OpenAPI

````yaml /openapi.json post /broker-invite
openapi: 3.0.0
info:
  title: Korint API
  description: >-
    Quoting, policy issuance, billing, claims, documents and compliance for
    insurance distribution.
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.korint.io
    description: Production
  - url: https://api.sandbox.korint.io
    description: Sandbox
security:
  - oauth2: []
  - bearerAuth: []
tags: []
paths:
  /broker-invite:
    post:
      tags:
        - invitations
      summary: Invite a broker
      description: Sends the broker an email inviting them to join the brokerage firm.
      operationId: InvitationController_brokerInvite
      parameters:
        - name: tenant
          in: header
          required: true
          description: Your tenant identifier. Requests without it are rejected.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BrokerInviteBody'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InviteOutput'
        '400':
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/InvalidEmailErrorDto'
              examples:
                INVALID_EMAIL:
                  value:
                    code: INVALID_EMAIL
                    message: Invalid email
                    details: {}
          description: ''
components:
  schemas:
    BrokerInviteBody:
      type: object
      properties:
        email:
          format: email
          type: string
          description: Email address to invite
        brokerageFirmId:
          pattern: >-
            ^brokerage_firm(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
          type: string
          description: Brokerage firm id
        firstName:
          type: string
          description: First name
        lastName:
          type: string
          description: Last name
        brokerRole:
          type: string
          description: Broker role
      required:
        - email
        - brokerageFirmId
        - firstName
        - lastName
    InviteOutput:
      type: object
      properties: {}
    InvalidEmailErrorDto:
      type: object
      properties:
        code:
          type: string
          enum:
            - INVALID_EMAIL
        message:
          type: string
          example: Invalid email
        details:
          $ref: '#/components/schemas/InvalidEmailDetailsDto'
      required:
        - code
        - message
        - details
    InvalidEmailDetailsDto:
      type: object
      properties:
        email:
          type: string
      required:
        - email
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://korint-tenant.auth.eu-west-3.amazoncognito.com/oauth2/token
          scopes:
            korint.io/account: Read account information
            korint.io/analytics: Access analytics endpoints
            korint.io/assets: Access asset endpoints
            korint.io/billing: Access billing endpoints
            korint.io/branches: Access branch endpoints
            korint.io/broker: Access broker endpoints
            korint.io/claims: Access claim endpoints
            korint.io/comments: Access comment endpoints
            korint.io/customers: Access customer endpoints
            korint.io/derogations: Access derogation endpoints
            korint.io/documents: Access document endpoints
            korint.io/external: Access external lookup endpoints
            korint.io/external-claims: Declare claims from an external system
            korint.io/internal-notes: Access internal note endpoints
            korint.io/invitations: Access invitation endpoints
            korint.io/payments: Access payment endpoints
            korint.io/permissions: Access permission management endpoints
            korint.io/policies: Access policy endpoints
            korint.io/quotes: Access quote endpoints
            korint.io/reportings: Access reporting endpoints
            korint.io/signature: Access signature endpoints
      description: >-
        Machine-to-machine clients use the OAuth 2.0 client credentials grant.
        Each tenant has its own authorization server: in the token URL below,
        replace `tenant` with your tenant identifier.
    bearerAuth:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: An access token obtained from your tenant authorization server.

````