Create BigDataCorp KYC iframe session

curl --request POST \
  --url https://api.pods.finance/api/v1/kyc/bigdatacorp/sessions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "cpf": "52998224725",
  "email": "[email protected]",
  "walletAddress": "0xb794F5eA0ba39494cE839613fffBA74279579268",
  "externalUserId": "app-user-001"
}
'

import requests

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

payload = {
    "cpf": "52998224725",
    "email": "[email protected]",
    "walletAddress": "0xb794F5eA0ba39494cE839613fffBA74279579268",
    "externalUserId": "app-user-001"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    cpf: '52998224725',
    email: '[email protected]',
    walletAddress: '0xb794F5eA0ba39494cE839613fffBA74279579268',
    externalUserId: 'app-user-001'
  })
};

fetch('https://api.pods.finance/api/v1/kyc/bigdatacorp/sessions', 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/bigdatacorp/sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'cpf' => '52998224725',
    'email' => '[email protected]',
    'walletAddress' => '0xb794F5eA0ba39494cE839613fffBA74279579268',
    'externalUserId' => 'app-user-001'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"cpf\": \"52998224725\",\n  \"email\": \"[email protected]\",\n  \"walletAddress\": \"0xb794F5eA0ba39494cE839613fffBA74279579268\",\n  \"externalUserId\": \"app-user-001\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.pods.finance/api/v1/kyc/bigdatacorp/sessions")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cpf\": \"52998224725\",\n  \"email\": \"[email protected]\",\n  \"walletAddress\": \"0xb794F5eA0ba39494cE839613fffBA74279579268\",\n  \"externalUserId\": \"app-user-001\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cpf\": \"52998224725\",\n  \"email\": \"[email protected]\",\n  \"walletAddress\": \"0xb794F5eA0ba39494cE839613fffBA74279579268\",\n  \"externalUserId\": \"app-user-001\"\n}"

response = http.request(request)
puts response.read_body

{
  "kycUserId": "550e8400-e29b-41d4-a716-446655440000",
  "iframeUrl": "https://iframe.bigdatacorp.com.br/550e8400-e29b-41d4-a716-446655440000",
  "iframeSessionId": "bigdatacorp-onboarding-id",
  "status": "created"
}

{
  "error": {
    "code": "QUOTE_NOT_FOUND",
    "message": "Quote not found or expired"
  }
}

{
  "error": {
    "code": "QUOTE_NOT_FOUND",
    "message": "Quote not found or expired"
  }
}

KYC

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. Repeated requests reuse an active capture for up to seven minutes. If the verified CPF maps to exactly one approved local BigDataCorp KYC profile, Pods creates a customer-scoped approved profile from the existing Avenia IDs without calling Avenia or creating another iframe. Otherwise, Pods can perform a bounded Avenia lookup while the CPF is present in this request.

POST

api

kyc

bigdatacorp

sessions

Create BigDataCorp KYC iframe session

curl --request POST \
  --url https://api.pods.finance/api/v1/kyc/bigdatacorp/sessions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "cpf": "52998224725",
  "email": "[email protected]",
  "walletAddress": "0xb794F5eA0ba39494cE839613fffBA74279579268",
  "externalUserId": "app-user-001"
}
'

import requests

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

payload = {
    "cpf": "52998224725",
    "email": "[email protected]",
    "walletAddress": "0xb794F5eA0ba39494cE839613fffBA74279579268",
    "externalUserId": "app-user-001"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    cpf: '52998224725',
    email: '[email protected]',
    walletAddress: '0xb794F5eA0ba39494cE839613fffBA74279579268',
    externalUserId: 'app-user-001'
  })
};

fetch('https://api.pods.finance/api/v1/kyc/bigdatacorp/sessions', 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/bigdatacorp/sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'cpf' => '52998224725',
    'email' => '[email protected]',
    'walletAddress' => '0xb794F5eA0ba39494cE839613fffBA74279579268',
    'externalUserId' => 'app-user-001'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"cpf\": \"52998224725\",\n  \"email\": \"[email protected]\",\n  \"walletAddress\": \"0xb794F5eA0ba39494cE839613fffBA74279579268\",\n  \"externalUserId\": \"app-user-001\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.pods.finance/api/v1/kyc/bigdatacorp/sessions")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cpf\": \"52998224725\",\n  \"email\": \"[email protected]\",\n  \"walletAddress\": \"0xb794F5eA0ba39494cE839613fffBA74279579268\",\n  \"externalUserId\": \"app-user-001\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cpf\": \"52998224725\",\n  \"email\": \"[email protected]\",\n  \"walletAddress\": \"0xb794F5eA0ba39494cE839613fffBA74279579268\",\n  \"externalUserId\": \"app-user-001\"\n}"

response = http.request(request)
puts response.read_body

{
  "kycUserId": "550e8400-e29b-41d4-a716-446655440000",
  "iframeUrl": "https://iframe.bigdatacorp.com.br/550e8400-e29b-41d4-a716-446655440000",
  "iframeSessionId": "bigdatacorp-onboarding-id",
  "status": "created"
}

{
  "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.

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"

string<email>

required

Applicant email

Example:

"[email protected]"

walletAddress

string

required

Applicant EVM wallet address

Example:

"0xb794F5eA0ba39494cE839613fffBA74279579268"

externalUserId

string

Optional id from your system for support correlation

Example:

"app-user-001"

Response

BigDataCorp iframe session created or approved BigDataCorp KYC profile reused

BigDataCorp session result. Repeated requests for an active capture return the same iframeUrl and iframeSessionId for up to seven minutes. An approved KYC profile reuse returns status approved with null iframe fields; 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> | null

required

BigDataCorp iframe URL for document and liveness capture. Pods reuses the same URL for an active capture for up to seven minutes. Null when no capture is needed.

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"

status

enum<string>

required

Normalized Pods KYC status

Available options:

created,

provider_pending,

approved,

rejected,

rejected_retryable,

blocked

Example:

"created"

Import Sumsub reusable KYC share token

Submit completed BigDataCorp KYC to Avenia