v1

latestOpenAPI 3.1.02026-08-041120270.3 KB

/api/users/register

endpoint para realizar o cadastro do usuário

post/api/users/register

Request body

emailstring required

e-mail do usuário

fullNamestring required

nome completo do usuário

identificationTypeinteger

1 (Brasil) , 2 (Internacional). Caso utilize ID internacional, o campo CPF receberá a identificação. E não terá seu formato validado.

cpfstring required

CPF do usuário ou CNPJ do usuário | ou um ID internacional caso o identificationType seja 2.

phoneNumberstring

telefone

positionstring

cargo

userTypeinteger required

tipo de usuário (interno = 1 (com cnpjLicensedCompany) , externo = 2 (sem cnpjLicensedCompany))

passwordstring required

senha do usuário

changePasswordboolean required

flag para definir se o usuário deverá alterar a senha no primeiro login.

cnpjLicensedCompanystring

CNPJ da empresa licenciada ao qual o usuário será vinculado (obrigatório para usuários internos)

acceptedTermboolean

aceite dos termos de uso

Response

200

succeededboolean

descriptionstring

Example response

{
  "succeeded": true,
  "data": {
    "email": "email@empresa.com.br",
    "fullName": "Marcos Felipe",
    "cpf": "00011155595",
    "userType": 1,
    "changePassword": true,
    "userStatus": 1,
    "cnpjLicensedCompany": "53113791001285",
    "companyName": "TOTVS S/A - Fábricas de Software",
    "position": "Dev",
    "phoneNumber": "31999999999",
    "isPublisher": true,
    "identificationType": 1
  },
  "messages": [
    {
      "code": "Success",
      "description": "Usuário cadastrado com sucesso!"
    }
  ],
  "description": "Usuário cadastrado com sucesso!"
}