Skip to content

Stripe: Post Sources Source Verify

Stripe sources.postSourcesSourceVerify: arguments, response, policy and SDK examples.

← Sources operations · Get started

Operation stripe.postsourcessourceverify

Provider route: POST /v1/sources/{source}/verify. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";
async function execute(input: Parameters<StripeIntegration["sources"]["postSourcesSourceVerify"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.sources.postSourcesSourceVerify(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.sources.post_sources_source_verify(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.sourcestringRequired within parentMaximum length: 5000
headersobjectOptionalAdditional keys: not allowed
headers.Idempotency-KeystringOptionalMinimum length: 1
Maximum length: 255
bodyobjectRequired within parentAdditional keys: not allowed
body.expandarrayOptionalSpecifies which fields in the response should be expanded.
body.expand[]stringEach itemMaximum length: 5000
body.valuesarrayRequired within parentThe values needed to verify the source.
body.values[]stringEach itemMaximum length: 5000

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Create a source — response body

Referenced models: Create a source — response body

21 more schemas are linked from the tables above, on the schema pages.

Create a source — response body — code verification
FieldTypePresenceDescription and constraints
$objectRoot
attempts_remainingJSONRequired within parent
attempts_remaining (anyOf 1)integerAlternativeThe number of attempts remaining to authenticate the source object with a verification code.
attempts_remaining (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
statusstringRequired within parentThe status of the code verification, either `pending` (awaiting verification, `attempts_remaining` should be greater than 0), `succeeded` (successful verification) or `failed` (failed verification, cannot be verified anymore as `attempts_remaining` should be 0).
Maximum length: 5000
Create a source — response body — source order
FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeA positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order.
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentThree-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
Format: currency
emailstringOptionalThe email address of the customer placing the order.
Maximum length: 5000
itemsJSONOptional
items (anyOf 1)arrayAlternativeList of items constituting the order.
items (anyOf 1)[]ModelEach itemExpand Create a source — response body — source order items List of items constituting the order item
items (anyOf 2)nullAlternative
shippingModelOptionalExpand Create a source — response body — source order shipping

Referenced models: Create a source — response body — source order shipping, Create a source — response body — source order items List of items constituting the order item

Create a source — response body — owner value address, email, name, phone, verified address, verified email, verified name, verified phone
FieldTypePresenceDescription and constraints
$objectRoot
addressJSONOptional
address (anyOf 1)JSONAlternativeOwner's address.
address (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a Location — response body — address
address (anyOf 2)nullAlternative
emailJSONOptional
email (anyOf 1)stringAlternativeOwner's email address.
Maximum length: 5000
email (anyOf 2)nullAlternative
nameJSONOptional
name (anyOf 1)stringAlternativeOwner's full name.
Maximum length: 5000
name (anyOf 2)nullAlternative
phoneJSONOptional
phone (anyOf 1)stringAlternativeOwner's phone number (including extension).
Maximum length: 5000
phone (anyOf 2)nullAlternative
verified_addressJSONOptional
verified_address (anyOf 1)JSONAlternativeVerified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
verified_address (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a Location — response body — address
verified_address (anyOf 2)nullAlternative
verified_emailJSONOptional
verified_email (anyOf 1)stringAlternativeVerified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
Maximum length: 5000
verified_email (anyOf 2)nullAlternative
verified_nameJSONOptional
verified_name (anyOf 1)stringAlternativeVerified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
Maximum length: 5000
verified_name (anyOf 2)nullAlternative
verified_phoneJSONOptional
verified_phone (anyOf 1)stringAlternativeVerified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
Maximum length: 5000
verified_phone (anyOf 2)nullAlternative

Referenced models: Create a Location — response body — address

Create a source — response body — receiver
FieldTypePresenceDescription and constraints
$objectRoot
addressJSONOptional
address (anyOf 1)stringAlternativeThe address of the receiver source. This is the value that should be communicated to the customer to send their funds to.
Maximum length: 5000
address (anyOf 2)nullAlternative
amount_chargedJSONRequired within parent
amount_charged (anyOf 1)integerAlternativeThe total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency.
amount_charged (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount_receivedJSONRequired within parent
amount_received (anyOf 1)integerAlternativeThe total amount received by the receiver source. `amount_received = amount_returned + amount_charged` should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency.
amount_received (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount_returnedJSONRequired within parent
amount_returned (anyOf 1)integerAlternativeThe total amount that was returned to the customer. The amount returned is expressed in the source's currency.
amount_returned (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
refund_attributes_methodstringRequired within parentType of refund attribute method, one of `email`, `manual`, or `none`.
Maximum length: 5000
refund_attributes_statusstringRequired within parentType of refund attribute status, one of `missing`, `requested`, or `available`.
Maximum length: 5000
Create a source — response body — redirect
FieldTypePresenceDescription and constraints
$objectRoot
failure_reasonJSONOptional
failure_reason (anyOf 1)stringAlternativeThe failure reason for the redirect, either `user_abort` (the customer aborted or dropped out of the redirect flow), `declined` (the authentication failed or the transaction was declined), or `processing_error` (the redirect failed due to a technical error). Present only if the redirect status is `failed`.
Maximum length: 5000
failure_reason (anyOf 2)nullAlternative
return_urlstringRequired within parentThe URL you provide to redirect the customer to after they authenticated their payment.
Maximum length: 5000
statusstringRequired within parentThe status of the redirect, either `pending` (ready to be used by your customer to authenticate the transaction), `succeeded` (successful authentication, cannot be reused) or `not_required` (redirect should not be used) or `failed` (failed authentication, cannot be reused).
Maximum length: 5000
urlstringRequired within parentThe URL provided to you to redirect a customer to as part of a `redirect` authentication flow.
Maximum length: 2048
Create a source — response body — ach credit transfer
FieldTypePresenceDescription and constraints
$objectRoot
account_numberJSONOptional
account_number (anyOf 1)stringAlternative
account_number (anyOf 2)nullAlternative
bank_nameJSONOptional
bank_name (anyOf 1)stringAlternative
bank_name (anyOf 2)nullAlternative
fingerprintJSONOptional
fingerprint (anyOf 1)stringAlternative
fingerprint (anyOf 2)nullAlternative
refund_account_holder_nameJSONOptional
refund_account_holder_name (anyOf 1)stringAlternative
refund_account_holder_name (anyOf 2)nullAlternative
refund_account_holder_typeJSONOptional
refund_account_holder_type (anyOf 1)stringAlternative
refund_account_holder_type (anyOf 2)nullAlternative
refund_routing_numberJSONOptional
refund_routing_number (anyOf 1)stringAlternative
refund_routing_number (anyOf 2)nullAlternative
routing_numberJSONOptional
routing_number (anyOf 1)stringAlternative
routing_number (anyOf 2)nullAlternative
swift_codeJSONOptional
swift_code (anyOf 1)stringAlternative
swift_code (anyOf 2)nullAlternative

SDK function policy ID: stripe.postsourcessourceverify. Catalog operation: PostSourcesSourceVerify. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.