Criar um Usuário Participante

Descrição: Cria um novo usuário participante.

Endpoint

POST/api/v1/integration/guest-users/-/producers/{producer_id}

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
email	E-mail de contato	String	Sim	Formatação de e-mail com @ e provedor e deve ser único
social_security	CPF do usuários	String	Sim	Somente números.
identity_card	RG do usuário	String	Não	Até 30 caracteres / Verifica a Regex
marital_status	Estado civil	Enum	Não	NOT_MARRIED, MARRIED, SEPARATE, DIVORCED, WIDOWER
name	Nome Completo	String	Sim	Até 50 caracteres
phone	Número de celular para contato	String	Não	Atender ao formato +5511999999999
address.city	Cidade	String	Não	Até 250 caracteres
address.country	País	String	Não	Até 50 caracteres
address.neighborhood	Bairro	String	Não	Até 250 caracteres
address.number	Número	String	Não	Apenas números
address.state	Estado	String	Não	Até 2 caracteres (Sigla)
address.street	Rua	String	Não	Até 250 caracteres
address.complement	Complemento	String	Não	Até 250 caracteres
address.zip_code	CEP	String	Não	CEP com "-"
signer.default_signer	Usuário é o signatário padrão	Bool	Sim	Apenas valores booleanos
signer.sign_as	O usuário irá assinar como testemunha ou representante legal	Enum	Sim	WITNESS, LEGAL_REPRESENTATIVE
signer.auth	Tipo de autenticação exigida para confirmação do usuário no momento da assinatura do contrato	Enum	Sim	EMAIL, SMS, WHATSAPP
signer.delivery	Informa como o signatário receberá as notificações de confirmação de assinatura e de documento finalizado	Enum	Sim	EMAIL, NONE

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/guest-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	Validações / Enumeradores
address	Endereço	Object	Sim	-
address.street	Rua	String	Sim	-
address.number	Número	String	-	-
address.complement	Complemento	String	-	-
address.neighborhood	Bairro	String	Sim	-
address.zip_code	CEP	String	Sim	-
address.city	Cidade	String	Sim	-
address.state	Estado	String	Sim	-
address.country	País	String	Sim	-
email	E-mail	String	Sim	-
full_name	Nome completo	String	Sim	-
identity_card	Cartão de identidade	String	Sim	Padrão: ^[a-zA-Z0-9]*$
sign_as	Assinar como	String	Sim	WITNESS, LEGAL_REPRESENTATIVE
signer	Signatário	Object	Sim	-
signer.auth	Autenticação	String	Sim	-
signer.delivery	Entrega	String	Sim	-
signer.company_id	ID da empresa	-	Sim	-
signer.default_signer	Signatário padrão	Boolean	Sim	-
signer.identity_id	ID de identidade	-	Sim	-
signer.name	Nome	String	Sim	-
signer.phone_number	Número de telefone	String	Sim	-
signer.sign_as	Assinar como	String	Sim	-
signer.type	Tipo	-	Sim	-
socialSecurity	Segurança social	String	Sim	-
social_security	Segurança social	String	Sim	Padrão: ^[a-zA-Z0-9]*$
default_signer	Signatário padrão	Boolean	-	-
marital_status	Estado civil	String	-	NOT_MARRIED, MARRIED, SEPARATE, DIVORCED, WIDOWER
phone_number	Número de telefone	String	-	-

Respostas

• 200 - Ok

{
    "id": "string"
}

• 400 - Bad Request

{
    "timestamp": "string (date-time)",
    "status": "integer (int32)",
    "error": "string"
}

• 401 - Unauthorized

• 404 - NotFound