Get Identity Verification Status

Get identity verification status for a user.

API scope required: users.read

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

Get Identity Verification Status

cURL

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

import requests

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

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}/identity-verification', 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}/identity-verification",
  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}/identity-verification"

	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}/identity-verification")
  .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}/identity-verification")

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

{
  "eligibility": {
    "type": "onramp",
    "status": "requires-data",
    "missingData": [
      "user-details",
      "kyc-data"
    ],
    "missingDocuments": [
      "id",
      "proof-of-address"
    ]
  }
}

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

Verification status

eligibility · object[] · required

Array of eligibility status for different verification types

Show child attributes

Example:

{
  "type": "onramp",
  "status": "requires-data",
  "missingData": ["user-details", "kyc-data"],
  "missingDocuments": ["id", "proof-of-address"]
}