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

# Create invitation (admin)

> Create an invitation for a platform as a Keystone admin. Typically used to onboard the first platform admin after platform registration.



## OpenAPI

````yaml https://api-staging.keystoneos.xyz/openapi.json post /v1/platforms/{platform_id}/invitations
openapi: 3.1.0
info:
  title: Keystone API
  description: Settlement orchestration API for tokenized Real-World Assets (RWAs).
  version: 0.1.0
servers:
  - url: https://api.keystoneos.xyz
    description: Production
security:
  - bearerAuth: []
tags:
  - name: health
    description: Health and version checks.
  - name: platforms
    description: Register and manage your platform profile.
  - name: environments
    description: Manage platform environments (sandbox, production).
  - name: settlement-templates
    description: View and manage settlement templates.
  - name: settlements
    description: Initiate, monitor, and manage settlements.
  - name: sessions
    description: Create and manage browser-safe session tokens for frontend widgets.
  - name: instructions
    description: Submit and manage bilateral settlement instructions.
  - name: invitations
    description: Invite team members to your platform.
  - name: members
    description: Manage platform team members and roles.
  - name: webhooks
    description: Configure webhook endpoints for real-time event notifications.
  - name: security
    description: IP allowlisting and API access controls.
  - name: activity
    description: Audit trail of platform actions.
  - name: dashboard
    description: Dashboard metrics and statistics.
  - name: callbacks
    description: Provider callback handlers (internal).
  - name: alchemy-webhooks
    description: Alchemy blockchain event webhooks (internal).
  - name: chains
    description: Supported blockchain networks for settlement.
  - name: admin
    description: KeyStone internal administration endpoints.
  - name: admin-platforms
    description: Admin platform management.
  - name: admin-settlements
    description: Admin settlement oversight and intervention.
  - name: admin-compliance
    description: Admin compliance check management.
  - name: admin-activity
    description: Admin system-wide activity logs.
  - name: admin-webhooks
    description: Admin webhook diagnostics.
  - name: internal
    description: Keystone-internal worker endpoints.
  - name: internal-compliance
    description: Internal compliance engine endpoints.
paths:
  /v1/platforms/{platform_id}/invitations:
    post:
      tags:
        - invitations
      summary: Create invitation (admin)
      description: >-
        Create an invitation for a platform as a Keystone admin. Typically used
        to onboard the first platform admin after platform registration.
      operationId: admin_create_invitation_v1_platforms__platform_id__invitations_post
      parameters:
        - name: platform_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Platform Id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvitationCreate'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvitationRead'
        '404':
          description: Platform not found.
        '422':
          description: Platform has no linked Auth0 Organization.
        '502':
          description: Failed to create invitation in Auth0.
components:
  schemas:
    InvitationCreate:
      properties:
        email:
          type: string
          format: email
          title: Email
        role_ids:
          items:
            type: string
          type: array
          title: Role Ids
          default: []
        send_email:
          type: boolean
          title: Send Email
          default: true
      type: object
      required:
        - email
      title: InvitationCreate
    InvitationRead:
      properties:
        id:
          type: string
          title: Id
        invitee_email:
          type: string
          title: Invitee Email
        inviter_name:
          type: string
          title: Inviter Name
        roles:
          items:
            type: string
          type: array
          title: Roles
        invitation_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Invitation Url
        created_at:
          anyOf:
            - type: string
            - type: string
              format: date-time
          title: Created At
        expires_at:
          anyOf:
            - type: string
            - type: string
              format: date-time
          title: Expires At
      type: object
      required:
        - id
        - invitee_email
        - inviter_name
        - roles
        - created_at
        - expires_at
      title: InvitationRead
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Auth0 JWT access token. See
        [Authentication](/getting-started/authentication) for details.

````