Skip to main content
GET
/
2025-06-09
/
documents
/
{documentId}
Get a User Document by ID
curl --request GET \
  --url https://staging.crossmint.com/api/2025-06-09/documents/{documentId} \
  --header 'X-API-KEY: <x-api-key>'
{
  "id": "doc_abc123xyz",
  "documentType": "id-passport",
  "createdAt": "2024-12-05T10:30:00.000Z",
  "expiresAt": "2030-12-31"
}

Documentation Index

Fetch the complete documentation index at: https://docs.crossmint.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
X-API-KEY
string
required

API key required for authentication

Path Parameters

​
documentId
string
required

Response

Document retrieved successfully

Response schema for a user document

​
id
string
required

Unique identifier for the document

Example:

"doc_abc123xyz"

​
documentType
enum<string>
required

Type of document

Available options:
id-ssn,
id-passport,
id-idcard-back,
id-idcard-front,
proof-of-address,
proof-of-income,
selfie-front,
selfie-left,
selfie-right
Example:

"id-passport"

​
createdAt
string
required

ISO 8601 timestamp when the document was created

Example:

"2024-12-05T10:30:00.000Z"

​
expiresAt
string

Document expiration date in YYYY-MM-DD format

Example:

"2030-12-31"