Upload de documentos

Descrição

Após a criação de uma solicitação, deve-se fazer o envio dos arquivos relacionados à mesma. São estes:

• Matrícula do imóvel
• IPTU
• Fotos
• Outros

O envio dos arquivos é opcional, porém é necessário haver um arquivo de matrícula para a execução da avaliação do imóvel.

No caso de uma solicitação do tipo appraisal_inspection (avaliação com vistoria) não é necessário subir duas vezes os arquivos. Os mesmos arquivos deverão ser atrelados às solicitações na rota de Inserção dos nomes dos arquivos enviados nas solicitações.

Os arquivos são armazenados em um bucket S3 na AWS. Por questões de segurança, para se fazer o upload dos arquivos, deve-se solicitar nessa rota as urls pré-assinadas equivalentes a cada arquivo, de acordo com o tipo:

Arquivo	file_type	Extensão
Matrícula do imóvel	property_registration	.png, .jpg, .jpeg, .pdf, .tif, .rar, .zip
Iptu do imóvel	iptu	.png, .jpg, .jpeg, .pdf, .tif, .rar, .zip
Fotos do imóvel	property_photos	.png, .jpg, .jpeg, .pdf, .tif, .rar, .zip
Outros	others	.png, .jpg, .jpeg, .pdf, .tif, .rar, .zip

Endpoint

https://api.prd.valuation.eemovel.com.br/avr/solicit/integration/generate_pre_signed_urls/<id_solicitação>

Método: POST

Headers

x-api-key = <x_api_key>

Corpo da requisição

[
  {
    "file_name": "matricula.pdf",
    "file_type": "property_registration"
  },
  {
    "file_name": "foto.png",
    "file_type": "property_photos"
  },
  {
    "file_name": "iptu.pdf",
    "file_type": "iptu"
  },
  {
    "file_name": "outros.kml",
    "file_type": "others"
  }
]

Success response 200

{
  "data": [
    {
      "url": "https://prd-platform-valuation-avr-files.s3.amazonaws.com/",
      "fields": {
        "key": "<id_solicitação>/property_registration/matricula.pdf",
        "AWSAccessKeyId": "<aws-access-key-id>",
        "x-amz-security-token": "<x-amz-security-token>",
        "policy": "<policy>",
        "signature": "<signature>"
      },
      "file_name": "matricula.pdf",
      "file_type": "property_registration"
    },
    {
      "url": "https://prd-platform-valuation-avr-files.s3.amazonaws.com/",
      "fields": {
        "key": "<id_solicitação>/property_photos/foto.png",
        "AWSAccessKeyId": "<aws-access-key-id>",
        "x-amz-security-token": "<x-amz-security-token>",
        "policy": "<policy>",
        "signature": "<signature>"
      },
      "file_name": "foto.png",
      "file_type": "property_photos"
    },
    {
      "url": "https://prd-platform-valuation-avr-files.s3.amazonaws.com/",
      "fields": {
        "key": "<id_solicitação>/iptu/iptu.pdf",
        "AWSAccessKeyId": "<aws-access-key-id>",
        "x-amz-security-token": "<x-amz-security-token>",
        "policy": "<policy>",
        "signature": "<signature>"
      },
      "file_name": "iptu.pdf",
      "file_type": "iptu"
    },
    {
      "url": "https://prd-platform-valuation-avr-files.s3.amazonaws.com/",
      "fields": {
        "key": "<id_solicitação>/others/outros.kml",
        "AWSAccessKeyId": "<aws-access-key-id>",
        "x-amz-security-token": "<x-amz-security-token>",
        "policy": "<policy>",
        "signature": "<signature>"
      },
      "file_name": "outros.kml",
      "file_type": "others"
    }
  ],
  "message": "Arquivo atualizado com sucesso!",
  "code": 200,
  "success": true
}

Uma url pré assinada é gerada para cada arquivo. É possível enviar mais de um arquivo de um mesmo tipo. Nesse caso, ambos serão armazenados na mesma pasta no AWS S3.

[
  {
    "file_name": "matricula-parte-1.pdf",
    "file_type": "property_registration"
  },
  {
    "file_name": "matricula-parte-2.pdf",
    "file_type": "property_registration"
  }
]

Error response 500

{
    "message": "Um erro desconhecido ocorreu ao tentar essa rota.",
    "code": 500,
    "success": false
}