Adicionar um operador a uma conta

Cria um novo registro de Bank Account.

Visão geral

Autenticação e pré-requisitos

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

Pré-requisitos: a rota exige identificador(es) de recurso já existente(s):

id — —

Request

Parâmetros

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

Corpo da requisição

Envie no formato application/json. Corpo obrigatório.

Campos

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

Exemplo de corpo

{
  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tenantName": "Fulano de Tal",
  "level": "Viewer"
}

Response

Resposta 200.

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`id`	`string`	opcional	—	—	`"texto"`
`createdAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`createdBy`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`tenant`	`string`	opcional	—	—	`"texto"`
`tenantDisplay`	`string`	opcional	—	—	`"texto"`
`updatedAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`updatedBy`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`ownerUser`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`ownerGroup`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`user`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`userId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`level`	`string`	opcional	—	—	`"texto"`
`levelDisplay`	`string`	opcional	—	—	`"texto"`
`status`	`string`	opcional	—	—	`"texto"`
`statusDisplay`	`string`	opcional	—	—	`"texto"`
`isDeleted`	`boolean`	opcional	—	—	`true`
`authorizedAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`bankAccountId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`accountNumber`	`integer (int64)`	opcional	—	—	`0`
`ownerNameAccount`	`string`	opcional	—	—	`"Fulano de Tal"`
`ownerAccountType`	`string`	opcional	—	—	`"texto"`
`bankAccountRequestId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`registrationNumber`	`string`	opcional	—	—	`"12345678909"`
`approvals`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`

Detalhe de `approvals`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`level`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`"Viewer"`
`action`	`string`	opcional	—	`Approve`, `Reject`, `Cancel`	`"Approve"`
`actionDisplay`	`string`	opcional	—	—	`"texto"`
`user`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`

Exemplo de resposta

{
  "id": "texto",
  "createdAt": "2025-08-11T13:45:00Z",
  "createdBy": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "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",
    "tenantName": "Fulano de Tal"
  },
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "texto",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupDisplay": "texto",
    "tenantDisplay": "texto"
  },
  "user": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "texto",
    "tenantName": "Fulano de Tal"
  },
  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "level": "texto",
  "levelDisplay": "texto",
  "status": "texto",
  "statusDisplay": "texto",
  "isDeleted": true,
  "authorizedAt": "2025-08-11T13:45:00Z",
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "accountNumber": 0,
  "ownerNameAccount": "Fulano de Tal",
  "ownerAccountType": "texto",
  "bankAccountRequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "registrationNumber": "12345678909",
  "approvals": [
    {
      "level": "Viewer",
      "action": "Approve",
      "actionDisplay": "texto",
      "user": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      }
    }
  ]
}

Códigos de retorno

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

Exemplos

curl -X POST "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Operator" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tenantName": "Fulano de Tal",
  "level": "Viewer"
}'

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

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

var rota = "/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Operator";

var corpo = new StringContent(
    """
    {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal",
      "level": "Viewer"
    }
    """,
    Encoding.UTF8, "application/json");

var resp = await http.PostAsync(rota, corpo);
resp.EnsureSuccessStatusCode();
var json = await resp.Content.ReadAsStringAsync();

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

const payload = {
  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tenantName": "Fulano de Tal",
  "level": "Viewer"
};

const resp = await fetch(`${baseUrl}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Operator`, {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(payload),
});

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

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

Downloads

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

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

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

Visão geral

Autenticação e pré-requisitos

Request

Parâmetros

Corpo da requisição

Campos

Exemplo de corpo

Response

Campos

Detalhe de approvals

Exemplo de resposta

Códigos de retorno

Exemplos

Downloads

Detalhe de `approvals`