Skip to main content
POST
Import Sumsub reusable KYC share token

Authorizations

x-api-key
string
header
required

API key for authentication. Obtain from your Pods dashboard.

Body

application/json

Reusable KYC share token import payload. At least one of cpf or taxId is required; sending both is allowed and cpf is what identity matching uses.

shareToken
string
required

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"

email
string<email>
required

Applicant email

walletAddress
string
required

Applicant wallet. Checksummed EVM address or Solana public key.

Example:

"EXYhCNamLPFfSMekSn7Lzc2cP32aZpRa7ok5gErdJzcj"

cpf
string

Brazilian CPF. Optional, and accepted alongside any taxIdCountry — a foreign national resident in Brazil holds both. Send it whenever it is known: it is what lets Pods reuse an already-approved identity instead of creating a duplicate at Avenia, and it is what opens the BRL rail. Pods stores only a salted hash and the last four digits.

Example:

"52998224725"

taxId
string

Tax identifier for an applicant verified with a document that carries no CPF, such as a passport, or whose jurisdiction is not Brazil. Supply either cpf or taxId; when taxIdCountry is BRA and the value is itself a valid CPF, Pods treats it as one. Pods stores only a salted hash and the last four digits.

Example:

"FX1234567"

taxIdCountry
string

ISO 3166-1 alpha-3 jurisdiction of the tax id (for example BRA or USA). Required whenever the tax id is not a CPF; it is inferred as BRA only when a cpf is sent or the taxId itself passes the CPF check digits. The country is part of the stored identity hash, so the same digits under two jurisdictions are two different identities — and a profile submitted under the wrong country cannot be corrected afterwards. A profile without a CPF does not receive the BRL ramp; unlock USD with POST /api/v1/kyc/currency-unlock.

Required string length: 3
Example:

"BRA"

Response

KYC token import submitted or approved Avenia identity reused

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"