# Referência de API — Crédito (UY3)

> 64 endpoints, organizados pelo fluxo de integração. Todos os exemplos usam os placeholders `{{baseUrl}}` (URL base do ambiente) e `{{token}}` (token JWT).

## Autenticação

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

## Pessoas

Cadastre ou selecione a pessoa (física ou jurídica) titular da operação.

### GET /v1/LegalPerson

**Lista todas as pessoas jurídicas inseridas** — Lista e filtra registros de Legal Person.

**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` |

**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:

```json
{
  "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 |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### POST /v1/LegalPerson

**Insere uma nova pessoa jurídica** — Cria um novo registro de Legal Person.

Insere uma nova pessoa jurídica. Caso já exista um cadastro existente da PJ visível ao operador solicitante (com base no CNPJ), os dados existentes serão atualizados e o ID retornado será o do registro existente. Coleções relacionadas serão combinadas (dados bancários, documentos, etc).

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `returnValue` | query | `string` | opcional | — | `valor` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `registrationNumber` | `string` | obrigatório | Número CNPJ | — | `"12345678909"` |
| `companyName` | `string` | obrigatório | Razão Social | — | `"Fulano de Tal"` |
| `name` | `string` | obrigatório | Nome fantasia | — | `"Fulano de Tal"` |
| `typeOfActivity` | `string` | opcional | — | `Industry`, `services`, `business` | `"Industry"` |
| `legalNature` | `string` | opcional | — | `MEI`, `EI`, `EIREILI`, `SA`, `LTDA`, `SLU`, `SUA`, `SS` | `"MEI"` |
| `municipalRegistration` | `string` | opcional | Inscrição municipal | — | `"texto"` |
| `stateRegistration` | `string` | opcional | Inscrição estadual | — | `"texto"` |
| `hasOpenCapitalRegistrationCVM` | `boolean` | opcional | Se possui registro de capital aberno CVM | — | `true` |
| `openDate` | `string (date-time)` | opcional | Data de início das atividades | — | `"2025-08-11T13:45:00Z"` |
| `email` | `string` | obrigatório | E-mail de contato | — | `"cliente@exemplo.com.br"` |
| `site` | `string` | opcional | Website institucional | — | `"texto"` |
| `responsible` | `string` | opcional | Responsável legal | — | `"texto"` |
| `address` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `phone` | `string` | obrigatório | Número de telefone | — | `"11987654321"` |
| `phoneExtension` | `string` | opcional | Ramal do telefone | — | `"11987654321"` |
| `phone2` | `string` | opcional | Número de telefone alternativo | — | `"11987654321"` |
| `phone2Extension` | `string` | opcional | Ramal do telefone alternativo | — | `"11987654321"` |
| `economicActivityCodeId` | `string (uuid)` | opcional | ID do Código de Atividade Econômica Principal (CNAE) | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `sameBillingAddress` | `boolean` | opcional | Indica se o endereço de cobrança é o mesmo endereço da sede | — | `true` |
| `b3Account` | `string` | opcional | Número da Conta B3 | — | `"texto"` |
| `averageMonthlyRevenue` | `number (double)` | opcional | Faturamento médio mensal dos últimos 12 meses | — | `1000` |
| `averageGrossProfitMargin` | `number (double)` | opcional | Margem Média de Lucro Bruto dos últimos 12 meses | — | `1000` |
| `initialShareCapital` | `number (double)` | opcional | Capital social integralizado | — | `1000` |
| `netWorth` | `number (double)` | opcional | Patrimônio Líquido | — | `1000` |
| `purchases` | `number (double)` | opcional | Valor em compras nos últimos 12 meses | — | `1000` |
| `amountRentedFinanced` | `number (double)` | opcional | Valor Alugado/Financiado | — | `1000` |
| `exportPercentage` | `number (double)` | opcional | Exportação (em % do faturamento) | — | `1.99` |
| `costWithSuppliers` | `number (double)` | opcional | Custo com fornecedores | — | `1000` |
| `numberOfEmployees` | `integer` | opcional | Número de funcionários | — | `0` |
| `payrollValue` | `number (double)` | opcional | Valor da folha de pagamentos | — | `1000` |
| `spendingAmountWithTax` | `number (double)` | opcional | Gasto corrente com impostos | — | `1.99` |
| `typeOfResidence` | `string` | opcional | — | `Owner`, `Rent` | `"Owner"` |
| `averageSalesPeriod` | `integer` | opcional | Período média de vendas (PMV) em dias | — | `0` |
| `fosterablePotential` | `number (double)` | opcional | Potencial fomentável | — | `1000` |
| `delayedSalePercentage` | `number (double)` | opcional | Percentual de Venda em Atraso | — | `1.99` |
| `description` | `string` | opcional | Descrição das atividades da empresa | — | `"texto"` |
| `allowAccessToSchedule` | `boolean` | opcional | Permite contato para agendamentos | — | `true` |
| `allowAccessToReceivables` | `boolean` | opcional | Permite acesso à carteira de recebíveis | — | `true` |
| `allowPartnerApiSubscription` | `boolean` | opcional | Permite acesso à API parceira | — | `true` |
| `uploads` | `array de objeto` | opcional | Documentos carregados | objeto — ver detalhe abaixo | `[ … ]` |
| `assets` | `array de objeto` | opcional | Lista de bens e diretos | objeto — ver detalhe abaixo | `[ … ]` |
| `externalEmployerId` | `integer` | opcional | — | — | `1` |
| `bankAccounts` | `array de objeto` | opcional | Lista de contas bancárias | objeto — ver detalhe abaixo | `[ … ]` |
| `relatedPerson` | `array de objeto` | opcional | Lista de pessoas envolvidas | objeto — ver detalhe abaixo | `[ … ]` |
| `riskRating` | `string` | opcional | — | `Low`, `Intermediary`, `High` | `"Low"` |
| `managerId` | `string (uuid)` | opcional | Gestor | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |

Detalhe de `ownerUser`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `ownerGroup`:

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

Detalhe de `address`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `addressName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |
| `zipCode` | `string` | opcional | — | — | `"01310930"` |
| `city` | `string` | obrigatório | — | — | `"texto"` |
| `uf` | `string` | opcional | — | `NaoSelecionado`, `AC`, `AL`, `AP`, `AM`, `BA`, `CE`, `DF`, `ES`, `GO`, `MA`, `MT`, `MS`, `MG`, `PA`, `PB`, `PR`, `PE`, `PI`, `RJ`, `RN`, `RS`, `RO`, `RR`, `SC`, `SP`, `SE`, `TO` | `"NaoSelecionado"` |
| `district` | `string` | obrigatório | — | — | `"texto"` |
| `number` | `string` | opcional | Número do endereço deve conter apenas números | — | `"texto"` |
| `complement` | `string` | opcional | — | — | `"texto"` |

Detalhe de `uploads`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `fileType` | `string` | obrigatório | — | `Document`, `Authorization`, `DriversLicense`, `WorkCard`, `ResidenceProofCompany`, `ResidenceProofPartners`, `Draft`, `SocialContract`, `RegistrationNumber`, `IdentificationDocumentWithPhoto`, `BankStatement`, `ManagerialBilling`, `RegistrationForm`, `Others`, `Selfie`, `SelfieWithIdentityCard`, `LastDeclaration`, `SignedContract`, `SigningStampContract`, `CreditReport`, `Assignment`, `Addition`, `FiduciaryAssignment`, `P7S`, `ZipedFiles`, `CNAB`, `Invoice`, `MinutesOfElection`, `Procuration`, `TermOfOwnership`, `Bylaws`, `IdentityCard`, `Collateral`, `Regulation`, `Balance`, `BalanceSheet`, `PLDFT`, `IncomeTax`, `DRE`, `Receipt`, `CompanyCard`, `AssignmetReport`, `NationalRegistryOfForeigners`, `NationalIdentityCard`, `RegionalRegistrationCard`, `Passaport`, `Paycheck`, `Indorsement`, `WarrantyRegistrationOfficeProof`, `OperationHistory`, `VehicleInspection`, `InsuranceCancellationTemplate`, `SignatureTemplateDraft`, `InssDefermentReport`, `InssMedicalReview` | `"Document"` |
| `fileName` | `string` | obrigatório | Nome do arquivo (retornado pelo GET v1/Upload) | — | `"Fulano de Tal"` |
| `displayName` | `string` | opcional | Nome de exibição do arquivo | — | `"Fulano de Tal"` |
| `documentDate` | `string (date-time)` | opcional | Data do próprio documento (emissão/referência), não a data do upload. Aceita em qualquer tipo de documento e sempre opcional.   Só tem efeito de negócio no laudo de deferimento INSS e na última perícia INSS, cujos valores são comparados aos cortes da regra de elegibilidade dos benefícios 32/92 (faixa 45–54); nos demais tipos é apenas informativa. | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `assets`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `naturalPersonId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `legalPersonId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `assetType` | `string` | obrigatório | — | `Cash`, `AccountsReceivable`, `Inventory`, `Investments`, `Vehicles`, `Furniture`, `Patents`, `RealEstate` | `"Cash"` |
| `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 |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `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 | — | `NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount` | `"NaturalCheckingAccount"` |
| `jointAccount` | `boolean` | opcional | — | — | `true` |
| `operationTypeValue` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |
| `pixKeyTypeValue` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `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"` |
| `typeOfRelationship` | `string` | opcional | — | `Issuer`, `PartnerGuarantor`, `Guarantor`, `Proxy`, `ProxyGuarantor`, `Partner`, `Spouse`, `Consenter`, `Witness`, `Assignor`, `Assignee`, `Endorser`, `Employer`, `Creditor`, `Debtor`, `PartnerDebtor`, `BillingAgent`, `BillingAgentApproverUser`, `Beneficiary`, `NotaryAgent`, `SettlementAgent`, `CreditorEndorser`, `FaithfulCustodian`, `JointGuarantor`, `ThirdPartyGuarantor`, `LegalRepresentative`, `InsuranceCompany`, `Presidente`, `Administrador`, `Diretor` | `"Issuer"` |
| `signatureType` | `string` | opcional | — | `email`, `sms`, `whatsapp` | `"email"` |
| `signatureValidation` | `string` | opcional | — | `EletronicSignatureAndDocument`, `SelfieSignature`, `SelfieDocumentSignature`, `FacialBiometrics`, `DigitalCertificate`, `EletronicSignature` | `"EletronicSignatureAndDocument"` |

Exemplo:

```json
{
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "registrationNumber": "12345678909",
  "companyName": "Fulano de Tal",
  "name": "Fulano de Tal",
  "typeOfActivity": "Industry",
  "legalNature": "MEI",
  "municipalRegistration": "texto",
  "stateRegistration": "texto",
  "hasOpenCapitalRegistrationCVM": true,
  "openDate": "2025-08-11T13:45:00Z",
  "email": "cliente@exemplo.com.br",
  "site": "texto",
  "responsible": "texto",
  "address": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "addressName": "Fulano de Tal",
    "zipCode": "01310930",
    "city": "texto",
    "uf": "NaoSelecionado",
    "district": "texto",
    "number": "texto",
    "complement": "texto"
  },
  "phone": "11987654321",
  "phoneExtension": "11987654321",
  "phone2": "11987654321",
  "phone2Extension": "11987654321",
  "economicActivityCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "sameBillingAddress": true,
  "b3Account": "texto",
  "averageMonthlyRevenue": 1000,
  "averageGrossProfitMargin": 1000,
  "initialShareCapital": 1000,
  "netWorth": 1000,
  "purchases": 1000,
  "amountRentedFinanced": 1000,
  "exportPercentage": 1.99,
  "costWithSuppliers": 1000,
  "numberOfEmployees": 0,
  "payrollValue": 1000,
  "spendingAmountWithTax": 1.99,
  "typeOfResidence": "Owner",
  "averageSalesPeriod": 0,
  "fosterablePotential": 1000,
  "delayedSalePercentage": 1.99,
  "description": "texto",
  "allowAccessToSchedule": true,
  "allowAccessToReceivables": true,
  "allowPartnerApiSubscription": true,
  "uploads": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "fileType": "Document",
      "fileName": "Fulano de Tal",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z"
    }
  ],
  "assets": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "naturalPersonId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "legalPersonId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "assetType": "Cash",
      "description": "texto",
      "registerNumber": "texto",
      "estimatedValue": 1000,
      "settled": true
    }
  ],
  "externalEmployerId": 1,
  "bankAccounts": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "bankCode": 0,
      "bankIspb": 0,
      "account": "texto",
      "accountDigit": "texto",
      "agency": "texto",
      "agencyDigit": "texto",
      "type": "NaturalCheckingAccount",
      "jointAccount": true,
      "operationTypeValue": "Transfer",
      "pixKeyTypeValue": "NaturalRegistrationNumber",
      "keyPix": "texto"
    }
  ],
  "relatedPerson": [
    {
      "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "typeOfRelationship": "Issuer",
      "signatureType": "email",
      "signatureValidation": "EletronicSignatureAndDocument"
    }
  ],
  "riskRating": "Low",
  "managerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
```

**Resposta 200**

Exemplo:

```json
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/LegalPerson" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "registrationNumber": "12345678909",
  "companyName": "Fulano de Tal",
  "name": "Fulano de Tal",
  "typeOfActivity": "Industry",
  "legalNature": "MEI",
  "municipalRegistration": "texto",
  "stateRegistration": "texto",
  "hasOpenCapitalRegistrationCVM": true,
  "openDate": "2025-08-11T13:45:00Z",
  "email": "cliente@exemplo.com.br",
  "site": "texto",
  "responsible": "texto",
  "address": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "addressName": "Fulano de Tal",
    "zipCode": "01310930",
    "city": "texto",
    "uf": "NaoSelecionado",
    "district": "texto",
    "number": "texto",
    "complement": "texto"
  },
  "phone": "11987654321",
  "phoneExtension": "11987654321",
  "phone2": "11987654321",
  "phone2Extension": "11987654321",
  "economicActivityCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "sameBillingAddress": true,
  "b3Account": "texto",
  "averageMonthlyRevenue": 1000,
  "averageGrossProfitMargin": 1000,
  "initialShareCapital": 1000,
  "netWorth": 1000,
  "purchases": 1000,
  "amountRentedFinanced": 1000,
  "exportPercentage": 1.99,
  "costWithSuppliers": 1000,
  "numberOfEmployees": 0,
  "payrollValue": 1000,
  "spendingAmountWithTax": 1.99,
  "typeOfResidence": "Owner",
  "averageSalesPeriod": 0,
  "fosterablePotential": 1000,
  "delayedSalePercentage": 1.99,
  "description": "texto",
  "allowAccessToSchedule": true,
  "allowAccessToReceivables": true,
  "allowPartnerApiSubscription": true,
  "uploads": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "fileType": "Document",
      "fileName": "Fulano de Tal",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z"
    }
  ],
  "assets": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "naturalPersonId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "legalPersonId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "assetType": "Cash",
      "description": "texto",
      "registerNumber": "texto",
      "estimatedValue": 1000,
      "settled": true
    }
  ],
  "externalEmployerId": 1,
  "bankAccounts": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "bankCode": 0,
      "bankIspb": 0,
      "account": "texto",
      "accountDigit": "texto",
      "agency": "texto",
      "agencyDigit": "texto",
      "type": "NaturalCheckingAccount",
      "jointAccount": true,
      "operationTypeValue": "Transfer",
      "pixKeyTypeValue": "NaturalRegistrationNumber",
      "keyPix": "texto"
    }
  ],
  "relatedPerson": [
    {
      "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "typeOfRelationship": "Issuer",
      "signatureType": "email",
      "signatureValidation": "EletronicSignatureAndDocument"
    }
  ],
  "riskRating": "Low",
  "managerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'
```

---

### GET /v1/LegalPerson/{id}

**Lista uma pessoa jurídica por id** — Consulta Legal Person pelo identificador informado na rota.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Resposta 200**

Campos:

| 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:

```json
{
  "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": [
    {
      "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"
      },
      "fileName": "Fulano de Tal",
      "fileType": "texto",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z",
      "tempUrl": "https://exemplo.com.br/callback",
      "tempGetUrl": "https://exemplo.com.br/callback",
      "tempPutUrl": "https://exemplo.com.br/callback"
    }
  ],
  "assets": [
    {
      "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"
      },
      "assetType": "texto",
      "assetTypeDisplay": "texto",
      "description": "texto",
      "registerNumber": "texto",
      "estimatedValue": 1000,
      "settled": true
    }
  ],
  "bankAccounts": [
    {
      "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"
      },
      "bankCode": "texto",
      "bankCodeCompe": 0,
      "bankCodeDisplay": "texto",
      "bankIspb": 0,
      "account": "texto",
      "accountDigit": "texto",
      "agency": "texto",
      "agencyDigit": "texto",
      "type": "texto",
      "typeDisplay": "texto",
      "jointAccount": true,
      "operationTypeValue": "texto",
      "pixKeyTypeValue": "texto",
      "keyPix": "texto"
    }
  ],
  "relatedPerson": [
    {
      "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "discriminator": "texto",
      "personIdDisplay": "texto",
      "typeOfRelationship": "texto",
      "typeOfRelationshipDisplay": "texto",
      "signatureType": "texto",
      "signatureTypeDisplay": "texto",
      "signatureValidation": "texto",
      "signatureValidationDisplay": "texto"
    }
  ],
  "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": {
      "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",
    "name": "Fulano de Tal",
    "alternativeName": "Fulano de Tal",
    "discriminator": "texto",
    "riskRating": "texto"
  }
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/v1/LegalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

### PUT /v1/LegalPerson/{id}

**Atualiza os dados de uma pessoa jurídica** — Atualiza por completo um registro de Legal Person existente.

Atualiza os dados de uma pessoa jurídica. Observe que essa requisição pode excluir registros relacionados caso não sejam incluídos no corpo. Por exemplo, dados bancários e uploads não referênciados serão excluídos. Isso pode causar erros caso o dado bancário esteja relacionado à uma operação de crédito concluída ou em andamento. Neste caso, utilize a API específica de atualização de dados bancários. Essa atualização é ignorada se a coleção relacionada for informada com valor nulo.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `returnValue` | query | `string` | opcional | — | `valor` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `companyName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |
| `name` | `string` | obrigatório | — | — | `"Fulano de Tal"` |
| `typeOfActivity` | `string` | opcional | — | `Industry`, `services`, `business` | `"Industry"` |
| `legalNature` | `string` | opcional | — | `MEI`, `EI`, `EIREILI`, `SA`, `LTDA`, `SLU`, `SUA`, `SS` | `"MEI"` |
| `municipalRegistration` | `string` | opcional | — | — | `"texto"` |
| `stateRegistration` | `string` | opcional | — | — | `"texto"` |
| `hasOpenCapitalRegistrationCVM` | `boolean` | opcional | — | — | `true` |
| `b3Account` | `string` | opcional | — | — | `"texto"` |
| `openDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `email` | `string` | obrigatório | — | — | `"cliente@exemplo.com.br"` |
| `site` | `string` | opcional | — | — | `"texto"` |
| `responsible` | `string` | opcional | — | — | `"texto"` |
| `address` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `phone` | `string` | obrigatório | — | — | `"11987654321"` |
| `phoneExtension` | `string` | opcional | — | — | `"11987654321"` |
| `phone2` | `string` | opcional | — | — | `"11987654321"` |
| `phone2Extension` | `string` | opcional | — | — | `"11987654321"` |
| `economicActivityCodeId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `sameBillingAddress` | `boolean` | opcional | — | — | `true` |
| `averageMonthlyRevenue` | `number (double)` | opcional | — | — | `1000` |
| `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` |
| `typeOfResidence` | `string` | opcional | — | `Owner`, `Rent` | `"Owner"` |
| `averageSalesPeriod` | `integer` | opcional | — | — | `0` |
| `fosterablePotential` | `number (double)` | opcional | — | — | `1000` |
| `delayedSalePercentage` | `number (double)` | opcional | — | — | `1.99` |
| `allowAccessToSchedule` | `boolean` | opcional | — | — | `true` |
| `allowAccessToReceivables` | `boolean` | opcional | — | — | `true` |
| `allowPartnerApiSubscription` | `boolean` | opcional | — | — | `true` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `externalEmployerId` | `integer` | opcional | — | — | `1` |
| `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 | `[ … ]` |
| `riskRating` | `string` | opcional | — | `Low`, `Intermediary`, `High` | `"Low"` |
| `managerId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |

Detalhe de `address`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `addressName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |
| `zipCode` | `string` | opcional | — | — | `"01310930"` |
| `city` | `string` | obrigatório | — | — | `"texto"` |
| `uf` | `string` | obrigatório | — | `NaoSelecionado`, `AC`, `AL`, `AP`, `AM`, `BA`, `CE`, `DF`, `ES`, `GO`, `MA`, `MT`, `MS`, `MG`, `PA`, `PB`, `PR`, `PE`, `PI`, `RJ`, `RN`, `RS`, `RO`, `RR`, `SC`, `SP`, `SE`, `TO` | `"NaoSelecionado"` |
| `district` | `string` | obrigatório | — | — | `"texto"` |
| `number` | `string` | opcional | Número do endereço deve conter apenas números | — | `"texto"` |
| `complement` | `string` | opcional | — | — | `"texto"` |

Detalhe de `uploads`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `id` | `string (uuid)` | opcional | Id do arquivo | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `fileName` | `string` | obrigatório | Nome do arquivo (retornado pelo GET v1/Upload) | — | `"Fulano de Tal"` |
| `fileType` | `string` | opcional | — | `Document`, `Authorization`, `DriversLicense`, `WorkCard`, `ResidenceProofCompany`, `ResidenceProofPartners`, `Draft`, `SocialContract`, `RegistrationNumber`, `IdentificationDocumentWithPhoto`, `BankStatement`, `ManagerialBilling`, `RegistrationForm`, `Others`, `Selfie`, `SelfieWithIdentityCard`, `LastDeclaration`, `SignedContract`, `SigningStampContract`, `CreditReport`, `Assignment`, `Addition`, `FiduciaryAssignment`, `P7S`, `ZipedFiles`, `CNAB`, `Invoice`, `MinutesOfElection`, `Procuration`, `TermOfOwnership`, `Bylaws`, `IdentityCard`, `Collateral`, `Regulation`, `Balance`, `BalanceSheet`, `PLDFT`, `IncomeTax`, `DRE`, `Receipt`, `CompanyCard`, `AssignmetReport`, `NationalRegistryOfForeigners`, `NationalIdentityCard`, `RegionalRegistrationCard`, `Passaport`, `Paycheck`, `Indorsement`, `WarrantyRegistrationOfficeProof`, `OperationHistory`, `VehicleInspection`, `InsuranceCancellationTemplate`, `SignatureTemplateDraft`, `InssDefermentReport`, `InssMedicalReview` | `"Document"` |
| `displayName` | `string` | opcional | Nome de exibição do arquivo | — | `"Fulano de Tal"` |
| `documentDate` | `string (date-time)` | opcional | Data do próprio documento (emissão/referência), não a data do upload. Aceita em qualquer tipo de documento e sempre opcional. Só tem efeito de negócio no laudo de deferimento INSS e na última perícia INSS (regra de elegibilidade dos benefícios 32/92). | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `assets`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `id` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `assetType` | `string` | obrigatório | — | `Cash`, `AccountsReceivable`, `Inventory`, `Investments`, `Vehicles`, `Furniture`, `Patents`, `RealEstate` | `"Cash"` |
| `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 |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `id` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `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 | — | `NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount` | `"NaturalCheckingAccount"` |
| `jointAccount` | `boolean` | opcional | — | — | `true` |
| `operationTypeValue` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |
| `pixKeyTypeValue` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `keyPix` | `string` | opcional | Chave Pix | — | `"texto"` |

Detalhe de `relatedPerson`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `legalPersonId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `personId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `typeOfRelationship` | `string` | opcional | — | `Issuer`, `PartnerGuarantor`, `Guarantor`, `Proxy`, `ProxyGuarantor`, `Partner`, `Spouse`, `Consenter`, `Witness`, `Assignor`, `Assignee`, `Endorser`, `Employer`, `Creditor`, `Debtor`, `PartnerDebtor`, `BillingAgent`, `BillingAgentApproverUser`, `Beneficiary`, `NotaryAgent`, `SettlementAgent`, `CreditorEndorser`, `FaithfulCustodian`, `JointGuarantor`, `ThirdPartyGuarantor`, `LegalRepresentative`, `InsuranceCompany`, `Presidente`, `Administrador`, `Diretor` | `"Issuer"` |
| `signatureType` | `string` | opcional | — | `email`, `sms`, `whatsapp` | `"email"` |
| `signatureValidation` | `string` | opcional | — | `EletronicSignatureAndDocument`, `SelfieSignature`, `SelfieDocumentSignature`, `FacialBiometrics`, `DigitalCertificate`, `EletronicSignature` | `"EletronicSignatureAndDocument"` |

Detalhe de `ownerUser`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `ownerGroup`:

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

Exemplo:

```json
{
  "companyName": "Fulano de Tal",
  "name": "Fulano de Tal",
  "typeOfActivity": "Industry",
  "legalNature": "MEI",
  "municipalRegistration": "texto",
  "stateRegistration": "texto",
  "hasOpenCapitalRegistrationCVM": true,
  "b3Account": "texto",
  "openDate": "2025-08-11T13:45:00Z",
  "email": "cliente@exemplo.com.br",
  "site": "texto",
  "responsible": "texto",
  "address": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "addressName": "Fulano de Tal",
    "zipCode": "01310930",
    "city": "texto",
    "uf": "NaoSelecionado",
    "district": "texto",
    "number": "texto",
    "complement": "texto"
  },
  "phone": "11987654321",
  "phoneExtension": "11987654321",
  "phone2": "11987654321",
  "phone2Extension": "11987654321",
  "economicActivityCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "sameBillingAddress": true,
  "averageMonthlyRevenue": 1000,
  "averageGrossProfitMargin": 1000,
  "initialShareCapital": 1000,
  "netWorth": 1000,
  "purchases": 1000,
  "amountRentedFinanced": 1000,
  "exportPercentage": 1.99,
  "costWithSuppliers": 1000,
  "numberOfEmployees": 0,
  "payrollValue": 1000,
  "spendingAmountWithTax": 1.99,
  "typeOfResidence": "Owner",
  "averageSalesPeriod": 0,
  "fosterablePotential": 1000,
  "delayedSalePercentage": 1.99,
  "allowAccessToSchedule": true,
  "allowAccessToReceivables": true,
  "allowPartnerApiSubscription": true,
  "description": "texto",
  "externalEmployerId": 1,
  "uploads": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fileName": "Fulano de Tal",
      "fileType": "Document",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z"
    }
  ],
  "assets": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "assetType": "Cash",
      "description": "texto",
      "registerNumber": "texto",
      "estimatedValue": 1000,
      "settled": true
    }
  ],
  "bankAccounts": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "bankCode": 0,
      "bankIspb": 0,
      "account": "texto",
      "accountDigit": "texto",
      "agency": "texto",
      "agencyDigit": "texto",
      "type": "NaturalCheckingAccount",
      "jointAccount": true,
      "operationTypeValue": "Transfer",
      "pixKeyTypeValue": "NaturalRegistrationNumber",
      "keyPix": "texto"
    }
  ],
  "relatedPerson": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "legalPersonId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "typeOfRelationship": "Issuer",
      "signatureType": "email",
      "signatureValidation": "EletronicSignatureAndDocument"
    }
  ],
  "riskRating": "Low",
  "managerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/LegalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "companyName": "Fulano de Tal",
  "name": "Fulano de Tal",
  "typeOfActivity": "Industry",
  "legalNature": "MEI",
  "municipalRegistration": "texto",
  "stateRegistration": "texto",
  "hasOpenCapitalRegistrationCVM": true,
  "b3Account": "texto",
  "openDate": "2025-08-11T13:45:00Z",
  "email": "cliente@exemplo.com.br",
  "site": "texto",
  "responsible": "texto",
  "address": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "addressName": "Fulano de Tal",
    "zipCode": "01310930",
    "city": "texto",
    "uf": "NaoSelecionado",
    "district": "texto",
    "number": "texto",
    "complement": "texto"
  },
  "phone": "11987654321",
  "phoneExtension": "11987654321",
  "phone2": "11987654321",
  "phone2Extension": "11987654321",
  "economicActivityCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "sameBillingAddress": true,
  "averageMonthlyRevenue": 1000,
  "averageGrossProfitMargin": 1000,
  "initialShareCapital": 1000,
  "netWorth": 1000,
  "purchases": 1000,
  "amountRentedFinanced": 1000,
  "exportPercentage": 1.99,
  "costWithSuppliers": 1000,
  "numberOfEmployees": 0,
  "payrollValue": 1000,
  "spendingAmountWithTax": 1.99,
  "typeOfResidence": "Owner",
  "averageSalesPeriod": 0,
  "fosterablePotential": 1000,
  "delayedSalePercentage": 1.99,
  "allowAccessToSchedule": true,
  "allowAccessToReceivables": true,
  "allowPartnerApiSubscription": true,
  "description": "texto",
  "externalEmployerId": 1,
  "uploads": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fileName": "Fulano de Tal",
      "fileType": "Document",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z"
    }
  ],
  "assets": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "assetType": "Cash",
      "description": "texto",
      "registerNumber": "texto",
      "estimatedValue": 1000,
      "settled": true
    }
  ],
  "bankAccounts": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "bankCode": 0,
      "bankIspb": 0,
      "account": "texto",
      "accountDigit": "texto",
      "agency": "texto",
      "agencyDigit": "texto",
      "type": "NaturalCheckingAccount",
      "jointAccount": true,
      "operationTypeValue": "Transfer",
      "pixKeyTypeValue": "NaturalRegistrationNumber",
      "keyPix": "texto"
    }
  ],
  "relatedPerson": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "legalPersonId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "typeOfRelationship": "Issuer",
      "signatureType": "email",
      "signatureValidation": "EletronicSignatureAndDocument"
    }
  ],
  "riskRating": "Low",
  "managerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'
```

---

### DELETE /v1/LegalPerson/{id}

**Exclui uma pessoa jurídica** — Remove um registro de Legal Person.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X DELETE "{{baseUrl}}/v1/LegalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /v1/LegalPerson/{id}/BankAccount

**Insere dados da(s) conta(s) bancária(s) para a pessoa jurídica** — Cria um novo registro de Legal Person.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | id pessoa jurídica | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Corpo da requisição** (`application/json`, lista/array)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `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 | — | `NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount` | `"NaturalCheckingAccount"` |
| `jointAccount` | `boolean` | opcional | — | — | `true` |
| `operationTypeValue` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |
| `pixKeyTypeValue` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `keyPix` | `string` | opcional | chave pix | — | `"texto"` |

Detalhe de `ownerUser`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `ownerGroup`:

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

Exemplo:

```json
[
  {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "bankCode": 0,
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "NaturalCheckingAccount",
    "jointAccount": true,
    "operationTypeValue": "Transfer",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "keyPix": "texto"
  }
]
```

**Resposta 200**

Exemplo:

```json
[
  "3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/LegalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6/BankAccount" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "bankCode": 0,
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "NaturalCheckingAccount",
    "jointAccount": true,
    "operationTypeValue": "Transfer",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "keyPix": "texto"
  }
]'
```

---

### POST /v1/LegalPerson/{id}/Upload

**Insere documentos para a pessoa jurídica** — Cria um novo registro de Legal Person.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | id pessoa jurídica | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Corpo da requisição** (`application/json`, lista/array)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `fileType` | `string` | obrigatório | — | `Document`, `Authorization`, `DriversLicense`, `WorkCard`, `ResidenceProofCompany`, `ResidenceProofPartners`, `Draft`, `SocialContract`, `RegistrationNumber`, `IdentificationDocumentWithPhoto`, `BankStatement`, `ManagerialBilling`, `RegistrationForm`, `Others`, `Selfie`, `SelfieWithIdentityCard`, `LastDeclaration`, `SignedContract`, `SigningStampContract`, `CreditReport`, `Assignment`, `Addition`, `FiduciaryAssignment`, `P7S`, `ZipedFiles`, `CNAB`, `Invoice`, `MinutesOfElection`, `Procuration`, `TermOfOwnership`, `Bylaws`, `IdentityCard`, `Collateral`, `Regulation`, `Balance`, `BalanceSheet`, `PLDFT`, `IncomeTax`, `DRE`, `Receipt`, `CompanyCard`, `AssignmetReport`, `NationalRegistryOfForeigners`, `NationalIdentityCard`, `RegionalRegistrationCard`, `Passaport`, `Paycheck`, `Indorsement`, `WarrantyRegistrationOfficeProof`, `OperationHistory`, `VehicleInspection`, `InsuranceCancellationTemplate`, `SignatureTemplateDraft`, `InssDefermentReport`, `InssMedicalReview` | `"Document"` |
| `fileName` | `string` | obrigatório | Nome do arquivo (retornado pelo GET v1/Upload) | — | `"Fulano de Tal"` |
| `displayName` | `string` | opcional | Nome de exibição do arquivo | — | `"Fulano de Tal"` |
| `documentDate` | `string (date-time)` | opcional | Data do próprio documento (emissão/referência), não a data do upload. Aceita em qualquer tipo de documento e sempre opcional.   Só tem efeito de negócio no laudo de deferimento INSS e na última perícia INSS, cujos valores são comparados aos cortes da regra de elegibilidade dos benefícios 32/92 (faixa 45–54); nos demais tipos é apenas informativa. | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `ownerUser`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `ownerGroup`:

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

