NAME

Net::API::Stripe::Connect::Account::Document - An interface to Stripe API

SYNOPSIS

    my $doc = $stripe->account->verification->document({
        back => '/some/file/path/scan_back.jpg',
        details => 'Low resolution jpeg',
        # Set by Stripe
        # details_code => 'document_not_readable',
        front => '/some/file/path/scan_front.jpg',
    });

VERSION

    0.1

DESCRIPTION

A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.

Tis is called from method document in module Net::API::Stripe::Connect::Account::Verification

CONSTRUCTOR

new( %ARG )

Creates a new Net::API::Stripe::Connect::Account::Document object. It may also take an hash like arguments, that also are method of the same name.

METHODS

back string (expandable)

The back of an ID returned by a file upload with a purpose value of identity_document.

When expanded, this is a Net::API::Stripe::File object.

details string

A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say “Identity document is too unclear to read”.

details_code string

One of document_corrupt, document_country_not_supported, document_expired, document_failed_copy, document_failed_other, document_failed_test_mode, document_fraudulent, document_failed_greyscale, document_incomplete, document_invalid, document_manipulated, document_missing_back, document_missing_front, document_not_readable, document_not_uploaded, document_photo_mismatch, document_too_large, or document_type_not_supported. A machine-readable code specifying the verification state for this document.

front string (expandable)

The front of an ID returned by a file upload with a purpose value of identity_document.

When expanded, this is a Net::API::Stripe::File object.

API SAMPLE

        {
          "id": "person_fake123456789",
          "object": "person",
          "account": "acct_fake123456789",
          "created": 1580075612,
          "dob": {
                "day": null,
                "month": null,
                "year": null
          },
          "first_name_kana": null,
          "first_name_kanji": null,
          "gender": null,
          "last_name_kana": null,
          "last_name_kanji": null,
          "metadata": {},
          "relationship": {
                "director": false,
                "executive": false,
                "owner": false,
                "percent_ownership": null,
                "representative": false,
                "title": null
          },
          "requirements": {
                "currently_due": [],
                "eventually_due": [],
                "past_due": [],
                "pending_verification": []
          },
          "verification": {
                "additional_document": {
                  "back": null,
                  "details": null,
                  "details_code": null,
                  "front": null
                },
                "details": null,
                "details_code": null,
                "document": {
                  "back": null,
                  "details": null,
                  "details_code": null,
                  "front": null
                },
                "status": "unverified"
          }
        }

HISTORY

v0.1

Initial version

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

Stripe API documentation:

https://stripe.com/docs/api

COPYRIGHT & LICENSE

Copyright (c) 2019-2020 DEGUEST Pte. Ltd.

You can use, copy, modify and redistribute this package and associated files under the same terms as Perl itself.