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

# Listar veículos da carteira (mobilidade)

> Retorna veículos em que o CPF é proprietário ou condutor aceito, com role em cada item. Quando role=conductor, inclui conductor_id (id do vínculo aceito). brand_name/model_name são resolvidos do catálogo quando há brand_id/model_id e não há brand_other/model_other.



## OpenAPI

````yaml https://raw.githubusercontent.com/prefeitura-rio/app-rmi/refs/heads/main/docs/openapi-v3.json get /citizen/{cpf}/vehicles
openapi: 3.0.0
info:
  description: >-
    API para gerenciamento de dados de cidadãos do Rio de Janeiro, incluindo
    autodeclaração de informações e verificação de contato.
  title: API RMI
  termsOfService: http://swagger.io/terms/
  contact:
    name: Suporte RMI
    url: http://www.rio.rj.gov.br
    email: suporte@rio.rj.gov.br
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: '1.0'
servers:
  - url: https://services.pref.rio/rmi/v1
    description: Production
  - url: https://services.staging.app.dados.rio/rmi/v1
    description: Staging
security: []
tags:
  - description: >-
      Operações relacionadas a cidadãos, incluindo consulta e atualização de
      dados autodeclarados
    name: citizen
  - description: >-
      Carteira de veículos (bicicleta elétrica, autopropelido, ciclomotor),
      condutores e catálogo
    name: mobilidade
  - description: Operações relacionadas a departamentos/unidades administrativas (UA)
    name: departments
  - description: Gerenciamento de categorias de notificação (admin) e listagem pública
    name: notification-categories
  - description: Gerenciamento de preferências de notificação por CPF e telefone
    name: notification-preferences
  - description: Operações de verificação de saúde da API
    name: health
  - description: >-
      Integração Salesforce Person Account: login sync, webhook inbound (delta),
      proxies CRM e push assíncrono RMI→SF via sync worker
    name: salesforce
paths:
  /citizen/{cpf}/vehicles:
    get:
      tags:
        - mobilidade
      summary: Listar veículos da carteira (mobilidade)
      description: >-
        Retorna veículos em que o CPF é proprietário ou condutor aceito, com
        role em cada item. Quando role=conductor, inclui conductor_id (id do
        vínculo aceito). brand_name/model_name são resolvidos do catálogo quando
        há brand_id/model_id e não há brand_other/model_other.
      parameters:
        - description: CPF do cidadão (11 dígitos)
          name: cpf
          in: path
          required: true
          schema:
            type: string
            minLength: 11
            maxLength: 11
        - description: 'Número da página (padrão: 1)'
          name: page
          in: query
          schema:
            type: integer
            minimum: 1
        - description: 'Itens por página (padrão: 10, máximo: 100)'
          name: per_page
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
      responses:
        '200':
          description: Lista paginada de veículos
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.PaginatedVehicles'
        '400':
          description: CPF ou paginação inválidos
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrorResponse'
        '401':
          description: Não autenticado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrorResponse'
        '403':
          description: Acesso negado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrorResponse'
        '500':
          description: Erro interno
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    models.PaginatedVehicles:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/models.VehicleListItem'
        pagination:
          type: object
          properties:
            page:
              type: integer
            per_page:
              type: integer
            total:
              type: integer
            total_pages:
              type: integer
    handlers.ErrorResponse:
      type: object
      properties:
        error:
          type: string
    models.VehicleListItem:
      type: object
      properties:
        brand_id:
          type: string
          nullable: true
        brand_name:
          type: string
          nullable: true
        brand_other:
          type: string
          nullable: true
        color:
          type: string
        conductor_id:
          type: string
        display_name:
          type: string
        id:
          type: string
        model_id:
          type: string
          nullable: true
        model_name:
          type: string
          nullable: true
        model_other:
          type: string
          nullable: true
        registration_number:
          type: string
          example: RJ-E-000001
        role:
          $ref: '#/components/schemas/models.VehicleRole'
        vehicle_photo_url:
          type: string
        vehicle_type:
          $ref: '#/components/schemas/models.VehicleType'
    models.VehicleRole:
      type: string
      enum:
        - owner
        - conductor
      x-enum-varnames:
        - VehicleRoleOwner
        - VehicleRoleConductor
    models.VehicleType:
      type: string
      enum:
        - bicicleta_eletrica
        - autopropelido
        - ciclomotor
      x-enum-varnames:
        - VehicleTypeBicicletaEletrica
        - VehicleTypeAutopropelido
        - VehicleTypeCiclomotor
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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