Estado civil - GrupoBRA/SocialAPI-v2-Doc GitHub Wiki

Obtendo o estado civil

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

GET

Retorno:

{
   "success":true,
   "data":{
      "SocialAPI":{
         "revisions":[
            {
               "pf_est_civil":"abcdef",
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            },
            {
               "pf_est_civil":"abcdef",
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            }
         ],
         "files":[
            {
               "pf_est_civil_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_est_civil":"abcdef",
         "author":{
            "oid":"{oid}",
            "uupfid":"{uupfid}",
            "nome":"Nome do autor",
            "timestamp":123123
         }
      }
   }
}

Alterando o estado civil

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

PUT

Payload:

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

Retorno:

Status code: 200

Hashes

  • Hash principal -> k10lj5
  • Solteiro -> sy77y6
  • Casado -> t5f9wm
  • Separado -> o0mmah
  • Divorciado -> z46swh
  • União estável -> krcd3f
  • Viúvo -> apxjjr
  • Não informado -> jc7cpy