> This is Payabli documentation. For a complete page index, fetch https://docs.payabli.com/llms.txt — append .md to any page URL for lightweight markdown. For section-level indexes, query parameters, and other AI-optimized access methods, see https://docs.payabli.com/ai-agents.md

# List application document requirements

GET https://api-sandbox.payabli.com/api/v2/requests/{requestsReference}/documents/requirements

Lists the documents an application asks for, from its template and from Payabli business rules. For example, a business with an annual revenue of $1,000,000 or more needs bank statements. Each requirement gives the `fieldPath` and `subject` to send when you upload, the formats it accepts, how many documents it takes, and how many are uploaded so far.

A person requirement appears once for each owner of the business, with that owner's `personReference`. The list is empty when the application asks for no documents.


Reference: https://docs.payabli.com/developers/api-reference/applications/list-application-document-requirements

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://api-sandbox.payabli.com/api` (Sandbox, default)
- `https://api.payabli.com/api` (Production)

## Request

### Path parameters

- `requestsReference` (string, required) — The application reference.

## Response

### 200

The application's document requirements.

- `success` (boolean, required) — Whether the request succeeded.
- `message` (string, required, nullable) — A human-readable result message.
- `traceId` (string, required, nullable) — The trace identifier for the request, useful for support.
- `data` (list of DocumentRequirement, required) — The application's document requirements. Empty when the application asks for no documents.

## Errors

### 401 Unauthorized Error

Unauthorized request.

- `isSuccess` (boolean, required) — Always `false` for error responses.
- `responseText` (string, required) — Error text describing what went wrong.
- `responseCode` (integer, optional) — Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
- `responseData` (PayabliErrorBodyResponseData, optional) — Object with detailed error context.

### 404 Not Found Error

The application doesn't exist.

- `success` (boolean, required) — Whether the request succeeded. Always `false`.
- `error` (string, required) — The error code, such as `VALIDATION_ERROR` or `NOT_FOUND`.
- `message` (string, required) — A human-readable description of the error.
- `traceId` (string, required, nullable) — The trace identifier for the request, useful for support.

### 500 Internal Server Error

Internal server error.

- `isSuccess` (boolean, required) — Always `false` for error responses.
- `responseText` (string, required) — Error text describing what went wrong.
- `responseCode` (integer, optional) — Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
- `responseData` (PayabliErrorBodyResponseData, optional) — Object with detailed error context.

## Types

### DocumentRequirement

A document the application asks for. A requirement comes from the application's template or from a Payabli business rule. For example, a business with an annual revenue of $1,000,000 or more needs bank statements. A person requirement appears once for each owner of the business, with that owner's `personReference`.

- `fieldPath` (string, required) — The requirement's identifier, such as `documents.bankStatement` or `person.documents.w9`. Send it as `fieldPath` when you upload a document for this requirement.
- `label` (string, required) — The requirement's display name.
- `source` (enum, required) — Where the requirement comes from: - `template`: the application's template. - `businessRule`: a Payabli rule, such as bank statements for a business with an annual revenue of $1,000,000 or more.
  - Allowed values: `template`, `businessRule`
- `subjectTypes` (list of enum, required) — The subjects a document for this requirement can be about. Send one of them as `subject` when you upload.
  - Allowed values: `business`, `paypoint`, `person`
- `required` (boolean, required) — When `true`, validation reports the requirement as missing until at least one document is uploaded for it. Submit doesn't enforce document requirements.
- `maxUploads` (integer, required) — The most documents you can upload for this requirement.
- `allowedFormats` (list of string, required) — The file formats this requirement accepts, such as `pdf`, `jpg`, `jpeg`, or `png`.
- `uploadedCount` (integer, required) — The number of documents uploaded for this requirement.
- `hint` (string, optional) — Guidance on what to upload. Omitted when the requirement has none.
- `personReference` (string, optional) — The person this requirement is for. Returned for person requirements only.

### PayabliErrorBodyResponseData

Object with detailed error context.

- `explanation` (string, optional) — Human-readable explanation of what happened.
- `todoAction` (string, optional) — Suggested resolution.

## Examples

### ListApplicationDocumentRequirements

**Response**

```json
{
  "success": true,
  "message": "Document requirements retrieved successfully",
  "traceId": "0HNPA847I3953:0000001E",
  "data": [
    {
      "fieldPath": "documents.bankStatement",
      "label": "Bank Statements",
      "source": "businessRule",
      "subjectTypes": [
        "paypoint",
        "business"
      ],
      "required": true,
      "maxUploads": 3,
      "allowedFormats": [
        "pdf",
        "jpg",
        "jpeg",
        "png"
      ],
      "uploadedCount": 0
    }
  ]
}
```

**SDK Code**

```python ListApplicationDocumentRequirements
import requests

url = "https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c/documents/requirements"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript ListApplicationDocumentRequirements
const url = 'https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c/documents/requirements';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go ListApplicationDocumentRequirements
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c/documents/requirements"

	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(res)
	fmt.Println(string(body))

}
```

```ruby ListApplicationDocumentRequirements
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c/documents/requirements")

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
```

```java ListApplicationDocumentRequirements
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c/documents/requirements")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php ListApplicationDocumentRequirements
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c/documents/requirements', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp ListApplicationDocumentRequirements
using RestSharp;

var client = new RestClient("https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c/documents/requirements");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift ListApplicationDocumentRequirements
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c/documents/requirements")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### ListTemplateDocumentRequirements

**Response**

```json
{
  "success": true,
  "message": "Document requirements retrieved successfully",
  "traceId": "0HNPA8416RDFS:0000000E",
  "data": [
    {
      "fieldPath": "documents.businessLicense",
      "label": "Business License",
      "source": "template",
      "subjectTypes": [
        "paypoint",
        "business"
      ],
      "required": false,
      "maxUploads": 1,
      "allowedFormats": [
        "pdf",
        "png",
        "jpg"
      ],
      "uploadedCount": 0,
      "hint": "Current business operating license"
    },
    {
      "fieldPath": "person.documents.w9",
      "label": "W-9 Form",
      "source": "template",
      "subjectTypes": [
        "person"
      ],
      "required": true,
      "maxUploads": 1,
      "allowedFormats": [
        "pdf"
      ],
      "uploadedCount": 0,
      "hint": "Signed W-9 tax form",
      "personReference": "01a0014d-ce1a-7110-9bac-c4c59647a88d"
    }
  ]
}
```

**SDK Code**

```python ListTemplateDocumentRequirements
import requests

url = "https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c/documents/requirements"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript ListTemplateDocumentRequirements
const url = 'https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c/documents/requirements';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go ListTemplateDocumentRequirements
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c/documents/requirements"

	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(res)
	fmt.Println(string(body))

}
```

```ruby ListTemplateDocumentRequirements
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c/documents/requirements")

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
```

```java ListTemplateDocumentRequirements
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c/documents/requirements")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php ListTemplateDocumentRequirements
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c/documents/requirements', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp ListTemplateDocumentRequirements
using RestSharp;

var client = new RestClient("https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c/documents/requirements");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift ListTemplateDocumentRequirements
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c/documents/requirements")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```