Exemplo:

```json
[
  {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "fileType": "Document",
    "fileName": "Fulano de Tal",
    "displayName": "Fulano de Tal",
    "documentDate": "2025-08-11T13:45:00Z"
  }
]
```

**Resposta 200**

Exemplo:

```json
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/LegalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6/Upload" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "fileType": "Document",
    "fileName": "Fulano de Tal",
    "displayName": "Fulano de Tal",
    "documentDate": "2025-08-11T13:45:00Z"
  }
]'
```

---

### PUT /v1/LegalPerson/{id}/BankAccount/{bankAccountId}

**Atualiza os dados bancários de uma pessoa jurídica** — Atualiza por completo um registro de Legal Person existente.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | id pessoa jurídica | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `bankAccountId` | path | `string (uuid)` | obrigatório | id conta bancária | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `id` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `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 | — | `NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount` | `"NaturalCheckingAccount"` |
| `jointAccount` | `boolean` | opcional | — | — | `true` |
| `operationTypeValue` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |
| `pixKeyTypeValue` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `keyPix` | `string` | opcional | Chave Pix | — | `"texto"` |

Detalhe de `ownerUser`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `ownerGroup`:

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

Exemplo:

```json
{
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "bankCode": 0,
  "bankIspb": 0,
  "account": "texto",
  "accountDigit": "texto",
  "agency": "texto",
  "agencyDigit": "texto",
  "type": "NaturalCheckingAccount",
  "jointAccount": true,
  "operationTypeValue": "Transfer",
  "pixKeyTypeValue": "NaturalRegistrationNumber",
  "keyPix": "texto"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/LegalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "bankCode": 0,
  "bankIspb": 0,
  "account": "texto",
  "accountDigit": "texto",
  "agency": "texto",
  "agencyDigit": "texto",
  "type": "NaturalCheckingAccount",
  "jointAccount": true,
  "operationTypeValue": "Transfer",
  "pixKeyTypeValue": "NaturalRegistrationNumber",
  "keyPix": "texto"
}'
```

---

### DELETE /v1/LegalPerson/{id}/BankAccount/{bankAccountId}

**Exclui os dados da conta bancária do cliente** — Remove um registro de Legal Person.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | id pessoa jurídica | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `bankAccountId` | path | `string (uuid)` | obrigatório | id conta bancária | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X DELETE "{{baseUrl}}/v1/LegalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

### PUT /v1/LegalPerson/{id}/Upload/{uploadId}

**Atualiza documento de uma pessoa jurídica** — Atualiza por completo um registro de Legal Person existente.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | id pessoa jurídica | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `uploadId` | path | `string (uuid)` | obrigatório | id documento | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `id` | `string (uuid)` | opcional | Id do arquivo | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `fileName` | `string` | obrigatório | Nome do arquivo (retornado pelo GET v1/Upload) | — | `"Fulano de Tal"` |
| `fileType` | `string` | opcional | — | `Document`, `Authorization`, `DriversLicense`, `WorkCard`, `ResidenceProofCompany`, `ResidenceProofPartners`, `Draft`, `SocialContract`, `RegistrationNumber`, `IdentificationDocumentWithPhoto`, `BankStatement`, `ManagerialBilling`, `RegistrationForm`, `Others`, `Selfie`, `SelfieWithIdentityCard`, `LastDeclaration`, `SignedContract`, `SigningStampContract`, `CreditReport`, `Assignment`, `Addition`, `FiduciaryAssignment`, `P7S`, `ZipedFiles`, `CNAB`, `Invoice`, `MinutesOfElection`, `Procuration`, `TermOfOwnership`, `Bylaws`, `IdentityCard`, `Collateral`, `Regulation`, `Balance`, `BalanceSheet`, `PLDFT`, `IncomeTax`, `DRE`, `Receipt`, `CompanyCard`, `AssignmetReport`, `NationalRegistryOfForeigners`, `NationalIdentityCard`, `RegionalRegistrationCard`, `Passaport`, `Paycheck`, `Indorsement`, `WarrantyRegistrationOfficeProof`, `OperationHistory`, `VehicleInspection`, `InsuranceCancellationTemplate`, `SignatureTemplateDraft`, `InssDefermentReport`, `InssMedicalReview` | `"Document"` |
| `displayName` | `string` | opcional | Nome de exibição do arquivo | — | `"Fulano de Tal"` |
| `documentDate` | `string (date-time)` | opcional | Data do próprio documento (emissão/referência), não a data do upload. Aceita em qualquer tipo de documento e sempre opcional. Só tem efeito de negócio no laudo de deferimento INSS e na última perícia INSS (regra de elegibilidade dos benefícios 32/92). | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `ownerUser`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `ownerGroup`:

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

Exemplo:

```json
{
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "fileName": "Fulano de Tal",
  "fileType": "Document",
  "displayName": "Fulano de Tal",
  "documentDate": "2025-08-11T13:45:00Z"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/LegalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6/Upload/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "fileName": "Fulano de Tal",
  "fileType": "Document",
  "displayName": "Fulano de Tal",
  "documentDate": "2025-08-11T13:45:00Z"
}'
```

---

### DELETE /v1/LegalPerson/{id}/Upload/{uploadId}

**Exclui documento da pessoa jurídica** — Remove um registro de Legal Person.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | id pessoa jurídica | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `uploadId` | path | `string (uuid)` | obrigatório | id documento | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X DELETE "{{baseUrl}}/v1/LegalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6/Upload/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /v1/LegalPerson/{id}/assign

**Atribui o registro de pessoa jurídica a um outro correspondente ou grupo** — Cria um novo registro de Legal Person.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Corpo da requisição** (`application/json`)

Campos:

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

Exemplo:

```json
{
  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "groupName": "Fulano de Tal",
  "tenant": "texto"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/LegalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6/assign" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "groupName": "Fulano de Tal",
  "tenant": "texto"
}'
```

---

### POST /v1/LegalPerson/{id}/Share

**Criar Legal Person** — Cria um novo registro de Legal Person.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `principalType` | `string` | opcional | — | `User`, `Group`, `Tenant`, `Application` | `"User"` |
| `principalId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `permissionLevel` | `string` | opcional | — | `View`, `Edit` | `"View"` |

Exemplo:

```json
{
  "principalType": "User",
  "principalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "permissionLevel": "View"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/LegalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6/Share" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "principalType": "User",
  "principalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "permissionLevel": "View"
}'
```

---

### GET /v1/NaturalPerson

**Lista todas as pessoas físicas inseridas** — Lista e filtra registros de Natural Person.

**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` |
| `personDisplay` | query | `string` | opcional | — | `valor` |
| `personSocialName` | query | `string` | opcional | — | `valor` |
| `registrationNumber` | query | `string` | opcional | — | `valor` |
| `email` | query | `string` | opcional | — | `valor` |
| `phone` | query | `string` | opcional | — | `valor` |
| `tenant` | query | `string` | opcional | — | `uy3` |
| `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` |

**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"` |
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `nationality` | `string` | opcional | — | — | `"texto"` |
| `pep` | `boolean` | opcional | — | — | `true` |
| `address` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `birthDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `civilStatus` | `string` | opcional | — | — | `"texto"` |
| `civilStatusDisplay` | `string` | opcional | — | — | `"texto"` |
| `gender` | `string` | opcional | — | — | `"texto"` |
| `genderDisplay` | `string` | opcional | — | — | `"texto"` |
| `documentType` | `string` | opcional | — | — | `"texto"` |
| `documentTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `documentNumber` | `string` | opcional | — | — | `"texto"` |
| `documentIssuer` | `string` | opcional | — | — | `"texto"` |
| `documentDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `documentExpiration` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `phone` | `string` | opcional | — | — | `"11987654321"` |
| `phoneExtension` | `string` | opcional | — | — | `"11987654321"` |
| `phone2` | `string` | opcional | — | — | `"11987654321"` |
| `phone2Extension` | `string` | opcional | — | — | `"11987654321"` |
| `email` | `string` | opcional | — | — | `"cliente@exemplo.com.br"` |
| `mothersName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `fathersName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `placeOfBirthCountry` | `string` | opcional | — | — | `"texto"` |
| `placeOfBirthState` | `string` | opcional | — | — | `"texto"` |
| `typeOfResidence` | `string` | opcional | — | — | `"texto"` |
| `typeOfResidenceDisplay` | `string` | opcional | — | — | `"texto"` |
| `hasDependents` | `boolean` | opcional | — | — | `true` |
| `totalDependents` | `integer` | opcional | — | — | `0` |
| `between7And15YearsOld` | `integer` | opcional | — | — | `0` |
| `upTo6YearsOld` | `integer` | opcional | — | — | `0` |
| `over15YearsOld` | `integer` | opcional | — | — | `0` |
| `workplace` | `string` | opcional | — | — | `"texto"` |
| `workplaceDisplay` | `string` | opcional | — | — | `"texto"` |
| `workplaceCompanyRegistrationNumber` | `string` | opcional | — | — | `"texto"` |
| `employeeNumber` | `string` | opcional | — | — | `"texto"` |
| `occupation` | `string` | opcional | — | — | `"texto"` |
| `natureOfOccupation` | `string` | opcional | — | — | `"texto"` |
| `natureOfOccupationDisplay` | `string` | opcional | — | — | `"texto"` |
| `commercialPhone` | `string` | opcional | — | — | `"11987654321"` |
| `commercialPhoneExtension` | `string` | opcional | — | — | `"11987654321"` |
| `netSalary` | `integer (int64)` | opcional | — | — | `0` |
| `otherIncome` | `integer (int64)` | opcional | — | — | `0` |
| `totalIncome` | `integer (int64)` | opcional | — | — | `0` |
| `admissionDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `commercialPhone2` | `string` | opcional | — | — | `"11987654321"` |
| `commercialPhone2Extension` | `string` | opcional | — | — | `"11987654321"` |
| `commercialAddress` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `economicActivityCodeId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `economicActivityCode` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `economicActivityCodeDisplay` | `string` | opcional | — | — | `"texto"` |
| `spouseIndividualRegistrationNumber` | `string` | opcional | — | — | `"texto"` |
| `spouseDocumentType` | `string` | opcional | — | — | `"texto"` |
| `spouseDocumentTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `spouseDocumentNumber` | `string` | opcional | — | — | `"texto"` |
| `spouseDocumentIssuer` | `string` | opcional | — | — | `"texto"` |
| `spouseDocumentDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `spouseDocumentExpiration` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `spouseName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `spouseWorkplace` | `string` | opcional | — | — | `"texto"` |
| `spouseOccupation` | `string` | opcional | — | — | `"texto"` |
| `spouseCommercialPhone` | `string` | opcional | — | — | `"11987654321"` |
| `spouseCommercialPhoneExtension` | `string` | opcional | — | — | `"11987654321"` |
| `spouseBirthDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `spouseNetSalary` | `number (double)` | opcional | — | — | `1000` |
| `spouseOtherIncome` | `number (double)` | opcional | — | — | `1000` |
| `spouseTotalIncome` | `number (double)` | opcional | — | — | `1000` |
| `allowContactWhatsApp` | `boolean` | opcional | — | — | `true` |
| `allowUpdatesWhatsApp` | `boolean` | opcional | — | — | `true` |
| `assets` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `uploads` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `bankAccounts` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `personCreditStatus` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `riskRating` | `string` | opcional | — | — | `"texto"` |
| `healthDeclaration` | `string` | opcional | Declaração de Saúde | — | `"texto"` |
| `department` | `string` | opcional | Departamento | — | `"texto"` |
| `socialName` | `string` | opcional | Nome Social | — | `"Fulano de Tal"` |

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 `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 `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 `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 `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` |

Exemplo:

```json
{
  "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",
      "name": "Fulano de Tal",
      "nationality": "texto",
      "pep": true,
      "address": {
        "addressName": "Fulano de Tal",
        "zipCode": "01310930",
        "city": "texto",
        "uf": "texto",
        "ufDisplay": "texto",
        "district": "texto",
        "number": "texto",
        "complement": "texto"
      },
      "birthDate": "2025-08-11T13:45:00Z",
      "civilStatus": "texto",
      "civilStatusDisplay": "texto",
      "gender": "texto",
      "genderDisplay": "texto",
      "documentType": "texto",
      "documentTypeDisplay": "texto",
      "documentNumber": "texto",
      "documentIssuer": "texto",
      "documentDate": "2025-08-11T13:45:00Z",
      "documentExpiration": "2025-08-11T13:45:00Z",
      "phone": "11987654321",
      "phoneExtension": "11987654321",
      "phone2": "11987654321",
      "phone2Extension": "11987654321",
      "email": "cliente@exemplo.com.br",
      "mothersName": "Fulano de Tal",
      "fathersName": "Fulano de Tal",
      "placeOfBirthCountry": "texto",
      "placeOfBirthState": "texto",
      "typeOfResidence": "texto",
      "typeOfResidenceDisplay": "texto",
      "hasDependents": true,
      "totalDependents": 0,
      "between7And15YearsOld": 0,
      "upTo6YearsOld": 0,
      "over15YearsOld": 0,
      "workplace": "texto",
      "workplaceDisplay": "texto",
      "workplaceCompanyRegistrationNumber": "texto",
      "employeeNumber": "texto",
      "occupation": "texto",
      "natureOfOccupation": "texto",
      "natureOfOccupationDisplay": "texto",
      "commercialPhone": "11987654321",
      "commercialPhoneExtension": "11987654321",
      "netSalary": 0,
      "otherIncome": 0,
      "totalIncome": 0,
      "admissionDate": "2025-08-11T13:45:00Z",
      "commercialPhone2": "11987654321",
      "commercialPhone2Extension": "11987654321",
      "commercialAddress": {
        "addressName": "Fulano de Tal",
        "zipCode": "01310930",
        "city": "texto",
        "uf": "texto",
        "ufDisplay": "texto",
        "district": "texto",
        "number": "texto",
        "complement": "texto"
      },
      "economicActivityCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "economicActivityCode": {
        "code": "texto",
        "description": "texto"
      },
      "economicActivityCodeDisplay": "texto",
      "spouseIndividualRegistrationNumber": "texto",
      "spouseDocumentType": "texto",
      "spouseDocumentTypeDisplay": "texto",
      "spouseDocumentNumber": "texto",
      "spouseDocumentIssuer": "texto",
      "spouseDocumentDate": "2025-08-11T13:45:00Z",
      "spouseDocumentExpiration": "2025-08-11T13:45:00Z",
      "spouseName": "Fulano de Tal",
      "spouseWorkplace": "texto",
      "spouseOccupation": "texto",
      "spouseCommercialPhone": "11987654321",
      "spouseCommercialPhoneExtension": "11987654321",
      "spouseBirthDate": "2025-08-11T13:45:00Z",
      "spouseNetSalary": 1000,
      "spouseOtherIncome": 1000,
      "spouseTotalIncome": 1000,
      "allowContactWhatsApp": true,
      "allowUpdatesWhatsApp": true,
      "assets": [
        {}
      ],
      "uploads": [
        {}
      ],
      "bankAccounts": [
        {}
      ],
      "personCreditStatus": {
        "registrationNumber": "12345678909",
        "validUntil": "2025-08-11T13:45:00Z",
        "status": "texto",
        "reason": "texto",
        "detailedReason": "texto",
        "approvedLimit": 0
      },
      "riskRating": "texto",
      "healthDeclaration": "texto",
      "department": "texto",
      "socialName": "Fulano de Tal"
    }
  ],
  "paginationToken": "texto",
  "totalValue": 0,
  "totalAssignmentValue": 0
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### POST /v1/NaturalPerson

**Insere uma nova pessoa física** — Cria um novo registro de Natural Person.

Insere uma nova pessoa física. Caso já exista um cadastro existente da PF visível ao operador solicitante (com base no CPF), os dados existentes serão atualizados e o ID retornado será o do registro existente. Coleções relacionadas serão combinadas (dados bancários, documentos, etc).

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `returnValue` | query | `string` | opcional | — | `valor` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `registrationNumber` | `string` | obrigatório | CPF da Pessoa | — | `"12345678910"` |
| `phone` | `string` | obrigatório | Número de Telefone principal | — | `"11912344321"` |
| `phoneExtension` | `string` | opcional | Ramal do telefone principal | — | `"1234"` |
| `email` | `string` | obrigatório | Email | — | `"teste@teste.com"` |
| `name` | `string` | obrigatório | Nome completo | — | `"Jo\u00E3o da Silva"` |
| `nationality` | `string` | opcional | Nacionalidade | — | `"Brasileira"` |
| `pep` | `boolean` | opcional | Pessoa politicamente exposta | — | `true` |
| `address` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `birthDate` | `string (date-time)` | opcional | Data de nascimento | — | `"2000-01-01"` |
| `civilStatus` | `string` | opcional | — | `Married`, `Widowed`, `Separated`, `Divorced`, `Single` | `"Married"` |
| `gender` | `string` | opcional | — | `NotInformed`, `Male`, `Female` | `"NotInformed"` |
| `documentType` | `string` | opcional | — | `RG`, `CPF`, `CNH`, `CTPS` | `"RG"` |
| `documentNumber` | `string` | opcional | Número de documento de identificação | — | `"texto"` |
| `documentIssuer` | `string` | opcional | Emissor do documento de identificação | — | `"texto"` |
| `documentDate` | `string (date-time)` | opcional | Data de emissão do documento de identificação | — | `"2025-08-11T13:45:00Z"` |
| `documentExpiration` | `string (date-time)` | opcional | Data de expiração do documento de identificação | — | `"2025-08-11T13:45:00Z"` |
| `phone2` | `string` | opcional | Telefone alternativo | — | `"11987654321"` |
| `phone2Extension` | `string` | opcional | Ramal do número de telefone alternativo | — | `"11987654321"` |
| `mothersName` | `string` | opcional | Nome completo da mãe | — | `"Fulano de Tal"` |
| `fathersName` | `string` | opcional | Nome completo do pai | — | `"Fulano de Tal"` |
| `placeOfBirthCountry` | `string` | opcional | Nacionalidade | — | `"texto"` |
| `placeOfBirthState` | `string` | opcional | Naturalidade | — | `"texto"` |
| `typeOfResidence` | `string` | opcional | — | `Owner`, `Rent` | `"Owner"` |
| `between7And15YearsOld` | `integer` | opcional | Dependentes de 7 a 15 anos de idade | — | `0` |
| `upTo6YearsOld` | `integer` | opcional | Dependentes de até 6 anos de idade | — | `0` |
| `over15YearsOld` | `integer` | opcional | Dependentes com mais de 15 anos de idade | — | `0` |
| `workplace` | `string` | opcional | Empresa em que trabalha | — | `"texto"` |
| `workplaceCompanyRegistrationNumber` | `string` | opcional | CNPJ da empresa em que trabalha | — | `"texto"` |
| `employeeNumber` | `string` | opcional | Matricula do funcionario na empresa em que trabalha | — | `"texto"` |
| `occupation` | `string` | opcional | Ocupação | — | `"texto"` |
| `natureOfOccupation` | `string` | opcional | — | `PrivateEmployee`, `PublicEmployee`, `Employer`, `Capitalist`, `Military`, `Autonomous`, `Other` | `"PrivateEmployee"` |
| `commercialPhone` | `string` | opcional | Telefone comercial | — | `"11987654321"` |
| `commercialPhoneExtension` | `string` | opcional | Ramal do telefone comercial | — | `"11987654321"` |
| `netSalary` | `number (double)` | opcional | Salário líquido (em centavos) | — | `1000` |
| `otherIncome` | `number (double)` | opcional | Outras receitas (em centavos) | — | `1000` |
| `admissionDate` | `string (date-time)` | opcional | Data de admissão | — | `"2025-08-11T13:45:00Z"` |
| `commercialPhone2` | `string` | opcional | Telefone comercial alternativo | — | `"11987654321"` |
| `commercialPhone2Extension` | `string` | opcional | Ramal do telefone comercial alternativo | — | `"11987654321"` |
| `commercialAddress` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `economicActivityCodeId` | `string (uuid)` | opcional | ID de referência do registro de atividade econômica (CNAE) | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `spouseIndividualRegistrationNumber` | `string` | opcional | Número de CPF do cônjuge | — | `"texto"` |
| `spouseDocumentType` | `string` | opcional | — | `RG`, `CPF`, `CNH`, `CTPS` | `"RG"` |
| `spouseDocumentNumber` | `string` | opcional | Número de documento de identificação do cônjuge | — | `"texto"` |
| `spouseDocumentIssuer` | `string` | opcional | Emissor do documento de identificação do cônjuge | — | `"texto"` |
| `spouseDocumentDate` | `string (date-time)` | opcional | Data de emissão do documento de identificação do cônjuge | — | `"2025-08-11T13:45:00Z"` |
| `spouseDocumentExpiration` | `string (date-time)` | opcional | Data de expiração do documento de identificação do cônjuge | — | `"2025-08-11T13:45:00Z"` |
| `spouseName` | `string` | opcional | Nome completo do cônjuge | — | `"Fulano de Tal"` |
| `spouseWorkplace` | `string` | opcional | Local de trabalho do cônjuge | — | `"texto"` |
| `spouseOccupation` | `string` | opcional | Ocupação do cônjuge | — | `"texto"` |
| `spouseCommercialPhone` | `string` | opcional | Telefone comercial do cônjuge | — | `"11987654321"` |
| `spouseCommercialPhoneExtension` | `string` | opcional | Ramal do telefone comercial do cônjuge | — | `"11987654321"` |
| `spouseBirthDate` | `string (date-time)` | opcional | Data de nascimento do cônjuge | — | `"2025-08-11T13:45:00Z"` |
| `spouseNetSalary` | `number (double)` | opcional | Salário líquido do cônjuge | — | `1000` |
| `spouseOtherIncome` | `number (double)` | opcional | Outras receitas do cônjuge | — | `1000` |
| `assets` | `array de objeto` | opcional | Lista de bens e direitos | objeto — ver detalhe abaixo | `[ … ]` |
| `allowContactWhatsApp` | `boolean` | opcional | Permitir contato via Whatsapp | — | `true` |
| `allowUpdatesWhatsApp` | `boolean` | opcional | Permitir notificações via Whatsapp | — | `true` |
| `uploads` | `array de objeto` | opcional | Lista de documentos carregados | objeto — ver detalhe abaixo | `[ … ]` |
| `bankAccounts` | `array de objeto` | opcional | Lista de contas bancárias | objeto — ver detalhe abaixo | `[ … ]` |
| `riskRating` | `string` | opcional | — | `Low`, `Intermediary`, `High` | `"Low"` |
| `healthDeclaration` | `string` | opcional | Declaração de Saúde | — | `"texto"` |
| `department` | `string` | opcional | Departamento | — | `"texto"` |
| `socialName` | `string` | opcional | Nome Social | — | `"Fulano de Tal"` |

Detalhe de `ownerUser`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `ownerGroup`:

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

Detalhe de `address`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `addressName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |
| `zipCode` | `string` | opcional | — | — | `"01310930"` |
| `city` | `string` | obrigatório | — | — | `"texto"` |
| `uf` | `string` | opcional | — | `NaoSelecionado`, `AC`, `AL`, `AP`, `AM`, `BA`, `CE`, `DF`, `ES`, `GO`, `MA`, `MT`, `MS`, `MG`, `PA`, `PB`, `PR`, `PE`, `PI`, `RJ`, `RN`, `RS`, `RO`, `RR`, `SC`, `SP`, `SE`, `TO` | `"NaoSelecionado"` |
| `district` | `string` | obrigatório | — | — | `"texto"` |
| `number` | `string` | opcional | Número do endereço deve conter apenas números | — | `"texto"` |
| `complement` | `string` | opcional | — | — | `"texto"` |

Detalhe de `assets`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `naturalPersonId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `legalPersonId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `assetType` | `string` | obrigatório | — | `Cash`, `AccountsReceivable`, `Inventory`, `Investments`, `Vehicles`, `Furniture`, `Patents`, `RealEstate` | `"Cash"` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `registerNumber` | `string` | opcional | — | — | `"texto"` |
| `estimatedValue` | `number (double)` | opcional | — | — | `1000` |
| `settled` | `boolean` | opcional | — | — | `true` |

Detalhe de `uploads`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `fileType` | `string` | obrigatório | — | `Document`, `Authorization`, `DriversLicense`, `WorkCard`, `ResidenceProofCompany`, `ResidenceProofPartners`, `Draft`, `SocialContract`, `RegistrationNumber`, `IdentificationDocumentWithPhoto`, `BankStatement`, `ManagerialBilling`, `RegistrationForm`, `Others`, `Selfie`, `SelfieWithIdentityCard`, `LastDeclaration`, `SignedContract`, `SigningStampContract`, `CreditReport`, `Assignment`, `Addition`, `FiduciaryAssignment`, `P7S`, `ZipedFiles`, `CNAB`, `Invoice`, `MinutesOfElection`, `Procuration`, `TermOfOwnership`, `Bylaws`, `IdentityCard`, `Collateral`, `Regulation`, `Balance`, `BalanceSheet`, `PLDFT`, `IncomeTax`, `DRE`, `Receipt`, `CompanyCard`, `AssignmetReport`, `NationalRegistryOfForeigners`, `NationalIdentityCard`, `RegionalRegistrationCard`, `Passaport`, `Paycheck`, `Indorsement`, `WarrantyRegistrationOfficeProof`, `OperationHistory`, `VehicleInspection`, `InsuranceCancellationTemplate`, `SignatureTemplateDraft`, `InssDefermentReport`, `InssMedicalReview` | `"Document"` |
| `fileName` | `string` | obrigatório | Nome do arquivo (retornado pelo GET v1/Upload) | — | `"Fulano de Tal"` |
| `displayName` | `string` | opcional | Nome de exibição do arquivo | — | `"Fulano de Tal"` |
| `documentDate` | `string (date-time)` | opcional | Data do próprio documento (emissão/referência), não a data do upload. Aceita em qualquer tipo de documento e sempre opcional.   Só tem efeito de negócio no laudo de deferimento INSS e na última perícia INSS, cujos valores são comparados aos cortes da regra de elegibilidade dos benefícios 32/92 (faixa 45–54); nos demais tipos é apenas informativa. | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `bankAccounts`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `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 | — | `NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount` | `"NaturalCheckingAccount"` |
| `jointAccount` | `boolean` | opcional | — | — | `true` |
| `operationTypeValue` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |
| `pixKeyTypeValue` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `keyPix` | `string` | opcional | chave pix | — | `"texto"` |

Exemplo:

```json
{
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "registrationNumber": "12345678910",
  "phone": "11912344321",
  "phoneExtension": "1234",
  "email": "teste@teste.com",
  "name": "Jo\u00E3o da Silva",
  "nationality": "Brasileira",
  "pep": true,
  "address": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "addressName": "Fulano de Tal",
    "zipCode": "01310930",
    "city": "texto",
    "uf": "NaoSelecionado",
    "district": "texto",
    "number": "texto",
    "complement": "texto"
  },
  "birthDate": "2000-01-01",
  "civilStatus": "Married",
  "gender": "NotInformed",
  "documentType": "RG",
  "documentNumber": "texto",
  "documentIssuer": "texto",
  "documentDate": "2025-08-11T13:45:00Z",
  "documentExpiration": "2025-08-11T13:45:00Z",
  "phone2": "11987654321",
  "phone2Extension": "11987654321",
  "mothersName": "Fulano de Tal",
  "fathersName": "Fulano de Tal",
  "placeOfBirthCountry": "texto",
  "placeOfBirthState": "texto",
  "typeOfResidence": "Owner",
  "between7And15YearsOld": 0,
  "upTo6YearsOld": 0,
  "over15YearsOld": 0,
  "workplace": "texto",
  "workplaceCompanyRegistrationNumber": "texto",
  "employeeNumber": "texto",
  "occupation": "texto",
  "natureOfOccupation": "PrivateEmployee",
  "commercialPhone": "11987654321",
  "commercialPhoneExtension": "11987654321",
  "netSalary": 1000,
  "otherIncome": 1000,
  "admissionDate": "2025-08-11T13:45:00Z",
  "commercialPhone2": "11987654321",
  "commercialPhone2Extension": "11987654321",
  "commercialAddress": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "addressName": "Fulano de Tal",
    "zipCode": "01310930",
    "city": "texto",
    "uf": "NaoSelecionado",
    "district": "texto",
    "number": "texto",
    "complement": "texto"
  },
  "economicActivityCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "spouseIndividualRegistrationNumber": "texto",
  "spouseDocumentType": "RG",
  "spouseDocumentNumber": "texto",
  "spouseDocumentIssuer": "texto",
  "spouseDocumentDate": "2025-08-11T13:45:00Z",
  "spouseDocumentExpiration": "2025-08-11T13:45:00Z",
  "spouseName": "Fulano de Tal",
  "spouseWorkplace": "texto",
  "spouseOccupation": "texto",
  "spouseCommercialPhone": "11987654321",
  "spouseCommercialPhoneExtension": "11987654321",
  "spouseBirthDate": "2025-08-11T13:45:00Z",
  "spouseNetSalary": 1000,
  "spouseOtherIncome": 1000,
  "assets": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "naturalPersonId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "legalPersonId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "assetType": "Cash",
      "description": "texto",
      "registerNumber": "texto",
      "estimatedValue": 1000,
      "settled": true
    }
  ],
  "allowContactWhatsApp": true,
  "allowUpdatesWhatsApp": true,
  "uploads": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "fileType": "Document",
      "fileName": "Fulano de Tal",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z"
    }
  ],
  "bankAccounts": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "bankCode": 0,
      "bankIspb": 0,
      "account": "texto",
      "accountDigit": "texto",
      "agency": "texto",
      "agencyDigit": "texto",
      "type": "NaturalCheckingAccount",
      "jointAccount": true,
      "operationTypeValue": "Transfer",
      "pixKeyTypeValue": "NaturalRegistrationNumber",
      "keyPix": "texto"
    }
  ],
  "riskRating": "Low",
  "healthDeclaration": "texto",
  "department": "texto",
  "socialName": "Fulano de Tal"
}
```

**Resposta 200**

Exemplo:

```json
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/NaturalPerson" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "registrationNumber": "12345678910",
  "phone": "11912344321",
  "phoneExtension": "1234",
  "email": "teste@teste.com",
  "name": "Jo\u00E3o da Silva",
  "nationality": "Brasileira",
  "pep": true,
  "address": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "addressName": "Fulano de Tal",
    "zipCode": "01310930",
    "city": "texto",
    "uf": "NaoSelecionado",
    "district": "texto",
    "number": "texto",
    "complement": "texto"
  },
  "birthDate": "2000-01-01",
  "civilStatus": "Married",
  "gender": "NotInformed",
  "documentType": "RG",
  "documentNumber": "texto",
  "documentIssuer": "texto",
  "documentDate": "2025-08-11T13:45:00Z",
  "documentExpiration": "2025-08-11T13:45:00Z",
  "phone2": "11987654321",
  "phone2Extension": "11987654321",
  "mothersName": "Fulano de Tal",
  "fathersName": "Fulano de Tal",
  "placeOfBirthCountry": "texto",
  "placeOfBirthState": "texto",
  "typeOfResidence": "Owner",
  "between7And15YearsOld": 0,
  "upTo6YearsOld": 0,
  "over15YearsOld": 0,
  "workplace": "texto",
  "workplaceCompanyRegistrationNumber": "texto",
  "employeeNumber": "texto",
  "occupation": "texto",
  "natureOfOccupation": "PrivateEmployee",
  "commercialPhone": "11987654321",
  "commercialPhoneExtension": "11987654321",
  "netSalary": 1000,
  "otherIncome": 1000,
  "admissionDate": "2025-08-11T13:45:00Z",
  "commercialPhone2": "11987654321",
  "commercialPhone2Extension": "11987654321",
  "commercialAddress": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "addressName": "Fulano de Tal",
    "zipCode": "01310930",
    "city": "texto",
    "uf": "NaoSelecionado",
    "district": "texto",
    "number": "texto",
    "complement": "texto"
  },
  "economicActivityCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "spouseIndividualRegistrationNumber": "texto",
  "spouseDocumentType": "RG",
  "spouseDocumentNumber": "texto",
  "spouseDocumentIssuer": "texto",
  "spouseDocumentDate": "2025-08-11T13:45:00Z",
  "spouseDocumentExpiration": "2025-08-11T13:45:00Z",
  "spouseName": "Fulano de Tal",
  "spouseWorkplace": "texto",
  "spouseOccupation": "texto",
  "spouseCommercialPhone": "11987654321",
  "spouseCommercialPhoneExtension": "11987654321",
  "spouseBirthDate": "2025-08-11T13:45:00Z",
  "spouseNetSalary": 1000,
  "spouseOtherIncome": 1000,
  "assets": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "naturalPersonId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "legalPersonId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "assetType": "Cash",
      "description": "texto",
      "registerNumber": "texto",
      "estimatedValue": 1000,
      "settled": true
    }
  ],
  "allowContactWhatsApp": true,
  "allowUpdatesWhatsApp": true,
  "uploads": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "fileType": "Document",
      "fileName": "Fulano de Tal",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z"
    }
  ],
  "bankAccounts": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "bankCode": 0,
      "bankIspb": 0,
      "account": "texto",
      "accountDigit": "texto",
      "agency": "texto",
      "agencyDigit": "texto",
      "type": "NaturalCheckingAccount",
      "jointAccount": true,
      "operationTypeValue": "Transfer",
      "pixKeyTypeValue": "NaturalRegistrationNumber",
      "keyPix": "texto"
    }
  ],
  "riskRating": "Low",
  "healthDeclaration": "texto",
  "department": "texto",
  "socialName": "Fulano de Tal"
}'
```

---

### GET /v1/NaturalPerson/{id}

**Lista uma pessoa física por id** — Consulta Natural Person pelo identificador informado na rota.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Resposta 200**

Campos:

| 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"` |
| `nationality` | `string` | opcional | — | — | `"texto"` |
| `pep` | `boolean` | opcional | — | — | `true` |
| `address` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `birthDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `civilStatus` | `string` | opcional | — | — | `"texto"` |
| `civilStatusDisplay` | `string` | opcional | — | — | `"texto"` |
| `gender` | `string` | opcional | — | — | `"texto"` |
| `genderDisplay` | `string` | opcional | — | — | `"texto"` |
| `documentType` | `string` | opcional | — | — | `"texto"` |
| `documentTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `documentNumber` | `string` | opcional | — | — | `"texto"` |
| `documentIssuer` | `string` | opcional | — | — | `"texto"` |
| `documentDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `documentExpiration` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `phone` | `string` | opcional | — | — | `"11987654321"` |
| `phoneExtension` | `string` | opcional | — | — | `"11987654321"` |
| `phone2` | `string` | opcional | — | — | `"11987654321"` |
| `phone2Extension` | `string` | opcional | — | — | `"11987654321"` |
| `email` | `string` | opcional | — | — | `"cliente@exemplo.com.br"` |
| `mothersName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `fathersName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `placeOfBirthCountry` | `string` | opcional | — | — | `"texto"` |
| `placeOfBirthState` | `string` | opcional | — | — | `"texto"` |
| `typeOfResidence` | `string` | opcional | — | — | `"texto"` |
| `typeOfResidenceDisplay` | `string` | opcional | — | — | `"texto"` |
| `hasDependents` | `boolean` | opcional | — | — | `true` |
| `totalDependents` | `integer` | opcional | — | — | `0` |
| `between7And15YearsOld` | `integer` | opcional | — | — | `0` |
| `upTo6YearsOld` | `integer` | opcional | — | — | `0` |
| `over15YearsOld` | `integer` | opcional | — | — | `0` |
| `workplace` | `string` | opcional | — | — | `"texto"` |
| `workplaceDisplay` | `string` | opcional | — | — | `"texto"` |
| `workplaceCompanyRegistrationNumber` | `string` | opcional | — | — | `"texto"` |
| `employeeNumber` | `string` | opcional | — | — | `"texto"` |
| `occupation` | `string` | opcional | — | — | `"texto"` |
| `natureOfOccupation` | `string` | opcional | — | — | `"texto"` |
| `natureOfOccupationDisplay` | `string` | opcional | — | — | `"texto"` |
| `commercialPhone` | `string` | opcional | — | — | `"11987654321"` |
| `commercialPhoneExtension` | `string` | opcional | — | — | `"11987654321"` |
| `netSalary` | `integer (int64)` | opcional | — | — | `0` |
| `otherIncome` | `integer (int64)` | opcional | — | — | `0` |
| `totalIncome` | `integer (int64)` | opcional | — | — | `0` |
| `admissionDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `commercialPhone2` | `string` | opcional | — | — | `"11987654321"` |
| `commercialPhone2Extension` | `string` | opcional | — | — | `"11987654321"` |
| `commercialAddress` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `economicActivityCodeId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `economicActivityCode` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `economicActivityCodeDisplay` | `string` | opcional | — | — | `"texto"` |
| `spouseIndividualRegistrationNumber` | `string` | opcional | — | — | `"texto"` |
| `spouseDocumentType` | `string` | opcional | — | — | `"texto"` |
| `spouseDocumentTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `spouseDocumentNumber` | `string` | opcional | — | — | `"texto"` |
| `spouseDocumentIssuer` | `string` | opcional | — | — | `"texto"` |
| `spouseDocumentDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `spouseDocumentExpiration` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `spouseName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `spouseWorkplace` | `string` | opcional | — | — | `"texto"` |
| `spouseOccupation` | `string` | opcional | — | — | `"texto"` |
| `spouseCommercialPhone` | `string` | opcional | — | — | `"11987654321"` |
| `spouseCommercialPhoneExtension` | `string` | opcional | — | — | `"11987654321"` |
| `spouseBirthDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `spouseNetSalary` | `number (double)` | opcional | — | — | `1000` |
| `spouseOtherIncome` | `number (double)` | opcional | — | — | `1000` |
| `spouseTotalIncome` | `number (double)` | opcional | — | — | `1000` |
| `allowContactWhatsApp` | `boolean` | opcional | — | — | `true` |
| `allowUpdatesWhatsApp` | `boolean` | opcional | — | — | `true` |
| `assets` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `uploads` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `bankAccounts` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `personCreditStatus` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `riskRating` | `string` | opcional | — | — | `"texto"` |
| `healthDeclaration` | `string` | opcional | Declaração de Saúde | — | `"texto"` |
| `department` | `string` | opcional | Departamento | — | `"texto"` |
| `socialName` | `string` | opcional | Nome Social | — | `"Fulano de Tal"` |

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 `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 `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 `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 `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` |

