GET/v1/LegalPerson

Crédito · Pessoas

Lista todas as pessoas jurídicas inseridas

Lista e filtra registros de Legal Person.

Visão geral

Autenticação e pré-requisitos

Requer autenticação. Envie o token no header Authorization: Bearer {{token}} (JWT do AWS Cognito). Integrações servidor-a-servidor podem usar X-Api-Key. Todo tráfego é HTTPS e a credencial nunca vai na URL nem em query string.

Request

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição	Exemplo
`page`	query	`integer`	opcional	—	`10`
`size`	query	`integer`	opcional	—	`10`
`searchString`	query	`string`	opcional	—	`valor`
`responsible`	query	`string`	opcional	—	`valor`
`companyName`	query	`string`	opcional	—	`valor`
`registrationNumber`	query	`string`	opcional	—	`valor`
`email`	query	`string`	opcional	—	`valor`
`phone`	query	`string`	opcional	—	`valor`
`initialDate`	query	`string (date-time)`	opcional	—	`valor`
`finalDate`	query	`string (date-time)`	opcional	—	`valor`
`isDeleted`	query	`boolean`	opcional	—	`true`
`pendingPreApprove`	query	`boolean`	opcional	—	`true`
`orderBy`	query	`string`	opcional	—	`valor`
`filterByOwner`	query	`string`	opcional	—	`valor`
`filterByOwnerGroup`	query	`string`	opcional	—	`valor`

Corpo da requisição

Este endpoint não recebe corpo.

Response

Resposta 200.

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`page`	`integer`	opcional	—	—	`0`
`totalPages`	`integer`	opcional	—	—	`0`
`totalItems`	`integer`	opcional	—	—	`0`
`data`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`
`paginationToken`	`string`	opcional	—	—	`"texto"`
`totalValue`	`integer (int64)`	opcional	—	—	`0`
`totalAssignmentValue`	`integer (int64)`	opcional	—	—	`0`

Detalhe de `data`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`id`	`string (uuid)`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`createdAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`createdBy`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`tenant`	`string`	opcional	—	—	`"texto"`
`tenantDisplay`	`string`	opcional	—	—	`"texto"`
`updatedAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`updatedBy`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`ownerUser`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`ownerGroup`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`registrationNumber`	`string`	opcional	—	—	`"12345678909"`
`companyName`	`string`	opcional	—	—	`"Fulano de Tal"`
`averageMonthlyRevenue`	`number (double)`	opcional	—	—	`1000`
`name`	`string`	opcional	—	—	`"Fulano de Tal"`
`typeOfActivity`	`string`	opcional	—	—	`"texto"`
`typeOfActivityDisplay`	`string`	opcional	—	—	`"texto"`
`legalNature`	`string`	opcional	—	—	`"texto"`
`externalEmployerId`	`integer`	opcional	—	—	`1`
`legalNatureDisplay`	`string`	opcional	—	—	`"texto"`
`municipalRegistration`	`string`	opcional	—	—	`"texto"`
`stateRegistration`	`string`	opcional	—	—	`"texto"`
`hasOpenCapitalRegistrationCVM`	`boolean`	opcional	—	—	`true`
`openDate`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`email`	`string`	opcional	—	—	`"cliente@exemplo.com.br"`
`site`	`string`	opcional	—	—	`"texto"`
`responsible`	`string`	opcional	—	—	`"texto"`
`address`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`phone`	`string`	opcional	—	—	`"11987654321"`
`phoneExtension`	`string`	opcional	—	—	`"11987654321"`
`phone2`	`string`	opcional	—	—	`"11987654321"`
`phone2Extension`	`string`	opcional	—	—	`"11987654321"`
`economicActivityCodeId`	`string (uuid)`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`economicActivityCode`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`sameBillingAddress`	`boolean`	opcional	—	—	`true`
`averageGrossProfitMargin`	`number (double)`	opcional	—	—	`1000`
`initialShareCapital`	`number (double)`	opcional	—	—	`1000`
`netWorth`	`number (double)`	opcional	—	—	`1000`
`purchases`	`number (double)`	opcional	—	—	`1000`
`amountRentedFinanced`	`number (double)`	opcional	—	—	`1000`
`exportPercentage`	`number (double)`	opcional	—	—	`1.99`
`costWithSuppliers`	`number (double)`	opcional	—	—	`1000`
`numberOfEmployees`	`integer`	opcional	—	—	`0`
`payrollValue`	`number (double)`	opcional	—	—	`1000`
`spendingAmountWithTax`	`number (double)`	opcional	—	—	`1.99`
`averageSalary`	`number (double)`	opcional	—	—	`1000`
`typeOfResidence`	`string`	opcional	—	—	`"texto"`
`typeOfResidenceDisplay`	`string`	opcional	—	—	`"texto"`
`averageSalesPeriod`	`integer`	opcional	—	—	`0`
`fosterablePotential`	`number (double)`	opcional	—	—	`1000`
`delayedSalePercentage`	`number (double)`	opcional	—	—	`1.99`
`description`	`string`	opcional	—	—	`"texto"`
`allowAccessToSchedule`	`boolean`	opcional	—	—	`true`
`allowAccessToReceivables`	`boolean`	opcional	—	—	`true`
`allowPartnerApiSubscription`	`boolean`	opcional	—	—	`true`
`status`	`string`	opcional	—	—	`"texto"`
`statusDisplay`	`string`	opcional	—	—	`"texto"`
`uploads`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`
`assets`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`
`bankAccounts`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`
`relatedPerson`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`
`personCreditStatus`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`riskRating`	`string`	opcional	—	—	`"texto"`
`b3Account`	`string`	opcional	—	—	`"texto"`
`managerIdDisplay`	`string`	opcional	—	—	`"texto"`
`manager`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`

