Skip to main content
GET
/
identity
/
v1
/
organizations
/
{organizationId}
Gets details for a specific organization.
curl --request GET \
  --url https://api.sandbox.tesouro.com/identity/v1/organizations/{organizationId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "displayName": "<string>",
  "isEnabled": true,
  "legalName": "<string>",
  "shortName": "<string>",
  "types": [
    "BANK"
  ],
  "address": {
    "address1": "<string>",
    "address2": "<string>",
    "city": "<string>",
    "country": "<string>",
    "postalCode": "<string>",
    "stateOrProvince": "<string>"
  },
  "childOrganizationTypeCounts": {},
  "domainName": "<string>",
  "embeddedBusinessData": {
    "businessStructureType": "<string>",
    "formationDate": "2023-12-25",
    "naicsCode": "<string>",
    "taxId": {
      "maskedTaxId": "<string>",
      "taxIdType": "<string>"
    }
  },
  "phoneNumber": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
organizationId
string<uuid>
required

The unique identifier of the organization to retrieve.

Response

Returns the organization details.

Response DTO for the organization details endpoint.

​
id
string<uuid>
required

The unique identifier of the organization.

​
displayName
string
required

The display name of the organization.

​
isEnabled
boolean
required

Whether the organization is currently enabled (active within the time window).

​
legalName
string
required

The legal name of the organization.

​
shortName
string
required

A short identifier for the organization.

​
types
enum<string>[]
required

The types assigned to the organization (e.g., VSP, Bank).

Available options:
BANK,
EMBEDDED,
PLATFORM,
TRANSACTOR,
VERTICAL_SOFTWARE_PROVIDER
​
address
object

The organization's address, if available.

​
childOrganizationTypeCounts
object

Counts of direct child organizations grouped by type (e.g., {"VERTICAL_SOFTWARE_PROVIDER": 3, "EMBEDDED": 2}). Empty dictionary if the organization has no children.

​
domainName
null | string

The domain name / website of the organization.

​
embeddedBusinessData
object

Embedded business entity data, populated when the target organization has embedded data.

​
phoneNumber
null | string

The organization's phone number, if available.