Exemplo:

```json
{
  "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",
  "name": "Fulano de Tal",
  "nationality": "texto",
  "pep": true,
  "address": {
    "addressName": "Fulano de Tal",
    "zipCode": "01310930",
    "city": "texto",
    "uf": "texto",
    "ufDisplay": "texto",
    "district": "texto",
    "number": "texto",
    "complement": "texto"
  },
  "birthDate": "2025-08-11T13:45:00Z",
  "civilStatus": "texto",
  "civilStatusDisplay": "texto",
  "gender": "texto",
  "genderDisplay": "texto",
  "documentType": "texto",
  "documentTypeDisplay": "texto",
  "documentNumber": "texto",
  "documentIssuer": "texto",
  "documentDate": "2025-08-11T13:45:00Z",
  "documentExpiration": "2025-08-11T13:45:00Z",
  "phone": "11987654321",
  "phoneExtension": "11987654321",
  "phone2": "11987654321",
  "phone2Extension": "11987654321",
  "email": "cliente@exemplo.com.br",
  "mothersName": "Fulano de Tal",
  "fathersName": "Fulano de Tal",
  "placeOfBirthCountry": "texto",
  "placeOfBirthState": "texto",
  "typeOfResidence": "texto",
  "typeOfResidenceDisplay": "texto",
  "hasDependents": true,
  "totalDependents": 0,
  "between7And15YearsOld": 0,
  "upTo6YearsOld": 0,
  "over15YearsOld": 0,
  "workplace": "texto",
  "workplaceDisplay": "texto",
  "workplaceCompanyRegistrationNumber": "texto",
  "employeeNumber": "texto",
  "occupation": "texto",
  "natureOfOccupation": "texto",
  "natureOfOccupationDisplay": "texto",
  "commercialPhone": "11987654321",
  "commercialPhoneExtension": "11987654321",
  "netSalary": 0,
  "otherIncome": 0,
  "totalIncome": 0,
  "admissionDate": "2025-08-11T13:45:00Z",
  "commercialPhone2": "11987654321",
  "commercialPhone2Extension": "11987654321",
  "commercialAddress": {
    "addressName": "Fulano de Tal",
    "zipCode": "01310930",
    "city": "texto",
    "uf": "texto",
    "ufDisplay": "texto",
    "district": "texto",
    "number": "texto",
    "complement": "texto"
  },
  "economicActivityCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "economicActivityCode": {
    "code": "texto",
    "description": "texto"
  },
  "economicActivityCodeDisplay": "texto",
  "spouseIndividualRegistrationNumber": "texto",
  "spouseDocumentType": "texto",
  "spouseDocumentTypeDisplay": "texto",
  "spouseDocumentNumber": "texto",
  "spouseDocumentIssuer": "texto",
  "spouseDocumentDate": "2025-08-11T13:45:00Z",
  "spouseDocumentExpiration": "2025-08-11T13:45:00Z",
  "spouseName": "Fulano de Tal",
  "spouseWorkplace": "texto",
  "spouseOccupation": "texto",
  "spouseCommercialPhone": "11987654321",
  "spouseCommercialPhoneExtension": "11987654321",
  "spouseBirthDate": "2025-08-11T13:45:00Z",
  "spouseNetSalary": 1000,
  "spouseOtherIncome": 1000,
  "spouseTotalIncome": 1000,
  "allowContactWhatsApp": true,
  "allowUpdatesWhatsApp": true,
  "assets": [
    {
      "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"
      },
      "assetType": "texto",
      "assetTypeDisplay": "texto",
      "description": "texto",
      "registerNumber": "texto",
      "estimatedValue": 1000,
      "settled": true
    }
  ],
  "uploads": [
    {
      "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"
      },
      "fileName": "Fulano de Tal",
      "fileType": "texto",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z",
      "tempUrl": "https://exemplo.com.br/callback",
      "tempGetUrl": "https://exemplo.com.br/callback",
      "tempPutUrl": "https://exemplo.com.br/callback"
    }
  ],
  "bankAccounts": [
    {
      "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"
      },
      "bankCode": "texto",
      "bankCodeCompe": 0,
      "bankCodeDisplay": "texto",
      "bankIspb": 0,
      "account": "texto",
      "accountDigit": "texto",
      "agency": "texto",
      "agencyDigit": "texto",
      "type": "texto",
      "typeDisplay": "texto",
      "jointAccount": true,
      "operationTypeValue": "texto",
      "pixKeyTypeValue": "texto",
      "keyPix": "texto"
    }
  ],
  "personCreditStatus": {
    "registrationNumber": "12345678909",
    "validUntil": "2025-08-11T13:45:00Z",
    "status": "texto",
    "reason": "texto",
    "detailedReason": "texto",
    "approvedLimit": 0
  },
  "riskRating": "texto",
  "healthDeclaration": "texto",
  "department": "texto",
  "socialName": "Fulano de Tal"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/v1/NaturalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

### PUT /v1/NaturalPerson/{id}

**Atualiza os dados de uma pessoa física** — Atualiza por completo um registro de Natural Person existente.

Atualiza os dados de uma pessoa física. Observe que essa requisição pode excluir registros relacionados caso não sejam incluídos no corpo. Por exemplo, dados bancários e uploads não referênciados serão excluídos. Isso pode causar erros caso o dado bancário esteja relacionado à uma operação de crédito concluída ou em andamento. Neste caso, utilize a API específica de atualização de dados bancários. Essa atualização é ignorada se a coleção relacionada for informada com valor nulo.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `returnValue` | query | `string` | opcional | — | `valor` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `phone` | `string` | obrigatório | — | — | `"11987654321"` |
| `phoneExtension` | `string` | opcional | — | — | `"11987654321"` |
| `email` | `string` | obrigatório | — | — | `"cliente@exemplo.com.br"` |
| `name` | `string` | obrigatório | — | — | `"Fulano de Tal"` |
| `nationality` | `string` | opcional | — | — | `"texto"` |
| `pep` | `boolean` | opcional | — | — | `true` |
| `address` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `birthDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `civilStatus` | `string` | opcional | — | `Married`, `Widowed`, `Separated`, `Divorced`, `Single` | `"Married"` |
| `gender` | `string` | opcional | — | `NotInformed`, `Male`, `Female` | `"NotInformed"` |
| `documentType` | `string` | opcional | — | `RG`, `CPF`, `CNH`, `CTPS` | `"RG"` |
| `documentNumber` | `string` | opcional | — | — | `"texto"` |
| `documentIssuer` | `string` | opcional | — | — | `"texto"` |
| `documentDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `documentExpiration` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `phone2` | `string` | opcional | — | — | `"11987654321"` |
| `phone2Extension` | `string` | opcional | — | — | `"11987654321"` |
| `mothersName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `fathersName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `placeOfBirthCountry` | `string` | opcional | — | — | `"texto"` |
| `placeOfBirthState` | `string` | opcional | — | — | `"texto"` |
| `typeOfResidence` | `string` | opcional | — | `Owner`, `Rent` | `"Owner"` |
| `between7And15YearsOld` | `integer` | opcional | — | — | `0` |
| `upTo6YearsOld` | `integer` | opcional | — | — | `0` |
| `over15YearsOld` | `integer` | opcional | — | — | `0` |
| `workplace` | `string` | opcional | — | — | `"texto"` |
| `workplaceCompanyRegistrationNumber` | `string` | opcional | — | — | `"texto"` |
| `employeeNumber` | `string` | opcional | — | — | `"texto"` |
| `occupation` | `string` | opcional | — | — | `"texto"` |
| `natureOfOccupation` | `string` | opcional | — | `PrivateEmployee`, `PublicEmployee`, `Employer`, `Capitalist`, `Military`, `Autonomous`, `Other` | `"PrivateEmployee"` |
| `commercialPhone` | `string` | opcional | — | — | `"11987654321"` |
| `commercialPhoneExtension` | `string` | opcional | — | — | `"11987654321"` |
| `netSalary` | `number (double)` | opcional | — | — | `1000` |
| `otherIncome` | `number (double)` | opcional | — | — | `1000` |
| `admissionDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `commercialPhone2` | `string` | opcional | — | — | `"11987654321"` |
| `commercialPhone2Extension` | `string` | opcional | — | — | `"11987654321"` |
| `commercialAddress` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `economicActivityCodeId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `spouseIndividualRegistrationNumber` | `string` | opcional | — | — | `"texto"` |
| `spouseDocumentType` | `string` | opcional | — | `RG`, `CPF`, `CNH`, `CTPS` | `"RG"` |
| `spouseDocumentNumber` | `string` | opcional | — | — | `"texto"` |
| `spouseDocumentIssuer` | `string` | opcional | — | — | `"texto"` |
| `spouseDocumentDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `spouseDocumentExpiration` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `spouseName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `spouseWorkplace` | `string` | opcional | — | — | `"texto"` |
| `spouseOccupation` | `string` | opcional | — | — | `"texto"` |
| `spouseCommercialPhone` | `string` | opcional | — | — | `"11987654321"` |
| `spouseCommercialPhoneExtension` | `string` | opcional | — | — | `"11987654321"` |
| `spouseBirthDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `spouseNetSalary` | `number (double)` | opcional | — | — | `1000` |
| `spouseOtherIncome` | `number (double)` | opcional | — | — | `1000` |
| `allowContactWhatsApp` | `boolean` | opcional | — | — | `true` |
| `allowUpdatesWhatsApp` | `boolean` | opcional | — | — | `true` |
| `assets` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `uploads` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `bankAccounts` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `riskRating` | `string` | opcional | — | `Low`, `Intermediary`, `High` | `"Low"` |
| `healthDeclaration` | `string` | opcional | Declaração de Saúde | — | `"texto"` |
| `department` | `string` | opcional | Departamento | — | `"texto"` |
| `socialName` | `string` | opcional | Nome Social | — | `"Fulano de Tal"` |

Detalhe de `ownerUser`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `ownerGroup`:

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

Detalhe de `address`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `addressName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |
| `zipCode` | `string` | opcional | — | — | `"01310930"` |
| `city` | `string` | obrigatório | — | — | `"texto"` |
| `uf` | `string` | obrigatório | — | `NaoSelecionado`, `AC`, `AL`, `AP`, `AM`, `BA`, `CE`, `DF`, `ES`, `GO`, `MA`, `MT`, `MS`, `MG`, `PA`, `PB`, `PR`, `PE`, `PI`, `RJ`, `RN`, `RS`, `RO`, `RR`, `SC`, `SP`, `SE`, `TO` | `"NaoSelecionado"` |
| `district` | `string` | obrigatório | — | — | `"texto"` |
| `number` | `string` | opcional | Número do endereço deve conter apenas números | — | `"texto"` |
| `complement` | `string` | opcional | — | — | `"texto"` |

Detalhe de `assets`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `id` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `assetType` | `string` | obrigatório | — | `Cash`, `AccountsReceivable`, `Inventory`, `Investments`, `Vehicles`, `Furniture`, `Patents`, `RealEstate` | `"Cash"` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `registerNumber` | `string` | opcional | — | — | `"texto"` |
| `estimatedValue` | `number (double)` | opcional | — | — | `1000` |
| `settled` | `boolean` | opcional | — | — | `true` |

Detalhe de `uploads`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `id` | `string (uuid)` | opcional | Id do arquivo | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `fileName` | `string` | obrigatório | Nome do arquivo (retornado pelo GET v1/Upload) | — | `"Fulano de Tal"` |
| `fileType` | `string` | opcional | — | `Document`, `Authorization`, `DriversLicense`, `WorkCard`, `ResidenceProofCompany`, `ResidenceProofPartners`, `Draft`, `SocialContract`, `RegistrationNumber`, `IdentificationDocumentWithPhoto`, `BankStatement`, `ManagerialBilling`, `RegistrationForm`, `Others`, `Selfie`, `SelfieWithIdentityCard`, `LastDeclaration`, `SignedContract`, `SigningStampContract`, `CreditReport`, `Assignment`, `Addition`, `FiduciaryAssignment`, `P7S`, `ZipedFiles`, `CNAB`, `Invoice`, `MinutesOfElection`, `Procuration`, `TermOfOwnership`, `Bylaws`, `IdentityCard`, `Collateral`, `Regulation`, `Balance`, `BalanceSheet`, `PLDFT`, `IncomeTax`, `DRE`, `Receipt`, `CompanyCard`, `AssignmetReport`, `NationalRegistryOfForeigners`, `NationalIdentityCard`, `RegionalRegistrationCard`, `Passaport`, `Paycheck`, `Indorsement`, `WarrantyRegistrationOfficeProof`, `OperationHistory`, `VehicleInspection`, `InsuranceCancellationTemplate`, `SignatureTemplateDraft`, `InssDefermentReport`, `InssMedicalReview` | `"Document"` |
| `displayName` | `string` | opcional | Nome de exibição do arquivo | — | `"Fulano de Tal"` |
| `documentDate` | `string (date-time)` | opcional | Data do próprio documento (emissão/referência), não a data do upload. Aceita em qualquer tipo de documento e sempre opcional. Só tem efeito de negócio no laudo de deferimento INSS e na última perícia INSS (regra de elegibilidade dos benefícios 32/92). | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `bankAccounts`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `id` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `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 | — | `NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount` | `"NaturalCheckingAccount"` |
| `jointAccount` | `boolean` | opcional | — | — | `true` |
| `operationTypeValue` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |
| `pixKeyTypeValue` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `keyPix` | `string` | opcional | Chave Pix | — | `"texto"` |

Exemplo:

```json
{
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "phone": "11987654321",
  "phoneExtension": "11987654321",
  "email": "cliente@exemplo.com.br",
  "name": "Fulano de Tal",
  "nationality": "texto",
  "pep": true,
  "address": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "addressName": "Fulano de Tal",
    "zipCode": "01310930",
    "city": "texto",
    "uf": "NaoSelecionado",
    "district": "texto",
    "number": "texto",
    "complement": "texto"
  },
  "birthDate": "2025-08-11T13:45:00Z",
  "civilStatus": "Married",
  "gender": "NotInformed",
  "documentType": "RG",
  "documentNumber": "texto",
  "documentIssuer": "texto",
  "documentDate": "2025-08-11T13:45:00Z",
  "documentExpiration": "2025-08-11T13:45:00Z",
  "phone2": "11987654321",
  "phone2Extension": "11987654321",
  "mothersName": "Fulano de Tal",
  "fathersName": "Fulano de Tal",
  "placeOfBirthCountry": "texto",
  "placeOfBirthState": "texto",
  "typeOfResidence": "Owner",
  "between7And15YearsOld": 0,
  "upTo6YearsOld": 0,
  "over15YearsOld": 0,
  "workplace": "texto",
  "workplaceCompanyRegistrationNumber": "texto",
  "employeeNumber": "texto",
  "occupation": "texto",
  "natureOfOccupation": "PrivateEmployee",
  "commercialPhone": "11987654321",
  "commercialPhoneExtension": "11987654321",
  "netSalary": 1000,
  "otherIncome": 1000,
  "admissionDate": "2025-08-11T13:45:00Z",
  "commercialPhone2": "11987654321",
  "commercialPhone2Extension": "11987654321",
  "commercialAddress": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "addressName": "Fulano de Tal",
    "zipCode": "01310930",
    "city": "texto",
    "uf": "NaoSelecionado",
    "district": "texto",
    "number": "texto",
    "complement": "texto"
  },
  "economicActivityCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "spouseIndividualRegistrationNumber": "texto",
  "spouseDocumentType": "RG",
  "spouseDocumentNumber": "texto",
  "spouseDocumentIssuer": "texto",
  "spouseDocumentDate": "2025-08-11T13:45:00Z",
  "spouseDocumentExpiration": "2025-08-11T13:45:00Z",
  "spouseName": "Fulano de Tal",
  "spouseWorkplace": "texto",
  "spouseOccupation": "texto",
  "spouseCommercialPhone": "11987654321",
  "spouseCommercialPhoneExtension": "11987654321",
  "spouseBirthDate": "2025-08-11T13:45:00Z",
  "spouseNetSalary": 1000,
  "spouseOtherIncome": 1000,
  "allowContactWhatsApp": true,
  "allowUpdatesWhatsApp": true,
  "assets": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "assetType": "Cash",
      "description": "texto",
      "registerNumber": "texto",
      "estimatedValue": 1000,
      "settled": true
    }
  ],
  "uploads": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fileName": "Fulano de Tal",
      "fileType": "Document",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z"
    }
  ],
  "bankAccounts": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "bankCode": 0,
      "bankIspb": 0,
      "account": "texto",
      "accountDigit": "texto",
      "agency": "texto",
      "agencyDigit": "texto",
      "type": "NaturalCheckingAccount",
      "jointAccount": true,
      "operationTypeValue": "Transfer",
      "pixKeyTypeValue": "NaturalRegistrationNumber",
      "keyPix": "texto"
    }
  ],
  "riskRating": "Low",
  "healthDeclaration": "texto",
  "department": "texto",
  "socialName": "Fulano de Tal"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/NaturalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "phone": "11987654321",
  "phoneExtension": "11987654321",
  "email": "cliente@exemplo.com.br",
  "name": "Fulano de Tal",
  "nationality": "texto",
  "pep": true,
  "address": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "addressName": "Fulano de Tal",
    "zipCode": "01310930",
    "city": "texto",
    "uf": "NaoSelecionado",
    "district": "texto",
    "number": "texto",
    "complement": "texto"
  },
  "birthDate": "2025-08-11T13:45:00Z",
  "civilStatus": "Married",
  "gender": "NotInformed",
  "documentType": "RG",
  "documentNumber": "texto",
  "documentIssuer": "texto",
  "documentDate": "2025-08-11T13:45:00Z",
  "documentExpiration": "2025-08-11T13:45:00Z",
  "phone2": "11987654321",
  "phone2Extension": "11987654321",
  "mothersName": "Fulano de Tal",
  "fathersName": "Fulano de Tal",
  "placeOfBirthCountry": "texto",
  "placeOfBirthState": "texto",
  "typeOfResidence": "Owner",
  "between7And15YearsOld": 0,
  "upTo6YearsOld": 0,
  "over15YearsOld": 0,
  "workplace": "texto",
  "workplaceCompanyRegistrationNumber": "texto",
  "employeeNumber": "texto",
  "occupation": "texto",
  "natureOfOccupation": "PrivateEmployee",
  "commercialPhone": "11987654321",
  "commercialPhoneExtension": "11987654321",
  "netSalary": 1000,
  "otherIncome": 1000,
  "admissionDate": "2025-08-11T13:45:00Z",
  "commercialPhone2": "11987654321",
  "commercialPhone2Extension": "11987654321",
  "commercialAddress": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "addressName": "Fulano de Tal",
    "zipCode": "01310930",
    "city": "texto",
    "uf": "NaoSelecionado",
    "district": "texto",
    "number": "texto",
    "complement": "texto"
  },
  "economicActivityCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "spouseIndividualRegistrationNumber": "texto",
  "spouseDocumentType": "RG",
  "spouseDocumentNumber": "texto",
  "spouseDocumentIssuer": "texto",
  "spouseDocumentDate": "2025-08-11T13:45:00Z",
  "spouseDocumentExpiration": "2025-08-11T13:45:00Z",
  "spouseName": "Fulano de Tal",
  "spouseWorkplace": "texto",
  "spouseOccupation": "texto",
  "spouseCommercialPhone": "11987654321",
  "spouseCommercialPhoneExtension": "11987654321",
  "spouseBirthDate": "2025-08-11T13:45:00Z",
  "spouseNetSalary": 1000,
  "spouseOtherIncome": 1000,
  "allowContactWhatsApp": true,
  "allowUpdatesWhatsApp": true,
  "assets": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "assetType": "Cash",
      "description": "texto",
      "registerNumber": "texto",
      "estimatedValue": 1000,
      "settled": true
    }
  ],
  "uploads": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fileName": "Fulano de Tal",
      "fileType": "Document",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z"
    }
  ],
  "bankAccounts": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "bankCode": 0,
      "bankIspb": 0,
      "account": "texto",
      "accountDigit": "texto",
      "agency": "texto",
      "agencyDigit": "texto",
      "type": "NaturalCheckingAccount",
      "jointAccount": true,
      "operationTypeValue": "Transfer",
      "pixKeyTypeValue": "NaturalRegistrationNumber",
      "keyPix": "texto"
    }
  ],
  "riskRating": "Low",
  "healthDeclaration": "texto",
  "department": "texto",
  "socialName": "Fulano de Tal"
}'
```

---

### DELETE /v1/NaturalPerson/{id}

**Exclui uma pessoa física** — Remove um registro de Natural Person.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X DELETE "{{baseUrl}}/v1/NaturalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /v1/NaturalPerson/{id}/BankAccount

**Insere dados da(s) conta(s) bancária(s) para a pessoa física** — Cria um novo registro de Natural Person.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | id pessoa física | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Corpo da requisição** (`application/json`, lista/array)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `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 | — | `NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount` | `"NaturalCheckingAccount"` |
| `jointAccount` | `boolean` | opcional | — | — | `true` |
| `operationTypeValue` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |
| `pixKeyTypeValue` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `keyPix` | `string` | opcional | chave pix | — | `"texto"` |

Detalhe de `ownerUser`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `ownerGroup`:

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

Exemplo:

```json
[
  {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "bankCode": 0,
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "NaturalCheckingAccount",
    "jointAccount": true,
    "operationTypeValue": "Transfer",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "keyPix": "texto"
  }
]
```

**Resposta 200**

Exemplo:

```json
[
  "3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/NaturalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6/BankAccount" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "bankCode": 0,
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "NaturalCheckingAccount",
    "jointAccount": true,
    "operationTypeValue": "Transfer",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "keyPix": "texto"
  }
]'
```

---

### POST /v1/NaturalPerson/{id}/Upload

**Insere dados do(s) documento(s) para a pessoa física** — Cria um novo registro de Natural Person.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | id pessoa física | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Corpo da requisição** (`application/json`, lista/array)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `fileType` | `string` | obrigatório | — | `Document`, `Authorization`, `DriversLicense`, `WorkCard`, `ResidenceProofCompany`, `ResidenceProofPartners`, `Draft`, `SocialContract`, `RegistrationNumber`, `IdentificationDocumentWithPhoto`, `BankStatement`, `ManagerialBilling`, `RegistrationForm`, `Others`, `Selfie`, `SelfieWithIdentityCard`, `LastDeclaration`, `SignedContract`, `SigningStampContract`, `CreditReport`, `Assignment`, `Addition`, `FiduciaryAssignment`, `P7S`, `ZipedFiles`, `CNAB`, `Invoice`, `MinutesOfElection`, `Procuration`, `TermOfOwnership`, `Bylaws`, `IdentityCard`, `Collateral`, `Regulation`, `Balance`, `BalanceSheet`, `PLDFT`, `IncomeTax`, `DRE`, `Receipt`, `CompanyCard`, `AssignmetReport`, `NationalRegistryOfForeigners`, `NationalIdentityCard`, `RegionalRegistrationCard`, `Passaport`, `Paycheck`, `Indorsement`, `WarrantyRegistrationOfficeProof`, `OperationHistory`, `VehicleInspection`, `InsuranceCancellationTemplate`, `SignatureTemplateDraft`, `InssDefermentReport`, `InssMedicalReview` | `"Document"` |
| `fileName` | `string` | obrigatório | Nome do arquivo (retornado pelo GET v1/Upload) | — | `"Fulano de Tal"` |
| `displayName` | `string` | opcional | Nome de exibição do arquivo | — | `"Fulano de Tal"` |
| `documentDate` | `string (date-time)` | opcional | Data do próprio documento (emissão/referência), não a data do upload. Aceita em qualquer tipo de documento e sempre opcional.   Só tem efeito de negócio no laudo de deferimento INSS e na última perícia INSS, cujos valores são comparados aos cortes da regra de elegibilidade dos benefícios 32/92 (faixa 45–54); nos demais tipos é apenas informativa. | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `ownerUser`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `ownerGroup`:

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

Exemplo:

```json
[
  {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "fileType": "Document",
    "fileName": "Fulano de Tal",
    "displayName": "Fulano de Tal",
    "documentDate": "2025-08-11T13:45:00Z"
  }
]
```

**Resposta 200**

Exemplo:

```json
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/NaturalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6/Upload" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "fileType": "Document",
    "fileName": "Fulano de Tal",
    "displayName": "Fulano de Tal",
    "documentDate": "2025-08-11T13:45:00Z"
  }
]'
```

---

### PUT /v1/NaturalPerson/{id}/BankAccount/{bankAccountId}

**Atualiza os dados bancários de uma pessoa física** — Atualiza por completo um registro de Natural Person existente.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | id pessoa física | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `bankAccountId` | path | `string (uuid)` | obrigatório | id conta bancária | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `id` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `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 | — | `NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount` | `"NaturalCheckingAccount"` |
| `jointAccount` | `boolean` | opcional | — | — | `true` |
| `operationTypeValue` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |
| `pixKeyTypeValue` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `keyPix` | `string` | opcional | Chave Pix | — | `"texto"` |

Detalhe de `ownerUser`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `ownerGroup`:

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

Exemplo:

```json
{
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "bankCode": 0,
  "bankIspb": 0,
  "account": "texto",
  "accountDigit": "texto",
  "agency": "texto",
  "agencyDigit": "texto",
  "type": "NaturalCheckingAccount",
  "jointAccount": true,
  "operationTypeValue": "Transfer",
  "pixKeyTypeValue": "NaturalRegistrationNumber",
  "keyPix": "texto"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/NaturalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "bankCode": 0,
  "bankIspb": 0,
  "account": "texto",
  "accountDigit": "texto",
  "agency": "texto",
  "agencyDigit": "texto",
  "type": "NaturalCheckingAccount",
  "jointAccount": true,
  "operationTypeValue": "Transfer",
  "pixKeyTypeValue": "NaturalRegistrationNumber",
  "keyPix": "texto"
}'
```

---

### DELETE /v1/NaturalPerson/{id}/BankAccount/{bankAccountId}

**Exclui os dados da conta bancário do cliente** — Remove um registro de Natural Person.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | id pessoa física | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `bankAccountId` | path | `string (uuid)` | obrigatório | id conta bancária | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X DELETE "{{baseUrl}}/v1/NaturalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

### PUT /v1/NaturalPerson/{id}/Upload/{uploadId}