Detalhe de `createdBy`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`userId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`registrationNumber`	`string`	opcional	—	—	`"12345678909"`
`userIdDisplay`	`string`	opcional	—	—	`"texto"`
`tenantDisplay`	`string`	opcional	—	—	`"texto"`
`tenant`	`string`	opcional	—	—	`"texto"`
`tenantName`	`string`	opcional	—	—	`"Fulano de Tal"`

Detalhe de `ownerGroup`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`groupDisplay`	`string`	opcional	—	—	`"texto"`
`groupId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`tenantDisplay`	`string`	opcional	—	—	`"texto"`
`tenantName`	`string`	opcional	—	—	`"Fulano de Tal"`

Detalhe de `address`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`addressName`	`string`	opcional	—	—	`"Fulano de Tal"`
`zipCode`	`string`	opcional	—	—	`"01310930"`
`city`	`string`	opcional	—	—	`"texto"`
`uf`	`string`	opcional	—	—	`"texto"`
`ufDisplay`	`string`	opcional	—	—	`"texto"`
`district`	`string`	opcional	—	—	`"texto"`
`number`	`string`	opcional	—	—	`"texto"`
`complement`	`string`	opcional	—	—	`"texto"`

Detalhe de `economicActivityCode`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`code`	`string`	opcional	—	—	`"texto"`
`description`	`string`	opcional	—	—	`"texto"`

Detalhe de `uploads`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`id`	`string (uuid)`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`createdAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`createdBy`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`tenant`	`string`	opcional	—	—	`"texto"`
`tenantDisplay`	`string`	opcional	—	—	`"texto"`
`updatedAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`updatedBy`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`ownerUser`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`ownerGroup`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`fileName`	`string`	opcional	—	—	`"Fulano de Tal"`
`fileType`	`string`	opcional	—	—	`"texto"`
`displayName`	`string`	opcional	—	—	`"Fulano de Tal"`
`documentDate`	`string (date-time)`	opcional	Data do próprio documento (emissão/referência), distinta da data do upload (CreatedAt). Retornada para qualquer tipo de documento; nula quando não foi informada no envio.	—	`"2025-08-11T13:45:00Z"`
`tempUrl`	`string`	opcional	—	—	`"https://exemplo.com.br/callback"`
`tempGetUrl`	`string`	opcional	—	—	`"https://exemplo.com.br/callback"`
`tempPutUrl`	`string`	opcional	—	—	`"https://exemplo.com.br/callback"`

Detalhe de `assets`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`id`	`string (uuid)`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`createdAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`createdBy`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`tenant`	`string`	opcional	—	—	`"texto"`
`tenantDisplay`	`string`	opcional	—	—	`"texto"`
`updatedAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`updatedBy`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`ownerUser`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`ownerGroup`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`assetType`	`string`	opcional	—	—	`"texto"`
`assetTypeDisplay`	`string`	opcional	—	—	`"texto"`
`description`	`string`	opcional	—	—	`"texto"`
`registerNumber`	`string`	opcional	—	—	`"texto"`
`estimatedValue`	`number (double)`	opcional	—	—	`1000`
`settled`	`boolean`	opcional	—	—	`true`

