Get an organization

curl --request GET \
  --url https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}

const options = {method: 'GET'};

fetch('https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "id": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
  "tradingName": "Acme Logística",
  "legalName": "Acme Logística e Transportes Ltda",
  "municipalDocument": "",
  "stateDocument": "",
  "address": {
    "stateCode": "35",
    "cityCode": "3550308",
    "street": "Avenida Paulista",
    "number": "1578",
    "complement": "Conjunto 92",
    "neighborhood": "Bela Vista",
    "city": "São Paulo",
    "state": "SP",
    "postalCode": "01310-200"
  },
  "status": "ACTIVE",
  "email": "financeiro@acme.com.br",
  "mainActivity": "4930202",
  "nationality": "BR",
  "phoneNumber": "+551132654000",
  "shareholders": [
    {
      "type": "PARTNER",
      "document": "31860492703",
      "firstName": "Mariana",
      "lastName": "Costa",
      "birthDate": "1986-04-23T00:00:00.000Z",
      "motherName": "",
      "email": "mariana.costa@acme.com.br",
      "phoneNumber": "+5511987654321",
      "annualRevenue": 18000000,
      "address": {
        "street": "Rua Haddock Lobo",
        "number": "595",
        "complement": "Apto 41",
        "neighborhood": "Cerqueira César",
        "city": "São Paulo",
        "state": "SP",
        "postalCode": "01414-001"
      }
    }
  ],
  "realm": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
  "createdAt": "2024-05-20T14:03:27.118Z",
  "updatedAt": "2026-09-30T11:48:02.775Z",
  "external": {
    "account": "1ffc63ec8f30faa86d28d79c"
  },
  "document": "47285193000138",
  "currency": "986",
  "foundingDate": "2015-03-12T00:00:00.000Z",
  "taxationRegime": "",
  "descriptionTaxationRegime": "",
  "annualRevenue": 960000000,
  "businessType": "LTDA",
  "walletProduct": "NORMAL",
  "isSuper": false
}

GET

realms

{realmId}

organizations

{organizationId}

Get an organization

curl --request GET \
  --url https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}

const options = {method: 'GET'};

fetch('https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "id": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
  "tradingName": "Acme Logística",
  "legalName": "Acme Logística e Transportes Ltda",
  "municipalDocument": "",
  "stateDocument": "",
  "address": {
    "stateCode": "35",
    "cityCode": "3550308",
    "street": "Avenida Paulista",
    "number": "1578",
    "complement": "Conjunto 92",
    "neighborhood": "Bela Vista",
    "city": "São Paulo",
    "state": "SP",
    "postalCode": "01310-200"
  },
  "status": "ACTIVE",
  "email": "financeiro@acme.com.br",
  "mainActivity": "4930202",
  "nationality": "BR",
  "phoneNumber": "+551132654000",
  "shareholders": [
    {
      "type": "PARTNER",
      "document": "31860492703",
      "firstName": "Mariana",
      "lastName": "Costa",
      "birthDate": "1986-04-23T00:00:00.000Z",
      "motherName": "",
      "email": "mariana.costa@acme.com.br",
      "phoneNumber": "+5511987654321",
      "annualRevenue": 18000000,
      "address": {
        "street": "Rua Haddock Lobo",
        "number": "595",
        "complement": "Apto 41",
        "neighborhood": "Cerqueira César",
        "city": "São Paulo",
        "state": "SP",
        "postalCode": "01414-001"
      }
    }
  ],
  "realm": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
  "createdAt": "2024-05-20T14:03:27.118Z",
  "updatedAt": "2026-09-30T11:48:02.775Z",
  "external": {
    "account": "1ffc63ec8f30faa86d28d79c"
  },
  "document": "47285193000138",
  "currency": "986",
  "foundingDate": "2015-03-12T00:00:00.000Z",
  "taxationRegime": "",
  "descriptionTaxationRegime": "",
  "annualRevenue": 960000000,
  "businessType": "LTDA",
  "walletProduct": "NORMAL",
  "isSuper": false
}

Path Parameters

realmId

string<uuid>

required

ID of your realm.

Format: UUID

organizationId

string<uuid>

required

ID of the organization.

Format: UUID

Response

200 - application/json

Successful response

An organization: a company that holds a Portão 3 account in your realm.

string<uuid>

required

ID of the organization.

Example:

"c4bd3f21-dfbd-44e8-8055-68ba15bed410"

tradingName

string

required

Trading name (nome fantasia).

Example:

"Acme Logística"

legalName

string

required

Registered legal name (razão social).

Example:

"Acme Logística e Transportes Ltda"

municipalDocument

string

required

Municipal registration number (inscrição municipal). Empty when not registered.

Example:

""

stateDocument

string

required

State registration number (inscrição estadual). Empty when not registered.

Example:

""

address

object

required

Registered address of the organization.

Show child attributes

status

enum<string>

required

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.

Available options:

CREATING,

AWAITING_BIOMETRIC_VALIDATION,

ACTIVE,

INACTIVE,

BLOCKED,

ERROR

Example:

"ACTIVE"

string

required

Contact e-mail of the organization.

Example:

"financeiro@acme.com.br"

mainActivity

string

required

Primary economic activity: the company's main CNAE code, digits only.

Example:

"4930202"

nationality

string

required

Country of the organization, as an ISO 3166-1 alpha-2 code.

Example:

"BR"

phoneNumber

string

required

Contact phone number in E.164 format.

Example:

"+551132654000"

shareholders

(Person · object | Company · object)[]

required

Partners, legal representatives and proxy holders of the organization: people (CPF) or companies (CNPJ).

A shareholder who is a person, identified by CPF.

Person
Company

Show child attributes

realm

string<uuid>

required

ID of the realm the organization belongs to.

Example:

"f495ff0c-ab54-4f99-8e92-ca8682e4de9b"

createdAt

string<date-time>

required

When the organization was created.

Example:

"2024-05-20T14:03:27.118Z"

updatedAt

string<date-time>

required

When the organization last changed.

Example:

"2026-09-30T11:48:02.775Z"

external

object

required

References to the organization's resources in other Portão 3 services.

Show child attributes

document

string

CNPJ of the organization, digits only.

Example:

"47285193000138"

currency

string

Currency of the organization's account, as an ISO 4217 numeric code: 986 is the Brazilian real.

Example:

"986"

foundingDate

string<date-time> | null

Founding date of the company. May be absent or null on older organizations.

Example:

"2015-03-12T00:00:00.000Z"

taxationRegime

string | null

Special tax regime code (regime especial de tributação) used when issuing service invoices (NFSe). Empty or null when not registered.

Example:

""

descriptionTaxationRegime

string | null

Description of the special tax regime. Empty or null when not registered.

Example:

""

annualRevenue

number

Declared annual revenue of the organization, in cents. Omitted when not declared.

Example:

960000000

businessType

enum<string>

Legal nature of the company. OUTRO means none of the others.

Available options:

LTDA,

SA,

EIRELI,

ME,

MEI,

EI,

SS,

SLU,

OUTRO

Example:

"LTDA"

walletProduct

enum<string>

Account product plan of the organization. Omitted when none was assigned.

Available options:

NORMAL,

SUPER,

BLACK,

RETRANSFER,

PRODUCT_08,

PRODUCT_09

Example:

"NORMAL"

isSuper

boolean

Whether walletProduct is SUPER. Omitted on older organizations.

Example:

false

Overview

Identity

Banking

Billing

Accounting

Registry

Platform

Notification

Rule Engine

Scheduling

Travel

Vehicles

Attachments

Get an organization

Path Parameters

Response