Pular para o conteúdo principal

Buscar usuário interno por CPF

Descrição: Busca um usuário interno de uma Companhia Produtora pelo CPF (social ID).

Endpoint

GET/api/v1/integration/producer-users/-/producers/{producer_id}/{social_id}:findBySocialId

Regras

AtributosDescriçãoTipoObrigatórioValidações
producer_idIdentificador da Companhia ProdutoraUUIDSim-
social_idCPF do usuárioStringSim-

Exemplo de Requisição

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

Parâmetros

Parâmetros de Caminho:

NomeDescriçãoTipoObrigatório
producer_idIdentificador da Companhia ProdutoraStringSim
social_idCPF do usuárioStringSim

Parâmetros de Cabeçalho

NomeDescriçãoTipoObrigatório
AuthorizationChave de API obtida via support-api@merx.techStringSim

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": false,
"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