Upload document

const form = new FormData();
form.append('type', 'articles_of_incorporation');
form.append('metadata', '{
  "verification_id": "123e4567-e89b-12d3-a456-426614174000",
  "category": "incorporation",
  "notes": "Primary incorporation document"
}');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

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

import requests

url = "https://api.getpalm.com/v1/business/{business_id}/document"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\narticles_of_incorporation\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n{\r\n  \"verification_id\": \"123e4567-e89b-12d3-a456-426614174000\",\r\n  \"category\": \"incorporation\",\r\n  \"notes\": \"Primary incorporation document\"\r\n}\r\n-----011000010111000001101001--"
headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

curl --request POST \
  --url https://api.getpalm.com/v1/business/{business_id}/document \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form type=articles_of_incorporation \
  --form 'metadata={
  "verification_id": "123e4567-e89b-12d3-a456-426614174000",
  "category": "incorporation",
  "notes": "Primary incorporation document"
}'

{
  "id": "906f369f-a73b-46a2-8184-ccc5c2848abd",
  "object": "document",
  "mode": "live",
  "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",
  "metadata": {
    "category": "incorporation"
  },
  "created_at": "2025-10-24T10:30:00Z",
  "updated_at": "2025-10-24T10:35:00Z"
}

POST

business

{business_id}

document

Upload document

const form = new FormData();
form.append('type', 'articles_of_incorporation');
form.append('metadata', '{
  "verification_id": "123e4567-e89b-12d3-a456-426614174000",
  "category": "incorporation",
  "notes": "Primary incorporation document"
}');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

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

import requests

url = "https://api.getpalm.com/v1/business/{business_id}/document"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\narticles_of_incorporation\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n{\r\n  \"verification_id\": \"123e4567-e89b-12d3-a456-426614174000\",\r\n  \"category\": \"incorporation\",\r\n  \"notes\": \"Primary incorporation document\"\r\n}\r\n-----011000010111000001101001--"
headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

curl --request POST \
  --url https://api.getpalm.com/v1/business/{business_id}/document \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form type=articles_of_incorporation \
  --form 'metadata={
  "verification_id": "123e4567-e89b-12d3-a456-426614174000",
  "category": "incorporation",
  "notes": "Primary incorporation document"
}'

{
  "id": "906f369f-a73b-46a2-8184-ccc5c2848abd",
  "object": "document",
  "mode": "live",
  "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",
  "metadata": {
    "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

business_id

string

required

The ID of the business to upload the document for.

Body

multipart/form-data

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,

ra_change_confirmation,

ra_resignation,

receipt,

other

Example:

"articles_of_incorporation"

metadata

object

required

Additional metadata

Example:

{
  "verification_id": "123e4567-e89b-12d3-a456-426614174000",
  "category": "incorporation",
  "notes": "Primary incorporation document"
}

Response

Document uploaded

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"

mode

enum<string>

required

Whether this resource is test or live; test and live data are isolated.

Available options:

test,

live

Example:

"live"

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,

ra_change_confirmation,

ra_resignation,

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,

verified

Example:

"verified"

upload_date

string<date-time>

required

ISO 8601 timestamp when the document was uploaded

Example:

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

metadata

object

required

Custom metadata

Example:

{ "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"

List documents

Verify existing business

⌘I