Schema2020-08-27object

gelato_document_report

Result from a document check

Source: openapi/spec3.json
Commit: d70de345383d
Active snapshot: da69df7e6e11

GelatoDocumentReport

object

Result from a document check

address

optionalnullable

Address as it appears in the document.

dob

optionalnullable

Date of birth as it appears in the document.

error

optionalnullable

Details on the verification error. Present when status is `unverified`.

expiration_date

optionalnullable

Expiration date of the document.

files array

optionalnullable

Array of [File](https://stripe.com/docs/api/files) ids containing images for this document.

first_name string

optionalnullable

First name as it appears in the document.

maxLength:5000

issued_date

optionalnullable

Issued date of the document.

issuing_country string

optionalnullable

Issuing country of the document.

maxLength:5000

last_name string

optionalnullable

Last name as it appears in the document.

maxLength:5000

number string

optionalnullable

Document ID number.

maxLength:5000

status string

required

Status of this `document` check.

Allowed: "unverified""verified"

type string

optionalnullable

Type of the document.

Allowed: "driving_license""id_card""passport"

Root JSON Schema

{"description":"Result from a document check","properties":{"address":{"anyOf":[{"$ref":"#/components/schemas/address"}],"description":"Address as it appears in the document.","nullable":true},"dob":{"anyOf":[{"$ref":"#/components/schemas/gelato_data_document_report_date_of_birth"}],"description":"Date of birth as it appears in the document.","nullable":true},"error":{"anyOf":[{"$ref":"#/components/schemas/gelato_document_report_error"}],"description":"Details on the verification error. Present when status is `unverified`.","nullable":true},"expiration_date":{"anyOf":[{"$ref":"#/components/schemas/gelato_data_document_report_expiration_date"}],"description":"Expiration date of the document.","nullable":true},"files":{"description":"Array of [File](https://stripe.com/docs/api/files) ids containing images for this document.","items":{"maxLength":5000,"type":"string"},"nullable":true,"type":"array"},"first_name":{"description":"First name as it appears in the document.","maxLength":5000,"nullable":true,"type":"string"},"issued_date":{"anyOf":[{"$ref":"#/components/schemas/gelato_data_document_report_issued_date"}],"description":"Issued date of the document.","nullable":true},"issuing_country":{"description":"Issuing country of the document.","maxLength":5000,"nullable":true,"type":"string"},"last_name":{"description":"Last name as it appears in the document.","maxLength":5000,"nullable":true,"type":"string"},"number":{"description":"Document ID number.","maxLength":5000,"nullable":true,"type":"string"},"status":{"description":"Status of this `document` check.","enum":["unverified","verified"],"type":"string","x-stripeBypassValidation":true},"type":{"description":"Type of the document.","enum":["driving_license","id_card","passport"],"nullable":true,"type":"string"}},"required":["status"],"title":"GelatoDocumentReport","type":"object","x-expandableFields":["address","dob","error","expiration_date","issued_date"]}