> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://partner.ninjatrader.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://partner.ninjatrader.com/_mcp/server.

# Prepare Agreement Documents

POST https://live.tradovateapi.com/v1/customerApplication/prepareagreementdocuments
Content-Type: application/json

### Prepare the agreement documents for a customer application.

**Available to:** All authenticated users

**Environments:** Live

**[Rate Limit](/overview/core-concepts/rate-limits):** 10 requests per hour, 30-second back-off, counts all requests

Generate the set of agreement documents the applicant needs to sign for a customer application. The system builds the documents from the application's applicant details, so call this after submitting them with [`submitApplicant`](/api/rest-api-endpoints/users/submit-applicant).

Provide the `customerApplicationId` returned by [`startCustomerApplication`](/api/rest-api-endpoints/users/start-customer-application). A successful response returns a `successHashCode`; the generated documents are stored as `AgreementDocument` entities linked to the application.

To work with the prepared documents:

- List them with [`agreementDocumentDependents`](/api/rest-api-endpoints/users/agreement-document-dependents), passing the `customerApplicationId` as `masterid`. The returned `id` values are the `agreementIds` you pass to [`signAgreementDocuments`](/api/rest-api-endpoints/users/sign-agreement-documents).
- Fetch a document's content for display with [`getAgreementDocument`](/api/rest-api-endpoints/users/get-agreement-document).

**Common Failure Scenarios**

- `customerApplicationId` does not reference an existing application.
- The application does not yet have applicant details — submit them first with [`submitApplicant`](/api/rest-api-endpoints/users/submit-applicant).

**Error Messages**

| `errorText` | Trigger |
|-------------|---------|
| Non-empty `errorText` | Document preparation failed; the field describes the reason. |

**Next Steps**

- Present the prepared documents to the applicant, then sign them with [`signAgreementDocuments`](/api/rest-api-endpoints/users/sign-agreement-documents).

Reference: https://partner.ninjatrader.com/connect/api/rest-api-endpoints/users/prepare-agreement-documents

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: connect
  version: 1.0.0
paths:
  /customerApplication/prepareagreementdocuments:
    post:
      operationId: prepare-agreement-documents
      summary: Prepare Agreement Documents
      description: >-
        ### Prepare the agreement documents for a customer application.


        **Available to:** All authenticated users


        **Environments:** Live


        **[Rate Limit](/overview/core-concepts/rate-limits):** 10 requests per
        hour, 30-second back-off, counts all requests


        Generate the set of agreement documents the applicant needs to sign for
        a customer application. The system builds the documents from the
        application's applicant details, so call this after submitting them with
        [`submitApplicant`](/api/rest-api-endpoints/users/submit-applicant).


        Provide the `customerApplicationId` returned by
        [`startCustomerApplication`](/api/rest-api-endpoints/users/start-customer-application).
        A successful response returns a `successHashCode`; the generated
        documents are stored as `AgreementDocument` entities linked to the
        application.


        To work with the prepared documents:


        - List them with
        [`agreementDocumentDependents`](/api/rest-api-endpoints/users/agreement-document-dependents),
        passing the `customerApplicationId` as `masterid`. The returned `id`
        values are the `agreementIds` you pass to
        [`signAgreementDocuments`](/api/rest-api-endpoints/users/sign-agreement-documents).

        - Fetch a document's content for display with
        [`getAgreementDocument`](/api/rest-api-endpoints/users/get-agreement-document).


        **Common Failure Scenarios**


        - `customerApplicationId` does not reference an existing application.

        - The application does not yet have applicant details — submit them
        first with
        [`submitApplicant`](/api/rest-api-endpoints/users/submit-applicant).


        **Error Messages**


        | `errorText` | Trigger |

        |-------------|---------|

        | Non-empty `errorText` | Document preparation failed; the field
        describes the reason. |


        **Next Steps**


        - Present the prepared documents to the applicant, then sign them with
        [`signAgreementDocuments`](/api/rest-api-endpoints/users/sign-agreement-documents).
      tags:
        - Users
      parameters:
        - name: Authorization
          in: header
          description: Bearer authentication
          required: true
          schema:
            type: string
      responses:
        '200':
          description: AgreementDocumentsResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgreementDocumentsResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PrepareAgreementDocuments'
servers:
  - url: https://live.tradovateapi.com/v1
    description: https://live.tradovateapi.com/v1
components:
  schemas:
    PrepareAgreementDocuments:
      type: object
      properties:
        customerApplicationId:
          type: integer
          format: int64
      required:
        - customerApplicationId
      title: PrepareAgreementDocuments
    AgreementDocumentsResponse:
      type: object
      properties:
        errorText:
          type: string
          description: Non-empty if the request failed
        successHashCode:
          type: integer
          format: int64
      title: AgreementDocumentsResponse
  securitySchemes:
    bearer_access_token:
      type: http
      scheme: bearer

```

## Examples



**Request**

```json
{
  "customerApplicationId": 123456789
}
```

**Response**

```json
{
  "errorText": "",
  "successHashCode": 987654321
}
```

**SDK Code**

```python
import requests

url = "https://live.tradovateapi.com/v1/customerApplication/prepareagreementdocuments"

payload = { "customerApplicationId": 123456789 }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://live.tradovateapi.com/v1/customerApplication/prepareagreementdocuments';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"customerApplicationId":123456789}'
};

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

```go
package main

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

func main() {

	url := "https://live.tradovateapi.com/v1/customerApplication/prepareagreementdocuments"

	payload := strings.NewReader("{\n  \"customerApplicationId\": 123456789\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

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

url = URI("https://live.tradovateapi.com/v1/customerApplication/prepareagreementdocuments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customerApplicationId\": 123456789\n}"

response = http.request(request)
puts response.read_body
```

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

HttpResponse<String> response = Unirest.post("https://live.tradovateapi.com/v1/customerApplication/prepareagreementdocuments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerApplicationId\": 123456789\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://live.tradovateapi.com/v1/customerApplication/prepareagreementdocuments', [
  'body' => '{
  "customerApplicationId": 123456789
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://live.tradovateapi.com/v1/customerApplication/prepareagreementdocuments");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"customerApplicationId\": 123456789\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["customerApplicationId": 123456789] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://live.tradovateapi.com/v1/customerApplication/prepareagreementdocuments")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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