Antes de prosseguir, saiba:

Os endpoints abaixo utilizam uma mesclagem experimental do melhor dos padrões de API REST e GraphQL.

---

Obtendo as imagens pelo tipo de documento

Endpoint: /v1/pessoa-fisica/document/{pf_id}/{param}/

A variável {param} aceita as possibilidades abaixo, além de aceitar receber mais de um tipo, sendo separados os valores por vírgula:

• all -> Retorna todos as imagens vinculadas à pessoa, independente dos tipos de documentos;
• s4ljz9 -> Nome Civil;
• cnbbg1 -> Nome Social;
• me1zbp -> CPF;
• kilwf3 -> Comprovante do Estado Civil;
• cjiy3i -> Comprovante de Escolaridade;
• ...

Exemplos:

• Retornando todas as imagens vinculadas à pessoa:

  • /v1/pessoa-fisica/document/{pf_id}/all/

• Retornando imagens do tipo CPF:

  • /v1/pessoa-fisica/document/{pf_id}/me1zbp/

• Retornando imagens do tipo Comprovante de Estado Civil e Comprovante de Escolaridade:

  • /v1/pessoa-fisica/document/{pf_id}/kilwf3,cjiy3i/

{
   "success":true,
   "data":{
      "SocialAPI":{
         "cnbbg1":[
            {
               "file_id":"{id}",
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            }
         ],
         "j8rzfu":[
            {
               "file_id":"{id}",
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            }
         ]
      }
   }
}

Obtendo tipos de documento vinculados à uma imagem

GET

Endpoint: /v1/pessoa-fisica/document/{pf_id}/id/{file_id}/

Retorno:

{
   "success":true,
   "data":{
      "SocialAPI":{
         "cnbbg1":[
            {
               "file_id":"{id}",
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            }
         ],
         "j8rzfu":[
            {
               "file_id":"{id}",
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            }
         ]
      }
   }
}

Vinculando ou desvinculando uma imagem a um (ou mais) tipo(s) de documento(s)

PUT

Endpoint: /v1/pessoa-fisica/document/change/

Payload:

{
   "pf_id":"{pf_id}",
   "file_id":"{file_id}",
   "add":[
      "cnbbg1",
      "j8rzfu"
   ],
   "remove":[
      "me1zbp"
   ],
   "device":{
      "id":"7df0723b4c86ab59711ea26c66642c47",
      "log":{
         "lat":"-7.9839111",
         "lon":"-34.8387671"
      }
   }
}

Retorno:

Status code: 200

Definição das hashes via MetaAPI

• doc_class -> [s4ljz9,cnbbg1,me1zbp,kilwf3,cjiy3i,j8rzfu,b1f25k,wa9tia,dhar00,ydog05,uw7l3t,rfgp1s,eoaedt]
• s4ljz9 -> Nome Civil -> [pf_nome_file]
• cnbbg1 -> Nome Social -> [pf_nome_social_file]
• me1zbp -> CPF -> [pf_cpf_file]
• kilwf3 -> Comprovante do Estado Civil -> [pf_est_civil_file]
• cjiy3i -> Comprovante de Escolaridade -> [pf_escol_file]
• j8rzfu -> Certidão de Nascimento -> [pf_nasc_file]
• b1f25k -> Certidão de Óbito -> [pf_obito_file]
• wa9tia -> Foto do Perfil -> [pf_foto]
• dhar00 -> Identidade -> [pf_rg_file]
• ydog05 -> Carteira de Trabalho -> [pf_ctps_file]
• uw7l3t -> Contrato de Trabalho -> [pf_ctps_contr_file]
• rfgp1s -> Comprovante de Residência -> [end_file]
• eoaedt -> Certidão de Tempo de Contribuição -> [pf_ctc_file]
• mw7ejh -> Prova de Vida
• hg7h0v -> PIS/PASEP/NIT
• yfq7bg -> Declaração de União Estável
• b2j5qi -> Título de Eleitor
• eiq3g9 -> Registro Nacional de Estrangeiro
• zmspog -> Carteira Nacional de Habilitação
• sdh4ld -> Registro em Conselho de Classe
• tdlt8z -> Certificado de Reservista
• kneeio -> Termo de Guarda
• d1pnsj -> Termo de Curatela
• btvl1j -> Laudo Médico
• un8jiv -> Comprovante de Dependência Econômica
• ebdf70 -> Portaria de posse
• d06f17 -> Portaria de concessão de beneficio
• wxgu4d -> Outros