Skip to content

Identidade

Vinícius Pozzebon edited this page Oct 17, 2017 · 29 revisions

Issue: https://github.com/BRAConsultoria/SocialAPI-v2/issues/41

Obtendo a identidade de uma pessoa

GET

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

Retorno:

{
   "success":true,
   "data":{
      "SocialAPI":{
         "revisions":[
            {
               "pf_rg_id":"{id}",
               "pf_rg":"123123XX",
               "pf_rg_emissao":"2001-01-01",
               "pf_rg_uf":"MT",
               "pf_rg_ent_classe_meta":"{hash}",
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            },
            {
               "pf_rg_id":"{id}",
               "pf_rg":"123123XX",
               "pf_rg_emissao":"2001-01-01",
               "pf_rg_uf":"MT",
               "pf_rg_ent_classe_meta":"{hash}",
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            }
         ],
         "files":[
            {
               "pf_rg_file_id":"{id}",
               "file_url":"url-image.jpg",
               "width":675,
               "height":325,
               "coordinate_x":90,
               "coordinate_y":120,
               "rotate":90.00,
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            }
         ],
         "others":[
            {
               "pf_rg_id":"{id}",
               "pf_rg":"123123XX",
               "pf_rg_emissao":"2001-01-01",
               "pf_rg_uf":"MT",
               "pf_rg_ent_classe_meta":"{hash}",
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            }
         ]
      }
   }
}

Forçando flush do cache

GET

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

Retorno conforme este endpoint.

Inserindo uma identidade

POST

Endpoint: /v1/pessoa-fisica/identidade/

Payload:

{
   "pf_id":"{pf_id}",
   "pf_rg":"123123XX",
   "pf_rg_emissao":"2001-01-01",
   "pf_rg_uf":"MT",
   "pf_rg_ent_classe_meta":"{hash}",
   "device":{
      "id":"7df0723b4c86ab59711ea26c66642c47",
      "log":{
         "lat":"-7.9839111",
         "lon":"-34.8387671"
      }
   }
}

Retorno:

Status code: 201

Alterando uma identidade

PUT

Endpoint: /v1/pessoa-fisica/identidade/{pf_id}/{pf_rg_id}/

Payload:

{
   "pf_rg":"123123XX",
   "pf_rg_emissao":"2001-01-01",
   "pf_rg_uf":"MT",
   "pf_rg_ent_classe_meta":"{hash}",
   "device":{
      "id":"7df0723b4c86ab59711ea26c66642c47",
      "log":{
         "lat":"-7.9839111",
         "lon":"-34.8387671"
      }
   }
}

Retorno:

Status code: 200

Vinculando uma imagem a uma identidade

POST

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

Payload:

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

Retorno:

Status code: 201

{
   "success":true,
   "data":{
      "SocialAPI":{
         "pf_rg_file_id":"{id}",
         "pf_id":"{id}",
         "file_id":"{id}"
      }
   }
}

Removendo a imagem de uma identidade

DELETE

Endpoint: /v1/pessoa-fisica/identidade/doc/{pf_id}/{pf_rg_file_id}/

Payload:

{
   "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