List realm accounts
curl --request GET \
--url https://api.banking.v2.portao3.com.br/realms/{realmId}/accountsimport requests
url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/accounts"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.banking.v2.portao3.com.br/realms/{realmId}/accounts', 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.banking.v2.portao3.com.br/realms/{realmId}/accounts",
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.banking.v2.portao3.com.br/realms/{realmId}/accounts"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.banking.v2.portao3.com.br/realms/{realmId}/accounts")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.banking.v2.portao3.com.br/realms/{realmId}/accounts")
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": "66f2a1c7b4d3e80012c9a0b4",
"realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
"organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
"legalName": "Transportes Horizonte Ltda",
"tradingName": "Horizonte Log",
"document": "11222333000181",
"foundingDate": "2015-03-18",
"businessType": "LTDA",
"mainActivity": "4930202",
"email": "financeiro@horizontelog.com.br",
"phoneNumber": "+5511987654321",
"shareholders": [
{
"document": "12345678909",
"_id": "66f2a1c7b4d3e80012c9a0b5",
"type": "PARTNER",
"firstName": "Mariana",
"lastName": "Souza Lima",
"birthDate": "1984-07-22",
"motherName": "Helena Souza Lima",
"email": "mariana.lima@horizontelog.com.br",
"phoneNumber": "+5511912345678",
"legalName": "Horizonte Participações Ltda",
"tradingName": "Horizonte Participações",
"mainActivity": "6463800",
"foundingDate": "2012-05-02",
"annualRevenue": 1500000,
"address": {
"street": "Avenida Paulista",
"number": "1578",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"postalCode": "01310-200",
"complement": "Conjunto 42"
},
"status": [
{
"status": "APPROVED",
"environment": "LIVE",
"analysisResult": [
"identity_verification_approved"
],
"_id": "66f2a1c7b4d3e80012c9a0b6",
"createdAt": "2024-09-24T13:02:11.000Z",
"updatedAt": "2024-09-24T13:18:40.000Z",
"approvedAt": "2024-09-24T13:18:40.000Z"
}
]
}
],
"status": [
{
"environment": "LIVE",
"status": "OPEN",
"analysisResult": [
"validated_data"
],
"_id": "66f2a1c7b4d3e80012c9a0b7",
"defaultWalletId": "66f2a1d0b4d3e80012c9a0b9",
"openedAt": "2024-09-24T13:02:11.000Z",
"closedAt": "2025-02-10T18:30:00.000Z",
"cardHolder": {
"status": "APPROVED",
"analysisResult": [
"<string>"
],
"createdAt": "2024-09-24T13:20:45.000Z",
"updatedAt": "2024-09-24T13:41:02.000Z",
"approvedAt": "2024-09-24T13:41:02.000Z"
},
"createdAt": "2024-09-24T13:02:11.000Z",
"updatedAt": "2024-09-24T13:20:45.000Z"
}
],
"bankingProvider": "<string>",
"external": [
{
"environment": "LIVE",
"_id": "66f2a1c7b4d3e80012c9a0b8",
"accountHolderId": "0b7e3d52-8c1a-4f6e-9d2b-5a4c3e1f0d97",
"treasuryAccountHolderId": "5e2c9a14-7b3d-4c8f-a6e1-2d9b0f4c8a63",
"treasuryAccountId": "c81f4e07-2a6b-4d93-b5e8-7f1a0c3d9b42",
"prepaidTreasuryAccountId": "e4a7c2b9-0d3f-4e61-8b5a-9c2d1f7e3a08",
"cardHolderId": "7d3b1e9a-4c2f-4a8d-b6e0-1f5c9a2d7b34",
"accountType": "<string>",
"productId": "portao3_product_02",
"accountRequestId": "2f9d6b3a-8e1c-4b7a-9d05-6c3e2a1f8b70",
"companyStatuteOcrId": "a1c5e9f3-6b2d-4e8a-9c71-3d0f5b2e7a19",
"contractOcrId": "d6b2f8a4-1e9c-4c3d-8a57-0b4e2f9c6d31",
"partnersOcr": [
{
"document": "12345678909",
"documentType": "CNH",
"ocrFrontId": "3b0f6f5e-6a3e-4b4e-9a54-6c1f0b2d9e11",
"ocrBackId": "9c2a7d41-1f0e-4e8b-a3c2-0d6e5b4f7a22",
"_id": "66f2a1c7b4d3e80012c9a0ba"
}
],
"fundsinBagId": "4c8e2a6f-9b1d-4f3a-8e75-2a0c6d9b1f53",
"fundsinDictId": "8f1b5d9c-3a7e-4c2b-9f60-1d4a8e2c7b95",
"migratedAt": "2024-03-11T09:00:00.000Z",
"createdAt": "2024-09-24T13:02:11.000Z",
"updatedAt": "2024-09-24T13:20:45.000Z"
}
],
"createdAt": "2024-09-24T13:02:11.000Z",
"updatedAt": "2024-09-24T13:20:45.000Z",
"annualRevenue": 480000000,
"address": {
"street": "Avenida Paulista",
"number": "1578",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"postalCode": "01310-200",
"complement": "Conjunto 42"
},
"walletProduct": "NORMAL",
"__v": 0
}
]{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "BANKING",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "realmId",
"message": "Invalid UUID",
"code": "REALMID_UUID"
}
]
}List realm accounts
Lists the accounts of every organization in your realm.
GET
/
realms
/
{realmId}
/
accounts
List realm accounts
curl --request GET \
--url https://api.banking.v2.portao3.com.br/realms/{realmId}/accountsimport requests
url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/accounts"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.banking.v2.portao3.com.br/realms/{realmId}/accounts', 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.banking.v2.portao3.com.br/realms/{realmId}/accounts",
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.banking.v2.portao3.com.br/realms/{realmId}/accounts"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.banking.v2.portao3.com.br/realms/{realmId}/accounts")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.banking.v2.portao3.com.br/realms/{realmId}/accounts")
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": "66f2a1c7b4d3e80012c9a0b4",
"realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
"organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
"legalName": "Transportes Horizonte Ltda",
"tradingName": "Horizonte Log",
"document": "11222333000181",
"foundingDate": "2015-03-18",
"businessType": "LTDA",
"mainActivity": "4930202",
"email": "financeiro@horizontelog.com.br",
"phoneNumber": "+5511987654321",
"shareholders": [
{
"document": "12345678909",
"_id": "66f2a1c7b4d3e80012c9a0b5",
"type": "PARTNER",
"firstName": "Mariana",
"lastName": "Souza Lima",
"birthDate": "1984-07-22",
"motherName": "Helena Souza Lima",
"email": "mariana.lima@horizontelog.com.br",
"phoneNumber": "+5511912345678",
"legalName": "Horizonte Participações Ltda",
"tradingName": "Horizonte Participações",
"mainActivity": "6463800",
"foundingDate": "2012-05-02",
"annualRevenue": 1500000,
"address": {
"street": "Avenida Paulista",
"number": "1578",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"postalCode": "01310-200",
"complement": "Conjunto 42"
},
"status": [
{
"status": "APPROVED",
"environment": "LIVE",
"analysisResult": [
"identity_verification_approved"
],
"_id": "66f2a1c7b4d3e80012c9a0b6",
"createdAt": "2024-09-24T13:02:11.000Z",
"updatedAt": "2024-09-24T13:18:40.000Z",
"approvedAt": "2024-09-24T13:18:40.000Z"
}
]
}
],
"status": [
{
"environment": "LIVE",
"status": "OPEN",
"analysisResult": [
"validated_data"
],
"_id": "66f2a1c7b4d3e80012c9a0b7",
"defaultWalletId": "66f2a1d0b4d3e80012c9a0b9",
"openedAt": "2024-09-24T13:02:11.000Z",
"closedAt": "2025-02-10T18:30:00.000Z",
"cardHolder": {
"status": "APPROVED",
"analysisResult": [
"<string>"
],
"createdAt": "2024-09-24T13:20:45.000Z",
"updatedAt": "2024-09-24T13:41:02.000Z",
"approvedAt": "2024-09-24T13:41:02.000Z"
},
"createdAt": "2024-09-24T13:02:11.000Z",
"updatedAt": "2024-09-24T13:20:45.000Z"
}
],
"bankingProvider": "<string>",
"external": [
{
"environment": "LIVE",
"_id": "66f2a1c7b4d3e80012c9a0b8",
"accountHolderId": "0b7e3d52-8c1a-4f6e-9d2b-5a4c3e1f0d97",
"treasuryAccountHolderId": "5e2c9a14-7b3d-4c8f-a6e1-2d9b0f4c8a63",
"treasuryAccountId": "c81f4e07-2a6b-4d93-b5e8-7f1a0c3d9b42",
"prepaidTreasuryAccountId": "e4a7c2b9-0d3f-4e61-8b5a-9c2d1f7e3a08",
"cardHolderId": "7d3b1e9a-4c2f-4a8d-b6e0-1f5c9a2d7b34",
"accountType": "<string>",
"productId": "portao3_product_02",
"accountRequestId": "2f9d6b3a-8e1c-4b7a-9d05-6c3e2a1f8b70",
"companyStatuteOcrId": "a1c5e9f3-6b2d-4e8a-9c71-3d0f5b2e7a19",
"contractOcrId": "d6b2f8a4-1e9c-4c3d-8a57-0b4e2f9c6d31",
"partnersOcr": [
{
"document": "12345678909",
"documentType": "CNH",
"ocrFrontId": "3b0f6f5e-6a3e-4b4e-9a54-6c1f0b2d9e11",
"ocrBackId": "9c2a7d41-1f0e-4e8b-a3c2-0d6e5b4f7a22",
"_id": "66f2a1c7b4d3e80012c9a0ba"
}
],
"fundsinBagId": "4c8e2a6f-9b1d-4f3a-8e75-2a0c6d9b1f53",
"fundsinDictId": "8f1b5d9c-3a7e-4c2b-9f60-1d4a8e2c7b95",
"migratedAt": "2024-03-11T09:00:00.000Z",
"createdAt": "2024-09-24T13:02:11.000Z",
"updatedAt": "2024-09-24T13:20:45.000Z"
}
],
"createdAt": "2024-09-24T13:02:11.000Z",
"updatedAt": "2024-09-24T13:20:45.000Z",
"annualRevenue": 480000000,
"address": {
"street": "Avenida Paulista",
"number": "1578",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"postalCode": "01310-200",
"complement": "Conjunto 42"
},
"walletProduct": "NORMAL",
"__v": 0
}
]{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "BANKING",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "realmId",
"message": "Invalid UUID",
"code": "REALMID_UUID"
}
]
}An organization normally has a single account, so the list holds about one item per organization that requested one; each carries the
organizationId it belongs to. The list is not paginated and has no filters.Path Parameters
ID of your realm.
Format: UUID
Response
Successful response
ID of the account. Use it as {accountId} in the account, wallet and card endpoints.
Example:
"66f2a1c7b4d3e80012c9a0b4"
ID of the realm the account belongs to.
Example:
"f495ff0c-ab54-4f99-8e92-ca8682e4de9b"
ID of the organization that owns the account.
Example:
"c4bd3f21-dfbd-44e8-8055-68ba15bed410"
Legal name of the company (razão social).
Example:
"Transportes Horizonte Ltda"
Trading name of the company (nome fantasia). Empty when it has none.
Example:
"Horizonte Log"
CNPJ of the company (14 digits, no punctuation).
Example:
"11222333000181"
Founding date of the company, as YYYY-MM-DD (older accounts may carry a full date-time).
Example:
"2015-03-18"
Legal form of the company, usually one of LTDA, SA, EIRELI, ME, MEI, EI, SS, SLU or OUTRO. Older accounts may carry it as free text.
Example:
"LTDA"
Main economic activity of the company (CNAE code, 7 digits).
Example:
"4930202"
Contact e-mail address of the company.
Example:
"financeiro@horizontelog.com.br"
Contact phone number of the company, in E.164 format. A few older accounts keep the format they were registered with.
Example:
"+5511987654321"
Partners, proxy holders and legal representatives of the company.
Show child attributes
Show child attributes
Status of the account in each environment it was requested in. An account has one entry per environment — usually just LIVE.
Show child attributes
Show child attributes
Internal code of the banking partner that holds the account. You never need it to call this API.
References of the account at the banking partner, one entry per environment.
Show child attributes
Show child attributes
When the account was created.
Example:
"2024-09-24T13:02:11.000Z"
When the account last changed.
Example:
"2024-09-24T13:20:45.000Z"
Declared annual revenue, in cents (BRL). Only when it was informed.
Example:
480000000
Address of the company. Absent on a few older accounts registered without one.
Show child attributes
Show child attributes
Product tier of the account: NORMAL, SUPER, BLACK, RETRANSFER, PRODUCT_08 or PRODUCT_09. It sets which product new wallets and cards are issued under.
Example:
"NORMAL"
Internal revision counter of the record.
Example:
0