Unlock foreign currency capability

curl --request POST \
  --url https://api.pods.finance/api/v1/kyc/currency-unlock \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "currency": "usd",
  "kycUserId": "550e8400-e29b-41d4-a716-446655440000",
  "rampProvider": "avenia",
  "bankBeneficiaryName": "Jane Doe",
  "bankName": "Chase",
  "bankAccountNumber": "123456789",
  "bankRoutingNumber": "021000021",
  "beneficiaryStreetLine1": "1 Main St",
  "beneficiaryCity": "New York",
  "beneficiaryState": "NY",
  "beneficiaryPostalCode": "10001",
  "beneficiaryCountry": "US",
  "alias": "Jane Chase wire",
  "beneficiaryStreetLine2": "<string>"
}
'

import requests

url = "https://api.pods.finance/api/v1/kyc/currency-unlock"

payload = {
    "currency": "usd",
    "kycUserId": "550e8400-e29b-41d4-a716-446655440000",
    "rampProvider": "avenia",
    "bankBeneficiaryName": "Jane Doe",
    "bankName": "Chase",
    "bankAccountNumber": "123456789",
    "bankRoutingNumber": "021000021",
    "beneficiaryStreetLine1": "1 Main St",
    "beneficiaryCity": "New York",
    "beneficiaryState": "NY",
    "beneficiaryPostalCode": "10001",
    "beneficiaryCountry": "US",
    "alias": "Jane Chase wire",
    "beneficiaryStreetLine2": "<string>"
}
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({
    currency: 'usd',
    kycUserId: '550e8400-e29b-41d4-a716-446655440000',
    rampProvider: 'avenia',
    bankBeneficiaryName: 'Jane Doe',
    bankName: 'Chase',
    bankAccountNumber: '123456789',
    bankRoutingNumber: '021000021',
    beneficiaryStreetLine1: '1 Main St',
    beneficiaryCity: 'New York',
    beneficiaryState: 'NY',
    beneficiaryPostalCode: '10001',
    beneficiaryCountry: 'US',
    alias: 'Jane Chase wire',
    beneficiaryStreetLine2: '<string>'
  })
};

fetch('https://api.pods.finance/api/v1/kyc/currency-unlock', 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/currency-unlock",
  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([
    'currency' => 'usd',
    'kycUserId' => '550e8400-e29b-41d4-a716-446655440000',
    'rampProvider' => 'avenia',
    'bankBeneficiaryName' => 'Jane Doe',
    'bankName' => 'Chase',
    'bankAccountNumber' => '123456789',
    'bankRoutingNumber' => '021000021',
    'beneficiaryStreetLine1' => '1 Main St',
    'beneficiaryCity' => 'New York',
    'beneficiaryState' => 'NY',
    'beneficiaryPostalCode' => '10001',
    'beneficiaryCountry' => 'US',
    'alias' => 'Jane Chase wire',
    'beneficiaryStreetLine2' => '<string>'
  ]),
  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/currency-unlock"

	payload := strings.NewReader("{\n  \"currency\": \"usd\",\n  \"kycUserId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"rampProvider\": \"avenia\",\n  \"bankBeneficiaryName\": \"Jane Doe\",\n  \"bankName\": \"Chase\",\n  \"bankAccountNumber\": \"123456789\",\n  \"bankRoutingNumber\": \"021000021\",\n  \"beneficiaryStreetLine1\": \"1 Main St\",\n  \"beneficiaryCity\": \"New York\",\n  \"beneficiaryState\": \"NY\",\n  \"beneficiaryPostalCode\": \"10001\",\n  \"beneficiaryCountry\": \"US\",\n  \"alias\": \"Jane Chase wire\",\n  \"beneficiaryStreetLine2\": \"<string>\"\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/currency-unlock")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"currency\": \"usd\",\n  \"kycUserId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"rampProvider\": \"avenia\",\n  \"bankBeneficiaryName\": \"Jane Doe\",\n  \"bankName\": \"Chase\",\n  \"bankAccountNumber\": \"123456789\",\n  \"bankRoutingNumber\": \"021000021\",\n  \"beneficiaryStreetLine1\": \"1 Main St\",\n  \"beneficiaryCity\": \"New York\",\n  \"beneficiaryState\": \"NY\",\n  \"beneficiaryPostalCode\": \"10001\",\n  \"beneficiaryCountry\": \"US\",\n  \"alias\": \"Jane Chase wire\",\n  \"beneficiaryStreetLine2\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pods.finance/api/v1/kyc/currency-unlock")

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  \"currency\": \"usd\",\n  \"kycUserId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"rampProvider\": \"avenia\",\n  \"bankBeneficiaryName\": \"Jane Doe\",\n  \"bankName\": \"Chase\",\n  \"bankAccountNumber\": \"123456789\",\n  \"bankRoutingNumber\": \"021000021\",\n  \"beneficiaryStreetLine1\": \"1 Main St\",\n  \"beneficiaryCity\": \"New York\",\n  \"beneficiaryState\": \"NY\",\n  \"beneficiaryPostalCode\": \"10001\",\n  \"beneficiaryCountry\": \"US\",\n  \"alias\": \"Jane Chase wire\",\n  \"beneficiaryStreetLine2\": \"<string>\"\n}"

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

