Upload a User Document

Upload a document for a user.

API scope required: users.create

POST /2025-06-09/documents

Upload a User Document

cURL

curl --request POST \
  --url https://staging.crossmint.com/api/2025-06-09/documents \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '
{
  "reference": {
    "userLocator": "email:[e-mail]"
  },
  "documentType": "id-passport",
  "data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
  "expiresAt": "2030-12-31"
}
'

import requests

url = "https://staging.crossmint.com/api/2025-06-09/documents"

payload = {
    "reference": { "userLocator": "email:[e-mail]" },
    "documentType": "id-passport",
    "data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
    "expiresAt": "2030-12-31"
}
headers = {
    "X-API-KEY": "<x-api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    reference: {userLocator: 'email:[e-mail]'},
    documentType: 'id-passport',
    data: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==',
    expiresAt: '2030-12-31'
  })
};

fetch('https://staging.crossmint.com/api/2025-06-09/documents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://staging.crossmint.com/api/2025-06-09/documents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reference' => [
        'userLocator' => 'email:[e-mail]'
    ],
    'documentType' => 'id-passport',
    'data' => 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==',
    'expiresAt' => '2030-12-31'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://staging.crossmint.com/api/2025-06-09/documents"

	payload := strings.NewReader("{\n  \"reference\": {\n    \"userLocator\": \"email:[e-mail]\"\n  },\n  \"documentType\": \"id-passport\",\n  \"data\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==\",\n  \"expiresAt\": \"2030-12-31\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://staging.crossmint.com/api/2025-06-09/documents")
  .header("X-API-KEY", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reference\": {\n    \"userLocator\": \"email:[e-mail]\"\n  },\n  \"documentType\": \"id-passport\",\n  \"data\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==\",\n  \"expiresAt\": \"2030-12-31\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://staging.crossmint.com/api/2025-06-09/documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reference\": {\n    \"userLocator\": \"email:[e-mail]\"\n  },\n  \"documentType\": \"id-passport\",\n  \"data\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==\",\n  \"expiresAt\": \"2030-12-31\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": "doc_abc123xyz",
  "documentType": "id-passport",
  "createdAt": "2024-12-05T10:30:00.000Z",
  "expiresAt": "2030-12-31"
}

{
  "id": "doc_abc123xyz",
  "documentType": "id-passport",
  "createdAt": "2024-12-05T10:30:00.000Z",
  "expiresAt": "2030-12-31"
}

Headers

X-API-KEY · string · required

API key required for authentication

Body

application/json

reference · object · required

Reference to the user who owns this document

Show child attributes

Example:

{ "userLocator": "email:[e-mail]" }

documentType · enum<string> · required

Type of document

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

Example:

"id-passport"

data · string · required

Base64 encoded document data

Minimum string length: 1

Example:

"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="

expiresAt · string

Document expiration date in YYYY-MM-DD format

Pattern: ^\d{4}-\d{2}-\d{2}$

Example:

"2030-12-31"

Response

200

application/json

Document replaced successfully

id · string · required

Unique identifier for the document

Example:

"doc_abc123xyz"

documentType · enum<string> · required

Type of document

Available options: id-passport, id-idcard-back, id-idcard-front, id-residency-permit, 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"