Buscar usuário participante pelo identificador (ID)

Descrição: Busca os dados de um usuário participante pelo seu identificador único.

Endpoint

GET/api/v1/integration/guest-users/{guest_user_id}

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
guest_user_id	Identificador do usuário participante	UUID	Sim	-

Exemplo de Requisição

cURL

curl -X GET \
  -H "Authorization: {SUA_API_KEY}" \
  "https://api.merx.tech/api/v1/integration/guest-users/{guest_user_id}"

Java

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

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/guest-users/{guest_user_id}"))
    .header("Authorization", "{SUA_API_KEY}")
    .GET()
    .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/{guest_user_id}',
  {
    method: 'GET',
    headers: {
      'Authorization': '{SUA_API_KEY}',
    },
  }
);
const data = await response.json();
console.log(data);

Python

import requests

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

headers = {
    "Authorization": "{SUA_API_KEY}",
}

response = requests.get(url, headers=headers)
print(response.json())

Parâmetros

Parâmetros de Cabeçalho

Nome	Descrição	Tipo	Obrigatório
Authorization	Chave de API obtida via support-api@merx.tech	String	Sim

Parâmetros de Caminho:

Nome	Descrição	Tipo	Obrigatório
guest_user_id	Identificador do usuário participante	String	Sim

Respostas

• 200 - Ok

{
    "id": "string",
    "name": "string",
    "identity_card": "string",
    "phone": "string",
    "email": "string",
    "social_security": "string",
    "sign_as": "string",
    "default_signer": true,
    "address": {
        "street": "string",
        "number": "string",
        "complement": "string",
        "neighborhood": "string",
        "zip_code": "string",
        "city": "string",
        "state": "string",
        "country": "string"
    },
    "address_id": "string",
    "marital_status": "string",
    "company_id": "string",
    "auth": "string",
    "enabled": true,
    "removed": false,
    "created_at": "string",
    "updated_at": "string"
}

• 400 - Bad Request

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

• 401 - Unauthorized

• 404 - NotFound