**Atualiza o documento de uma pessoa física** — Atualiza por completo um registro de Natural Person existente.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | id pessoa física | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `uploadId` | path | `string (uuid)` | obrigatório | id documento | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `id` | `string (uuid)` | opcional | Id do arquivo | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `fileName` | `string` | obrigatório | Nome do arquivo (retornado pelo GET v1/Upload) | — | `"Fulano de Tal"` |
| `fileType` | `string` | opcional | — | `Document`, `Authorization`, `DriversLicense`, `WorkCard`, `ResidenceProofCompany`, `ResidenceProofPartners`, `Draft`, `SocialContract`, `RegistrationNumber`, `IdentificationDocumentWithPhoto`, `BankStatement`, `ManagerialBilling`, `RegistrationForm`, `Others`, `Selfie`, `SelfieWithIdentityCard`, `LastDeclaration`, `SignedContract`, `SigningStampContract`, `CreditReport`, `Assignment`, `Addition`, `FiduciaryAssignment`, `P7S`, `ZipedFiles`, `CNAB`, `Invoice`, `MinutesOfElection`, `Procuration`, `TermOfOwnership`, `Bylaws`, `IdentityCard`, `Collateral`, `Regulation`, `Balance`, `BalanceSheet`, `PLDFT`, `IncomeTax`, `DRE`, `Receipt`, `CompanyCard`, `AssignmetReport`, `NationalRegistryOfForeigners`, `NationalIdentityCard`, `RegionalRegistrationCard`, `Passaport`, `Paycheck`, `Indorsement`, `WarrantyRegistrationOfficeProof`, `OperationHistory`, `VehicleInspection`, `InsuranceCancellationTemplate`, `SignatureTemplateDraft`, `InssDefermentReport`, `InssMedicalReview` | `"Document"` |
| `displayName` | `string` | opcional | Nome de exibição do arquivo | — | `"Fulano de Tal"` |
| `documentDate` | `string (date-time)` | opcional | Data do próprio documento (emissão/referência), não a data do upload. Aceita em qualquer tipo de documento e sempre opcional. Só tem efeito de negócio no laudo de deferimento INSS e na última perícia INSS (regra de elegibilidade dos benefícios 32/92). | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `ownerUser`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `ownerGroup`:

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

Exemplo:

```json
{
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "fileName": "Fulano de Tal",
  "fileType": "Document",
  "displayName": "Fulano de Tal",
  "documentDate": "2025-08-11T13:45:00Z"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/NaturalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6/Upload/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "fileName": "Fulano de Tal",
  "fileType": "Document",
  "displayName": "Fulano de Tal",
  "documentDate": "2025-08-11T13:45:00Z"
}'
```

---

### DELETE /v1/NaturalPerson/{id}/Upload/{uploadId}

**Exclui documento do cliente** — Remove um registro de Natural Person.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | id pessoa física | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `uploadId` | path | `string (uuid)` | obrigatório | id conta bancária | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X DELETE "{{baseUrl}}/v1/NaturalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6/Upload/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /v1/NaturalPerson/{id}/assign

**Atribui o registro de pessoa física a um outro correspondente ou grupo** — Cria um novo registro de Natural Person.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Corpo da requisição** (`application/json`)

Campos:

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

Exemplo:

```json
{
  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "groupName": "Fulano de Tal",
  "tenant": "texto"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/NaturalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6/assign" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "groupName": "Fulano de Tal",
  "tenant": "texto"
}'
```

---

### POST /v1/NaturalPerson/{id}/Share

**Criar Natural Person** — Cria um novo registro de Natural Person.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `principalType` | `string` | opcional | — | `User`, `Group`, `Tenant`, `Application` | `"User"` |
| `principalId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `permissionLevel` | `string` | opcional | — | `View`, `Edit` | `"View"` |

Exemplo:

```json
{
  "principalType": "User",
  "principalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "permissionLevel": "View"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/NaturalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6/Share" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "principalType": "User",
  "principalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "permissionLevel": "View"
}'
```

---

## Simulação

Simule a operação e obtenha parcelas, CET, IOF e custos antes de contratar.

### POST /v{version}/Amortization

**Gera simulações de operações de crédito e obtém plano de pagamento, CET** — Cria um novo registro de Amortization.

Gera simulações de operações de crédito e obtém plano de pagamento, CET, custo de emissão, IOF, etc.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `version` | path | `string` | obrigatório | — | `1` |
| `fgtsCredentialsName` | query | `string` | opcional | — | `valor` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `productId` | `string (uuid)` | obrigatório | Identificador do Produto relacionado a operação | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `legalPerson` | `boolean` | obrigatório | — | — | `true` |
| `personId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `amortization` | `objeto` | obrigatório | Dados da operação. Utilize um dos valores definidos em "AmortizationType" | varia conforme o tipo — ver exemplo | `{ … }` |

Exemplo:

```json
{
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "legalPerson": true,
  "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "registrationNumber": "12345678909",
  "amortization": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "amortizationType": "texto",
    "startDate": "2025-08-11T13:45:00Z",
    "apr": 1.99,
    "includePaymentFixedCosts": true,
    "validationErrors": [
      {
        "memberNames": [],
        "errorMessage": "texto"
      }
    ],
    "agentCommissions": [
      {
        "name": "Fulano de Tal",
        "amount": 1000,
        "type": {},
        "baseValue": {},
        "chargeCommissionFrom": {},
        "financeCost": true
      }
    ],
    "agentCommission": {
      "name": "Fulano de Tal",
      "amount": 1000,
      "type": "Absolute",
      "baseValue": "InitialValue",
      "chargeCommissionFrom": "All",
      "financeCost": true,
      "totalValue": 0
    }
  }
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string (uuid)` | opcional | Identificador da simulação | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `productId` | `string (uuid)` | opcional | Identificador do produto da simulação | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `productName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `calculateByValueType` | `string` | opcional | Tipo de tabela de amortização | — | `"texto"` |
| `requestedAmount` | `integer (int64)` | opcional | Valor solicitado pelo tomador. Quando calculado pelo valor líquido, o valor solicitado é o liquido da operação. | — | `0` |
| `initialValue` | `integer (int64)` | opcional | Valor inicial da dívida contraída | — | `0` |
| `liquidValue` | `integer (int64)` | opcional | Valor líquido da operação | — | `1` |
| `monthlyInterest` | `number (double)` | opcional | Taxa de juros nominal mensal da operação | — | `1000` |
| `yearlyInterest` | `number (double)` | opcional | Taxa de juros nominal anual da operação | — | `1000` |
| `startDate` | `string (date-time)` | opcional | Data de início da operação | — | `"2025-08-11T13:45:00Z"` |
| `dueDate` | `string (date-time)` | opcional | Data de encerramento da operação (vencimento da última parcela) | — | `"2025-08-11T13:45:00Z"` |
| `comm` | `integer` | opcional | Valor total de custo de Emissão da operação (soma das comissão do agente e custos de emissão UY3), em centavos | — | `0` |
| `efectiveCommissions` | `array de objeto` | opcional | Custos de Emissão detalhados da operação, inclui tanto as comissões do produto quanto às solicitadas pelo originador, observados os limites estabelecidos | objeto — ver detalhe abaixo | `[ … ]` |
| `commTc` | `integer` | opcional | Valor total de custos de emissão devidos por razão de novo cliente, em centavos | — | `0` |
| `commNonTc` | `integer` | opcional | Total de custos de emissão devidos por razão de cliente recorrente ou cobrança geral, em centavos | — | `0` |
| `agentCommissions` | `array de objeto` | opcional | Custos de Emissão solicitados pelo originador, sem observância dos limites estabelecidos no produto. Para verificar os custos efetivamente considerados, veja efectiveCommissions | objeto — ver detalhe abaixo | `[ … ]` |
| `finTax` | `integer` | opcional | Valor de IOF da operação | — | `0` |
| `effectiveMonthlyCost` | `number (double)` | opcional | Custo Efetivo Total (CET) Mensal da operação | — | `1000` |
| `effectiveYearlyCost` | `number (double)` | opcional | Custo Efetivo Total (CET) Anual da operação | — | `1000` |
| `registrationNumber` | `string` | opcional | CPF para consulta FGTS | — | `"12345678909"` |
| `termInMonths` | `integer` | opcional | Quantidade de parcelas [Obsoleto. Utilizar campo 'numberOfPayments'] | — | `0` |
| `numberOfPayments` | `integer` | opcional | Quantidade de parcelas que serão pagas pelo tomador | — | `0` |
| `paymentFixedCosts` | `integer (int64)` | opcional | — | — | `0` |
| `firstPaymentDate` | `string (date-time)` | opcional | Data do primeiro pagamento | — | `"2025-08-11T13:45:00Z"` |
| `paymentScheduleItems` | `array de objeto` | opcional | Plano de pagamento da operação | objeto — ver detalhe abaixo | `[ … ]` |
| `amortizationType` | `string` | opcional | Tipo de amortização (Price, SAC, CleanPrice, etc) | — | `"texto"` |
| `apr` | `number (double)` | opcional | Taxa de juros (APR) | — | `1.99` |
| `includePaymentFixedCosts` | `boolean` | opcional | Incluir valor da parcela fixa na simulação | — | `true` |
| `financeTaxExempted` | `boolean` | opcional | Isenção de IOF | — | `true` |
| `fiduciaryGuarantee` | `number (double)` | opcional | Percentual de Garantia fiduciária | — | `1000` |
| `indexer` | `string` | opcional | Indexador Pós-Fixado que deve ser aplicado à cada parcela | — | `"texto"` |
| `indexerValue` | `number (double)` | opcional | Percentual Indexador Pós-fixado que deve ser aplicado à cada parcela | — | `1000` |
| `numberOfInterestPayments` | `integer` | opcional | Parcelas de pagamento de juros | — | `0` |
| `calculationType` | `string` | opcional | Base de cálculo (V360Meses, etc) | — | `"texto"` |
| `dueDateOnBusinessDays` | `boolean` | opcional | Datas de vencimento são ajustadas para o próximo dia útil | — | `true` |
| `paymentPeriodicity` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |

Detalhe de `efectiveCommissions`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `commissionName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `commissionValueInCents` | `integer (int64)` | opcional | — | — | `0` |
| `commissionValueInCentsDisplay` | `string` | opcional | — | — | `"texto"` |
| `financed` | `boolean` | opcional | — | — | `true` |

Detalhe de `agentCommissions`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `amount` | `number (double)` | opcional | — | — | `1000` |
| `amountDisplay` | `string` | opcional | — | — | `"texto"` |
| `type` | `string` | opcional | — | — | `"texto"` |
| `baseValue` | `string` | opcional | — | — | `"texto"` |
| `chargeCommissionFrom` | `string` | opcional | — | — | `"texto"` |
| `financeCost` | `boolean` | opcional | — | — | `true` |

Detalhe de `paymentScheduleItems`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `dueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `principalAmountInCents` | `integer (int64)` | opcional | — | — | `0` |
| `amortization` | `integer (int64)` | opcional | — | — | `0` |
| `interest` | `integer (int64)` | opcional | — | — | `0` |
| `financeTax` | `integer (int64)` | opcional | — | — | `0` |
| `payment` | `integer (int64)` | opcional | — | — | `0` |
| `addedFixedCosts` | `integer (int64)` | opcional | — | — | `0` |

Detalhe de `paymentPeriodicity`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `every` | `integer` | opcional | A cada quantos per�odos | — | `0` |
| `periodicity` | `string` | opcional | Tipo de periodicidade (Monthly, Quarterly, etc) | — | `"texto"` |

Exemplo:

```json
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "productName": "Fulano de Tal",
  "calculateByValueType": "texto",
  "requestedAmount": 0,
  "initialValue": 0,
  "liquidValue": 1,
  "monthlyInterest": 1000,
  "yearlyInterest": 1000,
  "startDate": "2025-08-11T13:45:00Z",
  "dueDate": "2025-08-11T13:45:00Z",
  "comm": 0,
  "efectiveCommissions": [
    {
      "commissionName": "Fulano de Tal",
      "commissionValueInCents": 0,
      "commissionValueInCentsDisplay": "texto",
      "financed": true
    }
  ],
  "commTc": 0,
  "commNonTc": 0,
  "agentCommissions": [
    {
      "name": "Fulano de Tal",
      "amount": 1000,
      "amountDisplay": "texto",
      "type": "texto",
      "baseValue": "texto",
      "chargeCommissionFrom": "texto",
      "financeCost": true
    }
  ],
  "finTax": 0,
  "effectiveMonthlyCost": 1000,
  "effectiveYearlyCost": 1000,
  "registrationNumber": "12345678909",
  "termInMonths": 0,
  "numberOfPayments": 0,
  "paymentFixedCosts": 0,
  "firstPaymentDate": "2025-08-11T13:45:00Z",
  "paymentScheduleItems": [
    {
      "dueDate": "2025-08-11T13:45:00Z",
      "principalAmountInCents": 0,
      "amortization": 0,
      "interest": 0,
      "financeTax": 0,
      "payment": 0,
      "addedFixedCosts": 0
    }
  ],
  "amortizationType": "texto",
  "apr": 1.99,
  "includePaymentFixedCosts": true,
  "financeTaxExempted": true,
  "fiduciaryGuarantee": 1000,
  "indexer": "texto",
  "indexerValue": 1000,
  "numberOfInterestPayments": 0,
  "calculationType": "texto",
  "dueDateOnBusinessDays": true,
  "paymentPeriodicity": {
    "every": 0,
    "periodicity": "texto"
  }
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `400` | Requisição inválida (validação de campos ou regra de negócio). |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/Amortization" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "legalPerson": true,
  "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "registrationNumber": "12345678909",
  "amortization": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "amortizationType": "texto",
    "startDate": "2025-08-11T13:45:00Z",
    "apr": 1.99,
    "includePaymentFixedCosts": true,
    "validationErrors": [
      {
        "memberNames": [],
        "errorMessage": "texto"
      }
    ],
    "agentCommissions": [
      {
        "name": "Fulano de Tal",
        "amount": 1000,
        "type": {},
        "baseValue": {},
        "chargeCommissionFrom": {},
        "financeCost": true
      }
    ],
    "agentCommission": {
      "name": "Fulano de Tal",
      "amount": 1000,
      "type": "Absolute",
      "baseValue": "InitialValue",
      "chargeCommissionFrom": "All",
      "financeCost": true,
      "totalValue": 0
    }
  }
}'
```

---

### POST /v{version}/Amortization/Batch

**Gera simulações em lote de operações de crédito e obtém plano de pagamento, CET** — Cria um novo registro de Amortization.

Gera simulações em lote de operações de crédito e obtém plano de pagamento, CET, custo de emissão, IOF, etc.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `version` | path | `string` | obrigatório | — | `1` |
| `fgtsCredentialsName` | query | `string` | opcional | — | `valor` |

**Corpo da requisição** (`application/json`, lista/array)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `productId` | `string (uuid)` | obrigatório | Identificador do Produto relacionado a operação | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `legalPerson` | `boolean` | obrigatório | — | — | `true` |
| `personId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `amortization` | `objeto` | obrigatório | Dados da operação. Utilize um dos valores definidos em "AmortizationType" | varia conforme o tipo — ver exemplo | `{ … }` |

Exemplo:

```json
[
  {
    "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "legalPerson": true,
    "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "amortization": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "amortizationType": "texto",
      "startDate": "2025-08-11T13:45:00Z",
      "apr": 1.99,
      "includePaymentFixedCosts": true,
      "validationErrors": [
        {
          "memberNames": [],
          "errorMessage": "texto"
        }
      ],
      "agentCommissions": [
        {
          "name": "Fulano de Tal",
          "amount": 1000,
          "type": {},
          "baseValue": {},
          "chargeCommissionFrom": {},
          "financeCost": true
        }
      ],
      "agentCommission": {
        "name": "Fulano de Tal",
        "amount": 1000,
        "type": "Absolute",
        "baseValue": "InitialValue",
        "chargeCommissionFrom": "All",
        "financeCost": true,
        "totalValue": 0
      }
    }
  }
]
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string (uuid)` | opcional | Identificador da simulação | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `productId` | `string (uuid)` | opcional | Identificador do produto da simulação | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `productName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `calculateByValueType` | `string` | opcional | Tipo de tabela de amortização | — | `"texto"` |
| `requestedAmount` | `integer (int64)` | opcional | Valor solicitado pelo tomador. Quando calculado pelo valor líquido, o valor solicitado é o liquido da operação. | — | `0` |
| `initialValue` | `integer (int64)` | opcional | Valor inicial da dívida contraída | — | `0` |
| `liquidValue` | `integer (int64)` | opcional | Valor líquido da operação | — | `1` |
| `monthlyInterest` | `number (double)` | opcional | Taxa de juros nominal mensal da operação | — | `1000` |
| `yearlyInterest` | `number (double)` | opcional | Taxa de juros nominal anual da operação | — | `1000` |
| `startDate` | `string (date-time)` | opcional | Data de início da operação | — | `"2025-08-11T13:45:00Z"` |
| `dueDate` | `string (date-time)` | opcional | Data de encerramento da operação (vencimento da última parcela) | — | `"2025-08-11T13:45:00Z"` |
| `comm` | `integer` | opcional | Valor total de custo de Emissão da operação (soma das comissão do agente e custos de emissão UY3), em centavos | — | `0` |
| `efectiveCommissions` | `array de objeto` | opcional | Custos de Emissão detalhados da operação, inclui tanto as comissões do produto quanto às solicitadas pelo originador, observados os limites estabelecidos | objeto — ver detalhe abaixo | `[ … ]` |
| `commTc` | `integer` | opcional | Valor total de custos de emissão devidos por razão de novo cliente, em centavos | — | `0` |
| `commNonTc` | `integer` | opcional | Total de custos de emissão devidos por razão de cliente recorrente ou cobrança geral, em centavos | — | `0` |
| `agentCommissions` | `array de objeto` | opcional | Custos de Emissão solicitados pelo originador, sem observância dos limites estabelecidos no produto. Para verificar os custos efetivamente considerados, veja efectiveCommissions | objeto — ver detalhe abaixo | `[ … ]` |
| `finTax` | `integer` | opcional | Valor de IOF da operação | — | `0` |
| `effectiveMonthlyCost` | `number (double)` | opcional | Custo Efetivo Total (CET) Mensal da operação | — | `1000` |
| `effectiveYearlyCost` | `number (double)` | opcional | Custo Efetivo Total (CET) Anual da operação | — | `1000` |
| `registrationNumber` | `string` | opcional | CPF para consulta FGTS | — | `"12345678909"` |
| `termInMonths` | `integer` | opcional | Quantidade de parcelas [Obsoleto. Utilizar campo 'numberOfPayments'] | — | `0` |
| `numberOfPayments` | `integer` | opcional | Quantidade de parcelas que serão pagas pelo tomador | — | `0` |
| `paymentFixedCosts` | `integer (int64)` | opcional | — | — | `0` |
| `firstPaymentDate` | `string (date-time)` | opcional | Data do primeiro pagamento | — | `"2025-08-11T13:45:00Z"` |
| `paymentScheduleItems` | `array de objeto` | opcional | Plano de pagamento da operação | objeto — ver detalhe abaixo | `[ … ]` |
| `amortizationType` | `string` | opcional | Tipo de amortização (Price, SAC, CleanPrice, etc) | — | `"texto"` |
| `apr` | `number (double)` | opcional | Taxa de juros (APR) | — | `1.99` |
| `includePaymentFixedCosts` | `boolean` | opcional | Incluir valor da parcela fixa na simulação | — | `true` |
| `financeTaxExempted` | `boolean` | opcional | Isenção de IOF | — | `true` |
| `fiduciaryGuarantee` | `number (double)` | opcional | Percentual de Garantia fiduciária | — | `1000` |
| `indexer` | `string` | opcional | Indexador Pós-Fixado que deve ser aplicado à cada parcela | — | `"texto"` |
| `indexerValue` | `number (double)` | opcional | Percentual Indexador Pós-fixado que deve ser aplicado à cada parcela | — | `1000` |
| `numberOfInterestPayments` | `integer` | opcional | Parcelas de pagamento de juros | — | `0` |
| `calculationType` | `string` | opcional | Base de cálculo (V360Meses, etc) | — | `"texto"` |
| `dueDateOnBusinessDays` | `boolean` | opcional | Datas de vencimento são ajustadas para o próximo dia útil | — | `true` |
| `paymentPeriodicity` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |

Detalhe de `efectiveCommissions`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `commissionName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `commissionValueInCents` | `integer (int64)` | opcional | — | — | `0` |
| `commissionValueInCentsDisplay` | `string` | opcional | — | — | `"texto"` |
| `financed` | `boolean` | opcional | — | — | `true` |

Detalhe de `agentCommissions`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `amount` | `number (double)` | opcional | — | — | `1000` |
| `amountDisplay` | `string` | opcional | — | — | `"texto"` |
| `type` | `string` | opcional | — | — | `"texto"` |
| `baseValue` | `string` | opcional | — | — | `"texto"` |
| `chargeCommissionFrom` | `string` | opcional | — | — | `"texto"` |
| `financeCost` | `boolean` | opcional | — | — | `true` |

Detalhe de `paymentScheduleItems`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `dueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `principalAmountInCents` | `integer (int64)` | opcional | — | — | `0` |
| `amortization` | `integer (int64)` | opcional | — | — | `0` |
| `interest` | `integer (int64)` | opcional | — | — | `0` |
| `financeTax` | `integer (int64)` | opcional | — | — | `0` |
| `payment` | `integer (int64)` | opcional | — | — | `0` |
| `addedFixedCosts` | `integer (int64)` | opcional | — | — | `0` |

Detalhe de `paymentPeriodicity`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `every` | `integer` | opcional | A cada quantos per�odos | — | `0` |
| `periodicity` | `string` | opcional | Tipo de periodicidade (Monthly, Quarterly, etc) | — | `"texto"` |

Exemplo:

```json
[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "productName": "Fulano de Tal",
    "calculateByValueType": "texto",
    "requestedAmount": 0,
    "initialValue": 0,
    "liquidValue": 1,
    "monthlyInterest": 1000,
    "yearlyInterest": 1000,
    "startDate": "2025-08-11T13:45:00Z",
    "dueDate": "2025-08-11T13:45:00Z",
    "comm": 0,
    "efectiveCommissions": [
      {
        "commissionName": "Fulano de Tal",
        "commissionValueInCents": 0,
        "commissionValueInCentsDisplay": "texto",
        "financed": true
      }
    ],
    "commTc": 0,
    "commNonTc": 0,
    "agentCommissions": [
      {
        "name": "Fulano de Tal",
        "amount": 1000,
        "amountDisplay": "texto",
        "type": "texto",
        "baseValue": "texto",
        "chargeCommissionFrom": "texto",
        "financeCost": true
      }
    ],
    "finTax": 0,
    "effectiveMonthlyCost": 1000,
    "effectiveYearlyCost": 1000,
    "registrationNumber": "12345678909",
    "termInMonths": 0,
    "numberOfPayments": 0,
    "paymentFixedCosts": 0,
    "firstPaymentDate": "2025-08-11T13:45:00Z",
    "paymentScheduleItems": [
      {
        "dueDate": "2025-08-11T13:45:00Z",
        "principalAmountInCents": 0,
        "amortization": 0,
        "interest": 0,
        "financeTax": 0,
        "payment": 0,
        "addedFixedCosts": 0
      }
    ],
    "amortizationType": "texto",
    "apr": 1.99,
    "includePaymentFixedCosts": true,
    "financeTaxExempted": true,
    "fiduciaryGuarantee": 1000,
    "indexer": "texto",
    "indexerValue": 1000,
    "numberOfInterestPayments": 0,
    "calculationType": "texto",
    "dueDateOnBusinessDays": true,
    "paymentPeriodicity": {
      "every": 0,
      "periodicity": "texto"
    }
  }
]
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `400` | Requisição inválida (validação de campos ou regra de negócio). |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/Amortization/Batch" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "legalPerson": true,
    "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "amortization": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "amortizationType": "texto",
      "startDate": "2025-08-11T13:45:00Z",
      "apr": 1.99,
      "includePaymentFixedCosts": true,
      "validationErrors": [
        {
          "memberNames": [],
          "errorMessage": "texto"
        }
      ],
      "agentCommissions": [
        {
          "name": "Fulano de Tal",
          "amount": 1000,
          "type": {},
          "baseValue": {},
          "chargeCommissionFrom": {},
          "financeCost": true
        }
      ],
      "agentCommission": {
        "name": "Fulano de Tal",
        "amount": 1000,
        "type": "Absolute",
        "baseValue": "InitialValue",
        "chargeCommissionFrom": "All",
        "financeCost": true,
        "totalValue": 0
      }
    }
  }
]'
```

---

### GET /v{version}/Amortization/{id}

**Obtém simulações de operações de crédito geradas anteriormente** — Consulta Amortization pelo identificador informado na rota.

Obtém simulações de operações de crédito geradas anteriormente, incluindo plano de pagamento, CET, custo de emissão, IOF, etc.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `personId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `personDisplay` | `string` | opcional | — | — | `"texto"` |
| `personDiscriminator` | `string` | opcional | — | — | `"texto"` |
| `productId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `productIdDisplay` | `string` | opcional | — | — | `"texto"` |
| `legalPerson` | `boolean` | opcional | — | — | `true` |
| `amortizationId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `amortization` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `paymentScheduleItems` | `array de objeto` | opcional | — | — | `[ … ]` |

Detalhe de `amortization`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `amortizationType` | `string` | opcional | Tipo de tabela de amortização | — | `"texto"` |
| `calculateByValueType` | `string` | opcional | Tipo de cálculo de operação: Valor Bruto ou Valor Líquido | — | `"texto"` |
| `requestedAmount` | `integer (int64)` | opcional | Valor solicitado pelo tomador. Quando calculado pelo valor líquido, o valor solicitado é o liquido da operação. | — | `0` |
| `principalAmountInCents` | `integer (int64)` | opcional | Valor do principal da dívida. | — | `0` |
| `startDate` | `string (date-time)` | opcional | Data de início da operação | — | `"2025-08-11T13:45:00Z"` |
| `termInMonths` | `integer` | opcional | Prazo da operação (em meses ou anos, dependendo da periodicidade) | — | `0` |
| `numberOfPayments` | `integer` | opcional | Quantidade de parcelas que serão pagas pelo tomador | — | `0` |
| `paymentPeriodicity` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `absAmortizationInMonths` | `integer` | opcional | Número de períodos em que será dada carência de cobrança do principal | — | `0` |
| `absInterestInMonths` | `integer` | opcional | Número de períodos em que será dada carência de juros da operação. Será sempre menor ou igual à carência do principal. | — | `0` |
| `apr` | `number (double)` | opcional | Taxa de juros nominal da operação | — | `1.99` |
| `periodicity` | `string` | opcional | Periodicidade das parcelas da operação | — | `"texto"` |
| `daysInYear` | `integer` | opcional | Base de cálculos (dias no ano) | — | `0` |
| `agentCommission` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `calculationType` | `string` | opcional | Base de cálculo | — | `"texto"` |
| `firstPaymentDate` | `string (date-time)` | opcional | Data do primeiro pagamento | — | `"2025-08-11T13:45:00Z"` |
| `bankCommission` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `financeOperationsTax` | `number (double)` | opcional | Alíquota de IOF adicional utilizada durante o cálculo de IOF | — | `1.99` |
| `dailyFinanceOperationsTax` | `number (double)` | opcional | Alíquota de IOF diário utilizada durante o cálculo de IOF | — | `1.99` |
| `indexer` | `string` | opcional | Nome do indexador pós-fixado da operação, se utilizado | — | `"texto"` |
| `indexerValue` | `number (double)` | opcional | Quantidade (em percentual) do indexador que será aplicada a cada parcela da operação | — | `1000` |
| `paymentDay` | `integer` | opcional | Dia de vencimento das parcelas da operação | — | `0` |
| `skippedMonths` | `array de string` | opcional | Meses do ano em que foi dada carência no pagamento da parcela. Usado apenas em operações de CCI/Home Equity | — | `[ … ]` |
| `monthlyInterest` | `number (double)` | opcional | Taxa de juros nominal mensal da operação | — | `1000` |
| `yearlyInterest` | `number (double)` | opcional | Taxa de juros nominal anual da operação | — | `1000` |
| `effectiveMonthlyCost` | `number (double)` | opcional | Custo Efetivo Total (CET) Mensal da operação | — | `1000` |
| `effectiveYearlyCost` | `number (double)` | opcional | Custo Efetivo Total (CET) Anual da operação | — | `1000` |
| `liquidValue` | `integer (int64)` | opcional | Valor líquido da operação | — | `1` |
| `comm` | `integer` | opcional | Custo de Emissão da operação (soma da comissão do agente e Custo de emissão UY3) | — | `0` |
| `commTc` | `integer` | opcional | Custo de Emissão referentes à tarifas de cadastro (TC) | — | `0` |
| `commNonTc` | `integer` | opcional | Custo de Emissão da operação exceto tarifas de cadastro (TC) | — | `0` |
| `finTax` | `integer` | opcional | Valor de IOF da operação | — | `0` |
| `dueDate` | `string (date-time)` | opcional | Data de encerramento da operação (vencimento da última parcela) | — | `"2025-08-11T13:45:00Z"` |
| `initialValue` | `integer (int64)` | opcional | Valor inicial da dívida contraída | — | `0` |
| `fixedPaymentDuringGraduation` | `integer` | opcional | Valor da parcela durante o curso. Utilizado em operações de Financiamento Estudantil | — | `0` |
| `termsUntilGraduation` | `integer` | opcional | Número de períodos até o término do curso. Utilizado em operações de Financiamento Estudantil | — | `0` |
| `absAfterGraduation` | `integer` | opcional | Número de períodos com carência de pagamento após o término do curso. Utilizado em operações de Financiamento Estudantil | — | `0` |
| `pmt2Value` | `number (double)` | opcional | Valor do pagamento após o término da carência após conclusão do curso. Utilizado em operações de Financiamento Estudantil | — | `1000` |
| `fiduciaryGuarantee` | `number (double)` | opcional | Percentual de garantia fiduciária da operação. Utilizada em operações com garantia de duplicata. | — | `1000` |
| `financeTaxExempted` | `boolean` | opcional | Indica se a operação é isenta de IOF por definição legal | — | `true` |
| `issueNumber` | `integer` | opcional | Numero de série da nota comercial | — | `0` |
| `emissionNumber` | `integer` | opcional | Numero de emissão da nota comercial | — | `0` |
| `quantity` | `integer` | opcional | Quantidade de notas comerciais | — | `0` |
| `unitPrice` | `integer (int64)` | opcional | Valor unitario da nota comercial | — | `0` |
| `minEmissionCost` | `integer (int64)` | opcional | /// Custo Mínimo de Emissão com base no produto | — | `0` |
| `maxEmissionCost` | `integer (int64)` | opcional | Custo Máximo de Emissão com base no produto | — | `0` |
| `numberOfInterestPayments` | `integer` | opcional | Parcelas de pagamento de juros | — | `0` |
| `valueMarginReserve` | `integer (int64)` | opcional | Valor reserva de margem | — | `0` |
| `insuranceCoverAmount` | `integer (int64)` | opcional | Valor da cobertura do seguro | — | `0` |
| `paymentFixedCosts` | `integer (int64)` | opcional | Valor da parcela fixa | — | `0` |
| `includePaymentFixedCosts` | `boolean` | opcional | Incluir valor da parcela fixa na simulação | — | `true` |
| `dueDateOnBusinessDays` | `boolean` | opcional | Datas de vencimento são ajustadas para o próximo dia útil | — | `true` |
| `discountMode` | `boolean` | opcional | Calcula o juros baseado no valor de amortização em relação à data de início. Caso contrário, calcula o juros baseasdo no saldo devedor em relação à ultima parcela. | — | `true` |

Detalhe de `paymentPeriodicity`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `every` | `integer` | opcional | A cada quantos per�odos | — | `0` |
| `periodicity` | `string` | opcional | Tipo de periodicidade (Monthly, Quarterly, etc) | — | `"texto"` |

Detalhe de `agentCommission`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `amount` | `number (double)` | opcional | — | — | `1000` |
| `amountDisplay` | `string` | opcional | — | — | `"texto"` |
| `type` | `string` | opcional | — | — | `"texto"` |
| `baseValue` | `string` | opcional | — | — | `"texto"` |
| `chargeCommissionFrom` | `string` | opcional | — | — | `"texto"` |
| `financeCost` | `boolean` | opcional | — | — | `true` |

Exemplo:

