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, API)
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	Email de contato	String	Não	Formatação de e-mail com @ e provedor, até 255 caracteres. phone_number é obrigatório em qualquer caso, mesmo quando o e-mail é informado.
sign_as	Papel com que o usuário assina o documento	Enum	Sim	Enumerador (SIGN, APPROVE, PARTY, WITNESS, INTERVENING, RECEIPT, ENDORSER, ENDORSEE, ADMINISTRATOR, GUARANTOR, TRANSFEROR, TRANSFEREE, CONTRACTEE, CONTRACTOR, JOINT_DEBTOR, ISSUER, MANAGER, BUYER, SELLER, ATTORNEY, LEGAL_REPRESENTATIVE, CO_RESPONSIBLE, VALIDATOR, RATIFY, LESSOR, LESSEE, SURETY)
full_name	Nome completo	String	Sim	Até 255 caracteres
social_id	CPF	String	Sim	Obrigatório, apenas dígitos (padrão ^\d+$), até 20 caracteres. A API não exige 11 dígitos nem valida o dígito verificador do CPF

Exemplo de Requisição

cURL

curl -X POST \
  -H "Authorization: {SUA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "full_name": "Carlos Eduardo Ferreira",
    "social_id": "98765432100",
    "phone_number": "+5511999999999",
    "email": "carlos.ferreira@cooperativa.com.br",
    "auth": "EMAIL",
    "delivery": "EMAIL",
    "sign_as": "LEGAL_REPRESENTATIVE",
    "default_signer": true
  }' \
  "https://api.merx.tech/api/v1/integration/producer-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 = "{\"full_name\": \"Carlos Eduardo Ferreira\", \"social_id\": \"98765432100\", \"phone_number\": \"+5511999999999\", \"email\": \"carlos.ferreira@cooperativa.com.br\", \"auth\": \"EMAIL\", \"delivery\": \"EMAIL\", \"sign_as\": \"LEGAL_REPRESENTATIVE\", \"default_signer\": true}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/producer-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/producer-users/-/producers/{producer_id}',
  {
    method: 'POST',
    headers: {
      'Authorization': '{SUA_API_KEY}',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      full_name: 'Carlos Eduardo Ferreira',
      social_id: '98765432100',
      phone_number: '+5511999999999',
      email: 'carlos.ferreira@cooperativa.com.br',
      auth: 'EMAIL',
      delivery: 'EMAIL',
      sign_as: 'LEGAL_REPRESENTATIVE',
      default_signer: true,
    }),
  }
);
const data = await response.json();
console.log(data);

Python

import requests

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

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

payload = {
    "full_name": "Carlos Eduardo Ferreira",
    "social_id": "98765432100",
    "phone_number": "+5511999999999",
    "email": "carlos.ferreira@cooperativa.com.br",
    "auth": "EMAIL",
    "delivery": "EMAIL",
    "sign_as": "LEGAL_REPRESENTATIVE",
    "default_signer": True
}

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

SDK Java

import com.merx.sdk.api.MerxClient;
import com.merx.sdk.core.Environment;
import com.merx.sdk.model.identity.producer.CreateProducerUserRequest;
import java.util.UUID;

MerxClient merx = MerxClient.builder()
    .apiKey("{SUA_API_KEY}")
    .environment(Environment.SANDBOX)
    .build();

var id = merx.producerUsers().create(UUID.fromString("00000000-0000-0000-0000-000000000000"),
    CreateProducerUserRequest.builder()
        .fullName("Fulano de Tal")
        .socialId("12345678900")
        .email("fulano@demo.coop")
        .build());

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
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	Email de contato	String	Não
sign_as	Papel com que o usuário assina o documento	String	Sim
full_name	Nome completo	String	Sim
social_id	CPF	String	Sim
rne	Registro Nacional de Estrangeiro	String	Não
passport_number	Número do passaporte	String	Não
address_id	Identificador do endereço	UUID	Não
company_id	Identificador da empresa	UUID	Não
password	Senha do usuário	String	Não
given_name	Primeiro nome	String	Não
family_name	Sobrenome	String	Não
locale	Locale do usuário (ex: pt-BR)	String	Não
zoneinfo	Fuso horário do usuário	String	Não
preferred_username_type	Tipo de username preferido (EMAIL, PHONE_NUMBER, RNE, PASSPORT_NUMBER, CPF, CNPJ)	String	Não
preferred_username	Username preferido	String	Não
first_access	Indica se é o primeiro acesso	Boolean	Não
type	Tipo do signatário (ORIGINATOR, PRODUCER, EXTERNAL)	String	Não

Respostas

• 200 - Ok

{
    "id": "string"
}

• 400 - Bad Request

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

• 401 - Unauthorized

• 404 - NotFound