{
  "kycUserId": "550e8400-e29b-41d4-a716-446655440000",
  "provider": "sumsub",
  "email": "[email protected]",
  "walletAddress": "EXYhCNamLPFfSMekSn7Lzc2cP32aZpRa7ok5gErdJzcj",
  "walletAddresses": [
    "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",
  "ramps": {
    "unblockpay": {
      "status": "approved",
      "capabilities": {
        "BRL": true,
        "EUR": false,
        "USD": true
      },
      "verificationLink": "https://in.sumsub.com/websdk/p/EXAMPLE",
      "verification": {
        "approved": [],
        "partiallyRejected": [
          {
            "name": "PROOF_OF_ADDRESS",
            "rejectionCodes": [
              "EXPIRED"
            ],
            "rejectionDescription": "Bill is older than 3 months."
          }
        ],
        "pending": [
          "SELFIE"
        ],
        "rejected": [
          {
            "name": "PROOF_OF_ADDRESS",
            "rejectionCodes": [
              "EXPIRED"
            ],
            "rejectionDescription": "Bill is older than 3 months."
          }
        ],
        "type": "LIGHT",
        "underReview": []
      },
      "unlock": {
        "onrampReady": true,
        "offrampReady": false,
        "requiredBodyFields": [
          "bankBeneficiaryName",
          "bankName",
          "bankAccountNumber",
          "bankRoutingNumber",
          "beneficiaryStreetLine1",
          "beneficiaryCity",
          "beneficiaryState",
          "beneficiaryPostalCode",
          "beneficiaryCountry"
        ]
      }
    }
  }
}

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

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

Unlock foreign currency capability

Default rampProvider=avenia: after Avenia approves a foreign KYC profile, submit the USD unlock, refresh account metadata, and return usdEnabled. Idempotent when Avenia USD is already enabled. rampProvider=unblockpay refreshes GET /v1/customers//rails, persists unblockpay.capabilities, and returns ramps.unblockpay.unlock with the extra bank fields needed to register a wire External Account for offramp. Sending those fields on the same POST creates the External Account. Top-level usdEnabled stays Avenia-only.

POST

api

kyc

currency-unlock

Unlock foreign currency capability

curl --request POST \
  --url https://api.pods.finance/api/v1/kyc/currency-unlock \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "currency": "usd",
  "kycUserId": "550e8400-e29b-41d4-a716-446655440000",
  "rampProvider": "avenia",
  "bankBeneficiaryName": "Jane Doe",
  "bankName": "Chase",
  "bankAccountNumber": "123456789",
  "bankRoutingNumber": "021000021",
  "beneficiaryStreetLine1": "1 Main St",
  "beneficiaryCity": "New York",
  "beneficiaryState": "NY",
  "beneficiaryPostalCode": "10001",
  "beneficiaryCountry": "US",
  "alias": "Jane Chase wire",
  "beneficiaryStreetLine2": "<string>"
}
'

import requests

