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ário	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
company_id	Identificador da empresa	String	Não	-
address	Endereço do usuário	Object	Não	-
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

cURL

curl -X POST \
  -H "Authorization: {SUA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Maria Oliveira",
    "social_security": "98765432100",
    "email": "maria.oliveira@parceiro.com.br",
    "phone": "+5511999999999",
    "identity_card": "MG1234567",
    "marital_status": "NOT_MARRIED",
    "signer": {
      "auth": "EMAIL",
      "delivery": "EMAIL",
      "default_signer": true,
      "sign_as": "LEGAL_REPRESENTATIVE"
    }
  }' \
  "https://api.merx.tech/api/v1/integration/guest-users/-/producers/{producer_id}"

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

String body = "{\"name\": \"Maria Oliveira\", \"social_security\": \"98765432100\", \"email\": \"maria.oliveira@parceiro.com.br\", \"phone\": \"+5511999999999\", \"signer\": {\"auth\": \"EMAIL\", \"delivery\": \"EMAIL\", \"default_signer\": true, \"sign_as\": \"LEGAL_REPRESENTATIVE\"}}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/guest-users/-/producers/{producer_id}"))
    .header("Authorization", "{SUA_API_KEY}")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();

HttpClient client = HttpClient.newHttpClient();
try {
    HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
} catch (Exception e) {
    e.printStackTrace();
}

JavaScript

const response = await fetch(
  'https://api.merx.tech/api/v1/integration/guest-users/-/producers/{producer_id}',
  {
    method: 'POST',
    headers: {
      'Authorization': '{SUA_API_KEY}',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      name: 'Maria Oliveira',
      social_security: '98765432100',
      email: 'maria.oliveira@parceiro.com.br',
      phone: '+5511999999999',
      identity_card: 'MG1234567',
      marital_status: 'NOT_MARRIED',
      signer: {
        auth: 'EMAIL',
        delivery: 'EMAIL',
        default_signer: true,
        sign_as: 'LEGAL_REPRESENTATIVE',
      },
    }),
  }
);
const data = await response.json();
console.log(data);

Python

import requests

url = "https://api.merx.tech/api/v1/integration/guest-users/-/producers/{producer_id}"

headers = {
    "Authorization": "{SUA_API_KEY}",
    "Content-Type": "application/json"
}

payload = {
    "name": "Maria Oliveira",
    "social_security": "98765432100",
    "email": "maria.oliveira@parceiro.com.br",
    "phone": "+5511999999999",
    "identity_card": "MG1234567",
    "marital_status": "NOT_MARRIED",
    "signer": {
        "auth": "EMAIL",
        "delivery": "EMAIL",
        "default_signer": True,
        "sign_as": "LEGAL_REPRESENTATIVE"
    }
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

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	Chave de API obtida via support-api@merx.tech	String	Sim
Content-Type	application/json	String	Sim

Parâmetros do Corpo

Nome	Descrição	Tipo	Obrigatório	Validações / Enumeradores
name	Nome completo	String	Sim	Até 50 caracteres
social_security	CPF do usuário	String	Sim	Somente números
email	E-mail	String	Sim	Formato e-mail válido
phone	Número de celular	String	Não	Formato +5511999999999
identity_card	Cartão de identidade (RG)	String	Não	Até 30 caracteres
marital_status	Estado civil	Enum	Não	NOT_MARRIED, MARRIED, SEPARATE, DIVORCED, WIDOWER
company_id	Identificador da empresa	String	Não	-
address	Endereço	Object	Não	-
address.street	Rua	String	Não	-
address.number	Número	String	Não	-
address.complement	Complemento	String	Não	-
address.neighborhood	Bairro	String	Não	-
address.zip_code	CEP	String	Não	-
address.city	Cidade	String	Não	-
address.state	Estado	String	Não	-
address.country	País	String	Não	-
signer.default_signer	Signatário padrão	Boolean	Sim	-
signer.sign_as	Assinar como	Enum	Sim	WITNESS, LEGAL_REPRESENTATIVE
signer.auth	Tipo de autenticação	Enum	Sim	EMAIL, SMS, WHATSAPP
signer.delivery	Entrega de notificações	Enum	Sim	EMAIL, NONE

Respostas

• 200 - Ok

{
    "id": "string"
}

• 400 - Bad Request

{
  "messages": ["message.entidade.campo-inválido"]
}

• 401 - Unauthorized

• 404 - NotFound