```json
{
  "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "personDisplay": "texto",
  "personDiscriminator": "texto",
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "productIdDisplay": "texto",
  "legalPerson": true,
  "amortizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "amortization": {
    "amortizationType": "texto",
    "calculateByValueType": "texto",
    "requestedAmount": 0,
    "principalAmountInCents": 0,
    "startDate": "2025-08-11T13:45:00Z",
    "termInMonths": 0,
    "numberOfPayments": 0,
    "paymentPeriodicity": {
      "every": 0,
      "periodicity": "texto"
    },
    "absAmortizationInMonths": 0,
    "absInterestInMonths": 0,
    "apr": 1.99,
    "periodicity": "texto",
    "daysInYear": 0,
    "agentCommission": {
      "name": "Fulano de Tal",
      "amount": 1000,
      "amountDisplay": "texto",
      "type": "texto",
      "baseValue": "texto",
      "chargeCommissionFrom": "texto",
      "financeCost": true
    },
    "calculationType": "texto",
    "firstPaymentDate": "2025-08-11T13:45:00Z",
    "bankCommission": {
      "name": "Fulano de Tal",
      "amount": 1000,
      "amountDisplay": "texto",
      "type": "texto",
      "baseValue": "texto",
      "chargeCommissionFrom": "texto",
      "financeCost": true
    },
    "financeOperationsTax": 1.99,
    "dailyFinanceOperationsTax": 1.99,
    "indexer": "texto",
    "indexerValue": 1000,
    "paymentDay": 0,
    "skippedMonths": [
      "texto"
    ],
    "monthlyInterest": 1000,
    "yearlyInterest": 1000,
    "effectiveMonthlyCost": 1000,
    "effectiveYearlyCost": 1000,
    "liquidValue": 1,
    "comm": 0,
    "commTc": 0,
    "commNonTc": 0,
    "finTax": 0,
    "dueDate": "2025-08-11T13:45:00Z",
    "initialValue": 0,
    "fixedPaymentDuringGraduation": 0,
    "termsUntilGraduation": 0,
    "absAfterGraduation": 0,
    "pmt2Value": 1000,
    "fiduciaryGuarantee": 1000,
    "financeTaxExempted": true,
    "issueNumber": 0,
    "emissionNumber": 0,
    "quantity": 0,
    "unitPrice": 0,
    "minEmissionCost": 0,
    "maxEmissionCost": 0,
    "numberOfInterestPayments": 0,
    "valueMarginReserve": 0,
    "insuranceCoverAmount": 0,
    "paymentFixedCosts": 0,
    "includePaymentFixedCosts": true,
    "dueDateOnBusinessDays": true,
    "discountMode": true
  },
  "paymentScheduleItems": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "dueDate": "2025-08-11T13:45:00Z",
      "principalAmountInCents": 0,
      "amortization": 0,
      "interest": 0,
      "financeTax": 0,
      "payment": 0,
      "accruedInterest": 0,
      "addedFixedCosts": 0,
      "paymentNo": 0
    }
  ]
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/v1/Amortization/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

## Operação de crédito

Crie a operação, anexe documentos, envie para aprovação e acompanhe o status.

### POST /v{version}/CreditNote

**Cria uma nova solicitação de operação de crédito (CCB, CDC** — Cria um novo registro de Credit Note.

Cria uma nova solicitação de operação de crédito (CCB, CDC, Financiamento Estudantil, etc)

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `version` | path | `string` | obrigatório | — | `1` |
| `updateStartDate` | query | `boolean` | opcional | — | `true` |
| `returnValue` | query | `string` | opcional | — | `valor` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `productId` | `string (uuid)` | obrigatório | produto contratado | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `warranty` | `array de objeto` | opcional | Garantia de Bens | — | `[ … ]` |
| `emissionDate` | `string (date-time)` | opcional | Data de emissão do contrato | — | `"2025-08-11T13:45:00Z"` |
| `amortization` | `objeto` | obrigatório | Parâmetros da operação | varia conforme o tipo — ver exemplo | `{ … }` |
| `personId` | `string (uuid)` | obrigatório | Pessoa tomadora | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `liquidationType` | `string` | opcional | — | `Invoice`, `EletronicTransfer` | `"Invoice"` |
| `invoiceBarCode` | `string` | opcional | Linha digitável, para quando o tipo de liquidação é por boleto | — | `"texto"` |
| `beneficiaryId` | `string (uuid)` | opcional | Benefiário da operação | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `collateral` | `string` | opcional | Dados da garantia da operação | — | `"texto"` |
| `observations` | `string` | opcional | Observações gerais sobre a operação que poderão ser levadas em consideração pela mesa | — | `"texto"` |
| `status` | `string` | opcional | — | `Draft`, `ComplianceApproval`, `Signatures`, `Liquidation`, `Finished`, `Disapproved`, `Error`, `Revision`, `CreditApproval`, `InstrumentApproval`, `Canceled`, `WaitLiquidation`, `SignaturesValidation`, `PaymentRevision`, `ManualLiquidation`, `Warranty`, `ManualWarranty`, `MarginReserveApproval`, `WarrantyRevision`, `PartnerSignaturesValidation`, `OpenAccountRevision`, `VehicleInspection`, `VehicleInspectionApproval`, `GravameRegistration` | `"Draft"` |
| `bankAccountId` | `string (uuid)` | opcional | Conta bancária | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `isRegistered` | `boolean` | opcional | Indica se há registro em uma Registradora de Recebíveis | — | `true` |
| `bulkAssignment` | `boolean` | opcional | Indica se terá cessão em lote | — | `true` |
| `invoiceValue` | `integer (int64)` | opcional | Valor em centavos da nota fiscal | — | `0` |
| `invoiceNumber` | `string` | opcional | Número da nota fiscal (44 dígitos) | — | `"texto"` |
| `changeBankAccountId` | `string (uuid)` | opcional | Conta bancária de troco | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `issueNumber` | `integer` | opcional | Numero de série da nota comercial | — | `0` |
| `emissionNumber` | `integer` | opcional | Numero de emissão da nota comercial | — | `0` |
| `quantity` | `integer` | opcional | Quantidade de notas comerciais | — | `0` |
| `unitPrice` | `integer (int64)` | opcional | Valor unitario da nota comercial | — | `0` |
| `assignmentCalculation` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `assets` | `array de objeto` | opcional | Lista de IDs das garantias vinculadas à operação. São bens/diretos da(s) PFs ou PJs vinculadas à operação | objeto — ver detalhe abaixo | `[ … ]` |
| `relatedPersonCreditNote` | `array de objeto` | opcional | Lista das pessoas relacionadas a operação. | objeto — ver detalhe abaixo | `[ … ]` |
| `uploads` | `array de objeto` | opcional | Lista de arquivos relacionadas a operação. | objeto — ver detalhe abaixo | `[ … ]` |
| `paymentScheduleItems` | `array de objeto` | opcional | Lista de parcelas relacionadas a operação. | objeto — ver detalhe abaixo | `[ … ]` |
| `unicoSignScore` | `number (double)` | opcional | Score na Unico | — | `1000` |
| `facialSimilarityScore` | `number (double)` | opcional | Score na Unico | — | `1000` |
| `transitoryBankAccountId` | `string (uuid)` | opcional | Conta transitório do Roteiro de Liquidação | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `transitoryBankAccountOpenAccount` | `boolean` | opcional | — | — | `true` |
| `liquidationMode` | `string` | opcional | — | `Simple`, `LiquidationSchedule` | `"Simple"` |
| `liquidationSchedule` | `array de objeto` | opcional | Roteiro de liquidação | objeto — ver detalhe abaixo | `[ … ]` |
| `signatureDetails` | `array de objeto` | opcional | Dados da assinatura eletrônica de envolvidos | objeto — ver detalhe abaixo | `[ … ]` |
| `newPersonAndAccount` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `insurance` | `boolean` | opcional | Indica se a operação possui seguro | — | `true` |
| `dataprevOfferCTPSRequestId` | `integer (int64)` | opcional | RequestId da oferta CTPS de origem (espelho de DataprevEmployeeOfferCTPS.RequestId). Informado apenas quando a operação é criada a partir do leilão. Default null. | — | `1` |
| `isByxCreation` | `boolean` | opcional | Flag para indicar se a operação foi enviada pela BYX | — | `true` |

Detalhe de `ownerUser`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `ownerGroup`:

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

Detalhe de `assignmentCalculation`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `amount` | `number (double)` | opcional | — | — | `1000` |
| `type` | `string` | opcional | — | `Absolute`, `Percentage` | `"Absolute"` |
| `mode` | `string` | opcional | — | `InitialValue`, `PresentValuePayment`, `PresentValueCreditNote`, `Default` | `"InitialValue"` |

Detalhe de `assets`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |

Detalhe de `relatedPersonCreditNote`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `personId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `typeOfRelationship` | `string` | obrigatório | — | `Issuer`, `PartnerGuarantor`, `Guarantor`, `Proxy`, `ProxyGuarantor`, `Partner`, `Spouse`, `Consenter`, `Witness`, `Assignor`, `Assignee`, `Endorser`, `Employer`, `Creditor`, `Debtor`, `PartnerDebtor`, `BillingAgent`, `BillingAgentApproverUser`, `Beneficiary`, `NotaryAgent`, `SettlementAgent`, `CreditorEndorser`, `FaithfulCustodian`, `JointGuarantor`, `ThirdPartyGuarantor`, `LegalRepresentative`, `InsuranceCompany`, `Presidente`, `Administrador`, `Diretor` | `"Issuer"` |
| `relatedToId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `signatureType` | `string` | opcional | — | `email`, `sms`, `whatsapp` | `"email"` |
| `signatureValidation` | `string` | opcional | — | `EletronicSignatureAndDocument`, `SelfieSignature`, `SelfieDocumentSignature`, `FacialBiometrics`, `DigitalCertificate`, `EletronicSignature` | `"EletronicSignatureAndDocument"` |
| `percentage` | `number (double)` | opcional | — | — | `1.99` |

Detalhe de `uploads`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `fileType` | `string` | obrigatório | — | `Document`, `Authorization`, `DriversLicense`, `WorkCard`, `ResidenceProofCompany`, `ResidenceProofPartners`, `Draft`, `SocialContract`, `RegistrationNumber`, `IdentificationDocumentWithPhoto`, `BankStatement`, `ManagerialBilling`, `RegistrationForm`, `Others`, `Selfie`, `SelfieWithIdentityCard`, `LastDeclaration`, `SignedContract`, `SigningStampContract`, `CreditReport`, `Assignment`, `Addition`, `FiduciaryAssignment`, `P7S`, `ZipedFiles`, `CNAB`, `Invoice`, `MinutesOfElection`, `Procuration`, `TermOfOwnership`, `Bylaws`, `IdentityCard`, `Collateral`, `Regulation`, `Balance`, `BalanceSheet`, `PLDFT`, `IncomeTax`, `DRE`, `Receipt`, `CompanyCard`, `AssignmetReport`, `NationalRegistryOfForeigners`, `NationalIdentityCard`, `RegionalRegistrationCard`, `Passaport`, `Paycheck`, `Indorsement`, `WarrantyRegistrationOfficeProof`, `OperationHistory`, `VehicleInspection`, `InsuranceCancellationTemplate`, `SignatureTemplateDraft`, `InssDefermentReport`, `InssMedicalReview` | `"Document"` |
| `fileName` | `string` | obrigatório | Nome do arquivo (retornado pelo GET v1/Upload) | — | `"Fulano de Tal"` |
| `displayName` | `string` | opcional | Nome de exibição do arquivo | — | `"Fulano de Tal"` |
| `documentDate` | `string (date-time)` | opcional | Data do próprio documento (emissão/referência), não a data do upload. Aceita em qualquer tipo de documento e sempre opcional.   Só tem efeito de negócio no laudo de deferimento INSS e na última perícia INSS, cujos valores são comparados aos cortes da regra de elegibilidade dos benefícios 32/92 (faixa 45–54); nos demais tipos é apenas informativa. | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `paymentScheduleItems`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `dueDate` | `string (date-time)` | opcional | Data de vencimento da parcela | — | `"2025-08-11T13:45:00Z"` |
| `principalAmountInCents` | `integer (int64)` | opcional | Saldo devedor da parcela após a apuração de amortização e juros | — | `0` |
| `amortization` | `integer (int64)` | opcional | Valor amortizado (principal) na parcela | — | `0` |
| `interest` | `integer (int64)` | opcional | Juros apurados no período | — | `0` |
| `financeTax` | `integer (int64)` | opcional | Valor de IOF que incide sob a parcela (IOF diário + parcela do IOF base) | — | `0` |
| `addedFixedCosts` | `integer (int64)` | opcional | Valor de tarifas adicionais que devem ser incluídas em cada parcela (valor não é financiado) | — | `0` |
| `payment` | `integer (int64)` | opcional | Valor da parcela que será pago pelo devedor no vencimento | — | `0` |

Detalhe de `liquidationSchedule`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `amountInCents` | `integer (int64)` | obrigatório | — | — | `0` |
| `pixQrCode` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankSlip` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `pixKey` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `transfer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `informedDueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `signatureDetails`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `userAgent` | `string` | opcional | — | — | `"texto"` |
| `ip` | `string` | opcional | — | — | `"texto"` |
| `geoLocation` | `string` | opcional | — | — | `"texto"` |
| `operationalSystem` | `string` | opcional | — | — | `"texto"` |
| `deviceModel` | `string` | opcional | — | — | `"texto"` |
| `deviceName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `deviceType` | `string` | opcional | — | — | `"texto"` |
| `smsValidation` | `boolean` | opcional | — | — | `true` |
| `emailValidation` | `boolean` | opcional | — | — | `true` |

Detalhe de `newPersonAndAccount`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `personType` | `string` | opcional | — | `Natural`, `Legal` | `"Natural"` |
| `listBankAccounts` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `pixQrCode`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `qrCode` | `string` | obrigatório | — | — | `"texto"` |

Detalhe de `bankSlip`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `barcodeOrDigitableLine` | `string` | obrigatório | — | — | `"texto"` |

Detalhe de `pixKey`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `key` | `string` | obrigatório | — | — | `"texto"` |
| `pixKeyType` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `transfer`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `to` | `objeto` | obrigatório | — | objeto — ver detalhe abaixo | `{ … }` |
| `type` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |

Detalhe de `listBankAccounts`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `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 | — | `NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount` | `"NaturalCheckingAccount"` |
| `jointAccount` | `boolean` | opcional | — | — | `true` |
| `operationTypeValue` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |
| `pixKeyTypeValue` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `keyPix` | `string` | opcional | chave pix | — | `"texto"` |

Exemplo:

```json
{
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "warranty": [
    {
      "warrantyType": "Warranty"
    }
  ],
  "emissionDate": "2025-08-11T13:45:00Z",
  "amortization": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "amortizationType": "texto",
    "startDate": "2025-08-11T13:45:00Z",
    "apr": 1.99,
    "includePaymentFixedCosts": true,
    "validationErrors": [
      {
        "memberNames": [],
        "errorMessage": "texto"
      }
    ],
    "agentCommissions": [
      {
        "name": "Fulano de Tal",
        "amount": 1000,
        "type": {},
        "baseValue": {},
        "chargeCommissionFrom": {},
        "financeCost": true
      }
    ],
    "agentCommission": {
      "name": "Fulano de Tal",
      "amount": 1000,
      "type": "Absolute",
      "baseValue": "InitialValue",
      "chargeCommissionFrom": "All",
      "financeCost": true,
      "totalValue": 0
    }
  },
  "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "liquidationType": "Invoice",
  "invoiceBarCode": "texto",
  "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "collateral": "texto",
  "observations": "texto",
  "status": "Draft",
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isRegistered": true,
  "bulkAssignment": true,
  "invoiceValue": 0,
  "invoiceNumber": "texto",
  "changeBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "issueNumber": 0,
  "emissionNumber": 0,
  "quantity": 0,
  "unitPrice": 0,
  "assignmentCalculation": {
    "amount": 1000,
    "type": "Absolute",
    "mode": "InitialValue"
  },
  "assets": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "relatedPersonCreditNote": [
    {
      "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "typeOfRelationship": "Issuer",
      "relatedToId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "signatureType": "email",
      "signatureValidation": "EletronicSignatureAndDocument",
      "percentage": 1.99
    }
  ],
  "uploads": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "fileType": "Document",
      "fileName": "Fulano de Tal",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z"
    }
  ],
  "paymentScheduleItems": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "dueDate": "2025-08-11T13:45:00Z",
      "principalAmountInCents": 0,
      "amortization": 0,
      "interest": 0,
      "financeTax": 0,
      "addedFixedCosts": 0,
      "payment": 0
    }
  ],
  "unicoSignScore": 1000,
  "facialSimilarityScore": 1000,
  "transitoryBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "transitoryBankAccountOpenAccount": true,
  "liquidationMode": "Simple",
  "liquidationSchedule": [
    {
      "amountInCents": 0,
      "pixQrCode": {
        "qrCode": "texto"
      },
      "bankSlip": {
        "barcodeOrDigitableLine": "texto"
      },
      "pixKey": {
        "key": "texto",
        "pixKeyType": {},
        "typeDisplay": "texto"
      },
      "transfer": {
        "to": {},
        "type": {}
      },
      "description": "texto",
      "informedDueDate": "2025-08-11T13:45:00Z"
    }
  ],
  "signatureDetails": [
    {
      "registrationNumber": "12345678909",
      "userAgent": "texto",
      "ip": "texto",
      "geoLocation": "texto",
      "operationalSystem": "texto",
      "deviceModel": "texto",
      "deviceName": "Fulano de Tal",
      "deviceType": "texto",
      "smsValidation": true,
      "emailValidation": true
    }
  ],
  "newPersonAndAccount": {
    "personType": "Natural",
    "listBankAccounts": [
      {
        "ownerUser": {},
        "ownerGroup": {},
        "bankCode": 0,
        "bankIspb": 0,
        "account": "texto",
        "accountDigit": "texto",
        "agency": "texto",
        "agencyDigit": "texto",
        "type": {},
        "jointAccount": true,
        "operationTypeValue": {},
        "pixKeyTypeValue": {},
        "keyPix": "texto"
      }
    ]
  },
  "insurance": true,
  "dataprevOfferCTPSRequestId": 1,
  "isByxCreation": true
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "warranty": [
    {
      "warrantyType": "Warranty"
    }
  ],
  "emissionDate": "2025-08-11T13:45:00Z",
  "amortization": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "amortizationType": "texto",
    "startDate": "2025-08-11T13:45:00Z",
    "apr": 1.99,
    "includePaymentFixedCosts": true,
    "validationErrors": [
      {
        "memberNames": [],
        "errorMessage": "texto"
      }
    ],
    "agentCommissions": [
      {
        "name": "Fulano de Tal",
        "amount": 1000,
        "type": {},
        "baseValue": {},
        "chargeCommissionFrom": {},
        "financeCost": true
      }
    ],
    "agentCommission": {
      "name": "Fulano de Tal",
      "amount": 1000,
      "type": "Absolute",
      "baseValue": "InitialValue",
      "chargeCommissionFrom": "All",
      "financeCost": true,
      "totalValue": 0
    }
  },
  "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "liquidationType": "Invoice",
  "invoiceBarCode": "texto",
  "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "collateral": "texto",
  "observations": "texto",
  "status": "Draft",
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isRegistered": true,
  "bulkAssignment": true,
  "invoiceValue": 0,
  "invoiceNumber": "texto",
  "changeBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "issueNumber": 0,
  "emissionNumber": 0,
  "quantity": 0,
  "unitPrice": 0,
  "assignmentCalculation": {
    "amount": 1000,
    "type": "Absolute",
    "mode": "InitialValue"
  },
  "assets": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "relatedPersonCreditNote": [
    {
      "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "typeOfRelationship": "Issuer",
      "relatedToId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "signatureType": "email",
      "signatureValidation": "EletronicSignatureAndDocument",
      "percentage": 1.99
    }
  ],
  "uploads": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "fileType": "Document",
      "fileName": "Fulano de Tal",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z"
    }
  ],
  "paymentScheduleItems": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "dueDate": "2025-08-11T13:45:00Z",
      "principalAmountInCents": 0,
      "amortization": 0,
      "interest": 0,
      "financeTax": 0,
      "addedFixedCosts": 0,
      "payment": 0
    }
  ],
  "unicoSignScore": 1000,
  "facialSimilarityScore": 1000,
  "transitoryBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "transitoryBankAccountOpenAccount": true,
  "liquidationMode": "Simple",
  "liquidationSchedule": [
    {
      "amountInCents": 0,
      "pixQrCode": {
        "qrCode": "texto"
      },
      "bankSlip": {
        "barcodeOrDigitableLine": "texto"
      },
      "pixKey": {
        "key": "texto",
        "pixKeyType": {},
        "typeDisplay": "texto"
      },
      "transfer": {
        "to": {},
        "type": {}
      },
      "description": "texto",
      "informedDueDate": "2025-08-11T13:45:00Z"
    }
  ],
  "signatureDetails": [
    {
      "registrationNumber": "12345678909",
      "userAgent": "texto",
      "ip": "texto",
      "geoLocation": "texto",
      "operationalSystem": "texto",
      "deviceModel": "texto",
      "deviceName": "Fulano de Tal",
      "deviceType": "texto",
      "smsValidation": true,
      "emailValidation": true
    }
  ],
  "newPersonAndAccount": {
    "personType": "Natural",
    "listBankAccounts": [
      {
        "ownerUser": {},
        "ownerGroup": {},
        "bankCode": 0,
        "bankIspb": 0,
        "account": "texto",
        "accountDigit": "texto",
        "agency": "texto",
        "agencyDigit": "texto",
        "type": {},
        "jointAccount": true,
        "operationTypeValue": {},
        "pixKeyTypeValue": {},
        "keyPix": "texto"
      }
    ]
  },
  "insurance": true,
  "dataprevOfferCTPSRequestId": 1,
  "isByxCreation": true
}'
```

---

### POST /v{version}/CreditNote/Batch

**Cria múltiplas operações de crédito, relacionadas entre si** — Cria um novo registro de Credit Note.

Cria múltiplas operações de crédito, relacionadas entre si. Operações relacionadas terão um fluxo de assinaturas unificado.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `version` | path | `string` | obrigatório | — | `1` |
| `updateStartDate` | query | `boolean` | opcional | — | `true` |
| `doStepBatchSignature` | query | `boolean` | opcional | — | `true` |
| `mergeDocumentsForSignature` | query | `boolean` | opcional | — | `true` |
| `returnValue` | query | `string` | opcional | — | `valor` |

**Corpo da requisição** (`application/json`, lista/array)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `productId` | `string (uuid)` | obrigatório | produto contratado | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `warranty` | `array de objeto` | opcional | Garantia de Bens | — | `[ … ]` |
| `emissionDate` | `string (date-time)` | opcional | Data de emissão do contrato | — | `"2025-08-11T13:45:00Z"` |
| `amortization` | `objeto` | obrigatório | Parâmetros da operação | varia conforme o tipo — ver exemplo | `{ … }` |
| `personId` | `string (uuid)` | obrigatório | Pessoa tomadora | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `liquidationType` | `string` | opcional | — | `Invoice`, `EletronicTransfer` | `"Invoice"` |
| `invoiceBarCode` | `string` | opcional | Linha digitável, para quando o tipo de liquidação é por boleto | — | `"texto"` |
| `beneficiaryId` | `string (uuid)` | opcional | Benefiário da operação | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `collateral` | `string` | opcional | Dados da garantia da operação | — | `"texto"` |
| `observations` | `string` | opcional | Observações gerais sobre a operação que poderão ser levadas em consideração pela mesa | — | `"texto"` |
| `status` | `string` | opcional | — | `Draft`, `ComplianceApproval`, `Signatures`, `Liquidation`, `Finished`, `Disapproved`, `Error`, `Revision`, `CreditApproval`, `InstrumentApproval`, `Canceled`, `WaitLiquidation`, `SignaturesValidation`, `PaymentRevision`, `ManualLiquidation`, `Warranty`, `ManualWarranty`, `MarginReserveApproval`, `WarrantyRevision`, `PartnerSignaturesValidation`, `OpenAccountRevision`, `VehicleInspection`, `VehicleInspectionApproval`, `GravameRegistration` | `"Draft"` |
| `bankAccountId` | `string (uuid)` | opcional | Conta bancária | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `isRegistered` | `boolean` | opcional | Indica se há registro em uma Registradora de Recebíveis | — | `true` |
| `bulkAssignment` | `boolean` | opcional | Indica se terá cessão em lote | — | `true` |
| `invoiceValue` | `integer (int64)` | opcional | Valor em centavos da nota fiscal | — | `0` |
| `invoiceNumber` | `string` | opcional | Número da nota fiscal (44 dígitos) | — | `"texto"` |
| `changeBankAccountId` | `string (uuid)` | opcional | Conta bancária de troco | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `issueNumber` | `integer` | opcional | Numero de série da nota comercial | — | `0` |
| `emissionNumber` | `integer` | opcional | Numero de emissão da nota comercial | — | `0` |
| `quantity` | `integer` | opcional | Quantidade de notas comerciais | — | `0` |
| `unitPrice` | `integer (int64)` | opcional | Valor unitario da nota comercial | — | `0` |
| `assignmentCalculation` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `assets` | `array de objeto` | opcional | Lista de IDs das garantias vinculadas à operação. São bens/diretos da(s) PFs ou PJs vinculadas à operação | objeto — ver detalhe abaixo | `[ … ]` |
| `relatedPersonCreditNote` | `array de objeto` | opcional | Lista das pessoas relacionadas a operação. | objeto — ver detalhe abaixo | `[ … ]` |
| `uploads` | `array de objeto` | opcional | Lista de arquivos relacionadas a operação. | objeto — ver detalhe abaixo | `[ … ]` |
| `paymentScheduleItems` | `array de objeto` | opcional | Lista de parcelas relacionadas a operação. | objeto — ver detalhe abaixo | `[ … ]` |
| `unicoSignScore` | `number (double)` | opcional | Score na Unico | — | `1000` |
| `facialSimilarityScore` | `number (double)` | opcional | Score na Unico | — | `1000` |
| `transitoryBankAccountId` | `string (uuid)` | opcional | Conta transitório do Roteiro de Liquidação | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `transitoryBankAccountOpenAccount` | `boolean` | opcional | — | — | `true` |
| `liquidationMode` | `string` | opcional | — | `Simple`, `LiquidationSchedule` | `"Simple"` |
| `liquidationSchedule` | `array de objeto` | opcional | Roteiro de liquidação | objeto — ver detalhe abaixo | `[ … ]` |
| `signatureDetails` | `array de objeto` | opcional | Dados da assinatura eletrônica de envolvidos | objeto — ver detalhe abaixo | `[ … ]` |
| `newPersonAndAccount` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `insurance` | `boolean` | opcional | Indica se a operação possui seguro | — | `true` |
| `dataprevOfferCTPSRequestId` | `integer (int64)` | opcional | RequestId da oferta CTPS de origem (espelho de DataprevEmployeeOfferCTPS.RequestId). Informado apenas quando a operação é criada a partir do leilão. Default null. | — | `1` |
| `isByxCreation` | `boolean` | opcional | Flag para indicar se a operação foi enviada pela BYX | — | `true` |

Detalhe de `ownerUser`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `ownerGroup`:

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

Detalhe de `assignmentCalculation`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `amount` | `number (double)` | opcional | — | — | `1000` |
| `type` | `string` | opcional | — | `Absolute`, `Percentage` | `"Absolute"` |
| `mode` | `string` | opcional | — | `InitialValue`, `PresentValuePayment`, `PresentValueCreditNote`, `Default` | `"InitialValue"` |

Detalhe de `assets`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |

Detalhe de `relatedPersonCreditNote`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `personId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `typeOfRelationship` | `string` | obrigatório | — | `Issuer`, `PartnerGuarantor`, `Guarantor`, `Proxy`, `ProxyGuarantor`, `Partner`, `Spouse`, `Consenter`, `Witness`, `Assignor`, `Assignee`, `Endorser`, `Employer`, `Creditor`, `Debtor`, `PartnerDebtor`, `BillingAgent`, `BillingAgentApproverUser`, `Beneficiary`, `NotaryAgent`, `SettlementAgent`, `CreditorEndorser`, `FaithfulCustodian`, `JointGuarantor`, `ThirdPartyGuarantor`, `LegalRepresentative`, `InsuranceCompany`, `Presidente`, `Administrador`, `Diretor` | `"Issuer"` |
| `relatedToId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `signatureType` | `string` | opcional | — | `email`, `sms`, `whatsapp` | `"email"` |
| `signatureValidation` | `string` | opcional | — | `EletronicSignatureAndDocument`, `SelfieSignature`, `SelfieDocumentSignature`, `FacialBiometrics`, `DigitalCertificate`, `EletronicSignature` | `"EletronicSignatureAndDocument"` |
| `percentage` | `number (double)` | opcional | — | — | `1.99` |

Detalhe de `uploads`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `fileType` | `string` | obrigatório | — | `Document`, `Authorization`, `DriversLicense`, `WorkCard`, `ResidenceProofCompany`, `ResidenceProofPartners`, `Draft`, `SocialContract`, `RegistrationNumber`, `IdentificationDocumentWithPhoto`, `BankStatement`, `ManagerialBilling`, `RegistrationForm`, `Others`, `Selfie`, `SelfieWithIdentityCard`, `LastDeclaration`, `SignedContract`, `SigningStampContract`, `CreditReport`, `Assignment`, `Addition`, `FiduciaryAssignment`, `P7S`, `ZipedFiles`, `CNAB`, `Invoice`, `MinutesOfElection`, `Procuration`, `TermOfOwnership`, `Bylaws`, `IdentityCard`, `Collateral`, `Regulation`, `Balance`, `BalanceSheet`, `PLDFT`, `IncomeTax`, `DRE`, `Receipt`, `CompanyCard`, `AssignmetReport`, `NationalRegistryOfForeigners`, `NationalIdentityCard`, `RegionalRegistrationCard`, `Passaport`, `Paycheck`, `Indorsement`, `WarrantyRegistrationOfficeProof`, `OperationHistory`, `VehicleInspection`, `InsuranceCancellationTemplate`, `SignatureTemplateDraft`, `InssDefermentReport`, `InssMedicalReview` | `"Document"` |
| `fileName` | `string` | obrigatório | Nome do arquivo (retornado pelo GET v1/Upload) | — | `"Fulano de Tal"` |
| `displayName` | `string` | opcional | Nome de exibição do arquivo | — | `"Fulano de Tal"` |
| `documentDate` | `string (date-time)` | opcional | Data do próprio documento (emissão/referência), não a data do upload. Aceita em qualquer tipo de documento e sempre opcional.   Só tem efeito de negócio no laudo de deferimento INSS e na última perícia INSS, cujos valores são comparados aos cortes da regra de elegibilidade dos benefícios 32/92 (faixa 45–54); nos demais tipos é apenas informativa. | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `paymentScheduleItems`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `dueDate` | `string (date-time)` | opcional | Data de vencimento da parcela | — | `"2025-08-11T13:45:00Z"` |
| `principalAmountInCents` | `integer (int64)` | opcional | Saldo devedor da parcela após a apuração de amortização e juros | — | `0` |
| `amortization` | `integer (int64)` | opcional | Valor amortizado (principal) na parcela | — | `0` |
| `interest` | `integer (int64)` | opcional | Juros apurados no período | — | `0` |
| `financeTax` | `integer (int64)` | opcional | Valor de IOF que incide sob a parcela (IOF diário + parcela do IOF base) | — | `0` |
| `addedFixedCosts` | `integer (int64)` | opcional | Valor de tarifas adicionais que devem ser incluídas em cada parcela (valor não é financiado) | — | `0` |
| `payment` | `integer (int64)` | opcional | Valor da parcela que será pago pelo devedor no vencimento | — | `0` |

Detalhe de `liquidationSchedule`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `amountInCents` | `integer (int64)` | obrigatório | — | — | `0` |
| `pixQrCode` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankSlip` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `pixKey` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `transfer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `informedDueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `signatureDetails`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `userAgent` | `string` | opcional | — | — | `"texto"` |
| `ip` | `string` | opcional | — | — | `"texto"` |
| `geoLocation` | `string` | opcional | — | — | `"texto"` |
| `operationalSystem` | `string` | opcional | — | — | `"texto"` |
| `deviceModel` | `string` | opcional | — | — | `"texto"` |
| `deviceName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `deviceType` | `string` | opcional | — | — | `"texto"` |
| `smsValidation` | `boolean` | opcional | — | — | `true` |
| `emailValidation` | `boolean` | opcional | — | — | `true` |

Detalhe de `newPersonAndAccount`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `personType` | `string` | opcional | — | `Natural`, `Legal` | `"Natural"` |
| `listBankAccounts` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `pixQrCode`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `qrCode` | `string` | obrigatório | — | — | `"texto"` |

Detalhe de `bankSlip`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `barcodeOrDigitableLine` | `string` | obrigatório | — | — | `"texto"` |

Detalhe de `pixKey`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `key` | `string` | obrigatório | — | — | `"texto"` |
| `pixKeyType` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `transfer`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `to` | `objeto` | obrigatório | — | objeto — ver detalhe abaixo | `{ … }` |
| `type` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |

Detalhe de `listBankAccounts`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `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 | — | `NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount` | `"NaturalCheckingAccount"` |
| `jointAccount` | `boolean` | opcional | — | — | `true` |
| `operationTypeValue` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |
| `pixKeyTypeValue` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `keyPix` | `string` | opcional | chave pix | — | `"texto"` |

Exemplo:

```json
[
  {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "warranty": [
      {
        "warrantyType": "Warranty"
      }
    ],
    "emissionDate": "2025-08-11T13:45:00Z",
    "amortization": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "amortizationType": "texto",
      "startDate": "2025-08-11T13:45:00Z",
      "apr": 1.99,
      "includePaymentFixedCosts": true,
      "validationErrors": [
        {
          "memberNames": [],
          "errorMessage": "texto"
        }
      ],
      "agentCommissions": [
        {
          "name": "Fulano de Tal",
          "amount": 1000,
          "type": {},
          "baseValue": {},
          "chargeCommissionFrom": {},
          "financeCost": true
        }
      ],
      "agentCommission": {
        "name": "Fulano de Tal",
        "amount": 1000,
        "type": "Absolute",
        "baseValue": "InitialValue",
        "chargeCommissionFrom": "All",
        "financeCost": true,
        "totalValue": 0
      }
    },
    "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "liquidationType": "Invoice",
    "invoiceBarCode": "texto",
    "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "collateral": "texto",
    "observations": "texto",
    "status": "Draft",
    "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "isRegistered": true,
    "bulkAssignment": true,
    "invoiceValue": 0,
    "invoiceNumber": "texto",
    "changeBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "issueNumber": 0,
    "emissionNumber": 0,
    "quantity": 0,
    "unitPrice": 0,
    "assignmentCalculation": {
      "amount": 1000,
      "type": "Absolute",
      "mode": "InitialValue"
    },
    "assets": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    ],
    "relatedPersonCreditNote": [
      {
        "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "typeOfRelationship": "Issuer",
        "relatedToId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "signatureType": "email",
        "signatureValidation": "EletronicSignatureAndDocument",
        "percentage": 1.99
      }
    ],
    "uploads": [
      {
        "ownerUser": {
          "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "tenantName": "Fulano de Tal"
        },
        "ownerGroup": {
          "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "tenantName": "Fulano de Tal"
        },
        "fileType": "Document",
        "fileName": "Fulano de Tal",
        "displayName": "Fulano de Tal",
        "documentDate": "2025-08-11T13:45:00Z"
      }
    ],
    "paymentScheduleItems": [
      {
        "ownerUser": {
          "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "tenantName": "Fulano de Tal"
        },
        "ownerGroup": {
          "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "tenantName": "Fulano de Tal"
        },
        "dueDate": "2025-08-11T13:45:00Z",
        "principalAmountInCents": 0,
        "amortization": 0,
        "interest": 0,
        "financeTax": 0,
        "addedFixedCosts": 0,
        "payment": 0
      }
    ],
    "unicoSignScore": 1000,
    "facialSimilarityScore": 1000,
    "transitoryBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "transitoryBankAccountOpenAccount": true,
    "liquidationMode": "Simple",
    "liquidationSchedule": [
      {
        "amountInCents": 0,
        "pixQrCode": {
          "qrCode": "texto"
        },
        "bankSlip": {
          "barcodeOrDigitableLine": "texto"
        },
        "pixKey": {
          "key": "texto",
          "pixKeyType": {},
          "typeDisplay": "texto"
        },
        "transfer": {
          "to": {},
          "type": {}
        },
        "description": "texto",
        "informedDueDate": "2025-08-11T13:45:00Z"
      }
    ],
    "signatureDetails": [
      {
        "registrationNumber": "12345678909",
        "userAgent": "texto",
        "ip": "texto",
        "geoLocation": "texto",
        "operationalSystem": "texto",
        "deviceModel": "texto",
        "deviceName": "Fulano de Tal",
        "deviceType": "texto",
        "smsValidation": true,
        "emailValidation": true
      }
    ],
    "newPersonAndAccount": {
      "personType": "Natural",
      "listBankAccounts": [
        {
          "ownerUser": {},
          "ownerGroup": {},
          "bankCode": 0,
          "bankIspb": 0,
          "account": "texto",
          "accountDigit": "texto",
          "agency": "texto",
          "agencyDigit": "texto",
          "type": {},
          "jointAccount": true,
          "operationTypeValue": {},
          "pixKeyTypeValue": {},
          "keyPix": "texto"
        }
      ]
    },
    "insurance": true,
    "dataprevOfferCTPSRequestId": 1,
    "isByxCreation": true
  }
]
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/Batch" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "warranty": [
      {
        "warrantyType": "Warranty"
      }
    ],
    "emissionDate": "2025-08-11T13:45:00Z",
    "amortization": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "amortizationType": "texto",
      "startDate": "2025-08-11T13:45:00Z",
      "apr": 1.99,
      "includePaymentFixedCosts": true,
      "validationErrors": [
        {
          "memberNames": [],
          "errorMessage": "texto"
        }
      ],
      "agentCommissions": [
        {
          "name": "Fulano de Tal",
          "amount": 1000,
          "type": {},
          "baseValue": {},
          "chargeCommissionFrom": {},
          "financeCost": true
        }
      ],
      "agentCommission": {
        "name": "Fulano de Tal",
        "amount": 1000,
        "type": "Absolute",
        "baseValue": "InitialValue",
        "chargeCommissionFrom": "All",
        "financeCost": true,
        "totalValue": 0
      }
    },
    "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "liquidationType": "Invoice",
    "invoiceBarCode": "texto",
    "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "collateral": "texto",
    "observations": "texto",
    "status": "Draft",
    "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "isRegistered": true,
    "bulkAssignment": true,
    "invoiceValue": 0,
    "invoiceNumber": "texto",
    "changeBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "issueNumber": 0,
    "emissionNumber": 0,
    "quantity": 0,
    "unitPrice": 0,
    "assignmentCalculation": {
      "amount": 1000,
      "type": "Absolute",
      "mode": "InitialValue"
    },
    "assets": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    ],
    "relatedPersonCreditNote": [
      {
        "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "typeOfRelationship": "Issuer",
        "relatedToId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "signatureType": "email",
        "signatureValidation": "EletronicSignatureAndDocument",
        "percentage": 1.99
      }
    ],
    "uploads": [
      {
        "ownerUser": {
          "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "tenantName": "Fulano de Tal"
        },
        "ownerGroup": {
          "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "tenantName": "Fulano de Tal"
        },
        "fileType": "Document",
        "fileName": "Fulano de Tal",
        "displayName": "Fulano de Tal",
        "documentDate": "2025-08-11T13:45:00Z"
      }
    ],
    "paymentScheduleItems": [
      {
        "ownerUser": {
          "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "tenantName": "Fulano de Tal"
        },
        "ownerGroup": {
          "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "tenantName": "Fulano de Tal"
        },
        "dueDate": "2025-08-11T13:45:00Z",
        "principalAmountInCents": 0,
        "amortization": 0,
        "interest": 0,
        "financeTax": 0,
        "addedFixedCosts": 0,
        "payment": 0
      }
    ],
    "unicoSignScore": 1000,
    "facialSimilarityScore": 1000,
    "transitoryBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "transitoryBankAccountOpenAccount": true,
    "liquidationMode": "Simple",
    "liquidationSchedule": [
      {
        "amountInCents": 0,
        "pixQrCode": {
          "qrCode": "texto"
        },
        "bankSlip": {
          "barcodeOrDigitableLine": "texto"
        },
        "pixKey": {
          "key": "texto",
          "pixKeyType": {},
          "typeDisplay": "texto"
        },
        "transfer": {
          "to": {},
          "type": {}
        },
        "description": "texto",
        "informedDueDate": "2025-08-11T13:45:00Z"
      }
    ],
    "signatureDetails": [
      {
        "registrationNumber": "12345678909",
        "userAgent": "texto",
        "ip": "texto",
        "geoLocation": "texto",
        "operationalSystem": "texto",
        "deviceModel": "texto",
        "deviceName": "Fulano de Tal",
        "deviceType": "texto",
        "smsValidation": true,
        "emailValidation": true
      }
    ],
    "newPersonAndAccount": {
      "personType": "Natural",
      "listBankAccounts": [
        {
          "ownerUser": {},
          "ownerGroup": {},
          "bankCode": 0,
          "bankIspb": 0,
          "account": "texto",
          "accountDigit": "texto",
          "agency": "texto",
          "agencyDigit": "texto",
          "type": {},
          "jointAccount": true,
          "operationTypeValue": {},
          "pixKeyTypeValue": {},
          "keyPix": "texto"
        }
      ]
    },
    "insurance": true,
    "dataprevOfferCTPSRequestId": 1,
    "isByxCreation": true
  }
]'
```

---

### POST /v{version}/CreditNote/{id}/DuePaymentSchedule

**Calcular calendário de quitação** — Cria um novo registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `creditNoteId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `referenceDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `numberOfDays` | `integer` | opcional | — | — | `0` |

Exemplo:

```json
{
  "creditNoteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "referenceDate": "2025-08-11T13:45:00Z",
  "numberOfDays": 0
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/DuePaymentSchedule" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "creditNoteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "referenceDate": "2025-08-11T13:45:00Z",
  "numberOfDays": 0
}'
```

---

### PUT /v{version}/CreditNote/{id}/upload

**Atualiza a lista de documentos atrelados à operação** — Atualiza por completo um registro de Credit Note existente.

Atualiza a lista de documentos atrelados à operação. Permitido apenas quando o status da operação é Rascunho, Revisão, Aprovação de Instrumento ou Coleta de Assinaturas.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `uploads` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `uploads`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `id` | `string (uuid)` | opcional | Id do arquivo | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `fileName` | `string` | obrigatório | Nome do arquivo (retornado pelo GET v1/Upload) | — | `"Fulano de Tal"` |
| `fileType` | `string` | opcional | — | `Document`, `Authorization`, `DriversLicense`, `WorkCard`, `ResidenceProofCompany`, `ResidenceProofPartners`, `Draft`, `SocialContract`, `RegistrationNumber`, `IdentificationDocumentWithPhoto`, `BankStatement`, `ManagerialBilling`, `RegistrationForm`, `Others`, `Selfie`, `SelfieWithIdentityCard`, `LastDeclaration`, `SignedContract`, `SigningStampContract`, `CreditReport`, `Assignment`, `Addition`, `FiduciaryAssignment`, `P7S`, `ZipedFiles`, `CNAB`, `Invoice`, `MinutesOfElection`, `Procuration`, `TermOfOwnership`, `Bylaws`, `IdentityCard`, `Collateral`, `Regulation`, `Balance`, `BalanceSheet`, `PLDFT`, `IncomeTax`, `DRE`, `Receipt`, `CompanyCard`, `AssignmetReport`, `NationalRegistryOfForeigners`, `NationalIdentityCard`, `RegionalRegistrationCard`, `Passaport`, `Paycheck`, `Indorsement`, `WarrantyRegistrationOfficeProof`, `OperationHistory`, `VehicleInspection`, `InsuranceCancellationTemplate`, `SignatureTemplateDraft`, `InssDefermentReport`, `InssMedicalReview` | `"Document"` |
| `displayName` | `string` | opcional | Nome de exibição do arquivo | — | `"Fulano de Tal"` |
| `documentDate` | `string (date-time)` | opcional | Data do próprio documento (emissão/referência), não a data do upload. Aceita em qualquer tipo de documento e sempre opcional. Só tem efeito de negócio no laudo de deferimento INSS e na última perícia INSS (regra de elegibilidade dos benefícios 32/92). | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `ownerUser`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `ownerGroup`:

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

Exemplo:

```json
{
  "uploads": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fileName": "Fulano de Tal",
      "fileType": "Document",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z"
    }
  ]
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/upload" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "uploads": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fileName": "Fulano de Tal",
      "fileType": "Document",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z"
    }
  ]
}'
```

---

### PUT /v{version}/CreditNote/{id}/warranty

**Atualiza a lista de garantias atrelados à operação** — Atualiza por completo um registro de Credit Note existente.

Atualiza a lista de garantias atrelados à operação.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `productId` | `string (uuid)` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `warranty` | `array de objeto` | opcional | — | — | `[ … ]` |

Exemplo:

```json
{
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "warranty": [
    {
      "warrantyType": "Warranty"
    }
  ]
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/warranty" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "warranty": [
    {
      "warrantyType": "Warranty"
    }
  ]
}'
```

---

### GET /v{version}/CreditNote/{id}

**Obtém todas as informações de uma operação** — Consulta Credit Note pelo identificador informado na rota.

Obtém todas as informações de uma operação.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Resposta 200**

Exemplo:

```json
{
  "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"
  },
  "creditNoteNo": 0,
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "productIdDisplay": "texto",
  "productCategoryDisplay": "texto",
  "productInstrumentType": "texto",
  "acceptanceDate": "2025-08-11T13:45:00Z",
  "amortization": {
    "amortizationType": "texto",
    "calculateByValueType": "texto",
    "requestedAmount": 0,
    "principalAmountInCents": 0,
    "startDate": "2025-08-11T13:45:00Z",
    "termInMonths": 0,
    "numberOfPayments": 0,
    "paymentPeriodicity": {
      "every": 0,
      "periodicity": "texto"
    },
    "absAmortizationInMonths": 0,
    "absInterestInMonths": 0,
    "apr": 1.99,
    "periodicity": "texto",
    "daysInYear": 0,
    "agentCommission": {
      "name": "Fulano de Tal",
      "amount": 1000,
      "amountDisplay": "texto",
      "type": "texto",
      "baseValue": "texto",
      "chargeCommissionFrom": "texto",
      "financeCost": true
    },
    "calculationType": "texto",
    "firstPaymentDate": "2025-08-11T13:45:00Z",
    "bankCommission": {
      "name": "Fulano de Tal",
      "amount": 1000,
      "amountDisplay": "texto",
      "type": "texto",
      "baseValue": "texto",
      "chargeCommissionFrom": "texto",
      "financeCost": true
    },
    "financeOperationsTax": 1.99,
    "dailyFinanceOperationsTax": 1.99,
    "indexer": "texto",
    "indexerValue": 1000,
    "paymentDay": 0,
    "skippedMonths": [
      "texto"
    ],
    "monthlyInterest": 1000,
    "yearlyInterest": 1000,
    "effectiveMonthlyCost": 1000,
    "effectiveYearlyCost": 1000,
    "liquidValue": 1,
    "comm": 0,
    "commTc": 0,
    "commNonTc": 0,
    "finTax": 0,
    "dueDate": "2025-08-11T13:45:00Z",
    "initialValue": 0,
    "fixedPaymentDuringGraduation": 0,
    "termsUntilGraduation": 0,
    "absAfterGraduation": 0,
    "pmt2Value": 1000,
    "fiduciaryGuarantee": 1000,
    "financeTaxExempted": true,
    "issueNumber": 0,
    "emissionNumber": 0,
    "quantity": 0,
    "unitPrice": 0,
    "minEmissionCost": 0,
    "maxEmissionCost": 0,
    "numberOfInterestPayments": 0,
    "valueMarginReserve": 0,
    "insuranceCoverAmount": 0,
    "paymentFixedCosts": 0,
    "includePaymentFixedCosts": true,
    "dueDateOnBusinessDays": true,
    "discountMode": true
  },
  "warranty": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "warrantyType": "texto",
      "renavam": "texto",
      "typeOfVehicle": "texto",
      "chassis": "texto",
      "board": "texto",
      "plateState": "texto",
      "operationState": "texto",
      "supplier": "texto",
      "taxNumberOfSupplier": "texto",
      "brand": "texto",
      "color": "texto",
      "model": "texto",
      "yearOfManufacture": 0,
      "yearOfModel": 0,
      "typeOfFuel": "texto",
      "registryOffice": "texto",
      "registrationNumber": "12345678909",
      "width": 1000,
      "length": 1000,
      "addressName": "Fulano de Tal",
      "zipCodeAddress": "01310930",
      "city": "texto",
      "uf": "texto",
      "district": "texto",
      "addressNumber": "texto",
      "complementAddress": "texto",
      "propertyFeatures": "texto",
      "propertyValue": 0,
      "number": "texto",
      "court": "texto",
      "valueOfCause": 0,
      "claimant": "texto",
      "claimed": "texto",
      "typeOfProcess": "texto",
      "downPayment": 0,
      "sellerCompanyName": "Fulano de Tal",
      "sellerRegistrationNumber": "texto",
      "valueInCash": 0,
      "subtotalAmount": 0,
      "totalAmountFinancedTaxFree": 0,
      "register": "texto",
      "type": "texto",
      "splitMethodType": "texto",
      "paymentNetworks": [
        "texto"
      ],
      "constituted": true,
      "totalValue": 1000,
      "employeeCode": "texto",
      "agreementCode": "texto",
      "governmentDepartmentCode": "texto",
      "employeerInstCode": "texto",
      "governmentDepartmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "governmentDepartmentName": "Fulano de Tal",
      "warrantyCode": "texto",
      "paymentTransferDay": 0,
      "paymentAmountInCents": 0,
      "employmentStatusCode": "texto",
      "employmentStatusDescription": "texto",
      "previousAdeNumber": "texto",
      "warrantyDeadline": "2025-08-11T13:45:00Z",
      "warrantyOption": "texto",
      "warrantyOptionDisplay": "texto",
      "governmentDepartmentWarrantyStatus": "texto",
      "governmentDepartmentWarrantyStatusDisplay": "texto",
      "simulationRegistrationNumber": "texto",
      "payerName": "Fulano de Tal",
      "payerRegistrationNumber": "texto",
      "contractNumber": "texto",
      "invoiceNumber": "texto",
      "invoiceValue": 0,
      "discountValue": 0,
      "presentValue": 0,
      "dueDate": "2025-08-11T13:45:00Z",
      "paymentItemIndex": 0,
      "paymentItemTotal": 0,
      "yourNumber": "texto",
      "storeCode": 0,
      "productCode": 0,
      "creditType": "Duplicata_Mercantil",
      "identification": "texto",
      "emissionDate": "2025-08-11T13:45:00Z",
      "index": 0,
      "payerDescription": "NaturalPerson",
      "payerAdress": "texto",
      "payerZipCodeAdress": 0,
      "contractFee": 1000,
      "administratorName": "Fulano de Tal",
      "administratorRegistrationNumber": "texto",
      "quota": "texto",
      "group": "texto",
      "dataprev_EmployeeCode": "texto",
      "dataprev_EmployerRegistrationCode": 0,
      "dataprev_EmployerRegistrationNumber": "texto",
      "dataprev_EmployerName": "Fulano de Tal",
      "dataprev_DiscountStartPeriod": "texto",
      "dataprev_EmployeeAdmissionDate": "2025-08-11T13:45:00Z",
      "payingSourceRegistrationNumber": "texto",
      "payingSourceName": "Fulano de Tal",
      "dataprev_Status": "texto",
      "dataprev_StatusDisplay": "texto",
      "dataprev_OriginalMargin": 1000,
      "dataprev_AvailableMargin": 0,
      "dataprev_EmployeePositionCBOCode": 0,
      "dataprev_HasWarranty": true,
      "dataprev_WarrantyFgtsBalanceInCents": 0,
      "dataprev_WarrantyFgtsRescissionPenaltyInCents": 0,
      "dataprev_WarrantyRescissionBenefitPercentage": 1.99,
      "dataprev_CtpsDigitalAuthorizationNumber": "texto",
      "dataprev_ProposalNumber": "texto",
      "inss_RegistrationNumber": "texto",
      "inss_BenefitNumber": "texto",
      "inss_Name": "Fulano de Tal",
      "inss_BenefitType": "texto",
      "inss_BenefitTypeDescription": "texto",
      "inss_PaymentAccountType": "texto",
      "inss_PaymentAccountTypeDescription": "texto",
      "inss_PaymentBankCode": "texto",
      "inss_PaymentBankAgency": "texto",
      "inss_PaymentBankAccountNumber": "texto",
      "inss_AvailableMargin": 1000,
      "inss_OriginalMargin": 1000,
      "inss_MarginValue": 1000,
      "inss_MaximumInstallments": 0,
      "benefitCardMarginAmountInCents": 0,
      "benefitCardEmployeeCode": "texto",
      "benefitCardStartDate": "2025-08-11T13:45:00Z",
      "benefitCardWarrantyCode": "texto",
      "benefitCardCcbNumber": "texto",
      "benefitCardInstallmentValueInCents": 0,
      "ncm": "texto",
      "blNumber": "texto",
      "idInvoice": "texto",
      "valueBRL": 0,
      "policyNumber": "texto",
      "insuranceCompanyName": "Fulano de Tal",
      "insuranceCompanyCNPJ": "12345678000199",
      "inspectionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "inspectionStatus": "texto",
      "inspectionStatusDisplay": "texto",
      "inspectionUpdatedAt": "2025-08-11T13:45:00Z"
    }
  ],
  "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "personRegistrationNumber": "texto",
  "customPaymentPlan": true,
  "personEmail": "cliente@exemplo.com.br",
  "personDisplay": "texto",
  "personDiscriminator": "texto",
  "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "beneficiaryRegistrationNumber": "texto",
  "beneficiaryEmail": "cliente@exemplo.com.br",
  "beneficiaryDisplay": "texto",
  "beneficiaryDiscriminator": "texto",
  "liquidationType": "texto",
  "liquidationTypeDisplay": "texto",
  "invoiceBarCode": "texto",
  "observations": "texto",
  "collateral": "texto",
  "invoiceValue": 0,
  "invoiceNumber": "texto",
  "changeBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "changeBankAccount": {
    "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"
    },
    "bankCode": "texto",
    "bankCodeCompe": 0,
    "bankCodeDisplay": "texto",
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "texto",
    "typeDisplay": "texto",
    "jointAccount": true,
    "operationTypeValue": "texto",
    "pixKeyTypeValue": "texto",
    "keyPix": "texto"
  },
  "status": "texto",
  "statusDisplay": "texto",
  "statusValue": 0,
  "bankAccount": {
    "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"
    },
    "bankCode": "texto",
    "bankCodeCompe": 0,
    "bankCodeDisplay": "texto",
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "texto",
    "typeDisplay": "texto",
    "jointAccount": true,
    "operationTypeValue": "texto",
    "pixKeyTypeValue": "texto",
    "keyPix": "texto"
  },
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isRegistered": true,
  "bulkAssignment": true,
  "blockedUntil": "2025-08-11T13:45:00Z",
  "assignmentCalculation": {
    "amount": 1000,
    "type": "Absolute",
    "mode": "InitialValue"
  },
  "assignmentValue": 0,
  "assignmentDate": "2025-08-11T13:45:00Z",
  "assignmentCalculationResult": 0,
  "accruedInterest": 0,
  "issueNumber": 0,
  "emissionNumber": 0,
  "quantity": 0,
  "unitPrice": 0,
  "timeline": [
    {
      "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"
      },
      "index": 0,
      "name": "Fulano de Tal",
      "startedAt": "2025-08-11T13:45:00Z",
      "finishedAt": "2025-08-11T13:45:00Z",
      "description": "texto"
    }
  ],
  "assets": [
    {
      "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"
      },
      "assetType": "texto",
      "assetTypeDisplay": "texto",
      "description": "texto",
      "registerNumber": "texto",
      "estimatedValue": 1000,
      "settled": true
    }
  ],
  "relatedPersonCreditNote": [
    {
      "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "discriminator": "texto",
      "personIdDisplay": "texto",
      "typeOfRelationship": "texto",
      "typeOfRelationshipDisplay": "texto",
      "relatedToId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "relatedToDiscriminator": "texto",
      "relatedToIdDisplay": "texto",
      "signatureType": "texto",
      "signatureTypeDisplay": "texto",
      "signatureValidation": "texto",
      "signatureValidationDisplay": "texto",
      "percentage": 1.99,
      "isCreditBureauCheckSkipped": true
    }
  ],
  "uploads": [
    {
      "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"
      },
      "fileName": "Fulano de Tal",
      "fileType": "texto",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z",
      "tempUrl": "https://exemplo.com.br/callback",
      "tempGetUrl": "https://exemplo.com.br/callback",
      "tempPutUrl": "https://exemplo.com.br/callback"
    }
  ],
  "paymentScheduleItems": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "dueDate": "2025-08-11T13:45:00Z",
      "principalAmountInCents": 0,
      "amortization": 0,
      "interest": 0,
      "financeTax": 0,
      "payment": 0,
      "accruedInterest": 0,
      "addedFixedCosts": 0,
      "paymentNo": 0
    }
  ],
  "unicoSignScore": 1000,
  "facialSimilarityScore": 1000,
  "signatureDetails": [
    {
      "registrationNumber": "12345678909",
      "userAgent": "texto",
      "ip": "texto",
      "geoLocation": "texto",
      "operationalSystem": "texto",
      "deviceModel": "texto",
      "deviceName": "Fulano de Tal",
      "deviceType": "texto",
      "smsValidation": true,
      "emailValidation": true
    }
  ],
  "codeIPOC": "texto",
  "transitoryBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "transitoryBankAccount": {
    "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"
    },
    "bankCode": "texto",
    "bankCodeCompe": 0,
    "bankCodeDisplay": "texto",
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "texto",
    "typeDisplay": "texto",
    "jointAccount": true,
    "operationTypeValue": "texto",
    "pixKeyTypeValue": "texto",
    "keyPix": "texto"
  },
  "transitoryBankAccountOpenAccount": true,
  "liquidationSchedule": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "amountInCents": 0,
      "pixQrCode": {
        "qrCode": "texto"
      },
      "bankSlip": {
        "barcodeOrDigitableLine": "texto"
      },
      "pixKey": {
        "key": "texto",
        "pixKeyType": {},
        "typeDisplay": "texto"
      },
      "transfer": {
        "to": {},
        "type": {},
        "typeDisplay": "texto"
      },
      "description": "texto",
      "informedDueDate": "2025-08-11T13:45:00Z",
      "retrievedData": {
        "beneficiary": {},
        "bankslipData": {}
      },
      "type": "texto",
      "typeDisplay": "texto",
      "linkStatus": "texto",
      "linkStatusDisplay": "texto",
      "status": "texto",
      "statusDisplay": "texto",
      "paymentType": "texto",
      "paymentTypeDisplay": "texto",
      "failureMessage": "texto",
      "cosifAccountCode": "texto",
      "nsu": "texto"
    }
  ],
  "liquidationMode": "texto",
  "liquidationModeDisplay": "texto",
  "fgtscefProtocolNumber": "texto",
  "fgtscefProtocolDate": "2025-08-11T13:45:00Z",
  "batchSignatureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "liquidationClosureStatus": "texto",
  "liquidationClosureStatusDisplay": "texto",
  "creditNoteNoBase32": "texto",
  "installmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "personDetails": "texto",
  "insurance": true,
  "hasPersonDetailsDivergence": true,
  "scheduleEarliestDueDate": "2025-08-11T13:45:00Z",
  "isByxCreation": true
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

### PUT /v{version}/CreditNote/{id}

**Atualiza os atributos da operação, incluindo envolvidos, uploads, etc** — Atualiza por completo um registro de Credit Note existente.

Atualiza os atributos da operação, incluindo envolvidos, uploads, etc. Permitido apenas quando o status da operação é Rascunho, Rejeitada, Revisão ou Erro.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |
| `returnValue` | query | `string` | opcional | — | `valor` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `productId` | `string (uuid)` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `amortization` | `objeto` | obrigatório | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `warranty` | `array de objeto` | opcional | Garantia de Bens | — | `[ … ]` |
| `emissionDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `personId` | `string (uuid)` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `beneficiaryId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `liquidationType` | `string` | opcional | — | `Invoice`, `EletronicTransfer` | `"Invoice"` |
| `invoiceBarCode` | `string` | opcional | — | — | `"texto"` |
| `collateral` | `string` | opcional | — | — | `"texto"` |
| `observations` | `string` | opcional | — | — | `"texto"` |
| `bankAccountId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `isRegistered` | `boolean` | opcional | — | — | `true` |
| `bulkAssignment` | `boolean` | opcional | — | — | `true` |
| `invoiceValue` | `integer (int64)` | opcional | — | — | `0` |
| `invoiceNumber` | `string` | opcional | — | — | `"texto"` |
| `changeBankAccountId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `issueNumber` | `integer` | opcional | Numero de série da nota comercial | — | `0` |
| `emissionNumber` | `integer` | opcional | Numero de emissão da nota comercial | — | `0` |
| `quantity` | `integer` | opcional | Quantidade de notas comerciais | — | `0` |
| `unitPrice` | `integer (int64)` | opcional | Valor unitario da nota comercial | — | `0` |
| `assignmentCalculation` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `assets` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `relatedPersonCreditNote` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `uploads` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `paymentScheduleItems` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `unicoSignScore` | `number (double)` | opcional | Score na Unico | — | `1000` |
| `facialSimilarityScore` | `number (double)` | opcional | Score na Unico | — | `1000` |
| `signatureDetails` | `array de objeto` | opcional | Detalhes da assinatura eletrônica | objeto — ver detalhe abaixo | `[ … ]` |
| `transitoryBankAccountId` | `string (uuid)` | opcional | Conta transitório do Roteiro de Liquidação | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `transitoryBankAccountOpenAccount` | `boolean` | opcional | — | — | `true` |
| `liquidationMode` | `string` | opcional | — | `Simple`, `LiquidationSchedule` | `"Simple"` |
| `liquidationSchedule` | `array de objeto` | opcional | Roteiro de liquidação | objeto — ver detalhe abaixo | `[ … ]` |
| `insurance` | `boolean` | opcional | Indica se a operação possui seguro | — | `true` |

Detalhe de `ownerUser`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `ownerGroup`:

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

Detalhe de `assignmentCalculation`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `amount` | `number (double)` | opcional | — | — | `1000` |
| `type` | `string` | opcional | — | `Absolute`, `Percentage` | `"Absolute"` |
| `mode` | `string` | opcional | — | `InitialValue`, `PresentValuePayment`, `PresentValueCreditNote`, `Default` | `"InitialValue"` |

Detalhe de `assets`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |

Detalhe de `relatedPersonCreditNote`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `personId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `typeOfRelationship` | `string` | obrigatório | — | `Issuer`, `PartnerGuarantor`, `Guarantor`, `Proxy`, `ProxyGuarantor`, `Partner`, `Spouse`, `Consenter`, `Witness`, `Assignor`, `Assignee`, `Endorser`, `Employer`, `Creditor`, `Debtor`, `PartnerDebtor`, `BillingAgent`, `BillingAgentApproverUser`, `Beneficiary`, `NotaryAgent`, `SettlementAgent`, `CreditorEndorser`, `FaithfulCustodian`, `JointGuarantor`, `ThirdPartyGuarantor`, `LegalRepresentative`, `InsuranceCompany`, `Presidente`, `Administrador`, `Diretor` | `"Issuer"` |
| `relatedToId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `signatureType` | `string` | opcional | — | `email`, `sms`, `whatsapp` | `"email"` |
| `signatureValidation` | `string` | opcional | — | `EletronicSignatureAndDocument`, `SelfieSignature`, `SelfieDocumentSignature`, `FacialBiometrics`, `DigitalCertificate`, `EletronicSignature` | `"EletronicSignatureAndDocument"` |
| `percentage` | `number (double)` | opcional | — | — | `1.99` |

Detalhe de `uploads`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `id` | `string (uuid)` | opcional | Id do arquivo | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `fileName` | `string` | obrigatório | Nome do arquivo (retornado pelo GET v1/Upload) | — | `"Fulano de Tal"` |
| `fileType` | `string` | opcional | — | `Document`, `Authorization`, `DriversLicense`, `WorkCard`, `ResidenceProofCompany`, `ResidenceProofPartners`, `Draft`, `SocialContract`, `RegistrationNumber`, `IdentificationDocumentWithPhoto`, `BankStatement`, `ManagerialBilling`, `RegistrationForm`, `Others`, `Selfie`, `SelfieWithIdentityCard`, `LastDeclaration`, `SignedContract`, `SigningStampContract`, `CreditReport`, `Assignment`, `Addition`, `FiduciaryAssignment`, `P7S`, `ZipedFiles`, `CNAB`, `Invoice`, `MinutesOfElection`, `Procuration`, `TermOfOwnership`, `Bylaws`, `IdentityCard`, `Collateral`, `Regulation`, `Balance`, `BalanceSheet`, `PLDFT`, `IncomeTax`, `DRE`, `Receipt`, `CompanyCard`, `AssignmetReport`, `NationalRegistryOfForeigners`, `NationalIdentityCard`, `RegionalRegistrationCard`, `Passaport`, `Paycheck`, `Indorsement`, `WarrantyRegistrationOfficeProof`, `OperationHistory`, `VehicleInspection`, `InsuranceCancellationTemplate`, `SignatureTemplateDraft`, `InssDefermentReport`, `InssMedicalReview` | `"Document"` |
| `displayName` | `string` | opcional | Nome de exibição do arquivo | — | `"Fulano de Tal"` |
| `documentDate` | `string (date-time)` | opcional | Data do próprio documento (emissão/referência), não a data do upload. Aceita em qualquer tipo de documento e sempre opcional. Só tem efeito de negócio no laudo de deferimento INSS e na última perícia INSS (regra de elegibilidade dos benefícios 32/92). | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `paymentScheduleItems`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `dueDate` | `string (date-time)` | opcional | Data de vencimento da parcela | — | `"2025-08-11T13:45:00Z"` |
| `principalAmountInCents` | `integer (int64)` | opcional | Saldo devedor da parcela após a apuração de amortização e juros | — | `0` |
| `amortization` | `integer (int64)` | opcional | Valor amortizado (principal) na parcela | — | `0` |
| `interest` | `integer (int64)` | opcional | Juros apurados no período | — | `0` |
| `financeTax` | `integer (int64)` | opcional | Valor de IOF que incide sob a parcela (IOF diário + parcela do IOF base) | — | `0` |
| `addedFixedCosts` | `integer (int64)` | opcional | Valor de tarifas adicionais que devem ser incluídas em cada parcela (valor não é financiado) | — | `0` |
| `payment` | `integer (int64)` | opcional | Valor da parcela que será pago pelo devedor no vencimento | — | `0` |

