Buscar informações do usuário interno através do CPF

Descrição: Buscar informações do usuário interno da comercializadora através do CPF.

Endpoint

GET/api/v1/integration/cooperative-users/-/{social_Id}:findBySocialId

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
social_Id	CPF	String	Sim	Somente números

Exemplo de Requisição

cURL

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

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/cooperative-users/-/98765432100:findBySocialId"))
    .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/cooperative-users/-/98765432100:findBySocialId',
  {
    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/cooperative-users/-/98765432100:findBySocialId"

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

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

Parâmetros

Parâmetros de Caminho:

Nome	Descrição	Tipo	Obrigatório
social_Id	CPF	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

Respostas

• 200 - Ok

{
    "id": "string",
    "username": "string",
    "given_name": "string",
    "family_name": "string",
    "phone_number": "string",
    "role": "string",
    "locale": "string",
    "zoneinfo": "string",
    "email": "string",
    "email_verified": true,
    "phone_verified": true,
    "enabled": true,
    "social_id": "string",
    "first_access": true,
    "preferred_username": "string",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "preferred_username_type": "string"
}

• 400 - Bad Request

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

• 401 - Unauthorized

• 404 - NotFound