Skip to main content
POST
Create BigDataCorp KYC iframe session

Authorizations

x-api-key
string
header
required

API key for authentication. Obtain from your Pods dashboard.

Body

application/json

BigDataCorp iframe session creation payload

cpf
string
required

Brazilian CPF. Pods normalizes and hashes this value; the full CPF is not persisted.

Example:

"52998224725"

email
string<email>
required

Applicant email

walletAddress
string
required

Applicant EVM wallet address

Example:

"0xb794F5eA0ba39494cE839613fffBA74279579268"

externalUserId
string

Optional id from your system for support correlation

Example:

"app-user-001"

restartExistingSession
boolean

When true, always create a fresh BigDataCorp iframe session for this KYC profile. Use this when retrying or remounting a mobile WebView that may cache an earlier iframe URL.

Example:

true

Response

BigDataCorp iframe session created, reused, or resolved as an approved reusable identity

BigDataCorp session result. Requests reuse an active capture for up to seven minutes unless restartExistingSession is true, which creates a fresh iframe session in the same KYC profile. An approved Avenia identity reuse returns status approved, a safe completion iframe URL, null iframeSessionId, and requiresWebView false. Poll the returned kycUserId through the canonical status endpoint.

kycUserId
string<uuid>
required

Pods-generated public KYC user id

Example:

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

iframeUrl
string<uri>
required

BigDataCorp iframe URL for document and liveness capture. When capture is not needed because an approved Avenia identity was reused, Pods returns a safe completion URL instead of null for mobile WebView compatibility.

Example:

"https://iframe.bigdatacorp.com.br/550e8400-e29b-41d4-a716-446655440000"

iframeSessionId
string | null
required

Current BigDataCorp onboarding id. Use it as the WebView remount key so a cached iframe cannot be displayed after Pods returns a newer session. Null when no capture is needed.

Example:

"bigdatacorp-onboarding-id"

requiresWebView
boolean
required

Whether the client must mount the returned iframe URL for BigDataCorp capture.

Example:

true

status
enum<string>
required

Normalized Pods KYC status

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

"created"