Skip to content
Vinícius Pozzebon edited this page Nov 2, 2017 · 9 revisions

Obtendo as CTC's de uma pessoa

GET

Endpoint: /v1/pessoa-fisica/ctc/{pf_id}/

Retorno:

{
   "success":true,
   "data":{
      "SocialAPI":{
         "current":[
            {
               "pf_ctc_id":"{id}",
               "pf_ctc_num":"123123XX",
               "pf_ctc_emissor":"Ministério da Previdência Social",
               "pf_ctc_cnpj_emissor":"10582517000190",
               "pf_ctc_emissao":"2001-01-01",
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            },
            {
               "pf_ctc_id":"{id}",
               "pf_ctc_num":"123123XX",
               "pf_ctc_emissor":"Ministério da Previdência Social",
               "pf_ctc_cnpj_emissor":"10582517000190",
               "pf_ctc_emissao":"2001-01-01",
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            }
         ],
         "revisions":[

         ]
      }
   }
}

Forçando o flush do cache

GET

Endpoint: /v1/pessoa-fisica/ctc/flush/{pf_id}/

Retorno conforme o endpoint.

Inserindo uma CTC

POST

Endpoint: /v1/pessoa-fisica/ctc/

Payload:

{
   "pf_id":"{pf_id}",
   "pf_ctc_num":"123123XX",
   "pf_ctc_emissor":"Ministério da Previdência Social",
   "pf_ctc_cnpj_emissor":"10582517000190",
   "pf_ctc_emissao":"2001-01-01",
   "device":{
      "id":"7df0723b4c86ab59711ea26c66642c47",
      "log":{
         "lat":"-7.9839111",
         "lon":"-34.8387671"
      }
   }
}

Retorno:

Status code: 201

Alterando uma CTC

PUT

Endpoint: /v1/pessoa-fisica/ctc/{pf_id}/{pf_ctc_id}/

Payload:

{
   "pf_ctc_num":"123123XX",
   "pf_ctc_emissor":"Ministério da Previdência Social",
   "pf_ctc_cnpj_emissor":"10582517000190",
   "pf_ctc_emissao":"2001-01-01",
   "device":{
      "id":"7df0723b4c86ab59711ea26c66642c47",
      "log":{
         "lat":"-7.9839111",
         "lon":"-34.8387671"
      }
   }
}

Retorno:

Status code: 200

Removendo uma CTC

DELETE

Endpoint: /v1/pessoa-fisica/ctc/{pf_id}/{pf_ctc_id}/

Payload:

{
   "device":{
      "id":"7df0723b4c86ab59711ea26c66642c47",
      "log":{
         "lat":"-7.9839111",
         "lon":"-34.8387671"
      }
   }
}

Retorno:

Status code: 204

Vinculando uma imagem a uma CTC

POST

Endpoint: /v1/pessoa-fisica/ctc/doc/

Payload:

{
   "pf_id":"{pf_id}",
   "file_id":"{file_id}",
   "pf_ctc_id":"{pf_ctc_id}",
   "device":{
      "id":"7df0723b4c86ab59711ea26c66642c47",
      "log":{
         "lat":"-7.9839111",
         "lon":"-34.8387671"
      }
   }
}

Retorno:

Status code: 201

Removendo a imagem de uma CTC

DELETE

Endpoint: /v1/pessoa-fisica/ctc/doc/

Payload:

{
   "pf_id":"{pf_id}",
   "file_id":"{file_id}",
   "pf_ctc_id":"{pf_ctc_id}",
   "device":{
      "id":"7df0723b4c86ab59711ea26c66642c47",
      "log":{
         "lat":"-7.9839111",
         "lon":"-34.8387671"
      }
   }
}

Retorno:

Status code: 204

Iniciando

Cached results

Miscelânea

Pesquisando

Pessoa física

Nome

Nome social

Data de nascimento

Data de óbito

Estado civil

Escolaridade

Raça/cor

PNE

Nacionalidade

Naturalidade

Foto do perfil

Perfil

Bio

Login

Documentos

Identidade

PIS/PASEP/NIT

Título de eleitor

CNH

CTPS

CTC

Reservista

Cursos

Certidão de Nascimento Casamento

Carteira do Conselho de Classe

Remoção de Documentos

Contatos

Telefones

Emails

Endereços

Endereços(v2)

Família

Data exchange

Pessoa física

Clone this wiki locally