Retrieve Document

The retrieve document route is responsible for listing the documents of the assignment.

🚧

Attention point:

To use the route, it is necessary to use the assignment code obtained through the assignment launch.

Type Documents

CodeFormat
1RG FRENTE
2RG VERSO
3CNH FRENTE
4CNH VERSO
5LOGO
6RNE VERSO
7PERFIL
8ASSINATURA
9COMPROVANTE DE RESIDÊNCIA
10SELFIE COM RG
12INSCRIÇÃO MUNICIPAL
43OUTROS
13AVALIAÇÃO INTERNA DE RISCO
14ENRIQUECIMENTO
15TERMO CESSÃO
16CNAB CESSÃO
45CERTIDÃO DE CASAMENTO
17CPF
18CNPJ
19FATURAMENTO ÚLTIMOS 12 MESES
20CONTRATO SOCIAL
21ESTATUTO E ATA DE NOMEAÇÃO DE DIRETORIA
22CERTIFICADO DA CONDIÇÃO DE MICROEMPREENDEDOR INDIVIDUAL
23CPF SÓCIO/REPRESENTANTE
24RG FRENTE SÓCIO/REPRESENTANTE
25RG VERSO SÓCIO/REPRESENTANTE
26CNH FRENTE SÓCIO/REPRESENTANTE
27CNH VERSO SÓCIO/REPRESENTANTE
28COMPROVANTE RESIDENCIA SÓCIO/REPRESENTANTE
29CARTEIRA DE TRABALHO
43OUTROS
45CERTIDÃO DE CASAMENTO
46CRM

Types Extension

CodeFormat
1.png
2.pdf
3.jpeg
4.txt
7.doc
8.xls
9.xlsx
10.docx
11x-compressed(.rar)
12x-zip-compressed(.zip)

Response

Http CodeReturn CodeMessage
200200-01Success.
400400-01Something unexpected happened.
400400-09There are no results for the query.
401401-06The requested module is not enabled.

Response Parameters

ParameterFormatDescription
request_codestringUnique identifier for the request.
returnbooleanIndicates if the request was successful.
return_codestringCode indicating the result of the request.
messagestringDescription of the result of the request.
dataobjectDetails of the document.
data.[i]namestringName of the document.
data.[i]type_categoryintegerCategory type of the document.
data.[i]description_categorystringDescription of the document category.
data.[i]created_atstring (datetime)Timestamp when the document was created.

Request Parameters

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here!