Corbee Gestão

Cadastro Corretores

POST

/api/v2/broker

Requisição

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Exemplo:

Authorization: Bearer ********************

Parâmetros Bodyapplication/json

string

requerido

cpf

string

requerido

cnpj

string

opcional

Requerido para cadastro de corretores Pessoa Jurídica (PJ).

razaoSocial

string

opcional

Requerido para cadastro de corretores Pessoa Jurídica (PJ).

tipoCorretor

enum<integer>

requerido

Valores permitidos:

123

status

enum<string>

opcional

Valores permitidos:

string

requerido

telefone

string

requerido

nome

string

requerido

dtNascimento

string

requerido

Formato: 'AAAA-MM-DD'

loja

integer

requerido

Pode ser obitido no endpoint de listagem de lojas:
https://docs.gestao.corbee.com.br/lojas

logradouro

string

requerido

Nome da rua, avenida ou via do endereço.

numero

string

requerido

bairro

string

requerido

cidade

integer

requerido

Pode ser obitido no endpoint de listagem de cidades:
https://docs.gestao.corbee.com.br/cidades

estado

integer

requerido

Pode ser obitido no endpoint de listagem de estados:
https://docs.gestao.corbee.com.br/estados

cep

string

requerido

gerente

integer

requerido

Pode ser obitido no endpoint de listagem de gerentes:
https://docs.gestao.corbee.com.br/gerentes

idCentroCusto

integer

requerido

Pode ser obitido no endpoint de listagem de centro de custos:
https://docs.gestao.corbee.com.br/centro-de-custos

idGrupoComissionamento

integer

opcional

Pode ser obitido no endpoint de listagem de grupo de comissionamento:
https://docs.gestao.corbee.com.br/grupos-de-comissionamento

recebimento

array [object {8}]

requerido

tipo

enum<string>

requerido

Valores permitidos:

cccpdinheirochequepix

nomeFavorecido

string

opcional

documentoFavorecido

string

requerido

CPF ou CNPJ

banco

string

opcional

agencia

string

opcional

conta

string

opcional

chavePix

string

opcional

Obrigarória se o tipo de recebimento for 'pix'

tipoChavePix

enum<string>

opcional

Obrigarória se o tipo de recebimento for 'pix'

Valores permitidos:

cpfcnpjcelularemailaleatoria

permissoes

array [object {10}]

requerido

cadastroPropostaAreaCorretor

boolean

requerido

cadastroPropostaSimplificado

boolean

requerido

cadastroRefinanciamento

boolean

requerido

cadastroPropostaFGTS

boolean

requerido

visualizarComissao

boolean

requerido

exibirBonus

boolean

requerido

exibirStatusBanco

boolean

requerido

abrirChamados

boolean

requerido

digitacaoAutomaticaBanco

boolean

requerido

bloqueioPagamentos

array [object {5}]

requerido

Exemplo

{
  "login": "teste05",
  "cpf": "13122343365",
  "cnpj": "",
  "razaoSocial": "",
  "tipoCorretor": 1,
  "status": "A",
  "email": "email@gamil.com",
  "telefone": "(11)98776-5432",
  "nome": "Corretor Teste",
  "dtNascimento": "1999-10-23",
  "loja": 1,
  "logradouro": "Rua teste",
  "numero": "44",
  "bairro": "Centro",
  "cidade": 11791,
  "estado": 21,
  "cep": "01404001",
  "gerente": 2,
  "idCentroCusto": 1,
  "idGrupoComissionamento": 3,
  "recebimento": [
    {
      "tipo": "cc",
      "nomeFavorecido": "Corretor Teste",
      "documentoFavorecido": "13122343365",
      "banco": "001",
      "agencia": "1234",
      "conta": "12345",
      "tipoChavePix": "cpf",
      "chavePix": "13122343365"
    }
  ],
  "permissoes": [
    {
      "cadastroPropostaAreaCorretor": true,
      "cadastroPropostaSimplificado": false,
      "cadastroRefinanciamento": false,
      "cadastroPropostaFGTS": false,
      "visualizarComissao": false,
      "exibirBonus": false,
      "exibirStatusBanco": false,
      "abrirChamados": false,
      "digitacaoAutomaticaBanco": false,
      "bloqueioPagamentos": [
        {
          "pendenciaQuantidade": true,
          "pendenciaDias": true,
          "fisicoQuantidade": true,
          "fisicoDias": true,
          "pagarSemFisico": false
        }
      ]
    }
  ]
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://demo.corbee.com.br/api/v2/broker' \
--header 'Content-Type: application/json' \
--data-raw '{
  "login": "teste05",
  "cpf": "13122343365",
  "cnpj": "",
  "razaoSocial": "",
  "tipoCorretor": 1,
  "status": "A",
  "email": "email@gamil.com",
  "telefone": "(11)98776-5432",
  "nome": "Corretor Teste",
  "dtNascimento": "1999-10-23",
  "loja": 1,
  "logradouro": "Rua teste",
  "numero": "44",
  "bairro": "Centro",
  "cidade": 11791,
  "estado": 21,
  "cep": "01404001",
  "gerente": 2,
  "idCentroCusto": 1,
  "idGrupoComissionamento": 3,
  "recebimento": [
    {
      "tipo": "cc",
      "nomeFavorecido": "Corretor Teste",
      "documentoFavorecido": "13122343365",
      "banco": "001",
      "agencia": "1234",
      "conta": "12345",
      "tipoChavePix": "cpf",
      "chavePix": "13122343365"
    }
  ],
  "permissoes": [
    {
      "cadastroPropostaAreaCorretor": true,
      "cadastroPropostaSimplificado": false,
      "cadastroRefinanciamento": false,
      "cadastroPropostaFGTS": false,
      "visualizarComissao": false,
      "exibirBonus": false,
      "exibirStatusBanco": false,
      "abrirChamados": false,
      "digitacaoAutomaticaBanco": false,
      "bloqueioPagamentos": [
        {
          "pendenciaQuantidade": true,
          "pendenciaDias": true,
          "fisicoQuantidade": true,
          "fisicoDias": true,
          "pagarSemFisico": false
        }
      ]
    }
  ]
}'

Respostas

🟢200Success

application/json

Body

object {0}

Exemplo

{
  "status": "sucesso",
  "message": "Corretor cadastrado com sucesso.",
  "data": {
    "codigo": 869,
    "nome": "Corretor Teste",
    "login": "teste05",
    "senha": "A senha inicial corresponde ao CPF ou CNPJ (apenas números). No primeiro acesso, será obrigatória a troca dessa senha",
    "ticket": ""
  }
}

Página anterior

Tipos de Cancelamento

Próxima página

Atualização Corretores