Buscar Employee

Retorna os dados cadastrais de um trabalhador a partir do seu publicId. Utilize este endpoint para verificar os dados de um employee antes de iniciar o fluxo de originação ou para consultar o status atual do cadastro.

Parâmetros

Parâmetro	Local	Tipo	Descrição
publicId	path	string	Identificador público do employee (recebido na criação)

Buscar Employee

get

https://consignado.staging.giro.techhttps://consignado.giro.tech

/api/v1/originator/employees/{publicId}

Retorna os dados cadastrais de um trabalhador a partir do publicId.

Autorizações

BearerAuth

AuthorizationstringObrigatório

JWT token fornecido pelo administrador

Parâmetros de rota

publicIdstringObrigatório

Public ID do employee

Respostas

200

Employee retornado com sucesso

application/json

idinteger · int64Opcional

Identificador interno do trabalhador no sistema.

publicIdstringOpcional

Identificador público (16 caracteres Base64 URL-safe). Ex. Kj8mP2xQ9nR4sT6v

cpfstringOpcional

CPF do trabalhador cadastrado.

namestringOpcional

Nome civil completo do trabalhador.

birthDatestring · dateOpcional

Data de nascimento registrada.

motherNamestringOpcional

Nome completo da mãe registrado.

genderstring · enumOpcional

Gênero no cadastro.

Valor	Significado
MALE	Masculino
FEMALE	Feminino
NOT_INFORMED	Não informado

Valores possíveis:

idDocumentTypestring · enumOpcional

Mesmos valores de CreateEmployeeRequest.idDocumentType (ver tabela).

Valores possíveis:

idDocumentNumberstringOpcional

Número do documento de identificação registrado.

isPoliticallyExposedbooleanOpcional

Indicador de Pessoa Politicamente Exposta no cadastro do trabalhador.

phonestringOpcional

Telefone de contato registrado.

emailstringOpcional

E-mail registrado para contato.

partnerNamestringOpcional

Nome do cônjuge/parceiro registrado.

statusstring · enumOpcional

Situação cadastral do trabalhador.

Valor	Significado
ACTIVE	Cadastro ativo, pode operar
INACTIVE	Cadastro inativo (ex.: desligado)
REVOKED	Acesso revogado pelo originator

Valores possíveis:

createdDatestring · date-timeOpcional

Data e hora de criação do cadastro no sistema (UTC).

lastModifiedDatestring · date-timeOpcional

Data e hora da última atualização do cadastro (UTC).

401

Não autenticado

403

Permissão insuficiente

404

Employee não encontrado

get

/api/v1/originator/employees/{publicId}

HTTPcURLJavaScriptPython

GET /api/v1/originator/employees/{publicId} HTTP/1.1
Host: consignado.staging.giro.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 15,
  "publicId": "Kj8mP2xQ9nR4sT6v",
  "cpf": "12345678901",
  "name": "João da Silva",
  "birthDate": "1990-05-20",
  "phone": "11987654321",
  "email": "[email protected]",
  "status": "ACTIVE",
  "createdDate": "2025-01-10T14:30:00Z",
  "lastModifiedDate": "2025-01-10T14:30:00Z"
}

Central de Atendimento | Giro.TechGiro.Tech