API FlashAPI FlashAPI Flash
  • Guias
  • Especificação de API
Geral
Empresas
Colaboradores
Candidatos
Beneficios
Cartão Corporativo
Cargos
Centros de custo
Controle de jornada
Departamentos
Grupos
PII
    Buscar PII do ColaboradorAtualizar PII do Colaborador
Despesas
Férias
Pagamentos
powered by Zudoku
PII

​Buscar PII do Colaborador

Este endpoint permite buscar os dados sensíveis de um colaborador usando seu identificador único.

URL: /core/v1/pii/employees/{employeeId}/pii
Método: GET
Descrição: Retorna o PII de um colaborador pelo seu ID

Headers:

  • Content-Type: 'application/json'
  • x-flash-auth: <chave_de_api>

Parâmetros:

  • employeeId: string (ID do colaborador) *

[*] Campo obrigatório

Campos retornados:

  • id: string (Identificador do colaborador) *
  • address: AddressDTO (Endereço do colaborador)
  • banking: BankingDTO (Dados bancários)
  • birthDate: string (Data de nascimento em formato ISO)
  • gender: string (Gênero)
  • maritalStatus: string (Estado civil)
  • nationality: string (Nacionalidade)
  • pis: string (Número do PIS)
  • socialName: string (Nome social)

Campos de AddressDTO:

  • city: string
  • complement: string
  • district: string
  • number: string
  • state: string
  • street: string
  • zipCode: string

Campos de BankingDTO:

  • accountNumber: string
  • accountType: 'checking' | 'savings'
  • bankCode: string
  • bankName: string
  • branch: string

Resposta de Sucesso:

{ "id": "emp_123", "socialName": "nome-social-01", "nationality": "Brasileira", "birthDate": "1990-04-16T00:00:00.000Z", "gender": "male", "maritalStatus": "single", "pis": "12345678901", "address": { "city": "cidade-01", "complement": "Apto 12", "district": "bairro-01", "number": "01", "state": "SP", "street": "Rua A", "zipCode": "00000-000" }, "banking": { "accountNumber": "12345-6", "accountType": "checking", "bankCode": "341", "bankName": "banco-001", "branch": "1234" } }
json

Possíveis erros:

  • 404 → colaborador não encontrado
  • 403 → usuário não autenticado/autorizado

Remover Colaborador do GrupoAtualizar PII do Colaborador