Detalhe de `bankAccounts`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`id`	`string (uuid)`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`createdAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`createdBy`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`tenant`	`string`	opcional	—	—	`"texto"`
`tenantDisplay`	`string`	opcional	—	—	`"texto"`
`updatedAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`updatedBy`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`ownerUser`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`ownerGroup`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`bankCode`	`string`	opcional	—	—	`"texto"`
`bankCodeCompe`	`integer`	opcional	—	—	`0`
`bankCodeDisplay`	`string`	opcional	Nome de exibição do Código do banco	—	`"texto"`
`bankIspb`	`integer (int64)`	opcional	Código ISPB do banco	—	`0`
`account`	`string`	opcional	—	—	`"texto"`
`accountDigit`	`string`	opcional	—	—	`"texto"`
`agency`	`string`	opcional	—	—	`"texto"`
`agencyDigit`	`string`	opcional	—	—	`"texto"`
`type`	`string`	opcional	—	—	`"texto"`
`typeDisplay`	`string`	opcional	Nome de exibição do tipo da Conta Bancaria	—	`"texto"`
`jointAccount`	`boolean`	opcional	—	—	`true`
`operationTypeValue`	`string`	opcional	TED, PIX	—	`"texto"`
`pixKeyTypeValue`	`string`	opcional	tipo chave pix	—	`"texto"`
`keyPix`	`string`	opcional	chave pix	—	`"texto"`

Detalhe de `relatedPerson`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`personId`	`string (uuid)`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`discriminator`	`string`	opcional	—	—	`"texto"`
`personIdDisplay`	`string`	opcional	—	—	`"texto"`
`typeOfRelationship`	`string`	opcional	—	—	`"texto"`
`typeOfRelationshipDisplay`	`string`	opcional	—	—	`"texto"`
`signatureType`	`string`	opcional	—	—	`"texto"`
`signatureTypeDisplay`	`string`	opcional	—	—	`"texto"`
`signatureValidation`	`string`	opcional	—	—	`"texto"`
`signatureValidationDisplay`	`string`	opcional	—	—	`"texto"`

Detalhe de `personCreditStatus`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`registrationNumber`	`string`	opcional	—	—	`"12345678909"`
`validUntil`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`status`	`string`	opcional	—	—	`"texto"`
`reason`	`string`	opcional	—	—	`"texto"`
`detailedReason`	`string`	opcional	—	—	`"texto"`
`approvedLimit`	`integer (int64)`	opcional	—	—	`0`

Detalhe de `manager`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`id`	`string (uuid)`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`createdAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`createdBy`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`tenant`	`string`	opcional	—	—	`"texto"`
`tenantDisplay`	`string`	opcional	—	—	`"texto"`
`updatedAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`updatedBy`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`ownerUser`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`ownerGroup`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`registrationNumber`	`string`	opcional	—	—	`"12345678909"`
`name`	`string`	opcional	—	—	`"Fulano de Tal"`
`alternativeName`	`string`	opcional	—	—	`"Fulano de Tal"`
`discriminator`	`string`	opcional	—	—	`"texto"`
`riskRating`	`string`	opcional	—	—	`"texto"`

Exemplo de resposta

