Create BigDataCorp KYC iframe session
Starts the BigDataCorp document and liveness capture flow. Pods creates a KYC profile with provider bigdatacorp, stores only safe references and CPF hash/last4, and returns the iframe URL plus the Pods-generated kycUserId. 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. If the verified CPF maps to exactly one approved local BigDataCorp KYC profile or approved Avenia identity, Pods creates a customer-scoped approved profile from the existing Avenia IDs without starting a new capture. The response provides a safe completion URL and requiresWebView false for mobile compatibility. Otherwise, Pods can perform a bounded Avenia lookup while the CPF is present in this request.
Authorizations
API key for authentication. Obtain from your Pods dashboard.
Body
BigDataCorp iframe session creation payload
Brazilian CPF. Pods normalizes and hashes this value; the full CPF is not persisted.
"52998224725"
Applicant email
Applicant EVM wallet address
"0xb794F5eA0ba39494cE839613fffBA74279579268"
Optional id from your system for support correlation
"app-user-001"
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.
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.
Pods-generated public KYC user id
"550e8400-e29b-41d4-a716-446655440000"
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.
"https://iframe.bigdatacorp.com.br/550e8400-e29b-41d4-a716-446655440000"
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.
"bigdatacorp-onboarding-id"
Whether the client must mount the returned iframe URL for BigDataCorp capture.
true
Normalized Pods KYC status
created, provider_pending, approved, rejected, rejected_retryable, blocked "created"