List Documents
curl --request GET \
--url https://api.sandbox.wepayout.com.br/v2/register/companies/{uuid}/documents \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sandbox.wepayout.com.br/v2/register/companies/{uuid}/documents"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sandbox.wepayout.com.br/v2/register/companies/{uuid}/documents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.wepayout.com.br/v2/register/companies/{uuid}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.wepayout.com.br/v2/register/companies/{uuid}/documents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.wepayout.com.br/v2/register/companies/{uuid}/documents")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.wepayout.com.br/v2/register/companies/{uuid}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "1234-5678-90ab-cdef-1234567890ab",
"status": "documents_under_review",
"documents": [
{
"name": "Articles of Incorporation",
"tag": "articles_of_incorporation",
"description": "Company's current articles of incorporation",
"required": true,
"upload_status": "sent",
"review_status": "approved",
"created_at": "2024-01-10T10:00:00.000000Z",
"updated_at": "2024-01-18T10:00:00.000000Z",
"sent_at": "2024-01-17T10:00:00.000000Z",
"reviewed_at": "2024-01-18T10:00:00.000000Z",
"review_history": [
{
"action": "approved",
"timestamp": "2024-01-18T10:00:00.000000Z"
},
{
"action": "rejected",
"timestamp": "2024-01-16T10:00:00.000000Z",
"reason": "Illegible document"
}
]
},
{
"name": "Proof of Address",
"tag": "proof_of_address",
"description": "Updated proof of address",
"required": true,
"upload_status": "sent",
"review_status": "rejected",
"created_at": "2024-01-10T10:00:00.000000Z",
"updated_at": "2024-01-16T10:00:00.000000Z",
"sent_at": "2024-01-15T11:00:00.000000Z",
"reviewed_at": "2024-01-16T10:00:00.000000Z",
"review_history": [
{
"action": "rejected",
"timestamp": "2024-01-16T10:00:00.000000Z",
"reason": "Address mismatch"
}
]
},
{
"name": "Balance Sheet",
"tag": "balance_sheet",
"description": "Financial balance sheet",
"required": false,
"upload_status": "pending",
"review_status": "pending",
"created_at": "2024-01-10T10:00:00.000000Z",
"updated_at": "2024-01-10T10:00:00.000000Z",
"sent_at": null,
"reviewed_at": null,
"review_history": []
}
]
}
{
"message": "Access denied to this solicitation"
}
{
"message": "Solicitation not found"
}
Documents
List Documents
Read the documents linked to an onboarding solicitation, including each document’s upload/review state and its immutable decision history. Read-only — does not change the solicitation status.
GET
/
v2
/
register
/
companies
/
{uuid}
/
documents
List Documents
curl --request GET \
--url https://api.sandbox.wepayout.com.br/v2/register/companies/{uuid}/documents \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sandbox.wepayout.com.br/v2/register/companies/{uuid}/documents"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sandbox.wepayout.com.br/v2/register/companies/{uuid}/documents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.wepayout.com.br/v2/register/companies/{uuid}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.wepayout.com.br/v2/register/companies/{uuid}/documents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.wepayout.com.br/v2/register/companies/{uuid}/documents")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.wepayout.com.br/v2/register/companies/{uuid}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "1234-5678-90ab-cdef-1234567890ab",
"status": "documents_under_review",
"documents": [
{
"name": "Articles of Incorporation",
"tag": "articles_of_incorporation",
"description": "Company's current articles of incorporation",
"required": true,
"upload_status": "sent",
"review_status": "approved",
"created_at": "2024-01-10T10:00:00.000000Z",
"updated_at": "2024-01-18T10:00:00.000000Z",
"sent_at": "2024-01-17T10:00:00.000000Z",
"reviewed_at": "2024-01-18T10:00:00.000000Z",
"review_history": [
{
"action": "approved",
"timestamp": "2024-01-18T10:00:00.000000Z"
},
{
"action": "rejected",
"timestamp": "2024-01-16T10:00:00.000000Z",
"reason": "Illegible document"
}
]
},
{
"name": "Proof of Address",
"tag": "proof_of_address",
"description": "Updated proof of address",
"required": true,
"upload_status": "sent",
"review_status": "rejected",
"created_at": "2024-01-10T10:00:00.000000Z",
"updated_at": "2024-01-16T10:00:00.000000Z",
"sent_at": "2024-01-15T11:00:00.000000Z",
"reviewed_at": "2024-01-16T10:00:00.000000Z",
"review_history": [
{
"action": "rejected",
"timestamp": "2024-01-16T10:00:00.000000Z",
"reason": "Address mismatch"
}
]
},
{
"name": "Balance Sheet",
"tag": "balance_sheet",
"description": "Financial balance sheet",
"required": false,
"upload_status": "pending",
"review_status": "pending",
"created_at": "2024-01-10T10:00:00.000000Z",
"updated_at": "2024-01-10T10:00:00.000000Z",
"sent_at": null,
"reviewed_at": null,
"review_history": []
}
]
}
{
"message": "Access denied to this solicitation"
}
{
"message": "Solicitation not found"
}
Part of the Onboarding Documents flow. This endpoint reflects the current state and history of each document — uploads, resends and compliance decisions. It returns only the documents linked to the given solicitation and never alters its status.
Path Parameters
UUID of the solicitation (the
id returned by Create Company).- Format: UUID
- Example:
339074a8-1834-49c5-af94-4a044248d88d
Response
UUID of the solicitation.
Current status of the solicitation (e.g.
pending_documents, documents_under_review).Documents linked to the solicitation.
Show document object
Show document object
Human-readable name of the document.
Machine-readable identifier of the document type — the value used to upload it.
Description of what the document is.
Whether the document is mandatory for the onboarding to proceed.
Upload state, owned by the client. One of
pending, sent.Compliance review state. One of
pending, approved, rejected.When the document was attached to the solicitation. ISO 8601.
Last time the document state changed. ISO 8601.
When the document was last sent.
null if never uploaded.When the last review decision was taken. Always reflects the latest decision.
null if not reviewed yet.Immutable list of review decisions, ordered by date descending (newest first). Empty until the first decision.
{
"id": "1234-5678-90ab-cdef-1234567890ab",
"status": "documents_under_review",
"documents": [
{
"name": "Articles of Incorporation",
"tag": "articles_of_incorporation",
"description": "Company's current articles of incorporation",
"required": true,
"upload_status": "sent",
"review_status": "approved",
"created_at": "2024-01-10T10:00:00.000000Z",
"updated_at": "2024-01-18T10:00:00.000000Z",
"sent_at": "2024-01-17T10:00:00.000000Z",
"reviewed_at": "2024-01-18T10:00:00.000000Z",
"review_history": [
{
"action": "approved",
"timestamp": "2024-01-18T10:00:00.000000Z"
},
{
"action": "rejected",
"timestamp": "2024-01-16T10:00:00.000000Z",
"reason": "Illegible document"
}
]
},
{
"name": "Proof of Address",
"tag": "proof_of_address",
"description": "Updated proof of address",
"required": true,
"upload_status": "sent",
"review_status": "rejected",
"created_at": "2024-01-10T10:00:00.000000Z",
"updated_at": "2024-01-16T10:00:00.000000Z",
"sent_at": "2024-01-15T11:00:00.000000Z",
"reviewed_at": "2024-01-16T10:00:00.000000Z",
"review_history": [
{
"action": "rejected",
"timestamp": "2024-01-16T10:00:00.000000Z",
"reason": "Address mismatch"
}
]
},
{
"name": "Balance Sheet",
"tag": "balance_sheet",
"description": "Financial balance sheet",
"required": false,
"upload_status": "pending",
"review_status": "pending",
"created_at": "2024-01-10T10:00:00.000000Z",
"updated_at": "2024-01-10T10:00:00.000000Z",
"sent_at": null,
"reviewed_at": null,
"review_history": []
}
]
}
{
"message": "Access denied to this solicitation"
}
{
"message": "Solicitation not found"
}
Errors
| Status | When |
|---|---|
404 | Solicitation does not exist. |
403 | Solicitation exists but is not accessible with the authenticated credentials. |
Download a document file
To retrieve the latest uploaded file of a specific document, call:GET /v2/register/companies/{uuid}/documents/{tag}/file
The
tag of the document whose file you want to download (e.g. articles_of_incorporation).404.
| Status | When |
|---|---|
200 | File returned as a download. |
404 | Solicitation not found, or no file uploaded for that tag. |
403 | Solicitation not accessible with the authenticated credentials. |
cURL
curl -X GET "https://api.sandbox.wepayout.com.br/v2/register/companies/339074a8-1834-49c5-af94-4a044248d88d/documents/articles_of_incorporation/file" \
-H "Authorization: Bearer YOUR_API_KEY" \
-o articles_of_incorporation.pdf
Related Resources
Onboarding Documents Integration
Understand the full flow
Upload Document
Send the required files by tag
Was this page helpful?
⌘I