url = "https://api.pods.finance/api/v1/kyc/currency-unlock"

payload = {
    "currency": "usd",
    "kycUserId": "550e8400-e29b-41d4-a716-446655440000",
    "rampProvider": "avenia",
    "bankBeneficiaryName": "Jane Doe",
    "bankName": "Chase",
    "bankAccountNumber": "123456789",
    "bankRoutingNumber": "021000021",
    "beneficiaryStreetLine1": "1 Main St",
    "beneficiaryCity": "New York",
    "beneficiaryState": "NY",
    "beneficiaryPostalCode": "10001",
    "beneficiaryCountry": "US",
    "alias": "Jane Chase wire",
    "beneficiaryStreetLine2": "<string>"
}
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({
    currency: 'usd',
    kycUserId: '550e8400-e29b-41d4-a716-446655440000',
    rampProvider: 'avenia',
    bankBeneficiaryName: 'Jane Doe',
    bankName: 'Chase',
    bankAccountNumber: '123456789',
    bankRoutingNumber: '021000021',
    beneficiaryStreetLine1: '1 Main St',
    beneficiaryCity: 'New York',
    beneficiaryState: 'NY',
    beneficiaryPostalCode: '10001',
    beneficiaryCountry: 'US',
    alias: 'Jane Chase wire',
    beneficiaryStreetLine2: '<string>'
  })
};

fetch('https://api.pods.finance/api/v1/kyc/currency-unlock', 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/currency-unlock",
  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([
    'currency' => 'usd',
    'kycUserId' => '550e8400-e29b-41d4-a716-446655440000',
    'rampProvider' => 'avenia',
    'bankBeneficiaryName' => 'Jane Doe',
    'bankName' => 'Chase',
    'bankAccountNumber' => '123456789',
    'bankRoutingNumber' => '021000021',
    'beneficiaryStreetLine1' => '1 Main St',
    'beneficiaryCity' => 'New York',
    'beneficiaryState' => 'NY',
    'beneficiaryPostalCode' => '10001',
    'beneficiaryCountry' => 'US',
    'alias' => 'Jane Chase wire',
    'beneficiaryStreetLine2' => '<string>'
  ]),
  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/currency-unlock"

	payload := strings.NewReader("{\n  \"currency\": \"usd\",\n  \"kycUserId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"rampProvider\": \"avenia\",\n  \"bankBeneficiaryName\": \"Jane Doe\",\n  \"bankName\": \"Chase\",\n  \"bankAccountNumber\": \"123456789\",\n  \"bankRoutingNumber\": \"021000021\",\n  \"beneficiaryStreetLine1\": \"1 Main St\",\n  \"beneficiaryCity\": \"New York\",\n  \"beneficiaryState\": \"NY\",\n  \"beneficiaryPostalCode\": \"10001\",\n  \"beneficiaryCountry\": \"US\",\n  \"alias\": \"Jane Chase wire\",\n  \"beneficiaryStreetLine2\": \"<string>\"\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/currency-unlock")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"currency\": \"usd\",\n  \"kycUserId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"rampProvider\": \"avenia\",\n  \"bankBeneficiaryName\": \"Jane Doe\",\n  \"bankName\": \"Chase\",\n  \"bankAccountNumber\": \"123456789\",\n  \"bankRoutingNumber\": \"021000021\",\n  \"beneficiaryStreetLine1\": \"1 Main St\",\n  \"beneficiaryCity\": \"New York\",\n  \"beneficiaryState\": \"NY\",\n  \"beneficiaryPostalCode\": \"10001\",\n  \"beneficiaryCountry\": \"US\",\n  \"alias\": \"Jane Chase wire\",\n  \"beneficiaryStreetLine2\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pods.finance/api/v1/kyc/currency-unlock")

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  \"currency\": \"usd\",\n  \"kycUserId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"rampProvider\": \"avenia\",\n  \"bankBeneficiaryName\": \"Jane Doe\",\n  \"bankName\": \"Chase\",\n  \"bankAccountNumber\": \"123456789\",\n  \"bankRoutingNumber\": \"021000021\",\n  \"beneficiaryStreetLine1\": \"1 Main St\",\n  \"beneficiaryCity\": \"New York\",\n  \"beneficiaryState\": \"NY\",\n  \"beneficiaryPostalCode\": \"10001\",\n  \"beneficiaryCountry\": \"US\",\n  \"alias\": \"Jane Chase wire\",\n  \"beneficiaryStreetLine2\": \"<string>\"\n}"

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