Detalhe de `signatureDetails`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `userAgent` | `string` | opcional | — | — | `"texto"` |
| `ip` | `string` | opcional | — | — | `"texto"` |
| `geoLocation` | `string` | opcional | — | — | `"texto"` |
| `operationalSystem` | `string` | opcional | — | — | `"texto"` |
| `deviceModel` | `string` | opcional | — | — | `"texto"` |
| `deviceName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `deviceType` | `string` | opcional | — | — | `"texto"` |
| `smsValidation` | `boolean` | opcional | — | — | `true` |
| `emailValidation` | `boolean` | opcional | — | — | `true` |

Detalhe de `liquidationSchedule`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `amountInCents` | `integer (int64)` | obrigatório | — | — | `0` |
| `pixQrCode` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankSlip` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `pixKey` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `transfer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `informedDueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `pixQrCode`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `qrCode` | `string` | obrigatório | — | — | `"texto"` |

Detalhe de `bankSlip`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `barcodeOrDigitableLine` | `string` | obrigatório | — | — | `"texto"` |

Detalhe de `pixKey`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `key` | `string` | obrigatório | — | — | `"texto"` |
| `pixKeyType` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `transfer`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `to` | `objeto` | obrigatório | — | objeto — ver detalhe abaixo | `{ … }` |
| `type` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |

Detalhe de `to`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | obrigatório | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | obrigatório | — | — | `"12345678909"` |
| `bankCode` | `integer` | obrigatório | — | — | `0` |
| `bankIspb` | `integer (int64)` | obrigatório | — | — | `0` |
| `agency` | `string` | obrigatório | — | — | `"texto"` |
| `accountNumber` | `string` | obrigatório | — | — | `"texto"` |
| `accountType` | `string` | obrigatório | — | `NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount` | `"NaturalCheckingAccount"` |

Exemplo:

```json
{
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "amortization": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "amortizationType": "texto",
    "startDate": "2025-08-11T13:45:00Z",
    "apr": 1.99,
    "includePaymentFixedCosts": true,
    "validationErrors": [
      {
        "memberNames": [],
        "errorMessage": "texto"
      }
    ],
    "agentCommissions": [
      {
        "name": "Fulano de Tal",
        "amount": 1000,
        "type": {},
        "baseValue": {},
        "chargeCommissionFrom": {},
        "financeCost": true
      }
    ],
    "agentCommission": {
      "name": "Fulano de Tal",
      "amount": 1000,
      "type": "Absolute",
      "baseValue": "InitialValue",
      "chargeCommissionFrom": "All",
      "financeCost": true,
      "totalValue": 0
    }
  },
  "warranty": [
    {
      "warrantyType": "Warranty"
    }
  ],
  "emissionDate": "2025-08-11T13:45:00Z",
  "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "liquidationType": "Invoice",
  "invoiceBarCode": "texto",
  "collateral": "texto",
  "observations": "texto",
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isRegistered": true,
  "bulkAssignment": true,
  "invoiceValue": 0,
  "invoiceNumber": "texto",
  "changeBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "issueNumber": 0,
  "emissionNumber": 0,
  "quantity": 0,
  "unitPrice": 0,
  "assignmentCalculation": {
    "amount": 1000,
    "type": "Absolute",
    "mode": "InitialValue"
  },
  "assets": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "relatedPersonCreditNote": [
    {
      "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "typeOfRelationship": "Issuer",
      "relatedToId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "signatureType": "email",
      "signatureValidation": "EletronicSignatureAndDocument",
      "percentage": 1.99
    }
  ],
  "uploads": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fileName": "Fulano de Tal",
      "fileType": "Document",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z"
    }
  ],
  "paymentScheduleItems": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "dueDate": "2025-08-11T13:45:00Z",
      "principalAmountInCents": 0,
      "amortization": 0,
      "interest": 0,
      "financeTax": 0,
      "addedFixedCosts": 0,
      "payment": 0
    }
  ],
  "unicoSignScore": 1000,
  "facialSimilarityScore": 1000,
  "signatureDetails": [
    {
      "registrationNumber": "12345678909",
      "userAgent": "texto",
      "ip": "texto",
      "geoLocation": "texto",
      "operationalSystem": "texto",
      "deviceModel": "texto",
      "deviceName": "Fulano de Tal",
      "deviceType": "texto",
      "smsValidation": true,
      "emailValidation": true
    }
  ],
  "transitoryBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "transitoryBankAccountOpenAccount": true,
  "liquidationMode": "Simple",
  "liquidationSchedule": [
    {
      "amountInCents": 0,
      "pixQrCode": {
        "qrCode": "texto"
      },
      "bankSlip": {
        "barcodeOrDigitableLine": "texto"
      },
      "pixKey": {
        "key": "texto",
        "pixKeyType": {},
        "typeDisplay": "texto"
      },
      "transfer": {
        "to": {},
        "type": {}
      },
      "description": "texto",
      "informedDueDate": "2025-08-11T13:45:00Z"
    }
  ],
  "insurance": true
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "amortization": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "amortizationType": "texto",
    "startDate": "2025-08-11T13:45:00Z",
    "apr": 1.99,
    "includePaymentFixedCosts": true,
    "validationErrors": [
      {
        "memberNames": [],
        "errorMessage": "texto"
      }
    ],
    "agentCommissions": [
      {
        "name": "Fulano de Tal",
        "amount": 1000,
        "type": {},
        "baseValue": {},
        "chargeCommissionFrom": {},
        "financeCost": true
      }
    ],
    "agentCommission": {
      "name": "Fulano de Tal",
      "amount": 1000,
      "type": "Absolute",
      "baseValue": "InitialValue",
      "chargeCommissionFrom": "All",
      "financeCost": true,
      "totalValue": 0
    }
  },
  "warranty": [
    {
      "warrantyType": "Warranty"
    }
  ],
  "emissionDate": "2025-08-11T13:45:00Z",
  "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "liquidationType": "Invoice",
  "invoiceBarCode": "texto",
  "collateral": "texto",
  "observations": "texto",
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isRegistered": true,
  "bulkAssignment": true,
  "invoiceValue": 0,
  "invoiceNumber": "texto",
  "changeBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "issueNumber": 0,
  "emissionNumber": 0,
  "quantity": 0,
  "unitPrice": 0,
  "assignmentCalculation": {
    "amount": 1000,
    "type": "Absolute",
    "mode": "InitialValue"
  },
  "assets": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "relatedPersonCreditNote": [
    {
      "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "typeOfRelationship": "Issuer",
      "relatedToId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "signatureType": "email",
      "signatureValidation": "EletronicSignatureAndDocument",
      "percentage": 1.99
    }
  ],
  "uploads": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fileName": "Fulano de Tal",
      "fileType": "Document",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z"
    }
  ],
  "paymentScheduleItems": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "dueDate": "2025-08-11T13:45:00Z",
      "principalAmountInCents": 0,
      "amortization": 0,
      "interest": 0,
      "financeTax": 0,
      "addedFixedCosts": 0,
      "payment": 0
    }
  ],
  "unicoSignScore": 1000,
  "facialSimilarityScore": 1000,
  "signatureDetails": [
    {
      "registrationNumber": "12345678909",
      "userAgent": "texto",
      "ip": "texto",
      "geoLocation": "texto",
      "operationalSystem": "texto",
      "deviceModel": "texto",
      "deviceName": "Fulano de Tal",
      "deviceType": "texto",
      "smsValidation": true,
      "emailValidation": true
    }
  ],
  "transitoryBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "transitoryBankAccountOpenAccount": true,
  "liquidationMode": "Simple",
  "liquidationSchedule": [
    {
      "amountInCents": 0,
      "pixQrCode": {
        "qrCode": "texto"
      },
      "bankSlip": {
        "barcodeOrDigitableLine": "texto"
      },
      "pixKey": {
        "key": "texto",
        "pixKeyType": {},
        "typeDisplay": "texto"
      },
      "transfer": {
        "to": {},
        "type": {}
      },
      "description": "texto",
      "informedDueDate": "2025-08-11T13:45:00Z"
    }
  ],
  "insurance": true
}'
```

---

### DELETE /v{version}/CreditNote/{id}

**Exclui uma operação de crédito** — Remove um registro de Credit Note.

Exclui uma operação de crédito. Permitido apenas nos status Rascunho, Revisão, Rejeitado ou Cancelado

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X DELETE "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /v{version}/CreditNote/{id}/LiquidationSchedule

