Identidade - GrupoBRA/SocialAPI-v2-Doc GitHub Wiki

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
               }
            }
         ],
         "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

Hashes

Órgãos emissores de identidade

Hash principal -> gcinau
Secretaria de Segurança Pública -> SSP
Secretaria de Desenvolvimento Social -> SDS
Conselho Regional de Administração -> CRA
Conselho Regional de Assistência Social -> CRAS
Conselho Regional de Biblioteconomia -> CRB
Conselho Regional de Contabilidade -> CRC
Conselho Regional de Corretores de Imóveis -> CRECI
Conselho Regional de Economia -> CORECON
Conselho Regional de Enfermagem -> COREN
Conselho Regional de Engenharia, Arquitetura e Agronomia -> CREA
Conselho Regional de Estatística -> CONRE
Conselho Regional de Farmácia -> CRF
Conselho Regional de Fisioterapia e Terapia Ocupacional -> CREFITO
Conselho Regional de Medicina -> CRM
Conselho Regional de Medicina Veterinária -> CRMV
Conselho Regional de Nutrição -> CRN
Conselho Regional de Odontologia -> CRO
Conselho Regional de Profissionais de Relações Públicas -> CONRERP
Conselho Regional de Psicologia -> CRP
Conselho Regional de Química -> CRQ
Conselho Regional de Representantes Comerciais -> CORE
Conselho Regional de Biologia -> CRBIO
Conselho Regional de Fonoaudiologia -> CRFA
Conselho Regional de Serviço Social -> CORESS
Conselho Regional de Técnicos em Radiologia -> CRTR
Instituto Brasileiro de Atuários -> IBA
Ordem dos Advogados do Brasil -> OAB
Ordem dos Músicos do Brasil -> OMBCRE
Ministério da Aeronáutica -> MINAERO
Ministério do Exército -> MINEXE
Ministério da Marinha -> MINMAR
Polícia Federal -> POLFED
Polícia Militar -> POLMIL
Delegacia de Polícia Marítima, Aérea e de Fronteira -> DPMAF
Departamento de Transito -> DETRAN
Corpo de Bombeiros -> CBM