Pessoas

Upload de Documentos da Pessoa

Esse endpoint deve ser utilizado para gerar um link que irá possibilitar o envio de documentos relacionados ao cadastro do tilular de uma conta que será criada posteriormente.

Nós utilizamos o mecanismo de "Pre-signed Uploads" da AWS:

  1. Informar qual o nome do arquivo e sua extensão;

  2. O serviço irá retornar uma "upload_url" e um "key";

  3. No upload_url deve ser feito o upload do base64 do arquivo;

  4. O parâmetro "key" deve ser utilizado posteriormente no campo "" no cadastro da pessoa titular da conta;

Parâmetros do Body

  • file_name (string, obrigatório): O nome completo do arquivo que será feito o upload com a extensão correta. Por exemplo "arquivo_identidade.pdf".

Response

Se processado com sucesso será retornado um status_code "200" e um JSON no seguinte formato:

{
  "key": "<string>",
  "upload_url": "<string>",
  "download_url": "<string>"
}

  • key (string/UUID): ID para identificação do arquivo que foi enviado;

  • upload_url (string): URL para fazer o envio do arquivo;

  • download_url (string): URL para fazer o download do arquivo;

post/escrow/api/v1/documents/upload

Request

  • Base URL
    https://sandbox.platform.credit.celcoin.com.br
  • URL
    https://sandbox.platform.credit.celcoin.com.br/escrow/api/v1/documents/upload
  • Auth
    none declared

Headers

Content-Typestring
Acceptstring

Request body

object required

Example request

{
  "file_name": "nome_arquivo.png"
}

Response

OK

object required

Changes

No recorded changes to this operation across all 1 revision of this API.