{
  "kycUserId": "550e8400-e29b-41d4-a716-446655440000",
  "provider": "sumsub",
  "email": "[email protected]",
  "walletAddress": "EXYhCNamLPFfSMekSn7Lzc2cP32aZpRa7ok5gErdJzcj",
  "walletAddresses": [
    "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",
  "ramps": {
    "unblockpay": {
      "status": "approved",
      "capabilities": {
        "BRL": true,
        "EUR": false,
        "USD": true
      },
      "verificationLink": "https://in.sumsub.com/websdk/p/EXAMPLE",
      "verification": {
        "approved": [],
        "partiallyRejected": [
          {
            "name": "PROOF_OF_ADDRESS",
            "rejectionCodes": [
              "EXPIRED"
            ],
            "rejectionDescription": "Bill is older than 3 months."
          }
        ],
        "pending": [
          "SELFIE"
        ],
        "rejected": [
          {
            "name": "PROOF_OF_ADDRESS",
            "rejectionCodes": [
              "EXPIRED"
            ],
            "rejectionDescription": "Bill is older than 3 months."
          }
        ],
        "type": "LIGHT",
        "underReview": []
      },
      "unlock": {
        "onrampReady": true,
        "offrampReady": false,
        "requiredBodyFields": [
          "bankBeneficiaryName",
          "bankName",
          "bankAccountNumber",
          "bankRoutingNumber",
          "beneficiaryStreetLine1",
          "beneficiaryCity",
          "beneficiaryState",
          "beneficiaryPostalCode",
          "beneficiaryCountry"
        ]
      }
    }
  }
}

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

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

Body

application/json

Request Avenia currency unlock, or refresh UnblockPay rails / register a USD wire External Account when rampProvider is unblockpay

currency

enum<string>

required

Currency to unlock (Avenia) or refresh from ramp-provider rails (UnblockPay)

Available options:

usd

Example:

"usd"

kycUserId

string<uuid>

required

Pods-generated KYC user id returned by the foreign share-token endpoint

Example:

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

rampProvider

string

Fiat ramp provider. Omitted or empty defaults to avenia (submit unlock). unblockpay refreshes GET /rails and, when the USD bank fields below are complete, registers a wire External Account for offramp. Never writes top-level usdEnabled.

Example:

"avenia"

bankBeneficiaryName

string

UnblockPay USD offramp only. Same field Rivool already sends on Avenia USDC→USD quotes.

Example:

"Jane Doe"

bankName

string

Example:

"Chase"

bankAccountNumber

string

Example:

"123456789"

bankRoutingNumber

string

Example:

"021000021"

beneficiaryStreetLine1

string

Example:

"1 Main St"

beneficiaryCity

string

Example:

"New York"

beneficiaryState

string

Example:

"NY"

beneficiaryPostalCode

string

Example:

"10001"

beneficiaryCountry

string

Example:

"US"

alias

string

Optional UnblockPay External Account name. Defaults to bankBeneficiaryName.

Example:

"Jane Chase wire"

beneficiaryStreetLine2

string

Response

Currency unlock submitted or already enabled

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"

walletAddresses

string[]

required

Every wallet linked to this Pods KYC profile. walletAddress is the primary (first linked) address and remains for existing clients.

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"

ramps

object

Per ramp-provider KYC readiness. Present only when an UnblockPay nest exists. usdEnabled / brlaEnabled stay Avenia-only. When the nest is non-terminal, GET /status live-refreshes UnblockPay and may POST /check once after Path B uploads.

Show child attributes

Overview

Health

Swap

Tracking

Strategies

Ondo

Tokens

Transfer

Wallets

Smart Account

Ramp

Unlock foreign currency capability

Authorizations

Body

Response