Criar um usuário interno para uma Companhia Produtora
Descrição: Cria um novo usuário interno.
Endpoint
POST/api/v1/integration/producer-users/-/producers/{producer_id}
Regras
Atributos | Descrição | Tipo | Obrigatório | Validações |
---|---|---|---|---|
auth | Tipo de autenticação exigida para confirmação de autenticidade do usuário | Enum | Sim | Enumerador (EMAIL, SMS, WHATSAPP) |
default_signer | Usuário é o signatário padrão da Companhia Produtora? | Boolean | Sim | Apenas valores booleanos |
delivery | Informa como o signatário receberá as notificações | Enum | Sim | Enumerador (EMAIL, NONE) |
phone_number | Telefone celular de contato | String | Sim | Formato +5511999999999 |
Email de contato | String | Não | Formatação de e-mail com @ e provedor | |
sign_as | O usuário irá assinar como testemunha ou representante legal | Enum | Sim | Enumerador (WITNESS, LEGAL_REPRESENTATIVE) |
full_name | Nome completo | String | Sim | Até 255 caracteres |
social_identity | CPF | String | Sim | Apenas números. 11 dígitos. Validação do CPF |
Exemplo de Requisição
Exemplo de Requisição
curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://homolog.api.merx.tech/api/v1/integration/producer-users/-/producers/{producer_id}"
Parâmetros
Parâmetros de Caminho:
Nome | Descrição | Tipo | Obrigatório |
---|---|---|---|
producer_id | Identificador da Companhia Produtora | String | Sim |
Parâmetros de Cabeçalho
Nome | Descrição | Tipo | Obrigatório |
---|---|---|---|
Authorization | String | Sim |
Parâmetros do Corpo
Nome | Descrição | Tipo | Obrigatório |
---|---|---|---|
auth | Tipo de autenticação exigida | String | Sim |
default_signer | Usuário é o signatário padrão da Companhia Produtora? | Boolean | Sim |
delivery | Informa como o signatário receberá as notificações | String | Sim |
phone_number | Telefone celular de contato | String | Sim |
Email de contato | String | Não | |
sign_as | O usuário irá assinar como testemunha ou representante legal | String | Sim |
full_name | Nome completo | String | Sim |
social_identity | CPF | String | Sim |
Respostas
- 200 - Ok
{
"id": "string"
}
- 400 - Bad Request
{
"timestamp": "string (date-time)",
"status": "integer (int32)",
"error": "string"
}
401 - Unauthorized
404 - NotFound