{
  "page": 0,
  "totalPages": 0,
  "totalItems": 0,
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "2025-08-11T13:45:00Z",
      "createdBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "tenant": "texto",
      "tenantDisplay": "texto",
      "updatedAt": "2025-08-11T13:45:00Z",
      "updatedBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupDisplay": "texto",
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "registrationNumber": "12345678909",
      "companyName": "Fulano de Tal",
      "averageMonthlyRevenue": 1000,
      "name": "Fulano de Tal",
      "typeOfActivity": "texto",
      "typeOfActivityDisplay": "texto",
      "legalNature": "texto",
      "externalEmployerId": 1,
      "legalNatureDisplay": "texto",
      "municipalRegistration": "texto",
      "stateRegistration": "texto",
      "hasOpenCapitalRegistrationCVM": true,
      "openDate": "2025-08-11T13:45:00Z",
      "email": "cliente@exemplo.com.br",
      "site": "texto",
      "responsible": "texto",
      "address": {
        "addressName": "Fulano de Tal",
        "zipCode": "01310930",
        "city": "texto",
        "uf": "texto",
        "ufDisplay": "texto",
        "district": "texto",
        "number": "texto",
        "complement": "texto"
      },
      "phone": "11987654321",
      "phoneExtension": "11987654321",
      "phone2": "11987654321",
      "phone2Extension": "11987654321",
      "economicActivityCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "economicActivityCode": {
        "code": "texto",
        "description": "texto"
      },
      "sameBillingAddress": true,
      "averageGrossProfitMargin": 1000,
      "initialShareCapital": 1000,
      "netWorth": 1000,
      "purchases": 1000,
      "amountRentedFinanced": 1000,
      "exportPercentage": 1.99,
      "costWithSuppliers": 1000,
      "numberOfEmployees": 0,
      "payrollValue": 1000,
      "spendingAmountWithTax": 1.99,
      "averageSalary": 1000,
      "typeOfResidence": "texto",
      "typeOfResidenceDisplay": "texto",
      "averageSalesPeriod": 0,
      "fosterablePotential": 1000,
      "delayedSalePercentage": 1.99,
      "description": "texto",
      "allowAccessToSchedule": true,
      "allowAccessToReceivables": true,
      "allowPartnerApiSubscription": true,
      "status": "texto",
      "statusDisplay": "texto",
      "uploads": [
        {}
      ],
      "assets": [
        {}
      ],
      "bankAccounts": [
        {}
      ],
      "relatedPerson": [
        {}
      ],
      "personCreditStatus": {
        "registrationNumber": "12345678909",
        "validUntil": "2025-08-11T13:45:00Z",
        "status": "texto",
        "reason": "texto",
        "detailedReason": "texto",
        "approvedLimit": 0
      },
      "riskRating": "texto",
      "b3Account": "texto",
      "managerIdDisplay": "texto",
      "manager": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "createdAt": "2025-08-11T13:45:00Z",
        "createdBy": {},
        "tenant": "texto",
        "tenantDisplay": "texto",
        "updatedAt": "2025-08-11T13:45:00Z",
        "updatedBy": {},
        "ownerUser": {},
        "ownerGroup": {},
        "registrationNumber": "12345678909",
        "name": "Fulano de Tal",
        "alternativeName": "Fulano de Tal",
        "discriminator": "texto",
        "riskRating": "texto"
      }
    }
  ],
  "paginationToken": "texto",
  "totalValue": 0,
  "totalAssignmentValue": 0
}

Códigos de retorno

Código	Significado	Detalhe do contrato
`200`	Requisição bem-sucedida.	Success

Exemplos

curl -X GET "{{baseUrl}}/v1/LegalPerson" \
  -H "Authorization: Bearer {{token}}"

var baseUrl = "{{baseUrl}}";
var token   = "{{token}}";

using var http = new HttpClient { BaseAddress = new Uri(baseUrl) };
http.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", token);

var rota = "/v1/LegalPerson";

var resp = await http.GetAsync(rota);
resp.EnsureSuccessStatusCode();
var json = await resp.Content.ReadAsStringAsync();

const baseUrl = '{{baseUrl}}';
const token   = '{{token}}';

const resp = await fetch(`${baseUrl}/v1/LegalPerson`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
const data = await resp.json();

Troque apenas {{baseUrl}} e {{token}}. No Postman, defina-os como variáveis de environment; o cURL importa em Import > Raw text.

Downloads

Este endpoint já vem configurado nas collections abaixo, na pasta da etapa correspondente.

Collection completaConsignado privado e FGTS, em pastas espelhando a documentação.Baixar →Collection do Consignado privadoCadastros, operação e consultas do módulo.Baixar →Collection do FGTSCadastros, operação e consultas do módulo.Baixar →Environment do PostmanAs variáveis fora da collection, para versionar uma sem versionar o token.Baixar →Documentação consolidada para LLMToda a documentação em um arquivo de texto, na ordem da navegação.Baixar →Referência em MarkdownEste contrato, campo a campo, gerado do spec.Baixar →

Guia de importação: Como importar no Postman · Todos os downloads: Downloads

Visão geral

Autenticação e pré-requisitos

Request

Parâmetros

Corpo da requisição

Response

Campos

Detalhe de data

Detalhe de createdBy

Detalhe de ownerGroup

Detalhe de address

Detalhe de economicActivityCode

Detalhe de uploads

Detalhe de assets

Detalhe de bankAccounts

Detalhe de relatedPerson

Detalhe de personCreditStatus

Detalhe de manager