Skip to main content
GET
Get KYC status

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 or /api/v1/kyc/bigdatacorp/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

Available options:
sumsub,
bigdatacorp
Example:

"sumsub"

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

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 and BRLA became enabled.

Example:

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

updatedAt
string<date-time>
Example:

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