Consultar os documentos de uma Pessoa

Esse endpoint permite a realização de uma consulta dos documentos já enviados para o cadastro de uma Pessoa.

Parâmetros da URL

  • person_id (string, uuid v4) : Identificador do cadastro da Pessoa a ser consulta.

Parâmetros da Requisição

Não é necessário o envio de nenhum dado no corpo da requisição.

Resposta

Em caso de sucesso na consulta a resposta será um JSON no seguinte formato:

  • id (string/uuid v4): Identificador do documento enviado.
  • type (string): Tipo do arquivo enviado. Possíveis valores: NATIONAL_ID, DRIVERS_LICENSE, PROOF_OF_INCOME, CLASS_ID, MILITARY_ID, PROOF_OF_ADDRESS, SCR_AUTHORIZATION, BALANCE_SHEETS, INCOME_STATEMENT, BYLAWS, INCORPORATION_CERTIFICATE, FEDERAL_REGISTER_CERTIFICATE, INVOICE, CERTIFICATE, LETTER_OF_ATTORNEY, CONTRACTS, OTHER.
  • observations (string): Campo contendo as observações/detalhamento referente ao arquivo enviado.
  • status (string): Status de recebimento e se o arquivo é válido.
  • file_extension (string): Extensão/tipo do arquivo.
  • file_name (string): Nome do arquivo.
  • created_at (datetime): Data de envio do arquivo no formato ISO 8601.
  • version (int): Campo utilzado para versionamento do arquivo caso seja necessário.

Exemplo de JSON de resposta:

[{
    "id": "string/uuid v4",
    "type": "string",
    "observations": "string",
    "status": "string",
    "file_extension": "string",
    "file_name": "string",
    "created_at": "datetime",
    "version": int
}]

Language
URL
Click Try It! to start a request and see the response here!