Skip to main content
POST
/
api
/
user
/
document
/
upload
Upload user document
curl --request POST \
  --url https://api.sandbox.bitwage.com/api/user/document/upload \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "<string>",
  "doc_type": "<string>",
  "category": "front",
  "issuing_country": "<string>",
  "base64_image": "<string>",
  "tax_id": "<string>",
  "tax_id_type": "<string>"
}
'
{
  "success": true
}

Authorizations

Authorization
string
header
required

API key authentication. Include your access token as: Authorization: Basic <ACCESS_TOKEN>

Body

application/json
user_id
string
required
doc_type
string
required

Document type. Use tax_id for tax ID submission, or one of the image document types for identity verification.

category
enum<string>

Required for image documents. Passport and proof-of-address require front.

Available options:
front,
back
issuing_country
string

2-character ISO country code. Required for image documents.

base64_image
string

Base64-encoded image. Required for image documents.

tax_id
string

Required when doc_type is tax_id.

tax_id_type
string

Required when doc_type is tax_id.

Response

200 - application/json

Document uploaded successfully.

success
boolean