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

# Send warmed invites (V1 Legacy)

> V1-compatible endpoint to send pre-filled (KYC-primed) invites, in light or full mode.



## OpenAPI

````yaml openapi/openapi-v1.yaml POST /v1/invites/warmed
openapi: 3.0.3
info:
  title: B2B API V1 (Legacy)
  description: >-
    Rise is a blockchain first platform where by all actions are secured and
    executed on-chain. Rise has blockchain smart-contracts on the Arbitrum
    optimistic rollup chain that control the flow of funds. That means that
    executing a change within the Rise platform requires a wallet with
    permissions on the user or company's RiseID.
  version: 1.0.0
servers:
  - url: https://b2b-api.dev-riseworks.io
    description: Development
  - url: https://b2b-api.staging-riseworks.io
    description: Staging
  - url: https://b2b-api.riseworks.io
    description: Production
security: []
paths:
  /v1/invites/warmed:
    post:
      tags:
        - Invites
      summary: Send warmed invites (V1 Legacy)
      description: >-
        V1-compatible endpoint to send pre-filled (KYC-primed) invites, in light
        or full mode.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                light:
                  description: Light mode only requires name+email; defaults to false.
                  type: boolean
                users:
                  type: array
                  items:
                    type: object
                    properties:
                      sumsub_sharetoken:
                        type: string
                      role:
                        description: >-
                          One of 'contractor', 'team_employee',
                          'aor_contractor'.
                        type: string
                      details:
                        type: object
                        properties:
                          email:
                            type: string
                          firstname:
                            type: string
                          lastname:
                            type: string
                          middlename:
                            type: string
                          dob:
                            type: string
                          tin:
                            type: string
                          external_reference_id:
                            type: string
                          sumsub_id:
                            type: string
                          registrationType:
                            type: string
                        required:
                          - email
                      address:
                        type: object
                        properties:
                          country:
                            type: string
                          city:
                            type: string
                          state:
                            type: string
                          address_line1:
                            type: string
                          address_line2:
                            type: string
                          zip:
                            type: string
                          timezone:
                            type: string
                      companyData:
                        type: object
                        properties:
                          name:
                            type: string
                          phone:
                            type: string
                          tax_id:
                            type: string
                    required:
                      - details
                company_riseid:
                  description: RiseID of the company/team.
                  type: string
                company_id:
                  description: >-
                    Numeric id of the company/team (alternative to
                    company_riseid).
                  anyOf:
                    - type: string
                    - type: number
                role:
                  description: >-
                    One of 'contractor' (default), 'team_employee',
                    'aor_contractor'.
                  type: string
              required:
                - users
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      failed:
                        type: array
                        items:
                          type: object
                          properties:
                            invite:
                              type: string
                            error:
                              type: string
                          required:
                            - invite
                            - error
                          additionalProperties: false
                      countAdded:
                        type: number
                      invited:
                        type: array
                        items:
                          type: string
                    required:
                      - failed
                      - countAdded
                      - invited
                    additionalProperties: false
                required:
                  - data
                additionalProperties: false
        '400':
          description: Bad Request - Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                      - Bad Request
                  message:
                    type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - invalid_parameters
                      errors:
                        type: object
                        additionalProperties:
                          type: array
                          items:
                            type: string
                    required:
                      - type
                      - errors
                    additionalProperties: false
                required:
                  - error
                  - message
                additionalProperties: false
                description: Bad Request - Invalid parameters
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  data:
                    type: string
                  error_code:
                    type: string
                required:
                  - success
                  - data
                additionalProperties: false
                description: Unauthorized
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  data:
                    type: string
                  error_code:
                    type: string
                required:
                  - success
                  - data
                additionalProperties: false
                description: Forbidden
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  data:
                    type: string
                  error_code:
                    type: string
                required:
                  - success
                  - data
                additionalProperties: false
                description: Not Found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  data:
                    type: string
                  error_code:
                    type: string
                required:
                  - success
                  - data
                additionalProperties: false
                description: Internal Server Error

````