CNH - GrupoBRA/SocialAPI-v2-Doc GitHub Wiki

Obtendo a CNH de uma pessoa

GET: /v1/pessoa-fisica/cnh/{pf_id}/

Retorno:

{
   "success":true,
   "data":{
      "SocialAPI":{
         "revisions":[
            {
               "pf_cnh_id":"{id}",
               "pf_cnh":"123123XX",
               "pf_cnh_validade":"2001-01-01",
               "pf_cnh_prim_hab":"2001-01-01",
               "pf_cnh_cat":"hash",
               "pf_cnh_obs":"text",
               "pf_cnh_emissao":"2001-01-01",
               "cidade_id":"1",
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            }
         ],
         "others":[
            
         ]
      }
   }
}

Inserindo uma CNH

POST: /v1/pessoa-fisica/cnh/

Payload:

{
   "pf_id":"{pf_id}",
   "pf_cnh":"123123XX",
   "pf_cnh_validade":"2001-01-01",
   "pf_cnh_prim_hab":"2001-01-01",
   "pf_cnh_cat":"hash",
   "pf_cnh_obs":"text",
   "pf_cnh_emissao":"2001-01-01",
   "cidade_id":"1",
   "device":{
      "id":"7df0723b4c86ab59711ea26c66642c47",
      "log":{
         "lat":"-7.9839111",
         "lon":"-34.8387671"
      }
   }
}

Retorno:

Status code: 201

Alterando uma CNH

PUT: /v1/pessoa-fisica/cnh/{pf_id}/{pf_cnh_id}/

Payload:

{
   "pf_cnh":"123123XX",
   "pf_cnh_validade":"2001-01-01",
   "pf_cnh_prim_hab":"2001-01-01",
   "pf_cnh_cat":"hash",
   "pf_cnh_obs":"text",
   "pf_cnh_emissao":"2001-01-01",
   "cidade_id":"1",
   "device":{
      "id":"7df0723b4c86ab59711ea26c66642c47",
      "log":{
         "lat":"-7.9839111",
         "lon":"-34.8387671"
      }
   }
}

Retorno:

Status code: 200

Hashes

Categorias de CNH

  • Hash principal -> op0s2a
  • A -> cnh_a
  • B -> cnh_b
  • AB -> cnh_ab
  • C -> cnh_c
  • D -> cnh_d
  • E -> cnh_e