Import foreign Sumsub reusable KYC share token

curl --request POST \
  --url https://api.pods.finance/api/v1/kyc/foreign/sumsub-share-token \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "email": "[email protected]",
  "shareToken": "SUMSUB_SHARE_TOKEN",
  "sumsubApplicantId": "6a3502bf7fee2fab5377cb1e",
  "taxId": "123456789",
  "taxIdCountry": "USA",
  "walletAddress": "EXYhCNamLPFfSMekSn7Lzc2cP32aZpRa7ok5gErdJzcj"
}
'

import requests

url = "https://api.pods.finance/api/v1/kyc/foreign/sumsub-share-token"

payload = {
    "email": "[email protected]",
    "shareToken": "SUMSUB_SHARE_TOKEN",
    "sumsubApplicantId": "6a3502bf7fee2fab5377cb1e",
    "taxId": "123456789",
    "taxIdCountry": "USA",
    "walletAddress": "EXYhCNamLPFfSMekSn7Lzc2cP32aZpRa7ok5gErdJzcj"
}
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({
    email: '[email protected]',
    shareToken: 'SUMSUB_SHARE_TOKEN',
    sumsubApplicantId: '6a3502bf7fee2fab5377cb1e',
    taxId: '123456789',
    taxIdCountry: 'USA',
    walletAddress: 'EXYhCNamLPFfSMekSn7Lzc2cP32aZpRa7ok5gErdJzcj'
  })
};

fetch('https://api.pods.finance/api/v1/kyc/foreign/sumsub-share-token', 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/foreign/sumsub-share-token",
  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([
    'email' => '[email protected]',
    'shareToken' => 'SUMSUB_SHARE_TOKEN',
    'sumsubApplicantId' => '6a3502bf7fee2fab5377cb1e',
    'taxId' => '123456789',
    'taxIdCountry' => 'USA',
    'walletAddress' => 'EXYhCNamLPFfSMekSn7Lzc2cP32aZpRa7ok5gErdJzcj'
  ]),
  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/foreign/sumsub-share-token"

	payload := strings.NewReader("{\n  \"email\": \"[email protected]\",\n  \"shareToken\": \"SUMSUB_SHARE_TOKEN\",\n  \"sumsubApplicantId\": \"6a3502bf7fee2fab5377cb1e\",\n  \"taxId\": \"123456789\",\n  \"taxIdCountry\": \"USA\",\n  \"walletAddress\": \"EXYhCNamLPFfSMekSn7Lzc2cP32aZpRa7ok5gErdJzcj\"\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/foreign/sumsub-share-token")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"[email protected]\",\n  \"shareToken\": \"SUMSUB_SHARE_TOKEN\",\n  \"sumsubApplicantId\": \"6a3502bf7fee2fab5377cb1e\",\n  \"taxId\": \"123456789\",\n  \"taxIdCountry\": \"USA\",\n  \"walletAddress\": \"EXYhCNamLPFfSMekSn7Lzc2cP32aZpRa7ok5gErdJzcj\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pods.finance/api/v1/kyc/foreign/sumsub-share-token")

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  \"email\": \"[email protected]\",\n  \"shareToken\": \"SUMSUB_SHARE_TOKEN\",\n  \"sumsubApplicantId\": \"6a3502bf7fee2fab5377cb1e\",\n  \"taxId\": \"123456789\",\n  \"taxIdCountry\": \"USA\",\n  \"walletAddress\": \"EXYhCNamLPFfSMekSn7Lzc2cP32aZpRa7ok5gErdJzcj\"\n}"

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

{
  "kycUserId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "provider_pending"
}

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

Import foreign Sumsub reusable KYC share token

Submit a fresh Sumsub reusable KYC share token for a non-Brazil applicant after Sumsub approves the verification. Pods validates the foreign tax id, stores only a salted hash plus the last four digits, creates or reuses the customer profile and Avenia subaccount, imports the token into Avenia, and returns a Pods-generated kycUserId. Poll GET /api/v1/kyc/status until status is approved, then call POST /api/v1/kyc/currency-unlock to enable USD ramps.

POST

api

kyc

foreign

sumsub-share-token

Import foreign Sumsub reusable KYC share token

curl --request POST \
  --url https://api.pods.finance/api/v1/kyc/foreign/sumsub-share-token \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "email": "[email protected]",
  "shareToken": "SUMSUB_SHARE_TOKEN",
  "sumsubApplicantId": "6a3502bf7fee2fab5377cb1e",
  "taxId": "123456789",
  "taxIdCountry": "USA",
  "walletAddress": "EXYhCNamLPFfSMekSn7Lzc2cP32aZpRa7ok5gErdJzcj"
}
'

