Skip to main content
GET
/
api
/
v1
/
kyc
/
status
Get KYC status
curl --request GET \
  --url https://api.pods.finance/api/v1/kyc/status \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.pods.finance/api/v1/kyc/status"

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

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

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.pods.finance/api/v1/kyc/status', 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://api.pods.finance/api/v1/kyc/status",
  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: <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://api.pods.finance/api/v1/kyc/status"

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

	req.Header.Add("x-api-key", "<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://api.pods.finance/api/v1/kyc/status")
  .header("x-api-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.pods.finance/api/v1/kyc/status")

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

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

response = http.request(request)
puts response.read_body
{
  "kycUserId": "550e8400-e29b-41d4-a716-446655440000",
  "email": "[email protected]",
  "walletAddress": "0xb794F5eA0ba39494cE839613fffBA74279579268",
  "status": "provider_pending",
  "brlaEnabled": false,
  "rejectReason": "<string>",
  "providerStatus": "COMPLETED",
  "providerResult": "APPROVED",
  "providerMessage": "<string>",
  "livenessStatus": "passed",
  "documentStatus": "passed",
  "ageAtVerification": 26,
  "updatedAt": "2026-06-15T12:01:00.000Z"
}
{
  "error": {
    "code": "QUOTE_NOT_FOUND",
    "message": "Quote not found or expired"
  }
}
{
  "error": {
    "code": "QUOTE_NOT_FOUND",
    "message": "Quote not found or expired"
  }
}
{
  "error": {
    "code": "QUOTE_NOT_FOUND",
    "message": "Quote not found or expired"
  }
}

Authorizations

x-api-key
string
header
required

API key for authentication. Obtain from your Pods dashboard.

Query Parameters

kycUserId
string<uuid>
required

Pods-generated KYC user id returned by /api/v1/kyc/sumsub-share-token

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

KYC status retrieved

Current normalized KYC profile status

kycUserId
string<uuid>
required

Pods-generated public KYC user id

Example:

"550e8400-e29b-41d4-a716-446655440000"

email
string<email>
required
walletAddress
string
required

Ethereum address (EVM-compatible)

Example:

"0xb794F5eA0ba39494cE839613fffBA74279579268"

status
enum<string>
required

Normalized Pods KYC status

Available options:
created,
provider_pending,
approved,
rejected,
rejected_retryable,
blocked
Example:

"provider_pending"

brlaEnabled
boolean
required
Example:

false

rejectReason
string | null
required
providerStatus
string | null
required
Example:

"COMPLETED"

providerResult
string | null
required
Example:

"APPROVED"

providerMessage
string | null
required
provider
enum<string> | null

KYC provider used by this profile

Available options:
sumsub,
bigdatacorp
livenessStatus
string | null
Example:

"passed"

documentStatus
string | null
Example:

"passed"

ageAtVerification
number | null
Example:

26

updatedAt
string<date-time>
Example:

"2026-06-15T12:01:00.000Z"