**Criar Credit Note** — Cria um novo registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `amountInCents` | `integer (int64)` | obrigatório | — | — | `0` |
| `pixQrCode` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankSlip` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `pixKey` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `transfer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `informedDueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `pixQrCode`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `qrCode` | `string` | obrigatório | — | — | `"texto"` |

Detalhe de `bankSlip`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `barcodeOrDigitableLine` | `string` | obrigatório | — | — | `"texto"` |

Detalhe de `pixKey`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `key` | `string` | obrigatório | — | — | `"texto"` |
| `pixKeyType` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `transfer`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `to` | `objeto` | obrigatório | — | objeto — ver detalhe abaixo | `{ … }` |
| `type` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |

Detalhe de `to`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | obrigatório | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | obrigatório | — | — | `"12345678909"` |
| `bankCode` | `integer` | obrigatório | — | — | `0` |
| `bankIspb` | `integer (int64)` | obrigatório | — | — | `0` |
| `agency` | `string` | obrigatório | — | — | `"texto"` |
| `accountNumber` | `string` | obrigatório | — | — | `"texto"` |
| `accountType` | `string` | obrigatório | — | `NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount` | `"NaturalCheckingAccount"` |

Exemplo:

```json
{
  "amountInCents": 0,
  "pixQrCode": {
    "qrCode": "texto"
  },
  "bankSlip": {
    "barcodeOrDigitableLine": "texto"
  },
  "pixKey": {
    "key": "texto",
    "pixKeyType": "NaturalRegistrationNumber",
    "typeDisplay": "texto"
  },
  "transfer": {
    "to": {
      "name": "Fulano de Tal",
      "registrationNumber": "12345678909",
      "bankCode": 0,
      "bankIspb": 0,
      "agency": "texto",
      "accountNumber": "texto",
      "accountType": "NaturalCheckingAccount"
    },
    "type": "Transfer"
  },
  "description": "texto",
  "informedDueDate": "2025-08-11T13:45:00Z"
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `amountInCents` | `integer (int64)` | opcional | — | — | `0` |
| `pixQrCode` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankSlip` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `pixKey` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `transfer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `informedDueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `retrievedData` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `type` | `string` | opcional | — | — | `"texto"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |
| `linkStatus` | `string` | opcional | — | — | `"texto"` |
| `linkStatusDisplay` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | — | `"texto"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `paymentType` | `string` | opcional | — | — | `"texto"` |
| `paymentTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `failureMessage` | `string` | opcional | — | — | `"texto"` |
| `cosifAccountCode` | `string` | opcional | — | — | `"texto"` |
| `nsu` | `string` | opcional | — | — | `"texto"` |

Detalhe de `pixQrCode`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `qrCode` | `string` | opcional | — | — | `"texto"` |

Detalhe de `bankSlip`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `barcodeOrDigitableLine` | `string` | opcional | — | — | `"texto"` |

Detalhe de `pixKey`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `key` | `string` | opcional | — | — | `"texto"` |
| `pixKeyType` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `transfer`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `to` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `type` | `string` | opcional | — | `Transfer`, `Pix` | `"Transfer"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `retrievedData`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `beneficiary` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankslipData` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |

Detalhe de `to`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `bankCodeDisplay` | `string` | opcional | — | — | `"texto"` |
| `bankIspb` | `integer (int64)` | opcional | — | — | `0` |
| `agency` | `string` | opcional | — | — | `"texto"` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `accountType` | `string` | opcional | — | — | `"texto"` |
| `accountTypeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `beneficiary`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `bank` | `integer` | opcional | — | — | `0` |
| `bankCodeDisplay` | `string` | opcional | — | — | `"texto"` |
| `bankIspb` | `integer (int64)` | opcional | — | — | `0` |
| `agency` | `string` | opcional | — | — | `"texto"` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `accountType` | `string` | opcional | — | — | `"texto"` |
| `accountTypeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `bankslipData`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `dueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `discount` | `integer (int64)` | opcional | — | — | `0` |
| `paymentLimitDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Exemplo:

```json
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "amountInCents": 0,
  "pixQrCode": {
    "qrCode": "texto"
  },
  "bankSlip": {
    "barcodeOrDigitableLine": "texto"
  },
  "pixKey": {
    "key": "texto",
    "pixKeyType": "NaturalRegistrationNumber",
    "typeDisplay": "texto"
  },
  "transfer": {
    "to": {
      "name": "Fulano de Tal",
      "registrationNumber": "12345678909",
      "bankCode": 0,
      "bankCodeDisplay": "texto",
      "bankIspb": 0,
      "agency": "texto",
      "accountNumber": "texto",
      "accountType": "texto",
      "accountTypeDisplay": "texto"
    },
    "type": "Transfer",
    "typeDisplay": "texto"
  },
  "description": "texto",
  "informedDueDate": "2025-08-11T13:45:00Z",
  "retrievedData": {
    "beneficiary": {
      "name": "Fulano de Tal",
      "registrationNumber": "12345678909",
      "bank": 0,
      "bankCodeDisplay": "texto",
      "bankIspb": 0,
      "agency": "texto",
      "accountNumber": "texto",
      "accountType": "texto",
      "accountTypeDisplay": "texto"
    },
    "bankslipData": {
      "dueDate": "2025-08-11T13:45:00Z",
      "discount": 0,
      "paymentLimitDate": "2025-08-11T13:45:00Z"
    }
  },
  "type": "texto",
  "typeDisplay": "texto",
  "linkStatus": "texto",
  "linkStatusDisplay": "texto",
  "status": "texto",
  "statusDisplay": "texto",
  "paymentType": "texto",
  "paymentTypeDisplay": "texto",
  "failureMessage": "texto",
  "cosifAccountCode": "texto",
  "nsu": "texto"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/LiquidationSchedule" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "amountInCents": 0,
  "pixQrCode": {
    "qrCode": "texto"
  },
  "bankSlip": {
    "barcodeOrDigitableLine": "texto"
  },
  "pixKey": {
    "key": "texto",
    "pixKeyType": "NaturalRegistrationNumber",
    "typeDisplay": "texto"
  },
  "transfer": {
    "to": {
      "name": "Fulano de Tal",
      "registrationNumber": "12345678909",
      "bankCode": 0,
      "bankIspb": 0,
      "agency": "texto",
      "accountNumber": "texto",
      "accountType": "NaturalCheckingAccount"
    },
    "type": "Transfer"
  },
  "description": "texto",
  "informedDueDate": "2025-08-11T13:45:00Z"
}'
```

---

### PUT /v{version}/CreditNote/{id}/LiquidationSchedule/{liquidationId}

**Atualizar Credit Note** — Atualiza por completo um registro de Credit Note existente.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `liquidationId` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `amountInCents` | `integer (int64)` | obrigatório | — | — | `0` |
| `pixQrCode` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankSlip` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `pixKey` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `transfer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `informedDueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `pixQrCode`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `qrCode` | `string` | obrigatório | — | — | `"texto"` |

Detalhe de `bankSlip`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `barcodeOrDigitableLine` | `string` | obrigatório | — | — | `"texto"` |

Detalhe de `pixKey`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `key` | `string` | obrigatório | — | — | `"texto"` |
| `pixKeyType` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `transfer`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `to` | `objeto` | obrigatório | — | objeto — ver detalhe abaixo | `{ … }` |
| `type` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |

Detalhe de `to`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | obrigatório | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | obrigatório | — | — | `"12345678909"` |
| `bankCode` | `integer` | obrigatório | — | — | `0` |
| `bankIspb` | `integer (int64)` | obrigatório | — | — | `0` |
| `agency` | `string` | obrigatório | — | — | `"texto"` |
| `accountNumber` | `string` | obrigatório | — | — | `"texto"` |
| `accountType` | `string` | obrigatório | — | `NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount` | `"NaturalCheckingAccount"` |

Exemplo:

```json
{
  "amountInCents": 0,
  "pixQrCode": {
    "qrCode": "texto"
  },
  "bankSlip": {
    "barcodeOrDigitableLine": "texto"
  },
  "pixKey": {
    "key": "texto",
    "pixKeyType": "NaturalRegistrationNumber",
    "typeDisplay": "texto"
  },
  "transfer": {
    "to": {
      "name": "Fulano de Tal",
      "registrationNumber": "12345678909",
      "bankCode": 0,
      "bankIspb": 0,
      "agency": "texto",
      "accountNumber": "texto",
      "accountType": "NaturalCheckingAccount"
    },
    "type": "Transfer"
  },
  "description": "texto",
  "informedDueDate": "2025-08-11T13:45:00Z"
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `amountInCents` | `integer (int64)` | opcional | — | — | `0` |
| `pixQrCode` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankSlip` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `pixKey` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `transfer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `informedDueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `retrievedData` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `type` | `string` | opcional | — | — | `"texto"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |
| `linkStatus` | `string` | opcional | — | — | `"texto"` |
| `linkStatusDisplay` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | — | `"texto"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `paymentType` | `string` | opcional | — | — | `"texto"` |
| `paymentTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `failureMessage` | `string` | opcional | — | — | `"texto"` |
| `cosifAccountCode` | `string` | opcional | — | — | `"texto"` |
| `nsu` | `string` | opcional | — | — | `"texto"` |

Detalhe de `pixQrCode`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `qrCode` | `string` | opcional | — | — | `"texto"` |

Detalhe de `bankSlip`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `barcodeOrDigitableLine` | `string` | opcional | — | — | `"texto"` |

Detalhe de `pixKey`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `key` | `string` | opcional | — | — | `"texto"` |
| `pixKeyType` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `transfer`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `to` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `type` | `string` | opcional | — | `Transfer`, `Pix` | `"Transfer"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `retrievedData`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `beneficiary` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankslipData` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |

Detalhe de `to`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `bankCodeDisplay` | `string` | opcional | — | — | `"texto"` |
| `bankIspb` | `integer (int64)` | opcional | — | — | `0` |
| `agency` | `string` | opcional | — | — | `"texto"` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `accountType` | `string` | opcional | — | — | `"texto"` |
| `accountTypeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `beneficiary`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `bank` | `integer` | opcional | — | — | `0` |
| `bankCodeDisplay` | `string` | opcional | — | — | `"texto"` |
| `bankIspb` | `integer (int64)` | opcional | — | — | `0` |
| `agency` | `string` | opcional | — | — | `"texto"` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `accountType` | `string` | opcional | — | — | `"texto"` |
| `accountTypeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `bankslipData`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `dueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `discount` | `integer (int64)` | opcional | — | — | `0` |
| `paymentLimitDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Exemplo:

```json
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "amountInCents": 0,
  "pixQrCode": {
    "qrCode": "texto"
  },
  "bankSlip": {
    "barcodeOrDigitableLine": "texto"
  },
  "pixKey": {
    "key": "texto",
    "pixKeyType": "NaturalRegistrationNumber",
    "typeDisplay": "texto"
  },
  "transfer": {
    "to": {
      "name": "Fulano de Tal",
      "registrationNumber": "12345678909",
      "bankCode": 0,
      "bankCodeDisplay": "texto",
      "bankIspb": 0,
      "agency": "texto",
      "accountNumber": "texto",
      "accountType": "texto",
      "accountTypeDisplay": "texto"
    },
    "type": "Transfer",
    "typeDisplay": "texto"
  },
  "description": "texto",
  "informedDueDate": "2025-08-11T13:45:00Z",
  "retrievedData": {
    "beneficiary": {
      "name": "Fulano de Tal",
      "registrationNumber": "12345678909",
      "bank": 0,
      "bankCodeDisplay": "texto",
      "bankIspb": 0,
      "agency": "texto",
      "accountNumber": "texto",
      "accountType": "texto",
      "accountTypeDisplay": "texto"
    },
    "bankslipData": {
      "dueDate": "2025-08-11T13:45:00Z",
      "discount": 0,
      "paymentLimitDate": "2025-08-11T13:45:00Z"
    }
  },
  "type": "texto",
  "typeDisplay": "texto",
  "linkStatus": "texto",
  "linkStatusDisplay": "texto",
  "status": "texto",
  "statusDisplay": "texto",
  "paymentType": "texto",
  "paymentTypeDisplay": "texto",
  "failureMessage": "texto",
  "cosifAccountCode": "texto",
  "nsu": "texto"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/LiquidationSchedule/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "amountInCents": 0,
  "pixQrCode": {
    "qrCode": "texto"
  },
  "bankSlip": {
    "barcodeOrDigitableLine": "texto"
  },
  "pixKey": {
    "key": "texto",
    "pixKeyType": "NaturalRegistrationNumber",
    "typeDisplay": "texto"
  },
  "transfer": {
    "to": {
      "name": "Fulano de Tal",
      "registrationNumber": "12345678909",
      "bankCode": 0,
      "bankIspb": 0,
      "agency": "texto",
      "accountNumber": "texto",
      "accountType": "NaturalCheckingAccount"
    },
    "type": "Transfer"
  },
  "description": "texto",
  "informedDueDate": "2025-08-11T13:45:00Z"
}'
```

---

### DELETE /v{version}/CreditNote/{id}/LiquidationSchedule/{liquidationId}

**Remover Credit Note** — Remove um registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `liquidationId` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X DELETE "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/LiquidationSchedule/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v{version}/CreditNote/{id}/LiquidationScheduleCreditNote

**Listar Credit Note** — Lista e filtra registros de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |
| `linkStatus` | query | `string` | opcional | — | `valor` |
| `status` | query | `string` | opcional | — | `valor` |
| `page` | query | `integer` | opcional | — | `10` |
| `size` | query | `integer` | opcional | — | `10` |

**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"` |
| `amountInCents` | `integer (int64)` | opcional | — | — | `0` |
| `pixQrCode` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankSlip` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `pixKey` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `transfer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `informedDueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `retrievedData` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `type` | `string` | opcional | — | — | `"texto"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |
| `linkStatus` | `string` | opcional | — | — | `"texto"` |
| `linkStatusDisplay` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | — | `"texto"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `paymentType` | `string` | opcional | — | — | `"texto"` |
| `paymentTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `failureMessage` | `string` | opcional | — | — | `"texto"` |
| `cosifAccountCode` | `string` | opcional | — | — | `"texto"` |
| `nsu` | `string` | opcional | — | — | `"texto"` |

Detalhe de `pixQrCode`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `qrCode` | `string` | opcional | — | — | `"texto"` |

Detalhe de `bankSlip`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `barcodeOrDigitableLine` | `string` | opcional | — | — | `"texto"` |

Detalhe de `pixKey`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `key` | `string` | opcional | — | — | `"texto"` |
| `pixKeyType` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `transfer`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `to` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `type` | `string` | opcional | — | `Transfer`, `Pix` | `"Transfer"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `retrievedData`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `beneficiary` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankslipData` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |

Detalhe de `to`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `bankCodeDisplay` | `string` | opcional | — | — | `"texto"` |
| `bankIspb` | `integer (int64)` | opcional | — | — | `0` |
| `agency` | `string` | opcional | — | — | `"texto"` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `accountType` | `string` | opcional | — | — | `"texto"` |
| `accountTypeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `beneficiary`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `bank` | `integer` | opcional | — | — | `0` |
| `bankCodeDisplay` | `string` | opcional | — | — | `"texto"` |
| `bankIspb` | `integer (int64)` | opcional | — | — | `0` |
| `agency` | `string` | opcional | — | — | `"texto"` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `accountType` | `string` | opcional | — | — | `"texto"` |
| `accountTypeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `bankslipData`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `dueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `discount` | `integer (int64)` | opcional | — | — | `0` |
| `paymentLimitDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Exemplo:

```json
{
  "page": 0,
  "totalPages": 0,
  "totalItems": 0,
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "amountInCents": 0,
      "pixQrCode": {
        "qrCode": "texto"
      },
      "bankSlip": {
        "barcodeOrDigitableLine": "texto"
      },
      "pixKey": {
        "key": "texto",
        "pixKeyType": {},
        "typeDisplay": "texto"
      },
      "transfer": {
        "to": {},
        "type": {},
        "typeDisplay": "texto"
      },
      "description": "texto",
      "informedDueDate": "2025-08-11T13:45:00Z",
      "retrievedData": {
        "beneficiary": {},
        "bankslipData": {}
      },
      "type": "texto",
      "typeDisplay": "texto",
      "linkStatus": "texto",
      "linkStatusDisplay": "texto",
      "status": "texto",
      "statusDisplay": "texto",
      "paymentType": "texto",
      "paymentTypeDisplay": "texto",
      "failureMessage": "texto",
      "cosifAccountCode": "texto",
      "nsu": "texto"
    }
  ],
  "paginationToken": "texto",
  "totalValue": 0,
  "totalAssignmentValue": 0
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/LiquidationScheduleCreditNote" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v{version}/CreditNote/{id}/LiquidationSchedule/{liquidationId}/Receipt

**Listar Credit Note** — Lista e filtra registros de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `liquidationId` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Resposta 200**

Exemplo:

```json
"texto"
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/LiquidationSchedule/3fa85f64-5717-4562-b3fc-2c963f66afa6/Receipt" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v{version}/CreditNote/{id}/GetPublicPayrollLoan

**Listar Credit Note** — Lista e filtra registros de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |
| `page` | query | `integer` | opcional | — | `10` |
| `size` | query | `integer` | opcional | — | `10` |
| `orderBy` | query | `string` | opcional | — | `valor` |
| `isDeleted` | query | `boolean` | opcional | — | `true` |

**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 | — | — | `[ … ]` |
| `paginationToken` | `string` | opcional | — | — | `"texto"` |
| `totalValue` | `integer (int64)` | opcional | — | — | `0` |
| `totalAssignmentValue` | `integer (int64)` | opcional | — | — | `0` |

Exemplo:

```json
{
  "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"
      },
      "creditNoteNo": 0,
      "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "productIdDisplay": "texto",
      "productCategoryDisplay": "texto",
      "productInstrumentType": "texto",
      "acceptanceDate": "2025-08-11T13:45:00Z",
      "amortization": {
        "amortizationType": "texto",
        "calculateByValueType": "texto",
        "requestedAmount": 0,
        "principalAmountInCents": 0,
        "startDate": "2025-08-11T13:45:00Z",
        "termInMonths": 0,
        "numberOfPayments": 0,
        "paymentPeriodicity": {},
        "absAmortizationInMonths": 0,
        "absInterestInMonths": 0,
        "apr": 1.99,
        "periodicity": "texto",
        "daysInYear": 0,
        "agentCommission": {},
        "calculationType": "texto",
        "firstPaymentDate": "2025-08-11T13:45:00Z",
        "bankCommission": {},
        "financeOperationsTax": 1.99,
        "dailyFinanceOperationsTax": 1.99,
        "indexer": "texto",
        "indexerValue": 1000,
        "paymentDay": 0,
        "skippedMonths": [],
        "monthlyInterest": 1000,
        "yearlyInterest": 1000,
        "effectiveMonthlyCost": 1000,
        "effectiveYearlyCost": 1000,
        "liquidValue": 1,
        "comm": 0,
        "commTc": 0,
        "commNonTc": 0,
        "finTax": 0,
        "dueDate": "2025-08-11T13:45:00Z",
        "initialValue": 0,
        "fixedPaymentDuringGraduation": 0,
        "termsUntilGraduation": 0,
        "absAfterGraduation": 0,
        "pmt2Value": 1000,
        "fiduciaryGuarantee": 1000,
        "financeTaxExempted": true,
        "issueNumber": 0,
        "emissionNumber": 0,
        "quantity": 0,
        "unitPrice": 0,
        "minEmissionCost": 0,
        "maxEmissionCost": 0,
        "numberOfInterestPayments": 0,
        "valueMarginReserve": 0,
        "insuranceCoverAmount": 0,
        "paymentFixedCosts": 0,
        "includePaymentFixedCosts": true,
        "dueDateOnBusinessDays": true,
        "discountMode": true
      },
      "warranty": [
        {}
      ],
      "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "personRegistrationNumber": "texto",
      "customPaymentPlan": true,
      "personEmail": "cliente@exemplo.com.br",
      "personDisplay": "texto",
      "personDiscriminator": "texto",
      "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "beneficiaryRegistrationNumber": "texto",
      "beneficiaryEmail": "cliente@exemplo.com.br",
      "beneficiaryDisplay": "texto",
      "beneficiaryDiscriminator": "texto",
      "liquidationType": "texto",
      "liquidationTypeDisplay": "texto",
      "invoiceBarCode": "texto",
      "observations": "texto",
      "collateral": "texto",
      "invoiceValue": 0,
      "invoiceNumber": "texto",
      "changeBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "changeBankAccount": {
        "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": {},
        "bankCode": "texto",
        "bankCodeCompe": 0,
        "bankCodeDisplay": "texto",
        "bankIspb": 0,
        "account": "texto",
        "accountDigit": "texto",
        "agency": "texto",
        "agencyDigit": "texto",
        "type": "texto",
        "typeDisplay": "texto",
        "jointAccount": true,
        "operationTypeValue": "texto",
        "pixKeyTypeValue": "texto",
        "keyPix": "texto"
      },
      "status": "texto",
      "statusDisplay": "texto",
      "statusValue": 0,
      "bankAccount": {
        "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": {},
        "bankCode": "texto",
        "bankCodeCompe": 0,
        "bankCodeDisplay": "texto",
        "bankIspb": 0,
        "account": "texto",
        "accountDigit": "texto",
        "agency": "texto",
        "agencyDigit": "texto",
        "type": "texto",
        "typeDisplay": "texto",
        "jointAccount": true,
        "operationTypeValue": "texto",
        "pixKeyTypeValue": "texto",
        "keyPix": "texto"
      },
      "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "isRegistered": true,
      "bulkAssignment": true,
      "blockedUntil": "2025-08-11T13:45:00Z",
      "assignmentCalculation": {
        "amount": 1000,
        "type": {},
        "mode": {}
      },
      "assignmentValue": 0,
      "assignmentDate": "2025-08-11T13:45:00Z",
      "assignmentCalculationResult": 0,
      "accruedInterest": 0,
      "issueNumber": 0,
      "emissionNumber": 0,
      "quantity": 0,
      "unitPrice": 0,
      "timeline": [
        {}
      ],
      "assets": [
        {}
      ],
      "relatedPersonCreditNote": [
        {}
      ],
      "uploads": [
        {}
      ],
      "paymentScheduleItems": [
        {}
      ],
      "unicoSignScore": 1000,
      "facialSimilarityScore": 1000,
      "signatureDetails": [
        {}
      ],
      "codeIPOC": "texto",
      "transitoryBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "transitoryBankAccount": {
        "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": {},
        "bankCode": "texto",
        "bankCodeCompe": 0,
        "bankCodeDisplay": "texto",
        "bankIspb": 0,
        "account": "texto",
        "accountDigit": "texto",
        "agency": "texto",
        "agencyDigit": "texto",
        "type": "texto",
        "typeDisplay": "texto",
        "jointAccount": true,
        "operationTypeValue": "texto",
        "pixKeyTypeValue": "texto",
        "keyPix": "texto"
      },
      "transitoryBankAccountOpenAccount": true,
      "liquidationSchedule": [
        {}
      ],
      "liquidationMode": "texto",
      "liquidationModeDisplay": "texto",
      "fgtscefProtocolNumber": "texto",
      "fgtscefProtocolDate": "2025-08-11T13:45:00Z",
      "batchSignatureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "liquidationClosureStatus": "texto",
      "liquidationClosureStatusDisplay": "texto",
      "creditNoteNoBase32": "texto",
      "installmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "personDetails": "texto",
      "insurance": true,
      "hasPersonDetailsDivergence": true,
      "scheduleEarliestDueDate": "2025-08-11T13:45:00Z",
      "isByxCreation": true
    }
  ],
  "paginationToken": "texto",
  "totalValue": 0,
  "totalAssignmentValue": 0
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/GetPublicPayrollLoan" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v1/CreditNote

**[v1] Lista operações de crédito recebendo cada filtro como parâmetro de query…** — Lista e filtra registros de Credit Note.

[v1] Lista operações de crédito recebendo cada filtro como parâmetro de query individual.

**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` |
| `status` | query | `array de string` | opcional | — | `valor` |
| `creditNoteNo` | query | `integer` | opcional | — | `10` |
| `personId` | query | `string (uuid)` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `personDisplay` | query | `string` | opcional | — | `valor` |
| `initialDate` | query | `string (date-time)` | opcional | — | `valor` |
| `finalDate` | query | `string (date-time)` | opcional | — | `valor` |
| `initialPaymentDate` | query | `string (date-time)` | opcional | — | `valor` |
| `finalPaymentDate` | query | `string (date-time)` | opcional | — | `valor` |
| `isDeleted` | query | `boolean` | opcional | — | `true` |
| `orderBy` | query | `string` | opcional | — | `valor` |
| `minValue` | query | `integer (int64)` | opcional | — | `10` |
| `maxValue` | query | `integer (int64)` | opcional | — | `10` |
| `filterByOwner` | query | `string` | opcional | — | `valor` |
| `filterByOwnerGroup` | query | `string` | opcional | — | `valor` |
| `assigned` | query | `boolean` | opcional | — | `true` |
| `productCategoryDisplay` | query | `string` | opcional | — | `valor` |
| `relatedPersons` | query | `array de string` | opcional | — | `valor` |
| `ownLiquidation` | query | `boolean` | opcional | — | `true` |
| `ownCompliance` | query | `boolean` | opcional | — | `true` |
| `liquidationMode` | query | `string` | opcional | — | `valor` |
| `productId` | query | `string (uuid)` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `onlyShared` | query | `boolean` | opcional | — | `true` |
| `closureStatus` | query | `string` | opcional | — | `valor` |
| `liquidationModeList` | query | `array de string` | opcional | — | `valor` |
| `productCategoryDisplayList` | query | `array de string` | opcional | — | `valor` |
| `productIdList` | query | `array de string (uuid)` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `personIdList` | query | `array de string (uuid)` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `filterByOwnerGroupList` | query | `array de string` | opcional | — | `valor` |
| `filterByCorbanList` | query | `array de string` | opcional | — | `valor` |
| `minimumInterestRate` | query | `number (double)` | opcional | — | `100.00` |
| `maximumInterestRate` | query | `number (double)` | opcional | — | `100.00` |
| `minOpApr` | query | `number (double)` | opcional | — | `100.00` |
| `maxOpApr` | query | `number (double)` | opcional | — | `100.00` |
| `filterByObservations` | query | `string` | opcional | — | `valor` |
| `insurance` | query | `boolean` | opcional | — | `true` |
| `initialScheduleDueDate` | query | `string (date-time)` | opcional | — | `valor` |
| `finalScheduleDueDate` | query | `string (date-time)` | opcional | — | `valor` |

**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 | — | — | `[ … ]` |
| `paginationToken` | `string` | opcional | — | — | `"texto"` |
| `totalValue` | `integer (int64)` | opcional | — | — | `0` |
| `totalAssignmentValue` | `integer (int64)` | opcional | — | — | `0` |

Exemplo:

```json
{
  "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"
      },
      "creditNoteNo": 0,
      "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "productIdDisplay": "texto",
      "productCategoryDisplay": "texto",
      "productInstrumentType": "texto",
      "acceptanceDate": "2025-08-11T13:45:00Z",
      "amortization": {
        "amortizationType": "texto",
        "calculateByValueType": "texto",
        "requestedAmount": 0,
        "principalAmountInCents": 0,
        "startDate": "2025-08-11T13:45:00Z",
        "termInMonths": 0,
        "numberOfPayments": 0,
        "paymentPeriodicity": {},
        "absAmortizationInMonths": 0,
        "absInterestInMonths": 0,
        "apr": 1.99,
        "periodicity": "texto",
        "daysInYear": 0,
        "agentCommission": {},
        "calculationType": "texto",
        "firstPaymentDate": "2025-08-11T13:45:00Z",
        "bankCommission": {},
        "financeOperationsTax": 1.99,
        "dailyFinanceOperationsTax": 1.99,
        "indexer": "texto",
        "indexerValue": 1000,
        "paymentDay": 0,
        "skippedMonths": [],
        "monthlyInterest": 1000,
        "yearlyInterest": 1000,
        "effectiveMonthlyCost": 1000,
        "effectiveYearlyCost": 1000,
        "liquidValue": 1,
        "comm": 0,
        "commTc": 0,
        "commNonTc": 0,
        "finTax": 0,
        "dueDate": "2025-08-11T13:45:00Z",
        "initialValue": 0,
        "fixedPaymentDuringGraduation": 0,
        "termsUntilGraduation": 0,
        "absAfterGraduation": 0,
        "pmt2Value": 1000,
        "fiduciaryGuarantee": 1000,
        "financeTaxExempted": true,
        "issueNumber": 0,
        "emissionNumber": 0,
        "quantity": 0,
        "unitPrice": 0,
        "minEmissionCost": 0,
        "maxEmissionCost": 0,
        "numberOfInterestPayments": 0,
        "valueMarginReserve": 0,
        "insuranceCoverAmount": 0,
        "paymentFixedCosts": 0,
        "includePaymentFixedCosts": true,
        "dueDateOnBusinessDays": true,
        "discountMode": true
      },
      "warranty": [
        {}
      ],
      "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "personRegistrationNumber": "texto",
      "customPaymentPlan": true,
      "personEmail": "cliente@exemplo.com.br",
      "personDisplay": "texto",
      "personDiscriminator": "texto",
      "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "beneficiaryRegistrationNumber": "texto",
      "beneficiaryEmail": "cliente@exemplo.com.br",
      "beneficiaryDisplay": "texto",
      "beneficiaryDiscriminator": "texto",
      "liquidationType": "texto",
      "liquidationTypeDisplay": "texto",
      "invoiceBarCode": "texto",
      "observations": "texto",
      "collateral": "texto",
      "invoiceValue": 0,
      "invoiceNumber": "texto",
      "changeBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "changeBankAccount": {
        "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": {},
        "bankCode": "texto",
        "bankCodeCompe": 0,
        "bankCodeDisplay": "texto",
        "bankIspb": 0,
        "account": "texto",
        "accountDigit": "texto",
        "agency": "texto",
        "agencyDigit": "texto",
        "type": "texto",
        "typeDisplay": "texto",
        "jointAccount": true,
        "operationTypeValue": "texto",
        "pixKeyTypeValue": "texto",
        "keyPix": "texto"
      },
      "status": "texto",
      "statusDisplay": "texto",
      "statusValue": 0,
      "bankAccount": {
        "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": {},
        "bankCode": "texto",
        "bankCodeCompe": 0,
        "bankCodeDisplay": "texto",
        "bankIspb": 0,
        "account": "texto",
        "accountDigit": "texto",
        "agency": "texto",
        "agencyDigit": "texto",
        "type": "texto",
        "typeDisplay": "texto",
        "jointAccount": true,
        "operationTypeValue": "texto",
        "pixKeyTypeValue": "texto",
        "keyPix": "texto"
      },
      "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "isRegistered": true,
      "bulkAssignment": true,
      "blockedUntil": "2025-08-11T13:45:00Z",
      "assignmentCalculation": {
        "amount": 1000,
        "type": {},
        "mode": {}
      },
      "assignmentValue": 0,
      "assignmentDate": "2025-08-11T13:45:00Z",
      "assignmentCalculationResult": 0,
      "accruedInterest": 0,
      "issueNumber": 0,
      "emissionNumber": 0,
      "quantity": 0,
      "unitPrice": 0,
      "timeline": [
        {}
      ],
      "assets": [
        {}
      ],
      "relatedPersonCreditNote": [
        {}
      ],
      "uploads": [
        {}
      ],
      "paymentScheduleItems": [
        {}
      ],
      "unicoSignScore": 1000,
      "facialSimilarityScore": 1000,
      "signatureDetails": [
        {}
      ],
      "codeIPOC": "texto",
      "transitoryBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "transitoryBankAccount": {
        "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": {},
        "bankCode": "texto",
        "bankCodeCompe": 0,
        "bankCodeDisplay": "texto",
        "bankIspb": 0,
        "account": "texto",
        "accountDigit": "texto",
        "agency": "texto",
        "agencyDigit": "texto",
        "type": "texto",
        "typeDisplay": "texto",
        "jointAccount": true,
        "operationTypeValue": "texto",
        "pixKeyTypeValue": "texto",
        "keyPix": "texto"
      },
      "transitoryBankAccountOpenAccount": true,
      "liquidationSchedule": [
        {}
      ],
      "liquidationMode": "texto",
      "liquidationModeDisplay": "texto",
      "fgtscefProtocolNumber": "texto",
      "fgtscefProtocolDate": "2025-08-11T13:45:00Z",
      "batchSignatureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "liquidationClosureStatus": "texto",
      "liquidationClosureStatusDisplay": "texto",
      "creditNoteNoBase32": "texto",
      "installmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "personDetails": "texto",
      "insurance": true,
      "hasPersonDetailsDivergence": true,
      "scheduleEarliestDueDate": "2025-08-11T13:45:00Z",
      "isByxCreation": true
    }
  ],
  "paginationToken": "texto",
  "totalValue": 0,
  "totalAssignmentValue": 0
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### GET /v1/CreditNote/related-operations

**Lista enxuta de operações relacionáveis para a picklist de "operação relacionada"…** — Lista e filtra registros de Credit Note.

Lista enxuta de operações relacionáveis para a picklist de "operação relacionada" na Compra de Dívida.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `personId` | query | `string (uuid)` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `creditNoteNo` | query | `integer` | opcional | — | `10` |
| `excludeId` | query | `string (uuid)` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `page` | query | `integer` | opcional | — | `10` |
| `size` | query | `integer` | opcional | — | `10` |

**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"` |
| `creditNoteNo` | `integer` | opcional | — | — | `0` |
| `productDisplay` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | `Draft`, `ComplianceApproval`, `Signatures`, `Liquidation`, `Finished`, `Disapproved`, `Error`, `Revision`, `CreditApproval`, `InstrumentApproval`, `Canceled`, `WaitLiquidation`, `SignaturesValidation`, `PaymentRevision`, `ManualLiquidation`, `Warranty`, `ManualWarranty`, `MarginReserveApproval`, `WarrantyRevision`, `PartnerSignaturesValidation`, `OpenAccountRevision`, `VehicleInspection`, `VehicleInspectionApproval`, `GravameRegistration` | `"Draft"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Exemplo:

```json
{
  "page": 0,
  "totalPages": 0,
  "totalItems": 0,
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "creditNoteNo": 0,
      "productDisplay": "texto",
      "status": "Draft",
      "statusDisplay": "texto",
      "createdAt": "2025-08-11T13:45:00Z"
    }
  ],
  "paginationToken": "texto",
  "totalValue": 0,
  "totalAssignmentValue": 0
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/v1/CreditNote/related-operations" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v{version}/CreditNote/Export/excel

**Exporta operações de crédito em formato Excel com base nos filtros informados** — Lista e filtra registros de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `version` | path | `string` | obrigatório | — | `1` |
| `CreditNoteNo` | query | `integer` | opcional | — | `10` |
| `SearchString` | query | `string` | opcional | — | `valor` |
| `PersonId` | query | `string (uuid)` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `PersonDisplay` | query | `string` | opcional | — | `valor` |
| `InitialDate` | query | `string (date-time)` | opcional | — | `valor` |
| `FinalDate` | query | `string (date-time)` | opcional | — | `valor` |
| `InitialPaymentDate` | query | `string (date-time)` | opcional | — | `valor` |
| `FinalPaymentDate` | query | `string (date-time)` | opcional | — | `valor` |
| `IsDeleted` | query | `boolean` | opcional | — | `true` |
| `MinValue` | query | `integer (int64)` | opcional | — | `10` |
| `MaxValue` | query | `integer (int64)` | opcional | — | `10` |
| `FilterByOwner` | query | `string` | opcional | — | `valor` |
| `FilterByOwnerGroup` | query | `string` | opcional | — | `valor` |
| `ProductCategoryDisplay` | query | `string` | opcional | — | `valor` |
| `RelatedPersons` | query | `array de string` | opcional | — | `valor` |
| `Status` | query | `array de string` | opcional | — | `valor` |
| `Assigned` | query | `boolean` | opcional | — | `true` |
| `OwnLiquidation` | query | `boolean` | opcional | — | `true` |
| `OwnCompliance` | query | `boolean` | opcional | — | `true` |
| `OnlyShared` | query | `boolean` | opcional | — | `true` |
| `LiquidationMode` | query | `string` | opcional | — | `valor` |
| `ProductId` | query | `string (uuid)` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `ClosureStatus` | query | `string` | opcional | — | `valor` |
| `LiquidationModeList` | query | `array de string` | opcional | — | `valor` |
| `ProductCategoryDisplayList` | query | `array de string` | opcional | — | `valor` |
| `ProductIdList` | query | `array de string (uuid)` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `PersonIdList` | query | `array de string (uuid)` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `FilterByOwnerGroupList` | query | `array de string` | opcional | — | `valor` |
| `FilterByCorbanList` | query | `array de string` | opcional | — | `valor` |
| `MinimumInterestRate` | query | `number (double)` | opcional | — | `100.00` |
| `MaximumInterestRate` | query | `number (double)` | opcional | — | `100.00` |
| `MinOpApr` | query | `number (double)` | opcional | — | `100.00` |
| `MaxOpApr` | query | `number (double)` | opcional | — | `100.00` |
| `FilterByObservations` | query | `string` | opcional | — | `valor` |
| `Insurance` | query | `boolean` | opcional | — | `true` |
| `InitialScheduleDueDate` | query | `string (date-time)` | opcional | — | `valor` |
| `FinalScheduleDueDate` | query | `string (date-time)` | opcional | — | `valor` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/v1/CreditNote/Export/excel" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v{version}/CreditNote/{id}/SignatureDetails

**Obtém os detalhes da assinatura da operação** — Lista e filtra registros de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | Id da operação de crédito | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `signatureDetails` | `array de objeto` | opcional | Detalhes da assinatura eletrônica coletada pelo parceiro | objeto — ver detalhe abaixo | `[ … ]` |
| `unicoSignScore` | `number (double)` | opcional | Score na Unico | — | `1000` |
| `facialSimilarityScore` | `number (double)` | opcional | Score de similaridade facial na Unico Cloud | — | `1000` |

Detalhe de `signatureDetails`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `userAgent` | `string` | opcional | — | — | `"texto"` |
| `ip` | `string` | opcional | — | — | `"texto"` |
| `geoLocation` | `string` | opcional | — | — | `"texto"` |
| `operationalSystem` | `string` | opcional | — | — | `"texto"` |
| `deviceModel` | `string` | opcional | — | — | `"texto"` |
| `deviceName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `deviceType` | `string` | opcional | — | — | `"texto"` |
| `smsValidation` | `boolean` | opcional | — | — | `true` |
| `emailValidation` | `boolean` | opcional | — | — | `true` |

Exemplo:

```json
{
  "signatureDetails": [
    {
      "registrationNumber": "12345678909",
      "userAgent": "texto",
      "ip": "texto",
      "geoLocation": "texto",
      "operationalSystem": "texto",
      "deviceModel": "texto",
      "deviceName": "Fulano de Tal",
      "deviceType": "texto",
      "smsValidation": true,
      "emailValidation": true
    }
  ],
  "unicoSignScore": 1000,
  "facialSimilarityScore": 1000
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `400` | Requisição inválida (validação de campos ou regra de negócio). |
| `401` | Não autenticado — token ausente, inválido ou expirado. |
| `403` | Autenticado, mas sem permissão para o recurso. |
| `404` | Recurso não encontrado. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/SignatureDetails" \
  -H "Authorization: Bearer {{token}}"
```

---

### PUT /v{version}/CreditNote/{id}/SignatureDetails

**Atualiza os detalhes da assinatura da operação** — Atualiza por completo um registro de Credit Note existente.

Atualiza os detalhes da assinatura da operação. Permitido quando o status é Rascunho, Revisão ou Assinaturas.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | Id da operação de crédito | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `signatureDetails` | `array de objeto` | opcional | Detalhes da assinatura eletrônica | objeto — ver detalhe abaixo | `[ … ]` |
| `unicoSignScore` | `number (double)` | opcional | Score na Unico | — | `1000` |
| `facialSimilarityScore` | `number (double)` | opcional | Score de similaridade facial na Unico Cloud | — | `1000` |

Detalhe de `signatureDetails`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `userAgent` | `string` | opcional | — | — | `"texto"` |
| `ip` | `string` | opcional | — | — | `"texto"` |
| `geoLocation` | `string` | opcional | — | — | `"texto"` |
| `operationalSystem` | `string` | opcional | — | — | `"texto"` |
| `deviceModel` | `string` | opcional | — | — | `"texto"` |
| `deviceName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `deviceType` | `string` | opcional | — | — | `"texto"` |
| `smsValidation` | `boolean` | opcional | — | — | `true` |
| `emailValidation` | `boolean` | opcional | — | — | `true` |

Exemplo:

```json
{
  "signatureDetails": [
    {
      "registrationNumber": "12345678909",
      "userAgent": "texto",
      "ip": "texto",
      "geoLocation": "texto",
      "operationalSystem": "texto",
      "deviceModel": "texto",
      "deviceName": "Fulano de Tal",
      "deviceType": "texto",
      "smsValidation": true,
      "emailValidation": true
    }
  ],
  "unicoSignScore": 1000,
  "facialSimilarityScore": 1000
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `204` | Sucesso sem corpo de resposta. |
| `400` | Requisição inválida (validação de campos ou regra de negócio). |
| `401` | Não autenticado — token ausente, inválido ou expirado. |
| `403` | Autenticado, mas sem permissão para o recurso. |
| `404` | Recurso não encontrado. |

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/SignatureDetails" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "signatureDetails": [
    {
      "registrationNumber": "12345678909",
      "userAgent": "texto",
      "ip": "texto",
      "geoLocation": "texto",
      "operationalSystem": "texto",
      "deviceModel": "texto",
      "deviceName": "Fulano de Tal",
      "deviceType": "texto",
      "smsValidation": true,
      "emailValidation": true
    }
  ],
  "unicoSignScore": 1000,
  "facialSimilarityScore": 1000
}'
```

---

### POST /v{version}/CreditNote/{id}/draftpreview

**Criar Credit Note** — Cria um novo registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |
| `useWatermark` | query | `boolean` | opcional | — | `true` |
| `createPdf` | query | `boolean` | opcional | — | `true` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/draftpreview" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /v{version}/CreditNote/{id}/LiquidationScheduleClosureUpdateStatus

**Atualiza o status de fechamento do roteiro de liquidacao** — Cria um novo registro de Credit Note.

Atualiza o status de fechamento do roteiro de liquidacao. Somente operacoes do tipo Roteiro de Liquidacao, encerradas e nao deletadas podem executar esse endpoint.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `liquidationClosureStatus` | `string` | obrigatório | — | `Pending`, `SettleOperation`, `TransferChangeAccount`, `TransitoryBankAccountClosed`, `Revision`, `Cancelled`, `Finished` | `"Pending"` |
| `reason` | `string` | obrigatório | — | — | `"texto"` |

Exemplo:

```json
{
  "liquidationClosureStatus": "Pending",
  "reason": "texto"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/LiquidationScheduleClosureUpdateStatus" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "liquidationClosureStatus": "Pending",
  "reason": "texto"
}'
```

---

### POST /v{version}/CreditNote/{id}/submitapproval

**Envia a operação para aprovação** — Cria um novo registro de Credit Note.

Envia a operação para aprovação. Após o envio, a mesma não poderá ser alterada até o término da análise.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |
| `updateStartDate` | query | `boolean` | opcional | — | `true` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/submitapproval" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /v{version}/CreditNote/{id}/donePaymentRevision

**Criar Credit Note** — Cria um novo registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `bankAccount` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `changeBankAccount` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |

Detalhe de `bankAccount`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `id` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `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 | — | `NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount` | `"NaturalCheckingAccount"` |
| `jointAccount` | `boolean` | opcional | — | — | `true` |
| `operationTypeValue` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |
| `pixKeyTypeValue` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `keyPix` | `string` | opcional | Chave Pix | — | `"texto"` |

Detalhe de `ownerUser`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `ownerGroup`:

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

Exemplo:

```json
{
  "bankAccount": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bankCode": 0,
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "NaturalCheckingAccount",
    "jointAccount": true,
    "operationTypeValue": "Transfer",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "keyPix": "texto"
  },
  "changeBankAccount": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bankCode": 0,
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "NaturalCheckingAccount",
    "jointAccount": true,
    "operationTypeValue": "Transfer",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "keyPix": "texto"
  }
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/donePaymentRevision" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "bankAccount": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bankCode": 0,
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "NaturalCheckingAccount",
    "jointAccount": true,
    "operationTypeValue": "Transfer",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "keyPix": "texto"
  },
  "changeBankAccount": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bankCode": 0,
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "NaturalCheckingAccount",
    "jointAccount": true,
    "operationTypeValue": "Transfer",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "keyPix": "texto"
  }
}'
```

---

### POST /v{version}/CreditNote/{id}/doneWarrantyRevision

**Criar Credit Note** — Cria um novo registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `warrantyIds` | `array de string (uuid)` | opcional | IDs das garantias que serão removidas do processo averbação | — | `[ … ]` |
| `reason` | `string` | opcional | Motivo da alteração das garantias | — | `"texto"` |
| `warrantyOfficeTokens` | `array de objeto` | opcional | Lista de tokens de averbação | objeto — ver detalhe abaixo | `[ … ]` |
| `observations` | `string` | opcional | Observação | — | `"texto"` |

Detalhe de `warrantyOfficeTokens`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `warrantyRegistrationOffice` | `string` | opcional | — | `None`, `Fgts`, `Zetra`, `Siape`, `Others`, `DataPrevCreditoTrabalhador`, `SemearInss`, `CarEquity` | `"None"` |
| `token` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `warrantyCode` | `string` | opcional | Código de garantia | — | `"texto"` |
| `expirationDate` | `string (date-time)` | opcional | Data expiração | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `token`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `tokenType` | `string` | opcional | — | `Reserve`, `NestEgg`, `Warranty` | `"Reserve"` |
| `tokenValue` | `string` | opcional | Valor do Token | — | `"texto"` |

Exemplo:

```json
{
  "warrantyIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "reason": "texto",
  "warrantyOfficeTokens": [
    {
      "warrantyRegistrationOffice": "None",
      "token": {
        "tokenType": {},
        "tokenValue": "texto"
      },
      "warrantyCode": "texto",
      "expirationDate": "2025-08-11T13:45:00Z"
    }
  ],
  "observations": "texto"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/doneWarrantyRevision" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "warrantyIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "reason": "texto",
  "warrantyOfficeTokens": [
    {
      "warrantyRegistrationOffice": "None",
      "token": {
        "tokenType": {},
        "tokenValue": "texto"
      },
      "warrantyCode": "texto",
      "expirationDate": "2025-08-11T13:45:00Z"
    }
  ],
  "observations": "texto"
}'
```

---

### POST /v{version}/CreditNote/{id}/disapproveWarrantyRevision

**Reprova a Revisão de Garantia de uma operação CarEquity: finaliza a operação em** — Cria um novo registro de Credit Note.

Reprova a Revisão de Garantia de uma operação CarEquity: finaliza a operação em Reprovado (sem liquidar). Diferente de "concluir" (que reenvia para nova averbação) e de "cancelar" (status Cancelada). O tratamento é feito pela sub-orquestração {opId}VETERA.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/disapproveWarrantyRevision" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /v{version}/CreditNote/{id}/paymentRevisionLiquidationSchedule

**Criar Credit Note** — Cria um novo registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `liquidationScheduleItems` | `array de objeto` | obrigatório | Itens do 'Roteiro de Liquidação' que serão alterados/adiconados | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `liquidationScheduleItems`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `liquidationScheduleId` | `string (uuid)` | opcional | Id do LiquidationSchedule, preencher em caso de edição | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `liquidationSchedule` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |

Detalhe de `liquidationSchedule`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `amountInCents` | `integer (int64)` | obrigatório | — | — | `0` |
| `pixQrCode` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankSlip` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `pixKey` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `transfer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `informedDueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `pixQrCode`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `qrCode` | `string` | obrigatório | — | — | `"texto"` |

Detalhe de `bankSlip`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `barcodeOrDigitableLine` | `string` | obrigatório | — | — | `"texto"` |

Detalhe de `pixKey`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `key` | `string` | obrigatório | — | — | `"texto"` |
| `pixKeyType` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `transfer`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `to` | `objeto` | obrigatório | — | objeto — ver detalhe abaixo | `{ … }` |
| `type` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |

Detalhe de `to`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | obrigatório | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | obrigatório | — | — | `"12345678909"` |
| `bankCode` | `integer` | obrigatório | — | — | `0` |
| `bankIspb` | `integer (int64)` | obrigatório | — | — | `0` |
| `agency` | `string` | obrigatório | — | — | `"texto"` |
| `accountNumber` | `string` | obrigatório | — | — | `"texto"` |
| `accountType` | `string` | obrigatório | — | `NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount` | `"NaturalCheckingAccount"` |

Exemplo:

```json
{
  "liquidationScheduleItems": [
    {
      "liquidationScheduleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "liquidationSchedule": {
        "amountInCents": 0,
        "pixQrCode": {},
        "bankSlip": {},
        "pixKey": {},
        "transfer": {},
        "description": "texto",
        "informedDueDate": "2025-08-11T13:45:00Z"
      }
    }
  ]
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/paymentRevisionLiquidationSchedule" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "liquidationScheduleItems": [
    {
      "liquidationScheduleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "liquidationSchedule": {
        "amountInCents": 0,
        "pixQrCode": {},
        "bankSlip": {},
        "pixKey": {},
        "transfer": {},
        "description": "texto",
        "informedDueDate": "2025-08-11T13:45:00Z"
      }
    }
  ]
}'
```

---

### POST /v{version}/CreditNote/{id}/liquidationScheduleClosureRevision

**Criar Credit Note** — Cria um novo registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `changeBankAccount` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |

Detalhe de `changeBankAccount`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `id` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `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 | — | `NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount` | `"NaturalCheckingAccount"` |
| `jointAccount` | `boolean` | opcional | — | — | `true` |
| `operationTypeValue` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |
| `pixKeyTypeValue` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `keyPix` | `string` | opcional | Chave Pix | — | `"texto"` |

Detalhe de `ownerUser`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `ownerGroup`:

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

Exemplo:

```json
{
  "changeBankAccount": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bankCode": 0,
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "NaturalCheckingAccount",
    "jointAccount": true,
    "operationTypeValue": "Transfer",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "keyPix": "texto"
  }
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/liquidationScheduleClosureRevision" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "changeBankAccount": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bankCode": 0,
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "NaturalCheckingAccount",
    "jointAccount": true,
    "operationTypeValue": "Transfer",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "keyPix": "texto"
  }
}'
```

---

### POST /v{version}/CreditNote/{id}/cancel

**Criar Credit Note** — Cria um novo registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |
| `checkAverbacao` | query | `boolean` | opcional | — | `true` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `message` | `string` | opcional | — | — | `"texto"` |
| `insertBlock` | `string` | opcional | — | `Person`, `Operation` | `"Person"` |
| `blockUntil` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `attributeTypes` | `array de string` | opcional | — | `zipcode`, `email`, `phone`, `documentnumber`, `ispb`, `registrationnumber` | `[ … ]` |
| `rejectionReasonCode` | `array de string` | opcional | — | — | `[ … ]` |

Exemplo:

```json
{
  "message": "texto",
  "insertBlock": "Person",
  "blockUntil": "2025-08-11T13:45:00Z",
  "attributeTypes": [
    "zipcode"
  ],
  "rejectionReasonCode": [
    "texto"
  ]
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/cancel" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "message": "texto",
  "insertBlock": "Person",
  "blockUntil": "2025-08-11T13:45:00Z",
  "attributeTypes": [
    "zipcode"
  ],
  "rejectionReasonCode": [
    "texto"
  ]
}'
```

---

### POST /v{version}/CreditNote/batch/cancel

**Criar Credit Note** — Cria um novo registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `version` | path | `string` | obrigatório | — | `1` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `creditNoteIds` | `array de string (uuid)` | opcional | — | — | `[ … ]` |
| `message` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `checkAverbacao` | `boolean` | opcional | — | — | `true` |

Detalhe de `message`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `message` | `string` | opcional | — | — | `"texto"` |
| `insertBlock` | `string` | opcional | — | `Person`, `Operation` | `"Person"` |
| `blockUntil` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `attributeTypes` | `array de string` | opcional | — | `zipcode`, `email`, `phone`, `documentnumber`, `ispb`, `registrationnumber` | `[ … ]` |
| `rejectionReasonCode` | `array de string` | opcional | — | — | `[ … ]` |

Exemplo:

```json
{
  "creditNoteIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "message": {
    "message": "texto",
    "insertBlock": "Person",
    "blockUntil": "2025-08-11T13:45:00Z",
    "attributeTypes": [
      "zipcode"
    ],
    "rejectionReasonCode": [
      "texto"
    ]
  },
  "checkAverbacao": true
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/batch/cancel" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "creditNoteIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "message": {
    "message": "texto",
    "insertBlock": "Person",
    "blockUntil": "2025-08-11T13:45:00Z",
    "attributeTypes": [
      "zipcode"
    ],
    "rejectionReasonCode": [
      "texto"
    ]
  },
  "checkAverbacao": true
}'
```

---

### GET /v{version}/CreditNote/{id}/transferReceipt

**Obtém o recibo de transferência relacionada à operação** — Lista e filtra registros de Credit Note.

Obtém o recibo de transferência relacionada à operação.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/transferReceipt" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /v{version}/CreditNote/{id}/restore

**Restaura Operação de Crédito excluída** — Cria um novo registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/restore" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v{version}/CreditNote/{id}/SignUrl

**Obtém as URLs de assinaturas relacionadas à operação** — Lista e filtra registros de Credit Note.

Obtém as URLs de assinaturas relacionadas à operação.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `creditNoteId` | `string (uuid)` | opcional | Id da operação de crédito | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `personId` | `string (uuid)` | opcional | Id do tomador da operação de crédito | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `personCellPhone` | `string` | opcional | Telefone celular do tomador | — | `"11987654321"` |
| `personEmail` | `string` | opcional | Email do tomador | — | `"cliente@exemplo.com.br"` |
| `url` | `string` | opcional | Link de assinatura do contrato | — | `"https://exemplo.com.br/callback"` |
| `createdAt` | `string (date-time)` | opcional | Data de criação do link | — | `"2025-08-11T13:45:00Z"` |
| `displayName` | `string` | opcional | Nome do tomador da operação | — | `"Fulano de Tal"` |

Exemplo:

```json
[
  {
    "creditNoteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "personCellPhone": "11987654321",
    "personEmail": "cliente@exemplo.com.br",
    "url": "https://exemplo.com.br/callback",
    "createdAt": "2025-08-11T13:45:00Z",
    "displayName": "Fulano de Tal"
  }
]
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/SignUrl" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /v{version}/CreditNote/{id}/Installment

**Criar Credit Note** — Cria um novo registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `walletCode` | `integer (int64)` | opcional | — | — | `0` |
| `billingSettingId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `communicationSettingId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |

Exemplo:

```json
{
  "walletCode": 0,
  "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "communicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/Installment" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "walletCode": 0,
  "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "communicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'
```

---

### POST /v{version}/CreditNote/{id}/Share

**Criar Credit Note** — Cria um novo registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `principalType` | `string` | opcional | — | `User`, `Group`, `Tenant`, `Application` | `"User"` |
| `principalId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `permissionLevel` | `string` | opcional | — | `View`, `Edit` | `"View"` |

Exemplo:

```json
{
  "principalType": "User",
  "principalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "permissionLevel": "View"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/Share" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "principalType": "User",
  "principalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "permissionLevel": "View"
}'
```

---

### PATCH /v{version}/CreditNote/FixDueDate

**Atualizar Credit Note** — Atualiza parcialmente um registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `version` | path | `string` | obrigatório | — | `1` |

**Corpo da requisição** (`application/json`, lista/array)

Exemplo:

```json
[
  "3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X PATCH "{{baseUrl}}/v1/CreditNote/FixDueDate" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '[
  "3fa85f64-5717-4562-b3fc-2c963f66afa6"
]'
```

---