Request a document

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'certificate_of_good_standing',
    palm_id: '4604-3477-1850',
    registration_jurisdiction: 'US-DE',
    registration_number: '7286832',
    business_id: '987e6543-e21a-45b6-c789-012345678901',
    metadata: {loan_application: 'LA-2291'}
  })
};

fetch('https://api.getpalm.com/v1/document-request', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.getpalm.com/v1/document-request"

payload = {
    "type": "certificate_of_good_standing",
    "palm_id": "4604-3477-1850",
    "registration_jurisdiction": "US-DE",
    "registration_number": "7286832",
    "business_id": "987e6543-e21a-45b6-c789-012345678901",
    "metadata": { "loan_application": "LA-2291" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

curl --request POST \
  --url https://api.getpalm.com/v1/document-request \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "certificate_of_good_standing",
  "palm_id": "4604-3477-1850",
  "registration_jurisdiction": "US-DE",
  "registration_number": "7286832",
  "business_id": "987e6543-e21a-45b6-c789-012345678901",
  "metadata": {
    "loan_application": "LA-2291"
  }
}
'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "object": "document_request",
  "mode": "live",
  "created_at": "2025-10-24T10:30:00Z",
  "updated_at": "2025-10-24T15:45:00Z",
  "metadata": {
    "external_id": "user_123_in_my_system",
    "customer_tier": "premium",
    "signup_source": "mobile_app"
  },
  "type": "certificate_of_good_standing",
  "status": "queued",
  "business_id": "987e6543-e21a-45b6-c789-012345678901",
  "palm_id": "2735-1926-5317",
  "registration_jurisdiction": "US-DE",
  "documents": [
    {
      "id": "906f369f-a73b-46a2-8184-ccc5c2848abd",
      "object": "document",
      "type": "certificate_of_good_standing",
      "uploaded_at": "2026-10-08T16:22:05Z"
    }
  ],
  "registration_number": "7086953",
  "result": {
    "standing": "compliant"
  },
  "failure_reason": "jurisdiction_declined",
  "completed_at": "2026-10-08T16:22:06Z"
}

Document Request

Request a document

⚠️ Early access — This endpoint is in preview and may change in backwards-incompatible ways before it is marked stable. Avoid depending on it in production, and reach out before building on it.

Request an official document for a registration, identified by exactly one of palm_id, registration_jurisdiction with registration_number, or business_id. The request is accepted immediately and fulfilled asynchronously: poll it, or subscribe to the document_request.completed and document_request.failed webhook events. A business is added to your portfolio for the registration when none exists yet. Unsupported jurisdictions and entity types are refused at creation.

POST

document-request

Request a document

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'certificate_of_good_standing',
    palm_id: '4604-3477-1850',
    registration_jurisdiction: 'US-DE',
    registration_number: '7286832',
    business_id: '987e6543-e21a-45b6-c789-012345678901',
    metadata: {loan_application: 'LA-2291'}
  })
};

