Skip to main content

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

AtributosDescriçãoTipoObrigatórioValidações
authTipo de autenticação exigida para confirmação de autenticidade do usuárioEnumSimEnumerador (EMAIL, SMS, WHATSAPP)
default_signerUsuário é o signatário padrão da Companhia Produtora?BooleanSimApenas valores booleanos
deliveryInforma como o signatário receberá as notificaçõesEnumSimEnumerador (EMAIL, NONE)
phone_numberTelefone celular de contatoStringSimFormato +5511999999999
emailEmail de contatoStringNãoFormatação de e-mail com @ e provedor
sign_asO usuário irá assinar como testemunha ou representante legalEnumSimEnumerador (WITNESS, LEGAL_REPRESENTATIVE)
full_nameNome completoStringSimAté 255 caracteres
social_identityCPFStringSimApenas 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:

NomeDescriçãoTipoObrigatório
producer_idIdentificador da Companhia ProdutoraStringSim

Parâmetros de Cabeçalho

NomeDescriçãoTipoObrigatório
AuthorizationStringSim

Parâmetros do Corpo

NomeDescriçãoTipoObrigatório
authTipo de autenticação exigidaStringSim
default_signerUsuário é o signatário padrão da Companhia Produtora?BooleanSim
deliveryInforma como o signatário receberá as notificaçõesStringSim
phone_numberTelefone celular de contatoStringSim
emailEmail de contatoStringNão
sign_asO usuário irá assinar como testemunha ou representante legalStringSim
full_nameNome completoStringSim
social_identityCPFStringSim

Respostas

  • 200 - Ok
{
"id": "string"
}
  • 400 - Bad Request
{
"timestamp": "string (date-time)",
"status": "integer (int32)",
"error": "string"
}
  • 401 - Unauthorized

  • 404 - NotFound