API Zen 2 - V2
  1. Gerenciador de Usuários
API Zen 2 - V2
  • API Zen 2 - V2
    • Raiz
      • Arquivos
        • Insere um anexo de documento no storage.
      • Autenticação
        • Realiza o login de um usuário na API utilizando e-mail e senha.
      • E-Doc
        • Consultar Pastas.
        • Cadastro de Documento.
        • Cancelar Documento.
      • Gerenciador de Empresas
        • Consulta informações sobre as empresas com base nos filtros fornecidos.
        • Cadastro de uma nova empresa no sistema.
        • Consulta informações sobre os departamentos com base nos filtros fornecidos.
        • Edição de uma empresa existente no sistema.
        • Consulta os grupos de empresas existentes no sistema, com base nos filtros fornecidos.
        • Consulta os perfis de acesso com base nos filtros fornecidos.
      • Gerenciador de Usuários
        • Criação de Usuário Empresa.
          POST
        • Consulta de Usuário(s) Empresa.
          GET
        • Vincular Usuário a Empresa(s).
          POST
        • Criação de Usuário Escritório.
          POST
        • Consulta de Usuário(s) Escritório.
          GET
      • Q-Colabore
        • Consultar Pastas.
        • Cancelar Documento.
        • Cadastro de Documento.
      • Q-Drive Documentos Fiscais
        • Realiza a importação de documentos fiscais, incluindo NF-e, CT-e, CT-e OS, NFC-e, CF-e e seus respectivos eventos.
      • Q-Drive NFS-e
        • Realiza a importação de Notas Fiscais de Serviço Eletrônica (NFS-e).
    • Esquemas
      • Schemas
        • AtivoInativoEnum
        • CadastroDocumentoEdocApiModel
        • CadastroDocumentoQcolaboreApiModel
        • ConsultaEmpresaModel
        • ConsultaUsuarioEmpresaModel
        • ConsultaUsuarioEscritorioModel
        • ConsultarPastasApiModel_EdocSubpastaApiModel
        • ConsultarPastasApiModel_QColaboreSubpastaApiModel
        • DFe_Classes_Flags_TipoAmbiente
        • DepartamentoRetornoApiModel
        • DownloadArquivoRetornoApiModel
        • EditarEmpresaApiModel
        • EdocSubpastaApiModel
        • EmpresaCadastroDocumentoApi
        • EmpresaRetornoApiModel
        • EnderecoApiModel
        • EnderecoEmpresa
        • GrupoEmpresaRetornoApiModel
        • InformacoesAdicionaisApiModel
        • InformacoesAdicionaisEmpresa
        • InserirEmpresaApiModel
        • InserirUsuarioEscritorioApiModel
        • LoginRetornoApi
        • LoginUsuarioApiV2Model
        • PerfilAcessoRetornoApiModel
        • PerfilTareffaApi
        • QColaboreSubpastaApiModel
        • QuestorZen_Application_Edoc_Models_CadastroDocumentoQcolaboreApiModel_EmpresaCadastroDocumentoApi
        • RegimeTributarioEnum
        • ResultadoImportacao
        • ResumoArquivoImportacao
        • RetornoApi
        • RetornoApi_ConsultaUsuarioEmpresaModel
        • RetornoApi_DepartamentoRetornoApiModel
        • RetornoApi_EmpresaRetornoApiModel
        • RetornoApi_GrupoEmpresaRetornoApiModel
        • RetornoApi_IEnumerable_ConsultaUsuarioEscritorioModel
        • RetornoApi_IEnumerable_ConsultarPastasApiModel_EdocSubpastaApiModel
        • RetornoApi_IEnumerable_ConsultarPastasApiModel_QColaboreSubpastaApiModel
        • RetornoApi_IEnumerable_DownloadArquivoRetornoApiModel
        • RetornoApi_Int64
        • RetornoApi_LoginRetornoApi
        • RetornoApi_Object
        • RetornoApi_PerfilAcessoRetornoApiModel
        • RetornoApi_ResultadoImportacao
        • RetornoApi_String
        • TipoAmbiente
        • TipoDepartamento
        • TipoDocumentoFiscal
        • TipoFone
        • TipoInscricao
        • UsuarioDestino
        • UsuarioDestinoEdoc
        • UsuarioEmpresaApiModel
        • VinculoEmpresaUsuarioApiV2Model
  1. Gerenciador de Usuários

Criação de Usuário Escritório.

POST
/v2/Usuarios/Escritorios
Este endpoint cria um novo usuário do tipo escritório. Além de realizar validações nos dados fornecidos, o processo inclui o envio de um e-mail para o novo usuário, confirmando o cadastro e permitindo o acesso ao sistema. A criação do usuário também envolve a verificação do e-mail fornecido para garantir que não esteja vinculado a outro usuário.
Validações:
Verificação se o corpo da requisição não é nulo ou contém campos inválidos.
Verificação se o e-mail informado já está vinculado a um usuário do tipo "Escritório", "Empresa" ou "Suporte".
Exemplo de Requisição (Rota):
Exemplo de Requisição (Body JSON):
{
  "Email": "maria.santos@exemplo.com",
  "Nome": "Maria Santos",
  "Cpf": "123.456.789-00",
  "Celular": "+55 11 98765-4321"
}
Validações Executadas:
O campo Email é obrigatório e deve ser um e-mail válido.
O campo Nome é obrigatório.
O campo Cpf deve conter 11 dígitos.
O campo Celular deve seguir o padrão internacional +55 XX XXXXX-XXXX.
Exemplo de Resposta de Sucesso (200 - OK):
{
  "sucesso": true,
  "mensagem": "Usuário do Escritório registrado com Sucesso.",
  "dados": null
}
Exemplo de Resposta de Erro (400 - Bad Request):
{
  "sucesso": false,
  "mensagens": "O corpo da requisição está nulo ou contém campos inválidos.",
  "dados": null
}

Requisição

Authorization
API Key
Adicionar parâmetro em header
Authorization
Exemplo:
Authorization: ********************
or
Parâmetros Bodyapplication/json

Examples

Respostas

🟢200OK
application/json
Usuário criado com sucesso.
Body

🟠400Solicitação incorreta
🟠404Não encontrado
🟠409Conflito
🔴500Erro interno do servidor
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v2/Usuarios/Escritorios' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "string",
    "nome": "string",
    "cpf": "string",
    "celular": "string",
    "sincronizarTareffa": true
}'
Response Response Example
200 - Exemplo 1
{
    "sucesso": true,
    "mensagens": "string",
    "dados": null
}
Modificado em 2025-09-24 14:39:45
Página anterior
Vincular Usuário a Empresa(s).
Próxima página
Consulta de Usuário(s) Escritório.
Built with