Arquivos e documentos

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