> ## 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.

# Get an organization

> Returns one of your organizations: its registration data, address, shareholders and account reference.



## OpenAPI

````yaml /api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}
openapi: 3.0.3
info:
  title: Identity
  version: 1.0.0
  description: >-
    Portão 3 identity API. Every endpoint requires a bearer token in the
    Authorization header (Authorization: Bearer <token>) unless its page states
    otherwise; see the Authentication guide. That requirement is not repeated
    per endpoint. Generated by tools/openapi from code (routes + security) and
    the hand-written spec (request/response bodies). 4 app groups run without
    the identity authorizer; publicPatterns enumerates every route they expose,
    except POST /auth/sign-in, documented with HTTP Basic for the API-client
    credentials flow. Confidence tiers: generated:typed=45 copied:manual=0
    unknown=0.
servers:
  - url: https://api.identity.v2.portao3.com.br/
    description: production
  - url: https://api.identity.dev.3pers.com.br/
    description: development
security: []
tags:
  - name: Authentication
  - name: Current User
  - name: Custom Fields
  - name: API Clients
  - name: Users
  - name: Organizations
  - name: Groups
  - name: Realms
paths:
  /realms/{realmId}/organizations/{organizationId}:
    get:
      tags:
        - Organizations
      summary: Get an organization
      description: >-
        Returns one of your organizations: its registration data, address,
        shareholders and account reference.
      operationId: getRealmsByRealmIdOrganizationsByOrganizationId
      parameters:
        - name: realmId
          in: path
          required: true
          description: |-
            ID of your realm.

            Format: `UUID`
          schema:
            type: string
            format: uuid
          example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b
        - name: organizationId
          in: path
          required: true
          description: |-
            ID of the organization.

            Format: `UUID`
          schema:
            type: string
            format: uuid
          example: c4bd3f21-dfbd-44e8-8055-68ba15bed410
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: ID of the organization.
                    example: c4bd3f21-dfbd-44e8-8055-68ba15bed410
                    format: uuid
                  tradingName:
                    type: string
                    description: Trading name (nome fantasia).
                    example: Acme Logística
                  legalName:
                    type: string
                    description: Registered legal name (razão social).
                    example: Acme Logística e Transportes Ltda
                  document:
                    type: string
                    description: CNPJ of the organization, digits only.
                    example: '47285193000138'
                  currency:
                    type: string
                    description: >-
                      Currency of the organization's account, as an ISO 4217
                      numeric code: `986` is the Brazilian real.
                    example: '986'
                  municipalDocument:
                    type: string
                    description: >-
                      Municipal registration number (inscrição municipal). Empty
                      when not registered.
                    example: ''
                  stateDocument:
                    type: string
                    description: >-
                      State registration number (inscrição estadual). Empty when
                      not registered.
                    example: ''
                  address:
                    type: object
                    properties:
                      street:
                        type: string
                        description: Street name.
                        example: Avenida Paulista
                      number:
                        type: string
                        description: Street number.
                        example: '1578'
                      complement:
                        type: string
                        description: Address complement, such as the floor or suite.
                        example: Conjunto 92
                      neighborhood:
                        type: string
                        description: Neighborhood.
                        example: Bela Vista
                      city:
                        type: string
                        description: City.
                        example: São Paulo
                      state:
                        type: string
                        description: State, as its two-letter code.
                        example: SP
                      postalCode:
                        type: string
                        description: Postal code (CEP), formatted `00000-000`.
                        example: 01310-200
                      stateCode:
                        type: string
                        nullable: true
                        description: IBGE code of the state. `null` when not registered.
                        example: '35'
                      cityCode:
                        type: string
                        nullable: true
                        description: IBGE code of the city. `null` when not registered.
                        example: '3550308'
                    required:
                      - stateCode
                      - cityCode
                    description: Registered address of the organization.
                  status:
                    type: string
                    enum:
                      - CREATING
                      - AWAITING_BIOMETRIC_VALIDATION
                      - ACTIVE
                      - INACTIVE
                      - BLOCKED
                      - ERROR
                    description: >-
                      Lifecycle status. Only `ACTIVE` organizations can operate;
                      `INACTIVE` and `BLOCKED` ones can't. `CREATING` and
                      `AWAITING_BIOMETRIC_VALIDATION` are onboarding stages, and
                      `ERROR` is a legacy failure state.
                    example: ACTIVE
                  email:
                    type: string
                    description: Contact e-mail of the organization.
                    example: financeiro@acme.com.br
                  foundingDate:
                    type: string
                    nullable: true
                    description: >-
                      Founding date of the company. May be absent or `null` on
                      older organizations.
                    example: '2015-03-12T00:00:00.000Z'
                    format: date-time
                  mainActivity:
                    type: string
                    description: >-
                      Primary economic activity: the company's main CNAE code,
                      digits only.
                    example: '4930202'
                  taxationRegime:
                    type: string
                    nullable: true
                    description: >-
                      Special tax regime code (regime especial de tributação)
                      used when issuing service invoices (NFSe). Empty or `null`
                      when not registered.
                    example: ''
                  descriptionTaxationRegime:
                    type: string
                    nullable: true
                    description: >-
                      Description of the special tax regime. Empty or `null`
                      when not registered.
                    example: ''
                  annualRevenue:
                    type: number
                    description: >-
                      Declared annual revenue of the organization, in cents.
                      Omitted when not declared.
                    example: 960000000
                  nationality:
                    type: string
                    description: >-
                      Country of the organization, as an ISO 3166-1 alpha-2
                      code.
                    example: BR
                  phoneNumber:
                    type: string
                    description: Contact phone number in E.164 format.
                    example: '+551132654000'
                  shareholders:
                    type: array
                    items:
                      anyOf:
                        - type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - LEGAL_REPRESENTATIVE
                                - PROXYHOLDER
                                - PARTNER
                              description: >-
                                Role of the shareholder: `PARTNER`,
                                `LEGAL_REPRESENTATIVE` or `PROXYHOLDER`.
                              example: PARTNER
                            document:
                              type: string
                              description: CPF of the person, digits only.
                              example: '31860492703'
                            firstName:
                              type: string
                              description: First name.
                              example: Mariana
                            lastName:
                              type: string
                              description: Last name.
                              example: Costa
                            birthDate:
                              type: string
                              nullable: true
                              description: Date of birth.
                              example: '1986-04-23T00:00:00.000Z'
                              format: date-time
                            motherName:
                              type: string
                              description: Mother's full name. Empty when not provided.
                              example: ''
                            email:
                              type: string
                              description: E-mail. Empty when not provided.
                              example: mariana.costa@acme.com.br
                            phoneNumber:
                              type: string
                              nullable: true
                              description: Phone number in E.164 format.
                              example: '+5511987654321'
                            annualRevenue:
                              type: number
                              description: >-
                                Declared annual income, in cents. Omitted when
                                not declared.
                              example: 18000000
                            address:
                              type: object
                              properties:
                                street:
                                  type: string
                                  description: Street name.
                                  example: Rua Haddock Lobo
                                number:
                                  type: string
                                  description: Street number.
                                  example: '595'
                                complement:
                                  type: string
                                  description: Address complement, such as the apartment.
                                  example: Apto 41
                                neighborhood:
                                  type: string
                                  description: Neighborhood.
                                  example: Cerqueira César
                                city:
                                  type: string
                                  description: City.
                                  example: São Paulo
                                state:
                                  type: string
                                  description: State, as its two-letter code.
                                  example: SP
                                postalCode:
                                  type: string
                                  description: Postal code (CEP), formatted `00000-000`.
                                  example: 01414-001
                              description: >-
                                Address of the person. May be absent on older
                                organizations.
                          required:
                            - type
                            - document
                          description: A shareholder who is a person, identified by CPF.
                          title: Person
                        - type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - LEGAL_REPRESENTATIVE
                                - PROXYHOLDER
                                - PARTNER
                              description: >-
                                Role of the shareholder: `PARTNER`,
                                `LEGAL_REPRESENTATIVE` or `PROXYHOLDER`.
                              example: PARTNER
                            document:
                              type: string
                              description: CNPJ of the company, digits only.
                              example: '18236120000158'
                            legalName:
                              type: string
                              description: Registered legal name.
                              example: Costa Participações Ltda
                            tradingName:
                              type: string
                              description: Trading name.
                              example: Costa Participações
                            mainActivity:
                              type: string
                              description: Primary CNAE code, digits only.
                              example: '6462000'
                            foundingDate:
                              type: string
                              nullable: true
                              description: Founding date.
                              example: '2012-08-06T00:00:00.000Z'
                              format: date-time
                            email:
                              type: string
                              description: E-mail. Empty when not provided.
                              example: contato@costaparticipacoes.com.br
                            phoneNumber:
                              type: string
                              nullable: true
                              description: Phone number in E.164 format.
                              example: '+551130457700'
                            annualRevenue:
                              type: number
                              description: >-
                                Declared annual revenue, in cents. Omitted when
                                not declared.
                              example: 480000000
                            address:
                              type: object
                              properties:
                                street:
                                  type: string
                                  description: Street name.
                                  example: Rua Haddock Lobo
                                number:
                                  type: string
                                  description: Street number.
                                  example: '595'
                                complement:
                                  type: string
                                  description: Address complement, such as the apartment.
                                  example: Apto 41
                                neighborhood:
                                  type: string
                                  description: Neighborhood.
                                  example: Cerqueira César
                                city:
                                  type: string
                                  description: City.
                                  example: São Paulo
                                state:
                                  type: string
                                  description: State, as its two-letter code.
                                  example: SP
                                postalCode:
                                  type: string
                                  description: Postal code (CEP), formatted `00000-000`.
                                  example: 01414-001
                              description: >-
                                Address of the company. May be absent on older
                                organizations.
                          required:
                            - type
                            - document
                          description: A shareholder that is a company, identified by CNPJ.
                          title: Company
                    description: >-
                      Partners, legal representatives and proxy holders of the
                      organization: people (CPF) or companies (CNPJ).
                  realm:
                    type: string
                    description: ID of the realm the organization belongs to.
                    example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b
                    format: uuid
                  businessType:
                    type: string
                    enum:
                      - LTDA
                      - SA
                      - EIRELI
                      - ME
                      - MEI
                      - EI
                      - SS
                      - SLU
                      - OUTRO
                    description: >-
                      Legal nature of the company. `OUTRO` means none of the
                      others.
                    example: LTDA
                  walletProduct:
                    type: string
                    enum:
                      - NORMAL
                      - SUPER
                      - BLACK
                      - RETRANSFER
                      - PRODUCT_08
                      - PRODUCT_09
                    description: >-
                      Account product plan of the organization. Omitted when
                      none was assigned.
                    example: NORMAL
                  isSuper:
                    type: boolean
                    description: >-
                      Whether `walletProduct` is `SUPER`. Omitted on older
                      organizations.
                    example: false
                  createdAt:
                    type: string
                    description: When the organization was created.
                    example: '2024-05-20T14:03:27.118Z'
                    format: date-time
                  updatedAt:
                    type: string
                    description: When the organization last changed.
                    example: '2026-09-30T11:48:02.775Z'
                    format: date-time
                  external:
                    type: object
                    properties:
                      account:
                        type: string
                        description: >-
                          ID of the organization's account in the Banking
                          service — the `accountId` of the Banking endpoints.
                          Absent when the organization has no Banking account.
                        example: 1ffc63ec8f30faa86d28d79c
                    description: >-
                      References to the organization's resources in other Portão
                      3 services.
                required:
                  - id
                  - tradingName
                  - legalName
                  - municipalDocument
                  - stateDocument
                  - address
                  - status
                  - email
                  - mainActivity
                  - nationality
                  - phoneNumber
                  - shareholders
                  - realm
                  - createdAt
                  - updatedAt
                  - external
                description: >-
                  An organization: a company that holds a Portão 3 account in
                  your realm.

````

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