Skip to main content
POST
/
v3
/
keys
/
test
Test an API key
curl --request POST \
  --url https://trust.verifyyou.com/v3/keys/test \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://trust.verifyyou.com/v3/keys/test"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://trust.verifyyou.com/v3/keys/test', 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://trust.verifyyou.com/v3/keys/test",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$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://trust.verifyyou.com/v3/keys/test"

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

req.Header.Add("Authorization", "Bearer <token>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://trust.verifyyou.com/v3/keys/test")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://trust.verifyyou.com/v3/keys/test")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "valid": true,
  "key_type": "<string>",
  "is_test": true,
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successful Response

valid
boolean
required

Whether the key resolved to an active account. An unknown or revoked key comes back as false, not an error.

key_type
string
required

Prefix of the key you sent: pk_live, pk_test, sk_live, sk_test, or unknown if it matched none of them.

Example:

"sk_test"

is_test
boolean | null

Whether the key is a test key. null when the key didn't resolve.

customer_id
string<uuid> | null

The company the key belongs to. null when the key didn't resolve.