Criar operador

POST 
/v1/operators

Cria um novo operador.

Request

Query Parameters

expand string
Expande as referências.
Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.
Example: data.loan
fields string

Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

Examples:

inclusao

Retorna apenas os campos `id` e `createdAt`.

Example: id,createdAt

exclusao

Retorna todos os campos, exceto `id`.

Example: -id

Header Parameters

Idempotency-Key string
Chave única de idempotência para evitar duplicação de requisições.
Example: 5f92f01728e009f403d8502e
base39-external-client-id string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.

application/json

Body

document stringrequired

O documento do operador sem pontuação.

name stringrequired

O nome completo do operador ou o nome da empresa.

email stringrequired

O endereço de e-mail do operador.

username stringrequired

Nome de usuário para login. Pode ser qualquer valor único.

metadata object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

Responses

201

Retorna o objeto Operator se a criação for bem-sucedida; caso contrário, um erro.

application/json

Schema

Schema

id string
Identificador exclusivo para o objeto.
Example: oprt_5f92f01728e009f403d8502e
document string

O documento do operador sem pontuação.

name string

O nome completo do operador ou o nome da empresa.

email string

O endereço de e-mail do operador.

username string

Nome de usuário para login. Pode ser qualquer valor único.

permissions

object

url uri

Example: /v1/permissions?operator=oprt_62d9889bd3985729e5a048ef&starting_after=perm_62d9889bd3985729e5a048ef

hasMore boolean

data

object[]

Array [

id string

Identificador exclusivo para o objeto.

Example: perm_62d9889bd3985729e5a048ef

company stringrequired

O ID da companhia que o operador tem permissão para acessar. Para as roles do tipo financial, backoffice, backoffice_financial, backoffice_automation e administrator company pode assumir o valor * que representa todas as companhias.

Example: comp_62d9889bd3985729e5a048ef

roles string[]required

Possible values: [approver, financial, administrator, backoffice, backoffice_financial, backoffice_automation]

createdAt date-time

Data de criação do objeto

Example: 2023-08-25T22:38:41.134Z

updatedAt date-time

Data de alteração do objeto

Example: 2023-08-25T22:38:41.134Z

deleted boolean

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Default value: false

Example: false

createdBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

]

metadata object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

createdAt date-time
Data de criação do objeto
Example: 2023-08-25T22:38:41.134Z
updatedAt date-time
Data de alteração do objeto
Example: 2023-08-25T22:38:41.134Z
deleted boolean
Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.
Default value: false
Example: false

createdBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

Example (from schema)

{
  "id": "oprt_5f92f01728e009f403d8502e",
  "document": "string",
  "name": "string",
  "email": "string",
  "username": "string",
  "permissions": {
    "url": "/v1/permissions?operator=oprt_62d9889bd3985729e5a048ef&starting_after=perm_62d9889bd3985729e5a048ef",
    "hasMore": true,
    "data": [
      {
        "id": "perm_62d9889bd3985729e5a048ef",
        "company": "comp_62d9889bd3985729e5a048ef",
        "roles": [
          "approver"
        ],
        "createdAt": "2023-08-25T22:38:41.134Z",
        "updatedAt": "2023-08-25T22:38:41.134Z",
        "deleted": false,
        "createdBy": {
          "clientId": "client_identifier",
          "externalClientId": "string",
          "app": "backoffice"
        },
        "updatedBy": {
          "clientId": "client_identifier",
          "externalClientId": "string",
          "app": "backoffice"
        }
      }
    ]
  },
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z",
  "updatedAt": "2023-08-25T22:38:41.134Z",
  "deleted": false,
  "createdBy": {
    "clientId": "client_identifier",
    "externalClientId": "string",
    "app": "backoffice"
  },
  "updatedBy": {
    "clientId": "client_identifier",
    "externalClientId": "string",
    "app": "backoffice"
  }
}

Loading...