Get KYC status

curl --request GET \
  --url https://api.pods.finance/api/v1/kyc/status \
  --header 'x-api-key: <api-key>'

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))

}

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",
  "provider": "sumsub",
  "email": "[email protected]",
  "walletAddress": "EXYhCNamLPFfSMekSn7Lzc2cP32aZpRa7ok5gErdJzcj",
  "status": "provider_pending",
  "brlaEnabled": false,
  "usdEnabled": false,
  "eurEnabled": false,
  "rejectReason": "<string>",
  "providerStatus": "COMPLETED",
  "providerResult": "APPROVED",
  "providerMessage": "<string>",
  "livenessStatus": "passed",
  "documentStatus": "passed",
  "birthDate": "1990-01-01T00:00:00.000Z",
  "ageAtVerification": 36,
  "bigDataCorpIframeCreatedAt": "2026-06-15T12:00:00.000Z",
  "bigDataCorpCompletedAt": "2026-06-15T12:04:00.000Z",
  "aveniaSubmissionStartedAt": "2026-06-15T12:04:30.000Z",
  "aveniaSubmittedAt": "2026-06-15T12:05:00.000Z",
  "aveniaApprovedAt": "2026-06-15T12:06:00.000Z",
  "documentEvidenceSource": "customer_attested",
  "livenessEvidenceSource": "customer_attested",
  "documentType": "<string>",
  "reason": {
    "code": "TAX_ID_ALREADY_VERIFIED",
    "message": "This person is already verified under another record.",
    "retryable": false,
    "retryFrom": "liveness"
  },
  "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"
  }
}

Ramp

Get KYC status

Returns the normalized Pods KYC status for a Pods-generated kycUserId. This is the canonical status endpoint for every KYC flow: Brazilian Sumsub share-token profiles, foreign Sumsub share-token profiles, BigDataCorp iframe profiles, and external evidence profiles. BigDataCorp profiles are polled while capture is pending; pending KYC attempts are refreshed before returning when possible. Pods also runs a durable background task to update the stored KYC state when clients stop polling. When a profile is rejected, read the reason object rather than rejectReason or providerResult — it is the only field guaranteed to stay stable across providers. For foreign USD flows, poll until status is approved and usdEnabled is true after currency unlock.

GET

api

kyc

status

Get KYC status

curl --request GET \
  --url https://api.pods.finance/api/v1/kyc/status \
  --header 'x-api-key: <api-key>'

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))

}

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",
  "provider": "sumsub",
  "email": "[email protected]",
  "walletAddress": "EXYhCNamLPFfSMekSn7Lzc2cP32aZpRa7ok5gErdJzcj",
  "status": "provider_pending",
  "brlaEnabled": false,
  "usdEnabled": false,
  "eurEnabled": false,
  "rejectReason": "<string>",
  "providerStatus": "COMPLETED",
  "providerResult": "APPROVED",
  "providerMessage": "<string>",
  "livenessStatus": "passed",
  "documentStatus": "passed",
  "birthDate": "1990-01-01T00:00:00.000Z",
  "ageAtVerification": 36,
  "bigDataCorpIframeCreatedAt": "2026-06-15T12:00:00.000Z",
  "bigDataCorpCompletedAt": "2026-06-15T12:04:00.000Z",
  "aveniaSubmissionStartedAt": "2026-06-15T12:04:30.000Z",
  "aveniaSubmittedAt": "2026-06-15T12:05:00.000Z",
  "aveniaApprovedAt": "2026-06-15T12:06:00.000Z",
  "documentEvidenceSource": "customer_attested",
  "livenessEvidenceSource": "customer_attested",
  "documentType": "<string>",
  "reason": {
    "code": "TAX_ID_ALREADY_VERIFIED",
    "message": "This person is already verified under another record.",
    "retryable": false,
    "retryFrom": "liveness"
  },
  "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, /api/v1/kyc/foreign/sumsub-share-token, /api/v1/kyc/bigdatacorp/sessions or /api/v1/kyc/sessions

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"

provider

enum<string>

required

KYC provider used for the profile. external_evidence means the capture was performed by the customer and submitted to Pods as attested evidence.

Available options:

sumsub,

bigdatacorp,

external_evidence

Example:

"sumsub"

string<email>

required

Example:

"[email protected]"

walletAddress

string

required

Wallet address stored on the Ramp KYC profile. Accepts a checksummed EVM address or a Solana public key. Later Pix quotes must use the same address as destinationAddress (onramp) or originAddress (offramp).

Example:

"EXYhCNamLPFfSMekSn7Lzc2cP32aZpRa7ok5gErdJzcj"

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

usdEnabled

boolean

required

True when the profile is approved for USD WIRE/ACH ramps via Avenia

Example:

false

eurEnabled

boolean

required

Reserved for a future EUR capability; always false today

Example:

false

rejectReason

string | null

required

providerStatus

string | null

required

Example:

"COMPLETED"

providerResult

string | null

required

Provider-specific normalized result. BigDataCorp may return values such as WAITING_ADDRESS_TO_SUBMIT_TO_AVENIA, DUPLICATE_TAX_ID, or AVENIA_KYC_SUBMIT_FAILED before the final Pods status is approved.

Example:

"APPROVED"

providerMessage

string | null

required

Provider message persisted for support and retry decisions, when available.

livenessStatus

string | null

required

Example:

"passed"

documentStatus

string | null

required

Example:

"passed"

birthDate

string | null

required

Resolved birth date in YYYY-MM-DD format for BigDataCorp profiles. Null while pending, unavailable, or not applicable to the provider.

Example:

"1990-01-01T00:00:00.000Z"

ageAtVerification

number | null

required

Example:

36

bigDataCorpIframeCreatedAt

string<date-time> | null

required

When the current BigDataCorp iframe session was created.

Example:

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

bigDataCorpCompletedAt

string<date-time> | null

required

When BigDataCorp completed document, liveness, and identity verification.

Example:

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

aveniaSubmissionStartedAt

string<date-time> | null

required

When Pods started the final Avenia submission. Repeated submit requests return the existing provider_pending result while this operation is in progress.

Example:

"2026-06-15T12:04:30.000Z"

aveniaSubmittedAt

string<date-time> | null

required

When the verified BigDataCorp profile was submitted to Avenia.

Example:

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

aveniaApprovedAt

string<date-time> | null

required

When Avenia approved the KYC attempt. For Brazil profiles this coincides with brlaEnabled; for foreign profiles poll usdEnabled after currency unlock.

Example:

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

documentEvidenceSource

enum<string>

required

Who captured the document. Null for profiles created before evidence sources were recorded.

Available options:

customer_attested,

deframe_managed

Example:

"customer_attested"

livenessEvidenceSource

enum<string>

required

Who ran the liveness check.

Available options:

customer_attested,

deframe_managed

Example:

"customer_attested"

documentType

string | null

required

Type of identity document submitted, when known.

reason

object

required

Present only when status is rejected or rejected_retryable. Prefer this over rejectReason and providerResult, which carry raw provider values and vary between providers.

Show child attributes

updatedAt

string<date-time>

Example:

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

Overview

Health

Swap

Tracking

Strategies

Ondo

Tokens

Transfer

Wallets

Smart Account

Ramp

Get KYC status

Authorizations

Query Parameters

Response