### Sample JWT Token Response
Source: https://context7.com/lurizin/texto28sdj/llms.txt
Example JSON response containing the access token for API authentication. The token includes encoded user information and expiration details. This token must be included in the Authorization header of subsequent API requests.
```json
{
"access_token": "eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.eyJzdWIiOnsiaWQiOiIwZDhlODc5MS0yZmM4LTQ3YTctYjk5MC02MmQ5YzRmMzA3N2QiLCJ1c2VySWQiOiJmZTY2OTNhNC1iMWJlLTQ1ODQtYmZjYS1hNGJmZDVhNGE4ZTAiLCJ0eXBlIjoiYXBwbGljYXRpb24iLCJzY29wZXMiOiJhcGktY29uc3VsdGEtc2lhcGUifSwiaWF0IjoxNjE4OTQxNDUxLCJleHAiOjE2MTg5NDg2NTEsImF1ZCI6ImNvbmVjdGFnb3YtYXVkIiwiaXNzIjoiY29uZWN0YWdvdi1pc3MifQ.SaEz7N1COAggwTGOebknFhtSEbnGM1A5OJu6D1AH9I",
"token_type": "Bearer"
}
```
--------------------------------
### Get UORG Details via cURL
Source: https://context7.com/lurizin/texto28sdj/llms.txt
Retrieves detailed registration data for a specific organizational unit including address and contact information. Requires unit code and authentication. Response includes extended organizational metadata.
```bash
curl --location --request POST 'https://h-apigateway.conectagov.estaleiro.serpro.gov.br/api-consulta-siape/v1/consulta-siape' \
--header 'x-cpf-usuario: 12345678901' \
--header 'Authorization: Bearer eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9...' \
--header 'Content-Type: application/xml' \
--data-raw '
AAA
AAA
AAAA
12345678901
17000
000001234
'
```
--------------------------------
### Query Educational Background (Bash)
Source: https://context7.com/lurizin/texto28sdj/llms.txt
Retrieves an employee's educational background and academic titles using the 'consultaDadosEscolares' SOAP service. Requires CPF, system credentials, and organization parameters. Response includes educational level and title information.
```bash
curl --location --request POST 'https://h-apigateway.conectagov.estaleiro.serpro.gov.br/api-consulta-siape/v1/consulta-siape' \
--header 'x-cpf-usuario: 12345678901' \
--header 'Authorization: Bearer eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9...' \
--header 'Content-Type: application/xml' \
--data-raw '
AAA
AAA
AAAA
12345678901
17000
b
c
'
```
--------------------------------
### ListaServidores API
Source: https://github.com/lurizin/texto28sdj/blob/main/siape.txt
Retrieves a list of server CPF numbers linked directly to the input Uorg.
```APIDOC
## GET /servidores/listaServidores
### Description
This endpoint returns a list of CPF numbers associated with the provided Uorg.
### Method
GET
### Endpoint
/servidores/listaServidores
### Parameters
#### Query Parameters
- **CodOrgao** (Int) - Required - Code of the Organization
- **siglaOrgao** (String) - Required - Acronym of the Organization
- **CodUorg** (Int) - Required - Code of the Uorg
- **SiglaUorg** (String) - Required - Acronym of the Uorg
- **nomeUorg** (String) - Required - Name of the Uorg
- **nomeExtendido** (String) - Optional - Extended Name
- **codMunicipio** (Int) - Required - Municipality Code
- **nomeMunicipio** (String) - Required - Municipality Name
- **codUorgPai** (Int) - Required - Parent Uorg Code
- **codUorgPagadora** (Int) - Required - Paying Uorg Code
- **codUorgPessoal** (Int) - Optional - Personnel Uorg Code
- **indicadorUorgPessoal** (String) - Required - Personnel Uorg Indicator
- **indicadorUorgUpag** (String) - Required - Upag Uorg Indicator
- **codUnidadeSiafi** (Int) - Required - Siafi Unit Code
- **CnpjUpag** (Int) - Required - Upag CNPJ
- **dataCriacaoUorg** (Date) - Required - Uorg Creation Date
- **diplomaLegalCriacaoUorg** (String) - Required - Legal Diploma of Uorg Creation
- **indicadorUorgAdministrativa** (String) - Required - Administrative Uorg Indicator
- **IndicadorUorgRegimenta** (String) - Required - Regiment Uorg Indicator
- **identificacaoAntecedentesUorg** (String) - Required - Uorg Antecedents Identification
- **cnpjLocalizador** (Int) - Required - Locator CNPJ
- **indicadorUorgDestIntegracao** (String) - Required - Uorg Destination Integration Indicator
- **nomeUorgMaiusculo** (String) - Required - Uorg Name in Uppercase
- **codAreaAtuaUorg** (Int) - Required - Uorg Area of Operation Code
- **nomeAreaAtuaUorg** (String) - Required - Uorg Area of Operation Name
- **SiglaSistema** (String) - Required - System Acronym
- **NomeSistema** (String) - Required - System Name
- **Senha** (String) - Required - Password
- **Cpf** (String) - Required - CPF
- **CodOrgao** (String) - Required - Organization Code
- **CodUorg** (String) - Required - Uorg Code
### Response
#### Success Response (200)
- **cpf** (Int) - CPF of the server
- **dataUltimaTransacao** (Date) - Date of the last transaction
#### Response Example
{
"cpf": 12345678901,
"dataUltimaTransacao": "2023-10-27T10:00:00Z"
}
```
--------------------------------
### Query Bank Account Information (Bash)
Source: https://context7.com/lurizin/texto28sdj/llms.txt
Retrieves an employee's bank account details for salary payments using the 'consultaDadosBancarios' SOAP service. Requires CPF, system credentials, and organization parameters. Response includes bank, branch, and account numbers.
```bash
curl --location --request POST 'https://h-apigateway.conectagov.estaleiro.serpro.gov.br/api-consulta-siape/v1/consulta-siape' \
--header 'x-cpf-usuario: 12345678901' \
--header 'Authorization: Bearer eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9...' \
--header 'Content-Type: application/xml' \
--data-raw '
AAA
AAA
AAAA
12345678901
17000
b
c
'
```
--------------------------------
### POST /api-consulta-siape/v1/consulta-siape - consultaDadosCurriculo
Source: https://context7.com/lurizin/texto28sdj/llms.txt
Retrieves comprehensive curriculum information including academic formation, professional experience, commission participation, and language proficiency.
```APIDOC
## POST /api-consulta-siape/v1/consulta-siape
### Description
Retrieves comprehensive curriculum information including academic formation, professional experience, commission participation, and language proficiency.
### Method
POST
### Endpoint
/api-consulta-siape/v1/consulta-siape
### Parameters
#### Request Headers
- **x-cpf-usuario** (string) - Required - User CPF
- **Authorization** (string) - Required - Bearer token
- **Content-Type** (string) - Required - application/xml
#### Request Body
- **siglaSistema** (string) - Required - System acronym
- **nomeSistema** (string) - Required - System name
- **senha** (string) - Required - Password
- **cpf** (string) - Required - User CPF
- **codOrgao** (string) - Required - Organization code
- **parmExistPag** (string) - Required - Payment existence parameter
- **parmTipoVinculo** (string) - Required - Bond type parameter
### Request Example
```xml
AAA
AAA
AAAA
12345678901
17000
b
c
```
### Response
#### Success Response (200)
- **identificUnica** (string) - Unique identifier
- **CPF** (string) - User CPF
- **ExperienciaProfissional** (array) - Professional experience data
- **Cursos** (array) - Course data
- **ParticipacaoComissoes** (array) - Commission participation data
- **Idiomas** (array) - Language proficiency data
```
--------------------------------
### Query Curriculum Data via cURL
Source: https://context7.com/lurizin/texto28sdj/llms.txt
Retrieves comprehensive curriculum information including academic formation, professional experience, and language proficiency. Requires authentication via Bearer token and CPF header. Inputs include CPF, organization code, and parameters. Output includes multiple arrays of professional data.
```bash
curl --location --request POST 'https://h-apigateway.conectagov.estaleiro.serpro.gov.br/api-consulta-siape/v1/consulta-siape' \
--header 'x-cpf-usuario: 12345678901' \
--header 'Authorization: Bearer eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9...' \
--header 'Content-Type: application/xml' \
--data-raw '
AAA
AAA
AAAA
12345678901
17000
b
c
'
```
--------------------------------
### POST /api-consulta-siape/v1/consulta-siape - listaServidores
Source: https://context7.com/lurizin/texto28sdj/llms.txt
Retrieves list of employee CPFs directly linked to a specific organizational unit.
```APIDOC
## POST /api-consulta-siape/v1/consulta-siape
### Description
Retrieves list of employee CPFs directly linked to a specific organizational unit.
### Method
POST
### Endpoint
/api-consulta-siape/v1/consulta-siape
### Parameters
#### Request Headers
- **x-cpf-usuario** (string) - Required - User CPF
- **Authorization** (string) - Required - Bearer token
- **Content-Type** (string) - Required - application/xml
#### Request Body
- **siglaSistema** (string) - Required - System acronym
- **nomeSistema** (string) - Required - System name
- **senha** (string) - Required - Password
- **cpf** (string) - Required - User CPF
- **codOrgao** (string) - Required - Organization code
- **codUorg** (string) - Required - UORG code
### Request Example
```xml
AAA
AAA
AAAA
12345678901
17000
000001234
```
### Response
#### Success Response (200)
- **employees** (array) - List of employees with cpf, dataUltimaTransacao
```
--------------------------------
### Query Instituted Pensions - Bash
Source: https://context7.com/lurizin/texto28sdj/llms.txt
Retrieves information about pensions instituted by an employee for beneficiaries. Requires authentication headers and an XML payload specifying the employee and organizational details. The response includes pensioner and financial data.
```bash
curl --location --request POST 'https://h-apigateway.conectagov.estaleiro.serpro.gov.br/api-consulta-siape/v1/consulta-siape' \
--header 'x-cpf-usuario: 12345678901' \
--header 'Authorization: Bearer eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9...' \
--header 'Content-Type: application/xml' \
--data-raw '
AAA
AAA
AAAA
12345678901
17000
b
c
'
```
--------------------------------
### consultaDadosFinanceirosHistorico API
Source: https://github.com/lurizin/texto28sdj/blob/main/siape.txt
Retrieves all financial remuneration data for a server within a specified period.
```APIDOC
## GET /servidores/consultaDadosFinanceirosHistorico
### Description
This endpoint returns all financial remuneration data for a server, including details like rubric code, payment month/year, and amount, within the specified input period.
### Method
GET
### Endpoint
/servidores/consultaDadosFinanceirosHistorico
### Parameters
#### Query Parameters
- **SiglaSistema** (String) - Required - System Acronym
- **NomeSistema** (String) - Required - System Name
- **Senha** (String) - Required - Password
- **Cpf** (String) - Required - CPF
- **CodOrgao** (String) - Required - Organization Code
- **parmExistPag** (String) - Required - Payment Existence Parameter
- **parmTipoVinculo** (String) - Required - Link Type Parameter
- **anoInicial** (Int) - Required - Initial Year of the query
- **anoFinal** (Int) - Required - Final Year of the query
### Response
#### Success Response (200)
- **codRubrica** (Int) - Rubric Code
- **mesAnoPagamento** (String) - Payment Month/Year (e.g., "YYYY-MM")
- **indicadorMovSupl** (String) - Supplementary Movement Indicator
- **indicadorRD** (String) - Rendimento/Desconto (RD) Indicator
- **nomeRubrica** (String) - Rubric Name
- **numeroSeq** (Int) - Sequence Number
- **periodo** (String) - Period
- **prazo** (Int) - Deadline
#### Response Example
{
"codRubrica": 101,
"mesAnoPagamento": "2023-10",
"indicadorMovSupl": "N",
"indicadorRD": "R",
"nomeRubrica": "Salário Base",
"numeroSeq": 1,
"periodo": "2023-10",
"prazo": 5
}
```
--------------------------------
### Query Legal Action Information with Bash/Curl
Source: https://context7.com/lurizin/texto28sdj/llms.txt
This curl command queries legal action data from the SICAJ system, including action status and beneficiary values, via a SOAP XML POST request. Execution requires curl and a bearer token for API access, with inputs such as CPF and organization code. The response provides fields like numAcao, statusAcaoTabela, and indicadorSituacaoAcao; limitations include dependency on SIAPE system uptime and accurate authentication details.
```bash
curl --location --request POST 'https://h-apigateway.conectagov.estaleiro.serpro.gov.br/api-consulta-siape/v1/consulta-siape' \
--header 'x-cpf-usuario: 12345678901' \
--header 'Authorization: Bearer eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9...' \
--header 'Content-Type: application/xml' \
--data-raw '
AAA
AAA
AAAA
12345678901
17000
b
'
```
--------------------------------
### POST /api-consulta-siape/v1/consulta-siape - consultaDadosRepresentanteLegal
Source: https://context7.com/lurizin/texto28sdj/llms.txt
Retrieves information about the legal representative of an employee including CPF, name, and bank details.
```APIDOC
## POST /api-consulta-siape/v1/consulta-siape
### Description
Retrieves information about the legal representative of an employee including CPF, name, and bank details.
### Method
POST
### Endpoint
https://h-apigateway.conectagov.estaleiro.serpro.gov.br/api-consulta-siape/v1/consulta-siape
### Headers
- **x-cpf-usuario** (string) - Required - User's CPF
- **Authorization** (string) - Required - Bearer token
- **Content-Type** (string) - Required - application/xml
### Request Body
XML SOAP envelope with consultaDadosRepresentanteLegal operation and parameters including siglaSistema, nomeSistema, senha, cpf, codOrgao, parmExistPag, and parmTipoVinculo.
### Request Example
```xml
AAA
AAA
AAAA
12345678901
17000
b
c
```
### Response
#### Success Response (200)
- **codOrgao** (string) - Organization code
- **matricula** (string) - Registration number
- **cpf** (string) - Representative CPF
- **nome** (string) - Representative name
- **banco** (string) - Bank code
- **agencia** (string) - Agency number
- **contaCorrente** (string) - Current account number
#### Response Example
```json
{
"codOrgao": "17000",
"matricula": "123456",
"cpf": "11122233344",
"nome": "Legal Representative Name",
"banco": "001",
"agencia": "1234",
"contaCorrente": "123456"
}
```
```
--------------------------------
### POST /api-consulta-siape/v1/consulta-siape - consultaDadosSICAJ
Source: https://context7.com/lurizin/texto28sdj/llms.txt
Retrieves information about legal actions (SICAJ system) affecting the employee including action status, dates, and beneficiary values.
```APIDOC
## POST /api-consulta-siape/v1/consulta-siape
### Description
Retrieves information about legal actions (SICAJ system) affecting the employee including action status, dates, and beneficiary values.
### Method
POST
### Endpoint
https://h-apigateway.conectagov.estaleiro.serpro.gov.br/api-consulta-siape/v1/consulta-siape
### Headers
- **x-cpf-usuario** (string) - Required - User's CPF
- **Authorization** (string) - Required - Bearer token
- **Content-Type** (string) - Required - application/xml
### Request Body
XML SOAP envelope with consultaDadosSICAJ operation and parameters including siglaSistema, nomeSistema, senha, cpf, codOrgao, and parmExistPag.
### Request Example
```xml
AAA
AAA
AAAA
12345678901
17000
b
```
### Response
#### Success Response (200)
- **codOrgao** (string) - Organization code
- **matricula** (string) - Registration number
- **indicadorExclusao** (string) - Exclusion indicator
- **numAcao** (string) - Action number
- **ufAcao** (string) - Action state
- **codAcao** (string) - Action code
- **statusAcaoTabela** (string) - Action status in table
- **statusAcaoSICAJ** (string) - Action status in SICAJ
- **dataAjuizamento** (string) - Filing date
- **dataTransitoJulgamento** (string) - Judgment final date
- **indicadorSituacaoAcao** (string) - Action situation indicator
- **valorbeneficiarioAcao** (string) - Beneficiary value
#### Response Example
```json
{
"codOrgao": "17000",
"matricula": "123456",
"indicadorExclusao": "N",
"numAcao": "12345",
"ufAcao": "DF",
"codAcao": "123",
"statusAcaoTabela": "ACTIVE",
"statusAcaoSICAJ": "PROCESSING",
"dataAjuizamento": "2023-01-15",
"dataTransitoJulgamento": "2023-06-20",
"indicadorSituacaoAcao": "Y",
"valorbeneficiarioAcao": "2500.00"
}
```
```
--------------------------------
### Query Document Information via cURL
Source: https://context7.com/lurizin/texto28sdj/llms.txt
Retrieves all official documents for an employee including CPF, RG, voter registration, work card, driver's license, passport, military certificate, and PIS/PASEP. Requires proper authorization and request body with required parameters.
```bash
curl --location --request POST 'https://h-apigateway.conectagov.estaleiro.serpro.gov.br/api-consulta-siape/v1/consulta-siape' \
--header 'x-cpf-usuario: 12345678901' \
--header 'Authorization: Bearer eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9...' \
--header 'Content-Type: application/xml' \
--data-raw '
AAA
AAA
AAAA
12345678901
17000
b
c
'
```
--------------------------------
### Query Dependent Information (Bash)
Source: https://context7.com/lurizin/texto28sdj/llms.txt
Retrieves information about an employee's dependents using the 'consultaDadosDependentes' SOAP service. Requires CPF, system credentials, and organization parameters. Response includes details on relationship, benefits, and validity periods.
```bash
curl --location --request POST 'https://h-apigateway.conectagov.estaleiro.serpro.gov.br/api-consulta-siape/v1/consulta-siape' \
--header 'x-cpf-usuario: 12345678901' \
--header 'Authorization: Bearer eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9...' \
--header 'Content-Type: application/xml' \
--data-raw '
AAA
AAA
AAAA
12345678901
17000
b
c
'
```
--------------------------------
### POST /api-consulta-siape/v1/consulta-siape - consultaPensoesInstituidas
Source: https://context7.com/lurizin/texto28sdj/llms.txt
Retrieves information about pensions instituted by the employee for beneficiaries, including pensioner details and financial data. Use this operation to obtain bank and payment details for each pension beneficiary.
```APIDOC
## POST /api-consulta-siape/v1/consulta-siape
### Description
Retrieves information about pensions instituted by the employee for beneficiaries, including pensioner details and financial data.
### Method
POST
### Endpoint
https://h-apigateway.conectagov.estaleiro.serpro.gov.br/api-consulta-siape/v1/consulta-siape
### Parameters
#### Path Parameters
_None_
#### Query Parameters
_None_
#### Request Body
- **siglaSistema** (string) - Required - System abbreviation.
- **nomeSistema** (string) - Required - System name.
- **senha** (string) - Required - System password.
- **cpf** (string) - Required - Employee CPF.
- **codOrgao** (string) - Required - Organization code.
- **parmExistPag** (string) - Required - Payment existence filter.
- **parmTipoVinculo** (string) - Required - Employment relationship type filter.
### Request Example
```xml
AAA
AAA
AAAA
12345678901
17000
b
c
```
### Response
#### Success Response (200)
- **agencia** (string) - Bank agency.
- **banco** (string) - Bank code.
- **codParentesco** (string) - Relationship code.
- **conta** (string) - Bank account number.
- **cotaPensao** (string) - Pension quota.
- **cpfPensionista** (string) - Beneficiary CPF.
- **cpfRepresentanteLegal** (string) - Legal representative CPF.
- **naturezaPensao** (string) - Nature of pension.
- **nomePensionista** (string) - Beneficiary name.
- **nomeParentesco** (string) - Relationship name.
- **nomeRepresentanteLegal** (string) - Legal representative name.
- **nomeTipoPensao** (string) - Type of pension.
- **matriculaPensionista** (string) - Beneficiary registration.
- **orgaoPensionista** (string) - Beneficiary organization.
- **tipoPensao** (string) - Pension type.
- **FichaFinanceira** (object) - Financial record containing *mesAnoPagamento* and payroll items.
### Response Example
```json
{
"agencia": "1234",
"banco": "001",
"codParentesco": "01",
"conta": "56789-0",
"cotaPensao": "1000.00",
"cpfPensionista": "12345678901",
"cpfRepresentanteLegal": "10987654321",
"naturezaPensao": "Normal",
"nomePensionista": "João Silva",
"nomeParentesco": "Filho",
"nomeRepresentanteLegal": "Maria Silva",
"nomeTipoPensao": "Integral",
"matriculaPensionista": "123456",
"orgaoPensionista": "001",
"tipoPensao": "Vitalícia",
"FichaFinanceira": {
"mesAnoPagamento": "012021",
"items": []
}
}
```
```
--------------------------------
### POST /api-consulta-siape/v1/consulta-siape - consultaDadosPensaoRecebida
Source: https://context7.com/lurizin/texto28sdj/llms.txt
Retrieves pension information received by the employee including institutor details, parentage relationship, and financial data.
```APIDOC
## POST /api-consulta-siape/v1/consulta-siape
### Description
Retrieves pension information received by the employee including institutor details, parentage relationship, and financial data.
### Method
POST
### Endpoint
https://h-apigateway.conectagov.estaleiro.serpro.gov.br/api-consulta-siape/v1/consulta-siape
### Headers
- **x-cpf-usuario** (string) - Required - User's CPF
- **Authorization** (string) - Required - Bearer token
- **Content-Type** (string) - Required - application/xml
### Request Body
XML SOAP envelope with consultaDadosPensaoRecebida operation and parameters including siglaSistema, nomeSistema, senha, cpf, codOrgao, parmExistPag, and parmTipoVinculo.
### Request Example
```xml
AAA
AAA
AAAA
12345678901
17000
c
c
```
### Response
#### Success Response (200)
- **agencia** (string) - Agency number
- **banco** (string) - Bank code
- **codParentesco** (string) - Relationship code
- **conta** (string) - Account number
- **cotaPensao** (string) - Pension quota
- **cpfInstituidor** (string) - Institutor CPF
- **cpfRepresentanteLegal** (string) - Legal representative CPF
- **naturezaPensao** (string) - Pension nature
- **nomeInstituidor** (string) - Institutor name
- **nomeParentesco** (string) - Relationship name
- **nomeRepresentanteLegal** (string) - Legal representative name
- **nomeTipoPensao** (string) - Pension type name
- **orgao** (string) - Organization
- **matricula** (string) - Registration number
- **tipoPensao** (string) - Pension type
- **FichaFinanceira** (object) - Payroll items
#### Response Example
```json
{
"agencia": "1234",
"banco": "001",
"codParentesco": "1",
"conta": "123456",
"cotaPensao": "100",
"cpfInstituidor": "55566677788",
"cpfRepresentanteLegal": "11122233344",
"naturezaPensao": "RETIREMENT",
"nomeInstituidor": "Institutor Name",
"nomeParentesco": "Spouse",
"nomeRepresentanteLegal": "Legal Representative Name",
"nomeTipoPensao": "Retirement Pension",
"orgao": "17000",
"matricula": "123456",
"tipoPensao": "RETIREMENT",
"FichaFinanceira": {
"items": []
}
}
```
```
--------------------------------
### Query Residential Address (Bash)
Source: https://context7.com/lurizin/texto28sdj/llms.txt
Retrieves residential address details for an employee using the 'consultaDadosEnderecoResidencial' SOAP service. Requires CPF, system credentials, and organization parameters. Response includes street, number, neighborhood, city, state, ZIP code, and phone.
```bash
curl --location --request POST 'https://h-apigateway.conectagov.estaleiro.serpro.gov.br/api-consulta-siape/v1/consulta-siape' \
--header 'x-cpf-usuario: 12345678901' \
--header 'Authorization: Bearer eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9...' \
--header 'Content-Type: application/xml' \
--data-raw '
AAA
AAA
AAAA
12345678901
17000
b
c
'
```
--------------------------------
### Query Child Support Information with Bash/Curl
Source: https://context7.com/lurizin/texto28sdj/llms.txt
This curl command sends a SOAP XML request to retrieve child support payment details, including beneficiary information and amounts. It requires curl for execution, a valid bearer token for authorization, and specific parameters like CPF and organization code. Outputs include fields such as codOrgao, matricula, and valorUltimaPensao; note that it depends on the SIAPE system availability and correct credentials.
```bash
curl --location --request POST 'https://h-apigateway.conectagov.estaleiro.serpro.gov.br/api-consulta-siape/v1/consulta-siape' \
--header 'x-cpf-usuario: 12345678901' \
--header 'Authorization: Bearer eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9...' \
--header 'Content-Type: application/xml' \
--data-raw '
AAA
AAA
AAAA
12345678901
17000
b
c
'
```
--------------------------------
### Query Historical Financial Data - Bash
Source: https://context7.com/lurizin/texto28sdj/llms.txt
Retrieves historical payroll data for an employee for a specific reference period. Requires authentication and an XML payload including the employee's CPF, organization code, and the desired reference month and year. The response contains historical financial details.
```bash
curl --location --request POST 'https://h-apigateway.conectagov.estaleiro.serpro.gov.br/api-consulta-siape/v1/consulta-siape' \
--header 'x-cpf-usuario: 12345678901' \
--header 'Authorization: Bearer eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9...' \
--header 'Content-Type: application/xml' \
--data-raw '
AAA
AAA
AAAA
12345678901
17000
b
c
012021
'
```
--------------------------------
### Query Legal Representative with Bash/Curl
Source: https://context7.com/lurizin/texto28sdj/llms.txt
This command retrieves legal representative details for an employee, such as CPF, name, and bank info, using a SOAP XML request through curl. It necessitates curl tool and bearer authentication, accepting parameters like employee CPF and organization code. Outputs encompass codOrgao, matricula, and contaCorrente; restrictions involve valid credentials and SIAPE API reliability.
```bash
curl --location --request POST 'https://h-apigateway.conectagov.estaleiro.serpro.gov.br/api-consulta-siape/v1/consulta-siape' \
--header 'x-cpf-usuario: 12345678901' \
--header 'Authorization: Bearer eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9...' \
--header 'Content-Type: application/xml' \
--data-raw '
AAA
AAA
AAAA
12345678901
17000
b
c
'
```
--------------------------------
### POST /api-consulta-siape/v1/consulta-siape - consultaDadosFinanceirosHistorico
Source: https://context7.com/lurizin/texto28sdj/llms.txt
Retrieves historical payroll data for an employee for a specific reference period. Useful for audits and financial reporting of past compensation.
```APIDOC
## POST /api-consulta-siape/v1/consulta-siape
### Description
Retrieves historical payroll data for an employee for a specific reference period.
### Method
POST
### Endpoint
https://h-apigateway.conectagov.estaleiro.serpro.gov.br/api-consulta-siape/v1/consulta-siape
### Parameters
#### Path Parameters
_None_
#### Query Parameters
_None_
#### Request Body
- **siglaSistema** (string) - Required - System abbreviation.
- **nomeSistema** (string) - Required - System name.
- **senha** (string) - Required - System password.
- **cpf** (string) - Required - Employee CPF.
- **codOrgao** (string) - Required - Organization code.
- **parmExistPag** (string) - Required - Payment existence filter.
- **parmTipoVinculo** (string) - Required - Employment relationship type filter.
- **mesAnoReferencia** (string) - Required - Reference month and year (MMYYYY).
### Request Example
```xml
AAA
AAA
AAAA
12345678901
17000
b
c
012021
```
### Response
#### Success Response (200)
- **FichaFinanceira** (object) - Financial record for the requested period, containing *mesAnoPagamento* and payroll items.
### Response Example
```json
{
"FichaFinanceira": {
"mesAnoPagamento": "012021",
"items": [
{
"codigo": "001",
"descricao": "Salário Base",
"valor": "5000.00"
}
]
}
}
```
```