import requests

url = "https://api.pods.finance/api/v1/kyc/foreign/sumsub-share-token"

payload = {
    "email": "[email protected]",
    "shareToken": "SUMSUB_SHARE_TOKEN",
    "sumsubApplicantId": "6a3502bf7fee2fab5377cb1e",
    "taxId": "123456789",
    "taxIdCountry": "USA",
    "walletAddress": "EXYhCNamLPFfSMekSn7Lzc2cP32aZpRa7ok5gErdJzcj"
}
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({
    email: '[email protected]',
    shareToken: 'SUMSUB_SHARE_TOKEN',
    sumsubApplicantId: '6a3502bf7fee2fab5377cb1e',
    taxId: '123456789',
    taxIdCountry: 'USA',
    walletAddress: 'EXYhCNamLPFfSMekSn7Lzc2cP32aZpRa7ok5gErdJzcj'
  })
};

fetch('https://api.pods.finance/api/v1/kyc/foreign/sumsub-share-token', 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/foreign/sumsub-share-token",
  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([
    'email' => '[email protected]',
    'shareToken' => 'SUMSUB_SHARE_TOKEN',
    'sumsubApplicantId' => '6a3502bf7fee2fab5377cb1e',
    'taxId' => '123456789',
    'taxIdCountry' => 'USA',
    'walletAddress' => 'EXYhCNamLPFfSMekSn7Lzc2cP32aZpRa7ok5gErdJzcj'
  ]),
  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/foreign/sumsub-share-token"

	payload := strings.NewReader("{\n  \"email\": \"[email protected]\",\n  \"shareToken\": \"SUMSUB_SHARE_TOKEN\",\n  \"sumsubApplicantId\": \"6a3502bf7fee2fab5377cb1e\",\n  \"taxId\": \"123456789\",\n  \"taxIdCountry\": \"USA\",\n  \"walletAddress\": \"EXYhCNamLPFfSMekSn7Lzc2cP32aZpRa7ok5gErdJzcj\"\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/foreign/sumsub-share-token")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"[email protected]\",\n  \"shareToken\": \"SUMSUB_SHARE_TOKEN\",\n  \"sumsubApplicantId\": \"6a3502bf7fee2fab5377cb1e\",\n  \"taxId\": \"123456789\",\n  \"taxIdCountry\": \"USA\",\n  \"walletAddress\": \"EXYhCNamLPFfSMekSn7Lzc2cP32aZpRa7ok5gErdJzcj\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pods.finance/api/v1/kyc/foreign/sumsub-share-token")

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  \"email\": \"[email protected]\",\n  \"shareToken\": \"SUMSUB_SHARE_TOKEN\",\n  \"sumsubApplicantId\": \"6a3502bf7fee2fab5377cb1e\",\n  \"taxId\": \"123456789\",\n  \"taxIdCountry\": \"USA\",\n  \"walletAddress\": \"EXYhCNamLPFfSMekSn7Lzc2cP32aZpRa7ok5gErdJzcj\"\n}"

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

{
  "kycUserId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "provider_pending"
}

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

Foreign reusable KYC share token import payload (non-Brazil tax id)

string<email>

required

Applicant email

Example:

"[email protected]"

Fresh Sumsub reusable KYC share token generated for the Avenia recipient

Example:

"SUMSUB_SHARE_TOKEN"

sumsubApplicantId

string

required

Unique Sumsub applicant id from the approved applicantReviewed webhook. Pods uses it for customer-scoped idempotency.

Example:

"6a3502bf7fee2fab5377cb1e"

taxId

string

required

Foreign tax identifier (for example SSN or national ID). Pods stores only a salted hash and the last four digits.

Example:

"123456789"

taxIdCountry

string

required

ISO 3166-1 alpha-3 country code for the tax id (for example USA)

Required string length: 3

Example:

"USA"

walletAddress

string

required

Applicant wallet. Checksummed EVM address or Solana public key.

Example:

"EXYhCNamLPFfSMekSn7Lzc2cP32aZpRa7ok5gErdJzcj"

Response

Foreign KYC token import submitted

KYC import submission result

kycUserId

string<uuid>

required

Pods-generated public KYC user id

Example:

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

status

enum<string>

required

Normalized Pods KYC status

Available options:

created,

provider_pending,

approved,

rejected,

rejected_retryable,

blocked

Example:

"provider_pending"

Overview

Health

Swap

Tracking

Strategies

Ondo

Tokens

Transfer

Wallets

Smart Account

Ramp

Import foreign Sumsub reusable KYC share token

Authorizations

Body

Response