Get a User

Get a user by its id

API scope required: users.read

GET /2025-06-09/users/{userLocator}

Get a User

cURL

curl --request GET \
  --url https://staging.crossmint.com/api/2025-06-09/users/{userLocator} \
  --header 'X-API-KEY: <x-api-key>'

import requests

url = "https://staging.crossmint.com/api/2025-06-09/users/{userLocator}"

headers = {"X-API-KEY": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-KEY': '<x-api-key>'}};

fetch('https://staging.crossmint.com/api/2025-06-09/users/{userLocator}', 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/users/{userLocator}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://staging.crossmint.com/api/2025-06-09/users/{userLocator}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<x-api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://staging.crossmint.com/api/2025-06-09/users/{userLocator}")
  .header("X-API-KEY", "<x-api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://staging.crossmint.com/api/2025-06-09/users/{userLocator}")

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

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<x-api-key>'

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

200

{
  "userDetails": true,
  "kycData": false,
  "dueDiligence": false,
  "verificationHistory": false,
  "email": "[e-mail]",
  "phoneNumber": "[phone]",
  "userId": "usr_1234567890",
  "legalDocuments": {
    "type": "crossmint-privacy-policy",
    "acceptedAt": "2023-01-01T00:00:00.000Z",
    "isValidVersion": true
  }
}

Headers

X-API-KEY · string · required

API key required for authentication

Path Parameters

userLocator · string · required

A user locator can be of the format:

• email:<email>
• userId:<userId>
• phoneNumber:<phoneNumber>
• twitter:<handle>
• x:<handle>

Response

200 - application/json

User found

userDetails · boolean · required

Whether user details have been provided

Example:

true

kycData · boolean · required

Whether KYC data has been provided

Example:

false

dueDiligence · boolean · required

Whether due diligence data has been provided

Example:

false

verificationHistory · boolean · required

Whether verification history has been provided

Example:

false

email · string

User's email address

Example:

"[e-mail]"

phoneNumber · string

User's phone number

Example:

"[phone]"

userId · string

Unique user identifier

Example:

"usr_1234567890"

legalDocuments · object[]

List of accepted legal documents

Show child attributes

Example:

{
  "type": "crossmint-privacy-policy",
  "acceptedAt": "2023-01-01T00:00:00.000Z",
  "isValidVersion": true
}