POST

Create a wallet entity document

ENDPOINT/v1/wallet-entities/{wallet_entity_id}/documents

Creates a document record and returns a presigned upload_url plus the document id. PUT the file bytes to upload_url before upload_url_expires_at. Send Idempotency-Key so retries return the original document.

Authentication & Headers

Header	Type	Requirement	Description
Authorization	string	REQUIRED	API key passed as an HTTP Bearer token: `Bearer rk_live_...`
X-Program-ID	UUID	PROGRAM-SCOPED	Program boundary UUID that scopes the issuing card, wallet, or transfer.
Content-Type	string	REQUIRED	Must be `application/json`.
Idempotency-Key	string	OPTIONAL	Unique UUID to prevent duplicate execution of financial creations or mutations.

Path Parameters

Parameter	Type	Requirement	Description
wallet_entity_id	string	REQUIRED	Unique identifier of the wallet entity.

Request Body Schema

application/json

document_typestring

REQUIRED

Kind of file uploaded for a wallet entity or an application. Use a government identity type for KYC, and entity documents for KYB.

Enum values:GOVERNMENT_IDPASSPORTDRIVERS_LICENSEPROOF_OF_ADDRESSSSN_CARDARTICLES_OF_INCORPORATIONEIN_LETTEROPERATING_AGREEMENTBENEFICIAL_OWNER_IDBANK_STATEMENTOTHER

file_namestring

REQUIRED

Original file name shown on later reads.

content_typestring

REQUIRED

MIME type of the file you will PUT to `upload_url`.

Enum values:application/pdfimage/jpegimage/pngimage/heicimage/webp

Response Codes & Schemas

201The document record, including a presigned upload URL.

application/json

{
  "id": "5e8a3c21-7b94-4d06-a1f2-9c4e6b8d0a37",
  "object": "document",
  "document_type": "DRIVERS_LICENSE",
  "status": "PENDING",
  "rejection_reasons": [],
  "file_name": "drivers-license.jpg",
  "content_type": "image/jpeg",
  "wallet_entity_id": "2e9c4b71-8a5d-4f03-b6e2-1c7d9a0f3e58",
  "application_id": null,
  "upload_url": "https://uploads.rookpayments.com/d/5e8a3c21-7b94-4d06-a1f2-9c4e6b8d0a37?token=u_live_8f1c2e3a4b5d",
  "upload_url_expires_at": "2026-08-27T15:20:00Z",
  "created_at": "2026-08-12T10:18:00Z",
  "updated_at": "2026-08-12T10:18:00Z"
}

400Bad Request: malformed JSON, failed schema validation, or conflicting parameters.

application/json

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "invalid order by: foo. Valid options are: [created_at updated_at]",
    "param": "order_by",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/invalid_request"
  }
}

401Unauthorized: missing, malformed, or unknown API key.

application/json

{
  "error": {
    "type": "authentication_error",
    "code": "authentication_error",
    "message": "A valid API key is required.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/authentication_error"
  }
}

403Forbidden: the API key is denied by RBAC, or it cannot access this program. A resource that exists on another program or organization returns `404 not_found`, not `403`.

application/json

{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The API key cannot access this program.",
    "param": "X-Program-ID",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/permission_denied"
  }
}

404Not Found: unknown id, or the resource is not visible to this API key.

application/json

{
  "error": {
    "type": "not_found_error",
    "code": "not_found",
    "message": "No card found for the given id.",
    "param": "card_id",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/not_found"
  }
}

409Conflict: incompatible state, or Idempotency-Key reused with a different body.

application/json

{
  "error": {
    "type": "conflict_error",
    "code": "conflict",
    "message": "The card cannot be reissued from its current state.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/conflict"
  }
}

429Too Many Requests: the API key exceeded its rate limit.

application/json

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limited",
    "message": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/rate_limited"
  }
}

500Internal Server Error: unexpected failure. Retry with the same Idempotency-Key.

application/json

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected error occurred. Retry with the same Idempotency-Key.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/internal_error"
  }
}