fetch('https://api.getpalm.com/v1/document-request', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.getpalm.com/v1/document-request"

payload = {
    "type": "certificate_of_good_standing",
    "palm_id": "4604-3477-1850",
    "registration_jurisdiction": "US-DE",
    "registration_number": "7286832",
    "business_id": "987e6543-e21a-45b6-c789-012345678901",
    "metadata": { "loan_application": "LA-2291" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

curl --request POST \
  --url https://api.getpalm.com/v1/document-request \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "certificate_of_good_standing",
  "palm_id": "4604-3477-1850",
  "registration_jurisdiction": "US-DE",
  "registration_number": "7286832",
  "business_id": "987e6543-e21a-45b6-c789-012345678901",
  "metadata": {
    "loan_application": "LA-2291"
  }
}
'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "object": "document_request",
  "mode": "live",
  "created_at": "2025-10-24T10:30:00Z",
  "updated_at": "2025-10-24T15:45:00Z",
  "metadata": {
    "external_id": "user_123_in_my_system",
    "customer_tier": "premium",
    "signup_source": "mobile_app"
  },
  "type": "certificate_of_good_standing",
  "status": "queued",
  "business_id": "987e6543-e21a-45b6-c789-012345678901",
  "palm_id": "2735-1926-5317",
  "registration_jurisdiction": "US-DE",
  "documents": [
    {
      "id": "906f369f-a73b-46a2-8184-ccc5c2848abd",
      "object": "document",
      "type": "certificate_of_good_standing",
      "uploaded_at": "2026-10-08T16:22:05Z"
    }
  ],
  "registration_number": "7086953",
  "result": {
    "standing": "compliant"
  },
  "failure_reason": "jurisdiction_declined",
  "completed_at": "2026-10-08T16:22:06Z"
}

Authorizations

Authorization

string

header

required

Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx

Body

application/json

type

enum<string>

required

Document type to request.

Available options:

certificate_of_good_standing

Example:

"certificate_of_good_standing"

palm_id

string

Palm ID of the registration. Provide exactly one of this, registration_jurisdiction with registration_number, or business_id.

Example:

"4604-3477-1850"

registration_jurisdiction

string

Registration jurisdiction in ISO 3166-2 format (e.g., US-CA, US-NY, US-TX)

Example:

"US-DE"

registration_number

string

The registration's number in that jurisdiction

Example:

"7286832"

business_id

string<uuid>

A business already in your portfolio.

Example:

"987e6543-e21a-45b6-c789-012345678901"

metadata

object

Up to 50 custom key-value pairs, echoed back on the resource.

Show child attributes

Example:

{ "loan_application": "LA-2291" }

Response

Document request accepted

string<uuid>

required

Unique identifier for the resource

Example:

"123e4567-e89b-12d3-a456-426614174000"

object

enum<string>

required

Object type

Available options:

document_request

Example:

"document_request"

mode

enum<string>

required

Whether this resource was created with test or live credentials. Test and live data are fully isolated — a test resource never appears in live results and vice versa.

Available options:

test,

live

Example:

"live"

created_at

string<date-time>

required

ISO 8601 timestamp of when the resource was created

Example:

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

updated_at

string<date-time>

required

ISO 8601 timestamp of when the resource was last updated

Example:

"2025-10-24T15:45:00Z"

metadata

object

required

Store up to 50 custom key-value pairs for application-specific data. Useful for storing references to external systems, feature flags, or other custom attributes.

Show child attributes

Example:

{
  "external_id": "user_123_in_my_system",
  "customer_tier": "premium",
  "signup_source": "mobile_app"
}

type

enum<string>

required

Requested document type

Available options:

certificate_of_good_standing

status

enum<string>

required

Current status

Available options:

queued,

processing,

completed,

failed

business_id

string<uuid>

required

Business the request and its documents attach to.

Example:

"987e6543-e21a-45b6-c789-012345678901"

palm_id

string

required

Palm ID of the registration the request resolved to.

Example:

"2735-1926-5317"

registration_jurisdiction

string

required

Jurisdiction of the registration (ISO 3166-2).

Example:

"US-DE"

documents

object[]

required

Documents delivered by this request, stored on the business record. Empty until delivery.

Show child attributes

registration_number

string | null

The registration's number in that jurisdiction.

Example:

"7086953"

result

object | null

Outcome of the request, populated on completed and null until then. Shape depends on type: certificate_of_good_standing → { standing }.

Show child attributes

failure_reason

enum<string> | null

Why the request failed. Populated on failed, null otherwise.

Available options:

jurisdiction_declined,

entity_not_found,

cannot_fulfill,

null

completed_at

string<date-time> | null

ISO 8601 timestamp of when the request reached a terminal status, null while in flight.

Example:

"2026-10-08T16:22:06Z"

Palm Introduction

API Introduction

Endpoints

Request a document

Authorizations

Body

Response