Document
Upload Document
Upload a document for a customer.
Authorization
bearer AuthorizationBearer <token>
In: header
Request Body
multipart/form-data
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://api.spherepay.co/v2/document" \ -F targetId="customer_66c4168d418a410eae282b83883bdc39" \ -F target="customer" \ -F documentType="passport" \ -F country="USA" \ -F side="front" \ -F description="Passport photo page" \ -F file="(binary)"{
"targetId": "customer_66c4168d418a410eae282b83883bdc39",
"target": "customer",
"documentType": "passport",
"country": "USA",
"side": "front",
"description": "Passport photo page",
"fileName": "passport_front_20250101.pdf",
"fileSize": 2048576,
"mimeType": "application/pdf",
"createdAt": "2025-12-31T10:30:00.000Z"
}{
"status": 400,
"detail": "Invalid request parameters",
"code": "address/invalid",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c"
}{
"status": 404,
"detail": "Resource not found",
"code": "resource/not-found",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c"
}{
"status": 422,
"detail": "Validation failed",
"code": "validation/failed",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"errors": [
{
"detail": "Invalid email format",
"pointer": "/email"
},
{
"detail": "Name is required",
"pointer": "/name"
}
]
}Last updated on