gelato_document_report_error
{
"type": "object",
"title": "GelatoDocumentReportError",
"properties": {
"code": {
"enum": [
"document_expired",
"document_type_not_supported",
"document_unverified_other"
],
"type": "string",
"nullable": true,
"description": "A short machine-readable string giving the reason for the verification failure.",
"x-stripeBypassValidation": true
},
"reason": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A human-readable message giving the reason for the failure. These messages can be shown to your users."
}
},
"description": "",
"x-expandableFields": []
}
gelato_email_report
{
"type": "object",
"title": "GelatoEmailReport",
"required": [
"status"
],
"properties": {
"email": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Email to be verified."
},
"error": {
"anyOf": [
{
"$ref": "#/components/schemas/gelato_email_report_error"
}
],
"nullable": true,
"description": "Details on the verification error. Present when status is `unverified`."
},
"status": {
"enum": [
"unverified",
"verified"
],
"type": "string",
"description": "Status of this `email` check.",
"x-stripeBypassValidation": true
}
},
"description": "Result from a email check",
"x-expandableFields": [
"error"
]
}
gelato_email_report_error
{
"type": "object",
"title": "GelatoEmailReportError",
"properties": {
"code": {
"enum": [
"email_unverified_other",
"email_verification_declined"
],
"type": "string",
"nullable": true,
"description": "A short machine-readable string giving the reason for the verification failure."
},
"reason": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A human-readable message giving the reason for the failure. These messages can be shown to your users."
}
},
"description": "",
"x-expandableFields": []
}
gelato_id_number_report
{
"type": "object",
"title": "GelatoIdNumberReport",
"required": [
"status"
],
"properties": {
"dob": {
"anyOf": [
{
"$ref": "#/components/schemas/gelato_data_id_number_report_date"
}
],
"nullable": true,
"description": "Date of birth."
},
"error": {
"anyOf": [
{
"$ref": "#/components/schemas/gelato_id_number_report_error"
}
],
"nullable": true,
"description": "Details on the verification error. Present when status is `unverified`."
},
"status": {
"enum": [
"unverified",
"verified"
],
"type": "string",
"description": "Status of this `id_number` check.",
"x-stripeBypassValidation": true
},
"id_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID number. When `id_number_type` is `us_ssn`, only the last 4 digits are present."
},
"last_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last name."
},
"first_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "First name."
},
"id_number_type": {
"enum": [
"br_cpf",
"sg_nric",
"us_ssn"
],
"type": "string",
"nullable": true,
"description": "Type of ID number."
}
},
"description": "Result from an id_number check",
"x-expandableFields": [
"dob",
"error"
]
}
gelato_id_number_report_error
{
"type": "object",
"title": "GelatoIdNumberReportError",
"properties": {
"code": {
"enum": [
"id_number_insufficient_document_data",
"id_number_mismatch",
"id_number_unverified_other"
],
"type": "string",
"nullable": true,
"description": "A short machine-readable string giving the reason for the verification failure."
},
"reason": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A human-readable message giving the reason for the failure. These messages can be shown to your users."
}
},
"description": "",
"x-expandableFields": []
}
gelato_phone_report
{
"type": "object",
"title": "GelatoPhoneReport",
"required": [
"status"
],
"properties": {
"error": {
"anyOf": [
{
"$ref": "#/components/schemas/gelato_phone_report_error"
}
],
"nullable": true,
"description": "Details on the verification error. Present when status is `unverified`."
},
"phone": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Phone to be verified."
},
"status": {
"enum": [
"unverified",
"verified"
],
"type": "string",
"description": "Status of this `phone` check.",
"x-stripeBypassValidation": true
}
},
"description": "Result from a phone check",
"x-expandableFields": [
"error"
]
}
gelato_phone_report_error
{
"type": "object",
"title": "GelatoPhoneReportError",
"properties": {
"code": {
"enum": [
"phone_unverified_other",
"phone_verification_declined"
],
"type": "string",
"nullable": true,
"description": "A short machine-readable string giving the reason for the verification failure."
},
"reason": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A human-readable message giving the reason for the failure. These messages can be shown to your users."
}
},
"description": "",
"x-expandableFields": []
}
gelato_provided_details
{
"type": "object",
"title": "GelatoProvidedDetails",
"properties": {
"email": {
"type": "string",
"maxLength": 5000,
"description": "Email of user being verified"
},
"phone": {
"type": "string",
"maxLength": 5000,
"description": "Phone number of user being verified"
}
},
"description": "",
"x-expandableFields": []
}
gelato_related_person
{
"type": "object",
"title": "GelatoRelatedPerson",
"required": [
"account",
"person"
],
"properties": {
"person": {
"type": "string",
"maxLength": 5000,
"description": "Token referencing the related Person resource."
},
"account": {
"type": "string",
"maxLength": 5000,
"description": "Token referencing the associated Account of the related Person resource."
}
},
"description": "",
"x-expandableFields": []
}
gelato_report_document_options
{
"type": "object",
"title": "GelatoReportDocumentOptions",
"properties": {
"allowed_types": {
"type": "array",
"items": {
"enum": [
"driving_license",
"id_card",
"passport"
],
"type": "string"
},
"description": "Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code."
},
"require_id_number": {
"type": "boolean",
"description": "Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth."
},
"require_live_capture": {
"type": "boolean",
"description": "Disable image uploads, identity document images have to be captured using the device’s camera."
},
"require_matching_selfie": {
"type": "boolean",
"description": "Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://docs.stripe.com/identity/selfie)."
}
},
"description": "",
"x-expandableFields": []
}
gelato_report_id_number_options
{
"type": "object",
"title": "GelatoReportIdNumberOptions",
"properties": {},
"description": "",
"x-expandableFields": []
}
gelato_selfie_report
{
"type": "object",
"title": "GelatoSelfieReport",
"required": [
"status"
],
"properties": {
"error": {
"anyOf": [
{
"$ref": "#/components/schemas/gelato_selfie_report_error"
}
],
"nullable": true,
"description": "Details on the verification error. Present when status is `unverified`."
},
"selfie": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the [File](https://docs.stripe.com/api/files) holding the image of the selfie used in this check."
},
"status": {
"enum": [
"unverified",
"verified"
],
"type": "string",
"description": "Status of this `selfie` check.",
"x-stripeBypassValidation": true
},
"document": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the [File](https://docs.stripe.com/api/files) holding the image of the identity document used in this check."
}
},
"description": "Result from a selfie check",
"x-expandableFields": [
"error"
]
}
gelato_selfie_report_error
{
"type": "object",
"title": "GelatoSelfieReportError",
"properties": {
"code": {
"enum": [
"selfie_document_missing_photo",
"selfie_face_mismatch",
"selfie_manipulated",
"selfie_unverified_other"
],
"type": "string",
"nullable": true,
"description": "A short machine-readable string giving the reason for the verification failure.",
"x-stripeBypassValidation": true
},
"reason": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A human-readable message giving the reason for the failure. These messages can be shown to your users."
}
},
"description": "",
"x-expandableFields": []
}
gelato_session_document_options
{
"type": "object",
"title": "GelatoSessionDocumentOptions",
"properties": {
"allowed_types": {
"type": "array",
"items": {
"enum": [
"driving_license",
"id_card",
"passport"
],
"type": "string"
},
"description": "Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code."
},
"require_id_number": {
"type": "boolean",
"description": "Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth."
},
"require_live_capture": {
"type": "boolean",
"description": "Disable image uploads, identity document images have to be captured using the device’s camera."
},
"require_matching_selfie": {
"type": "boolean",
"description": "Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://docs.stripe.com/identity/selfie)."
}
},
"description": "",
"x-expandableFields": []
}
gelato_session_email_options
{
"type": "object",
"title": "GelatoSessionEmailOptions",
"properties": {
"require_verification": {
"type": "boolean",
"description": "Request one time password verification of `provided_details.email`."
}
},
"description": "",
"x-expandableFields": []
}
gelato_session_id_number_options
{
"type": "object",
"title": "GelatoSessionIdNumberOptions",
"properties": {},
"description": "",
"x-expandableFields": []
}
gelato_session_last_error
{
"type": "object",
"title": "GelatoSessionLastError",
"properties": {
"code": {
"enum": [
"abandoned",
"consent_declined",
"country_not_supported",
"device_not_supported",
"document_expired",
"document_type_not_supported",
"document_unverified_other",
"email_unverified_other",
"email_verification_declined",
"id_number_insufficient_document_data",
"id_number_mismatch",
"id_number_unverified_other",
"phone_unverified_other",
"phone_verification_declined",
"selfie_document_missing_photo",
"selfie_face_mismatch",
"selfie_manipulated",
"selfie_unverified_other",
"under_supported_age"
],
"type": "string",
"nullable": true,
"description": "A short machine-readable string giving the reason for the verification or user-session failure.",
"x-stripeBypassValidation": true
},
"reason": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A message that explains the reason for verification or user-session failure."
}
},
"description": "Shows last VerificationSession error",
"x-expandableFields": []
}
gelato_session_matching_options
{
"type": "object",
"title": "GelatoSessionMatchingOptions",
"properties": {
"dob": {
"enum": [
"none",
"similar"
],
"type": "string",
"description": "Strictness of the DOB matching policy to apply."
},
"name": {
"enum": [
"none",
"similar"
],
"type": "string",
"description": "Strictness of the name matching policy to apply."
}
},
"description": "",
"x-expandableFields": []
}
gelato_session_phone_options
{
"type": "object",
"title": "GelatoSessionPhoneOptions",
"properties": {
"require_verification": {
"type": "boolean",
"description": "Request one time password verification of `provided_details.phone`."
}
},
"description": "",
"x-expandableFields": []
}
gelato_verification_report_options
{
"type": "object",
"title": "GelatoVerificationReportOptions",
"properties": {
"document": {
"$ref": "#/components/schemas/gelato_report_document_options"
},
"id_number": {
"$ref": "#/components/schemas/gelato_report_id_number_options"
}
},
"description": "",
"x-expandableFields": [
"document",
"id_number"
]
}
gelato_verification_session_options
{
"type": "object",
"title": "GelatoVerificationSessionOptions",
"properties": {
"email": {
"$ref": "#/components/schemas/gelato_session_email_options"
},
"phone": {
"$ref": "#/components/schemas/gelato_session_phone_options"
},
"document": {
"$ref": "#/components/schemas/gelato_session_document_options"
},
"matching": {
"$ref": "#/components/schemas/gelato_session_matching_options"
},
"id_number": {
"$ref": "#/components/schemas/gelato_session_id_number_options"
}
},
"description": "",
"x-expandableFields": [
"document",
"email",
"id_number",
"matching",
"phone"
]
}
gelato_verified_outputs
{
"type": "object",
"title": "GelatoVerifiedOutputs",
"properties": {
"dob": {
"anyOf": [
{
"$ref": "#/components/schemas/gelato_data_verified_outputs_date"
}
],
"nullable": true,
"description": "The user’s verified date of birth."
},
"sex": {
"enum": [
"[redacted]",
"female",
"male",
"unknown"
],
"type": "string",
"nullable": true,
"description": "The user's verified sex."
},
"email": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The user's verified email address"
},
"phone": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The user's verified phone number"
},
"address": {
"anyOf": [
{
"$ref": "#/components/schemas/address"
}
],
"nullable": true,
"description": "The user's verified address."
},
"id_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The user's verified id number."
},
"last_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The user's verified last name."
},
"first_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The user's verified first name."
},
"unparsed_sex": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The user's verified sex as it appears in the document."
},
"id_number_type": {
"enum": [
"br_cpf",
"sg_nric",
"us_ssn"
],
"type": "string",
"nullable": true,
"description": "The user's verified id number type."
},
"unparsed_place_of_birth": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The user's verified place of birth as it appears in the document."
}
},
"description": "",
"x-expandableFields": [
"address",
"dob"
]
}
identity.verification_report
{
"type": "object",
"title": "GelatoVerificationReport",
"required": [
"created",
"id",
"livemode",
"object",
"type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"type": {
"enum": [
"document",
"id_number",
"verification_flow"
],
"type": "string",
"description": "Type of report.",
"x-stripeBypassValidation": true
},
"email": {
"$ref": "#/components/schemas/gelato_email_report"
},
"phone": {
"$ref": "#/components/schemas/gelato_phone_report"
},
"object": {
"enum": [
"identity.verification_report"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"selfie": {
"$ref": "#/components/schemas/gelato_selfie_report"
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"options": {
"$ref": "#/components/schemas/gelato_verification_report_options"
},
"document": {
"$ref": "#/components/schemas/gelato_document_report"
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"id_number": {
"$ref": "#/components/schemas/gelato_id_number_report"
},
"verification_flow": {
"type": "string",
"maxLength": 5000,
"description": "The configuration token of a verification flow from the dashboard."
},
"client_reference_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems."
},
"verification_session": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the VerificationSession that created this report."
}
},
"description": "A VerificationReport is the result of an attempt to collect and verify data from a user.\nThe collection of verification checks performed is determined from the `type` and `options`\nparameters used. You can find the result of each verification check performed in the\nappropriate sub-resource: `document`, `id_number`, `selfie`.\n\nEach VerificationReport contains a copy of any data collected by the user as well as\nreference IDs which can be used to access collected images through the [FileUpload](https://docs.stripe.com/api/files)\nAPI. To configure and create VerificationReports, use the\n[VerificationSession](https://docs.stripe.com/api/identity/verification_sessions) API.\n\nRelated guide: [Accessing verification results](https://docs.stripe.com/identity/verification-sessions#results).",
"x-resourceId": "identity.verification_report",
"x-expandableFields": [
"document",
"email",
"id_number",
"options",
"phone",
"selfie"
]
}
identity.verification_session
{
"type": "object",
"title": "GelatoVerificationSession",
"required": [
"created",
"id",
"livemode",
"metadata",
"object",
"status",
"type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://docs.stripe.com/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe."
},
"type": {
"enum": [
"document",
"id_number",
"verification_flow"
],
"type": "string",
"description": "The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed.",
"x-stripeBypassValidation": true
},
"object": {
"enum": [
"identity.verification_session"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"canceled",
"processing",
"requires_input",
"verified"
],
"type": "string",
"description": "Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://docs.stripe.com/identity/how-sessions-work)."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"options": {
"anyOf": [
{
"$ref": "#/components/schemas/gelato_verification_session_options"
}
],
"nullable": true,
"description": "A set of options for the session’s verification checks."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"metadata": {
"type": "object",
"description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"redaction": {
"anyOf": [
{
"$ref": "#/components/schemas/verification_session_redaction"
}
],
"nullable": true,
"description": "Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null."
},
"last_error": {
"anyOf": [
{
"$ref": "#/components/schemas/gelato_session_last_error"
}
],
"nullable": true,
"description": "If present, this property tells you the last error encountered when processing the verification."
},
"client_secret": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The short-lived client secret used by Stripe.js to [show a verification modal](https://docs.stripe.com/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://docs.stripe.com/identity/verification-sessions#client-secret) to learn more."
},
"related_person": {
"$ref": "#/components/schemas/gelato_related_person"
},
"provided_details": {
"anyOf": [
{
"$ref": "#/components/schemas/gelato_provided_details"
}
],
"nullable": true,
"description": "Details provided about the user being verified. These details may be shown to the user."
},
"related_customer": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Customer ID"
},
"verified_outputs": {
"anyOf": [
{
"$ref": "#/components/schemas/gelato_verified_outputs"
}
],
"nullable": true,
"description": "The user’s verified data."
},
"verification_flow": {
"type": "string",
"maxLength": 5000,
"description": "The configuration token of a verification flow from the dashboard."
},
"client_reference_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems."
},
"last_verification_report": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/identity.verification_report"
}
],
"nullable": true,
"description": "ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://docs.stripe.com/identity/verification-sessions#results)",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/identity.verification_report"
}
]
}
},
"related_customer_account": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The ID of the Account representing a customer."
}
},
"description": "A VerificationSession guides you through the process of collecting and verifying the identities\nof your users. It contains details about the type of verification, such as what [verification\ncheck](/docs/identity/verification-checks) to perform. Only create one VerificationSession for\neach verification in your system.\n\nA VerificationSession transitions through [multiple\nstatuses](/docs/identity/how-sessions-work) throughout its lifetime as it progresses through\nthe verification flow. The VerificationSession contains the user's verified data after\nverification checks are complete.\n\nRelated guide: [The Verification Sessions API](https://docs.stripe.com/identity/verification-sessions)",
"x-resourceId": "identity.verification_session",
"x-expandableFields": [
"last_error",
"last_verification_report",
"options",
"provided_details",
"redaction",
"related_person",
"verified_outputs"
]
}
inbound_transfers
{
"type": "object",
"title": "InboundTransfers",
"required": [
"billing_details",
"type"
],
"properties": {
"type": {
"enum": [
"us_bank_account"
],
"type": "string",
"description": "The type of the payment method used in the InboundTransfer.",
"x-stripeBypassValidation": true
},
"billing_details": {
"$ref": "#/components/schemas/treasury_shared_resource_billing_details"
},
"us_bank_account": {
"$ref": "#/components/schemas/inbound_transfers_payment_method_details_us_bank_account"
}
},
"description": "",
"x-expandableFields": [
"billing_details",
"us_bank_account"
]
}
inbound_transfers_payment_method_details_us_bank_account
{
"type": "object",
"title": "inbound_transfers_payment_method_details_us_bank_account",
"required": [
"network"
],
"properties": {
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last four digits of the bank account number."
},
"mandate": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/mandate"
}
],
"description": "ID of the mandate used to make this payment.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/mandate"
}
]
}
},
"network": {
"enum": [
"ach"
],
"type": "string",
"description": "The network rails used. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type."
},
"bank_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Name of the bank associated with the bank account."
},
"fingerprint": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
},
"account_type": {
"enum": [
"checking",
"savings"
],
"type": "string",
"nullable": true,
"description": "Account type: checkings or savings. Defaults to checking if omitted."
},
"routing_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Routing number of the bank account."
},
"account_holder_type": {
"enum": [
"company",
"individual"
],
"type": "string",
"nullable": true,
"description": "Account holder type: individual or company."
}
},
"description": "",
"x-expandableFields": [
"mandate"
]
}
insights_resources_payment_evaluation_address
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationAddress",
"properties": {
"city": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "City, district, suburb, town, or village."
},
"line1": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Address line 1, such as the street, PO Box, or company name."
},
"line2": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Address line 2, such as the apartment, suite, unit, or building."
},
"state": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."
},
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
},
"postal_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ZIP or postal code."
}
},
"description": "Address data.",
"x-expandableFields": []
}
insights_resources_payment_evaluation_billing_details
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationBillingDetails",
"required": [
"address"
],
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Full name."
},
"email": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Email address."
},
"phone": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Billing phone number (including extension)."
},
"address": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_address"
}
},
"description": "Billing details attached to this payment evaluation.",
"x-expandableFields": [
"address"
]
}
insights_resources_payment_evaluation_client_device_metadata
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationClientDeviceMetadata",
"required": [
"radar_session"
],
"properties": {
"radar_session": {
"type": "string",
"maxLength": 5000,
"description": "ID for the Radar Session associated with the payment evaluation. A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments."
}
},
"description": "Client device metadata attached to this payment evaluation.",
"x-expandableFields": []
}
insights_resources_payment_evaluation_customer_details
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationCustomerDetails",
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The customer's full name or business name."
},
"email": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The customer's email address."
},
"phone": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The customer's phone number."
},
"customer": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The ID of the customer associated with the payment evaluation."
},
"customer_account": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The ID of the Account representing the customer associated with the payment evaluation."
}
},
"description": "Customer details attached to this payment evaluation.",
"x-expandableFields": []
}
insights_resources_payment_evaluation_dispute_opened
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationDisputeOpened",
"required": [
"amount",
"currency",
"reason"
],
"properties": {
"amount": {
"type": "integer",
"description": "Amount to dispute for this payment. A positive integer representing how much to charge in [the smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (for example, 100 cents to charge 1.00 USD or 100 to charge 100 Yen, a zero-decimal currency)."
},
"reason": {
"enum": [
"account_not_available",
"credit_not_processed",
"customer_initiated",
"duplicate",
"fraudulent",
"general",
"noncompliant",
"product_not_received",
"product_unacceptable",
"subscription_canceled",
"unrecognized"
],
"type": "string",
"description": "Reason given by cardholder for dispute."
},
"currency": {
"type": "string",
"format": "currency",
"description": "Three-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)."
}
},
"description": "Dispute opened event details attached to this payment evaluation.",
"x-expandableFields": []
}
insights_resources_payment_evaluation_early_fraud_warning_received
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationEarlyFraudWarningReceived",
"required": [
"fraud_type"
],
"properties": {
"fraud_type": {
"enum": [
"made_with_lost_card",
"made_with_stolen_card",
"other",
"unauthorized_use_of_card"
],
"type": "string",
"description": "The type of fraud labeled by the issuer."
}
},
"description": "Early Fraud Warning Received event details attached to this payment evaluation.",
"x-expandableFields": []
}
insights_resources_payment_evaluation_event
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationEvent",
"required": [
"occurred_at",
"type"
],
"properties": {
"type": {
"enum": [
"dispute_opened",
"early_fraud_warning_received",
"refunded",
"user_intervention_raised",
"user_intervention_resolved"
],
"type": "string",
"description": "Indicates the type of event attached to the payment evaluation."
},
"refunded": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_refunded"
},
"occurred_at": {
"type": "integer",
"format": "unix-time",
"description": "Timestamp when the event occurred."
},
"dispute_opened": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_dispute_opened"
},
"user_intervention_raised": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_user_intervention_raised"
},
"user_intervention_resolved": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_user_intervention_resolved"
},
"early_fraud_warning_received": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_early_fraud_warning_received"
}
},
"description": "Event reported for this payment evaluation.",
"x-expandableFields": [
"dispute_opened",
"early_fraud_warning_received",
"refunded",
"user_intervention_raised",
"user_intervention_resolved"
]
}
insights_resources_payment_evaluation_merchant_blocked
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationMerchantBlocked",
"required": [
"reason"
],
"properties": {
"reason": {
"enum": [
"authentication_required",
"blocked_for_fraud",
"invalid_payment",
"other"
],
"type": "string",
"description": "The reason the payment was blocked by the merchant."
}
},
"description": "Details of a merchant_blocked outcome attached to this payment evaluation.",
"x-expandableFields": []
}
insights_resources_payment_evaluation_money_movement_card
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationMoneyMovementCard",
"properties": {
"payment_type": {
"enum": [
"one_off",
"recurring",
"setup_one_off",
"setup_recurring"
],
"type": "string",
"nullable": true,
"description": "Describes the type of payment."
},
"customer_presence": {
"enum": [
"off_session",
"on_session"
],
"type": "string",
"nullable": true,
"description": "Describes the presence of the customer during the payment."
}
},
"description": "Money Movement card details attached to this payment.",
"x-expandableFields": []
}
insights_resources_payment_evaluation_money_movement_details
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationMoneyMovementDetails",
"required": [
"money_movement_type"
],
"properties": {
"card": {
"anyOf": [
{
"$ref": "#/components/schemas/insights_resources_payment_evaluation_money_movement_card"
}
],
"nullable": true,
"description": "Describes card money movement details for the payment evaluation."
},
"money_movement_type": {
"enum": [
"card"
],
"type": "string",
"description": "Describes the type of money movement. Currently only `card` is supported."
}
},
"description": "Money Movement details attached to this payment.",
"x-expandableFields": [
"card"
]
}
insights_resources_payment_evaluation_outcome
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationOutcome",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"failed",
"merchant_blocked",
"rejected",
"succeeded"
],
"type": "string",
"description": "Indicates the outcome of the payment evaluation."
},
"rejected": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_rejected"
},
"succeeded": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_succeeded"
},
"merchant_blocked": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_merchant_blocked"
},
"payment_intent_id": {
"type": "string",
"maxLength": 5000,
"description": "The PaymentIntent ID associated with the payment evaluation."
}
},
"description": "Outcome details for this payment evaluation.",
"x-expandableFields": [
"merchant_blocked",
"rejected",
"succeeded"
]
}
insights_resources_payment_evaluation_payment_details
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationPaymentDetails",
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "integer",
"description": "Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99)."
},
"currency": {
"type": "string",
"format": "currency",
"description": "Three-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)."
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An arbitrary string attached to the object. Often useful for displaying to users."
},
"shipping_details": {
"anyOf": [
{
"$ref": "#/components/schemas/insights_resources_payment_evaluation_shipping"
}
],
"nullable": true,
"description": "Shipping details for the payment evaluation."
},
"statement_descriptor": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Payment statement descriptor."
},
"money_movement_details": {
"anyOf": [
{
"$ref": "#/components/schemas/insights_resources_payment_evaluation_money_movement_details"
}
],
"nullable": true,
"description": "Details about the payment's customer presence and type."
},
"payment_method_details": {
"anyOf": [
{
"$ref": "#/components/schemas/insights_resources_payment_evaluation_payment_method_details"
}
],
"nullable": true,
"description": "Details about the payment method used for the payment."
}
},
"description": "Payment details attached to this payment evaluation.",
"x-expandableFields": [
"money_movement_details",
"payment_method_details",
"shipping_details"
]
}
insights_resources_payment_evaluation_payment_method_details
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationPaymentMethodDetails",
"required": [
"payment_method"
],
"properties": {
"payment_method": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_method"
}
],
"description": "The payment method used in this payment evaluation.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_method"
}
]
}
},
"billing_details": {
"anyOf": [
{
"$ref": "#/components/schemas/insights_resources_payment_evaluation_billing_details"
}
],
"nullable": true,
"description": "Billing information associated with the payment evaluation."
}
},
"description": "Payment method details attached to this payment evaluation.",
"x-expandableFields": [
"billing_details",
"payment_method"
]
}
insights_resources_payment_evaluation_refunded
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationRefunded",
"required": [
"amount",
"currency",
"reason"
],
"properties": {
"amount": {
"type": "integer",
"description": "Amount refunded for this payment. A positive integer representing how much to charge in [the smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (for example, 100 cents to charge 1.00 USD or 100 to charge 100 Yen, a zero-decimal currency)."
},
"reason": {
"enum": [
"duplicate",
"fraudulent",
"other",
"requested_by_customer"
],
"type": "string",
"description": "Indicates the reason for the refund."
},
"currency": {
"type": "string",
"format": "currency",
"description": "Three-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)."
}
},
"description": "Refunded Event details attached to this payment evaluation.",
"x-expandableFields": []
}
insights_resources_payment_evaluation_rejected
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationRejected",
"properties": {
"card": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_rejected_card"
}
},
"description": "Details of an rejected outcome attached to this payment evaluation.",
"x-expandableFields": [
"card"
]
}
insights_resources_payment_evaluation_rejected_card
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationRejectedCard",
"required": [
"address_line1_check",
"address_postal_code_check",
"cvc_check",
"reason"
],
"properties": {
"reason": {
"enum": [
"authentication_failed",
"do_not_honor",
"expired",
"incorrect_cvc",
"incorrect_number",
"incorrect_postal_code",
"insufficient_funds",
"invalid_account",
"lost_card",
"other",
"processing_error",
"reported_stolen",
"try_again_later"
],
"type": "string",
"description": "Card issuer's reason for the network decline."
},
"cvc_check": {
"enum": [
"fail",
"pass",
"unavailable",
"unchecked"
],
"type": "string",
"description": "Result of the CVC check."
},
"address_line1_check": {
"enum": [
"fail",
"pass",
"unavailable",
"unchecked"
],
"type": "string",
"description": "Result of the address line 1 check."
},
"address_postal_code_check": {
"enum": [
"fail",
"pass",
"unavailable",
"unchecked"
],
"type": "string",
"description": "Indicates whether the cardholder provided a postal code and if it matched the cardholder’s billing address."
}
},
"description": "Details of an rejected card outcome attached to this payment evaluation.",
"x-expandableFields": []
}
insights_resources_payment_evaluation_shipping
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationShipping",
"required": [
"address"
],
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Shipping name."
},
"phone": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Shipping phone number."
},
"address": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_address"
}
},
"description": "Shipping details attached to this payment.",
"x-expandableFields": [
"address"
]
}
insights_resources_payment_evaluation_signal_v2
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationSignalV2",
"required": [
"evaluated_at",
"risk_level",
"score"
],
"properties": {
"score": {
"type": "number",
"description": "Score for this signal. Possible values for evaluated payments are between 0 and 100. The value is returned with two decimal places and higher scores indicate a higher likelihood of the signal being true. A score of -1 is returned when a model evaluation was not performed, such as requests from incomplete integrations."
},
"risk_level": {
"enum": [
"elevated",
"highest",
"low",
"normal",
"not_assessed",
"unknown"
],
"type": "string",
"description": "Risk level of this signal, based on the score."
},
"evaluated_at": {
"type": "integer",
"format": "unix-time",
"description": "The time when this signal was evaluated."
}
},
"description": "A payment evaluation signal with evaluated_at, risk_level, and score fields.",
"x-expandableFields": []
}
insights_resources_payment_evaluation_signals
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationSignals",
"required": [
"fraudulent_payment"
],
"properties": {
"fraudulent_payment": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_signal_v2"
}
},
"description": "Collection of signals for this payment evaluation.",
"x-expandableFields": [
"fraudulent_payment"
]
}
insights_resources_payment_evaluation_succeeded
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationSucceeded",
"properties": {
"card": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_succeeded_card"
}
},
"description": "Details of a succeeded outcome attached to this payment evaluation.",
"x-expandableFields": [
"card"
]
}
insights_resources_payment_evaluation_succeeded_card
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationSucceededCard",
"required": [
"address_line1_check",
"address_postal_code_check",
"cvc_check"
],
"properties": {
"cvc_check": {
"enum": [
"fail",
"pass",
"unavailable",
"unchecked"
],
"type": "string",
"description": "Result of the CVC check."
},
"address_line1_check": {
"enum": [
"fail",
"pass",
"unavailable",
"unchecked"
],
"type": "string",
"description": "Result of the address line 1 check."
},
"address_postal_code_check": {
"enum": [
"fail",
"pass",
"unavailable",
"unchecked"
],
"type": "string",
"description": "Indicates whether the cardholder provided a postal code and if it matched the cardholder’s billing address."
}
},
"description": "Details of an succeeded card outcome attached to this payment evaluation.",
"x-expandableFields": []
}
insights_resources_payment_evaluation_user_intervention_raised
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationUserInterventionRaised",
"required": [
"key",
"type"
],
"properties": {
"key": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the user intervention event."
},
"type": {
"enum": [
"3ds",
"captcha",
"custom"
],
"type": "string",
"description": "Type of user intervention raised."
},
"custom": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_user_intervention_raised_custom"
}
},
"description": "User intervention raised event details attached to this payment evaluation",
"x-expandableFields": [
"custom"
]
}
insights_resources_payment_evaluation_user_intervention_raised_custom
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationUserInterventionRaisedCustom",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"maxLength": 5000,
"description": "Custom type of user intervention raised. The string must use a snake case description for the type of intervention performed."
}
},
"description": "User intervention raised custom event details attached to this payment evaluation",
"x-expandableFields": []
}
insights_resources_payment_evaluation_user_intervention_resolved
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationUserInterventionResolved",
"required": [
"key"
],
"properties": {
"key": {
"type": "string",
"maxLength": 5000,
"description": "Unique ID of this intervention. Use this to provide the result."
},
"outcome": {
"enum": [
"abandoned",
"failed",
"passed"
],
"type": "string",
"nullable": true,
"description": "Result of the intervention if it has been completed."
}
},
"description": "User Intervention Resolved Event details attached to this payment evaluation",
"x-expandableFields": []
}