> This page is for RakeSign.

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

# Get inspect document by ID

GET https://api.cloudraker.com/v1/signing/inspect/document/{id}

Uses the same resource permissions and lifecycle as the RakeSign application. Integration access is limited to its shared team. Required scopes: documents:read.

Reference: https://docs.cloudraker.com/rakesign/api/rake-sign/signing-get-inspect-document-by-id

## Authentication

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

## Request

### Path parameters

- `id` (string, required)

## Response

### 200

Authorized signing resource.

- `pageCount` (integer, required) — Pages in the document.
- `pages` (list of V1SigningInspectDocumentIdGetResponsesContentApplicationJsonSchemaPagesItems, required) — Each page in order, for laying out a page you have not rendered yet. Pages in one document can differ in size.
- `fields` (list of V1SigningInspectDocumentIdGetResponsesContentApplicationJsonSchemaFieldsItems, required) — Every placeholder marker found in the document, in no particular order. A document with no markers returns an empty array.

## Errors

### 400 Bad Request Error

The request could not complete.

- `code` (string, required)
- `message` (string, required)
- `retryable` (boolean, required)
- `requestId` (string, required)
- `docUrl` (string, optional)

### 401 Unauthorized Error

The request could not complete.

- `code` (string, required)
- `message` (string, required)
- `retryable` (boolean, required)
- `requestId` (string, required)
- `docUrl` (string, optional)

### 403 Forbidden Error

The request could not complete.

- `code` (string, required)
- `message` (string, required)
- `retryable` (boolean, required)
- `requestId` (string, required)
- `docUrl` (string, optional)

### 404 Not Found Error

The request could not complete.

- `code` (string, required)
- `message` (string, required)
- `retryable` (boolean, required)
- `requestId` (string, required)
- `docUrl` (string, optional)

### 409 Conflict Error

The request could not complete.

- `code` (string, required)
- `message` (string, required)
- `retryable` (boolean, required)
- `requestId` (string, required)
- `docUrl` (string, optional)

### 429 Too Many Requests Error

Rate limited. The `/v1` API allows at least **67 requests per minute per organization** (about 1,000 requests per 15 minutes) — a guaranteed floor, enforced per edge location, so a geographically spread caller may get more. Wait for the `Retry-After` interval and retry — the error is `retryable`.

- `code` (enum, required)
  - Allowed values: `rate_limited`
- `message` (string, required)
- `retryable` (boolean, required)
- `requestId` (string, required)
- `docUrl` (string, optional)

### 503 Service Unavailable Error

The request could not complete.

- `code` (string, required)
- `message` (string, required)
- `retryable` (boolean, required)
- `requestId` (string, required)
- `docUrl` (string, optional)

## Types

### V1SigningInspectDocumentIdGetResponsesContentApplicationJsonSchemaPagesItems

- `width` (double, required) — Page width in points.
- `height` (double, required) — Page height in points.

### V1SigningInspectDocumentIdGetResponsesContentApplicationJsonSchemaFieldsItems

- `kind` (enum, required) — The marker this came from: `[Signature N]`, `[Initials N]` or `[Date N]`, or their short forms.
  - Allowed values: `signature`, `initials`, `date`
- `slot` (integer, required) — The `N` in the marker. `signers[0]` signs slot 1, `signers[1]` slot 2, matched by position.
- `page` (integer, required) — The page holding the marker, counting from 1.
- `marker` (V1SigningInspectDocumentIdGetResponsesContentApplicationJsonSchemaFieldsItemsMarker, required) — The marker itself: how it is written, and where that text sits in the document.
- `box` (V1SigningInspectDocumentIdGetResponsesContentApplicationJsonSchemaFieldsItemsBox, required, nullable) — Where the output prints: the seal for a signature, the written text for initials and a date. `null` only when `status` is `off_page`.
- `status` (enum, required) — How this marker will print. - `ok`: prints at full size, clear of everything. - `shrunk`: prints smaller, either to clear nearby content or to match the other signatures in the document. - `overlaps_text`: nothing clears at any corner, so it prints at its smallest over the text beneath. The sender decides whether that is acceptable. - `overlaps_field`: it prints over another marker's output, because the two sit close enough that both claim the same space. A date is written in full, so it reaches well past its own marker. A slight clip is not reported, only an overlap taking at least a tenth of the smaller box. This is a warning. Only `overlapsSignature` stops a send. - `off_page`: no room on the page at any corner. This status stops a send.
  - Allowed values: `ok`, `shrunk`, `overlaps_text`, `overlaps_field`, `off_page`
- `overlapsSignature` (boolean, required) — True when this signature prints over the signature of another marker. Placement has tried every size and corner for both, so no layout keeps them apart. This stops a send: move one of the two markers to its own line. Always false for initials and a date.

### V1SigningInspectDocumentIdGetResponsesContentApplicationJsonSchemaFieldsItemsMarker

The marker itself: how it is written, and where that text sits in the document.

- `x` (double, required) — Distance from the left page edge, 0 to 1.
- `y` (double, required) — Distance from the top page edge, 0 to 1.
- `width` (double, required) — Fraction of the page width, 0 to 1.
- `height` (double, required) — Fraction of the page height, 0 to 1.
- `text` (string, required) — The marker exactly as it is written in the document, for example `[Signature 1]` or `[S1]`. Name this, not a short form you build yourself, when telling a sender which marker to move: it is the only spelling a search of their PDF will find.

### V1SigningInspectDocumentIdGetResponsesContentApplicationJsonSchemaFieldsItemsBox

A rectangle as a fraction of its page, with the origin at the top-left corner.

- `x` (double, required) — Distance from the left page edge, 0 to 1.
- `y` (double, required) — Distance from the top page edge, 0 to 1.
- `width` (double, required) — Fraction of the page width, 0 to 1.
- `height` (double, required) — Fraction of the page height, 0 to 1.

## Examples

**Response**

```json
{
  "pageCount": 1,
  "pages": [
    {
      "width": 1.1,
      "height": 1.1
    }
  ],
  "fields": [
    {
      "kind": "signature",
      "slot": 1,
      "page": 1,
      "marker": {
        "x": 1.1,
        "y": 1.1,
        "width": 1.1,
        "height": 1.1,
        "text": "[Signature 1]"
      },
      "box": {
        "x": 1.1,
        "y": 1.1,
        "width": 1.1,
        "height": 1.1
      },
      "status": "ok",
      "overlapsSignature": true
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.cloudraker.com/v1/signing/inspect/document/id"

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

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

print(response.json())
```

```javascript
const url = 'https://api.cloudraker.com/v1/signing/inspect/document/id';
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
package main

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

func main() {

	url := "https://api.cloudraker.com/v1/signing/inspect/document/id"

	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
require 'uri'
require 'net/http'

url = URI("https://api.cloudraker.com/v1/signing/inspect/document/id")

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
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.cloudraker.com/v1/signing/inspect/document/id")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.cloudraker.com/v1/signing/inspect/document/id', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.cloudraker.com/v1/signing/inspect/document/id");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.cloudraker.com/v1/signing/inspect/document/id")! 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()
```