Skip to main content
GET
/
v1
/
document
/
{document_id}
Retrieve a document
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getpalm.com/v1/document/{document_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "906f369f-a73b-46a2-8184-ccc5c2848abd",
  "object": "document",
  "type": "articles_of_incorporation",
  "filename": "articles_of_incorporation.pdf",
  "file_size": 524288,
  "content_type": "application/pdf",
  "status": "verified",
  "upload_date": "2025-10-24T10:30:00Z",
  "verification_details": {
    "verified_at": "2025-10-24T10:35:00Z",
    "verified_by": "automated",
    "extracted_data": {
      "business_name": "Acme Corporation",
      "formation_date": "2020-05-15",
      "state": "Delaware"
    },
    "rejection_reason": "Document is expired"
  },
  "metadata": {
    "verification_id": "123e4567-e89b-12d3-a456-426614174000",
    "category": "incorporation"
  },
  "created_at": "2025-10-24T10:30:00Z",
  "updated_at": "2025-10-24T10:35:00Z"
}

Authorizations

Authorization
string
header
required

Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx

Path Parameters

document_id
string
required

The ID of the document to retrieve.

Response

The document.

id
string<uuid>
required

Unique identifier for the document. Pass this to the document download endpoints.

Example:

"906f369f-a73b-46a2-8184-ccc5c2848abd"

object
enum<string>
required

Object type identifier, always "document"

Available options:
document
Example:

"document"

type
enum<string>
required

Document type classification

Available options:
passport,
drivers_license,
national_id,
government_id,
articles_of_incorporation,
certificate_of_formation,
operating_agreement,
bylaws,
ein_letter,
business_license,
certificate_of_good_standing,
bank_statement,
tax_return,
proof_of_address,
notice,
mail,
receipt,
other
Example:

"articles_of_incorporation"

filename
string
required

Original filename of the uploaded document

Maximum string length: 255
Example:

"articles_of_incorporation.pdf"

file_size
number
required

Size of the file in bytes

Required range: x >= 0
Example:

524288

content_type
string
required

MIME type of the file

Example:

"application/pdf"

status
enum<string>
required

Current status of the document

Available options:
pending,
processing,
verified,
failed,
rejected
Example:

"verified"

upload_date
string<date-time>
required

ISO 8601 timestamp when the document was uploaded

Example:

"2025-10-24T10:30:00Z"

verification_details
object
required

Additional details from document verification (if processed)

metadata
object
required

Custom metadata

Example:
{
"verification_id": "123e4567-e89b-12d3-a456-426614174000",
"category": "incorporation"
}
created_at
string<date-time>
required

ISO 8601 timestamp when the document record was created

Example:

"2025-10-24T10:30:00Z"

updated_at
string<date-time>
required

ISO 8601 timestamp when the document record was last updated

Example:

"2025-10-24T10:35:00Z"