> ## Documentation Index
> Fetch the complete documentation index at: https://developers.portao3.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# /realms/{realmId}/organizations/{organizationId}/vehicles



## OpenAPI

````yaml /api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles
openapi: 3.0.3
info:
  title: Platform
  version: 1.0.0
  description: >-
    Portão 3 platform API. Generated by tools/openapi from code (routes +
    security) and the hand-written spec (request/response bodies). Confidence
    tiers: generated:typed=56 copied:manual=6 unknown=66.
servers:
  - url: https://api.platform.v2.portao3.com.br/
    description: production
  - url: https://api.platform.dev.3pers.com.br/
    description: development
security:
  - bearerAuth: []
tags:
  - name: Wallets
  - name: Cards
  - name: PIX
  - name: PIX Keys (DICT)
  - name: Boleto
  - name: Transfers
  - name: Batch Payments
  - name: Scheduled Payments
  - name: Transactions & Statements
  - name: Invoices
  - name: Contracts & Deals
  - name: Billing
  - name: Notifications
  - name: Files
  - name: Users
  - name: Approval Requests
  - name: Vehicles
paths:
  /realms/{realmId}/organizations/{organizationId}/vehicles:
    post:
      tags:
        - Vehicles
      summary: /realms/{realmId}/organizations/{organizationId}/vehicles
      operationId: postRealmsByRealmIdOrganizationsByOrganizationIdVehicles
      parameters:
        - name: realmId
          in: path
          required: true
          schema:
            type: string
        - name: organizationId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                vehicle:
                  type: string
                  minLength: 1
                name:
                  type: string
                  minLength: 1
                  maxLength: 256
                licensePlate:
                  type: string
                  minLength: 1
                  maxLength: 16
                make:
                  type: string
                  minLength: 1
                  maxLength: 128
                model:
                  type: string
                  minLength: 1
                  maxLength: 128
                year:
                  type: integer
                  minimum: 1900
                  maximum: 2100
                shared:
                  minItems: 1
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                        minLength: 1
                      role:
                        type: string
                        enum:
                          - OWNER
                          - USER
                          - READ_ONLY
                      firstName:
                        type: string
                      lastName:
                        type: string
                      email:
                        type: string
                    required:
                      - id
                      - role
              required:
                - name
                - licensePlate
                - make
                - model
                - year
      responses:
        '201':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  realmId:
                    type: string
                  organizationId:
                    type: string
                  name:
                    type: string
                  licensePlate:
                    type: string
                  make:
                    type: string
                  model:
                    type: string
                  year:
                    type: number
                  status:
                    type: string
                    enum:
                      - ACTIVE
                      - ARCHIVED
                    description: >-
                      Vehicle lifecycle state — archiving is a soft-delete,
                      never a hard removal.
                  external:
                    type: object
                    properties:
                      walletId:
                        type: string
                      accountId:
                        type: string
                    required:
                      - walletId
                      - accountId
                    description: >-
                      Provider-side identifiers for the vehicle's dedicated
                      gas-card wallet.
                  createdBy:
                    type: string
                  updatedBy:
                    type: string
                  createdAt:
                    type: string
                  updatedAt:
                    type: string
                required:
                  - id
                  - realmId
                  - organizationId
                  - name
                  - licensePlate
                  - make
                  - model
                  - year
                  - status
                  - external
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````