/ 
Net-API-Stripe-v2.0.5
River stage one • 1 direct dependent • 1 total dependent
/ Net::API::Stripe::Connect::Account::Requirements

NAME

Net::API::Stripe::Connect::Account::Requirements - A Stripe Account Requirements Object

SYNOPSIS

my $req = $stripe->person->requirements({
    current_deadline => '2020-05-01',
    errors => [
        {
        code => 'invalid_address_city_state_postal_code',
        reason => 'Some reason why this failed',
        requirement => 'some_field',
        }
    ],
});

VERSION

v0.101.0

DESCRIPTION

Information about the requirements for this person, including what information needs to be collected, and by when.

This is instantiated from method requirements in modules Net::API::Stripe::Connect::Account, Net::API::Stripe::Connect::Person and Net::API::Stripe::Issuing::Card::Holder

CONSTRUCTOR

new( %ARG )

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

METHODS

alternatives array of hash

Fields that are due and can be satisfied by providing the corresponding alternative fields instead.

It has the following properties:

alternative_fields_due string_array

Fields that can be provided to satisfy all fields in original_fields_due.

original_fields_due string_array

Fields that are due and can be satisfied by providing all fields in alternative_fields_due.

current_deadline timestamp

The date the fields in currently_due must be collected by to keep the capability enabled for the account.

This is a DateTime object;

currently_due array containing strings

Fields that need to be collected to keep the person’s account enabled. If not collected by the account’s current_deadline, these fields appear in past_due as well, and the account is disabled.

disabled_reason string

If the capability is disabled, this string describes why. Possible values are requirement.fields_needed, pending.onboarding, pending.review, rejected_fraud, or rejected.other.

errors array of hash

The fields that need to be collected again because validation or verification failed for some reason.

This is an array reference of virtual objects class Net::API::Stripe::Connect::Account::Requirements::Errors

code The code for the type of error. Possible enum values
invalid_address_city_state_postal_code

The combination of the city, state, and postal code in the provided address could not be validated.

invalid_street_address

The street name and/or number for the provided address could not be validated.

invalid_value_other

An invalid value was provided for the related field. This is a general error code.

verification_document_address_mismatch

The address on the document did not match the address on the account. Upload a document with a matching address or update the address on the account.

verification_document_address_missing

The company address was missing on the document. Upload a document that includes the address.

verification_document_corrupt

The uploaded file for the document was invalid or corrupt. Upload a new file of the document.

verification_document_country_not_supported

The provided document was from an unsupported country.

verification_document_dob_mismatch

The date of birth (DOB) on the document did not match the DOB on the account. Upload a document with a matching DOB or update the DOB on the account.

verification_document_duplicate_type

The same type of document was used twice. Two unique types of documents are required for verification. Upload two different documents.

verification_document_expired

The document could not be used for verification because it has expired. If it’s an identity document, its expiration date must be before the date the document was submitted. If it’s an address document, the issue date must be within the last six months.

verification_document_failed_copy

The document could not be verified because it was detected as a copy (e.g., photo or scan). Upload the original document.

verification_document_failed_greyscale

The document could not be used for verification because it was in greyscale. Upload a color copy of the document.

verification_document_failed_other

The document could not be verified for an unknown reason. Ensure that the document follows the guidelines for document uploads.

verification_document_failed_test_mode

A test data helper was supplied to simulate verification failure. Refer to the documentation for test file tokens.

verification_document_fraudulent

The document was identified as altered or falsified.

verification_document_id_number_mismatch

The company ID number on the account could not be verified. Correct any errors in the ID number field or upload a document that includes the ID number.

verification_document_id_number_missing

The company ID number was missing on the document. Upload a document that includes the ID number.

verification_document_incomplete

The document was cropped or missing important information. Upload a complete scan of the document.

verification_document_invalid

The uploaded file was not one of the valid document types. Upload an acceptable ID document (e.g., ID card or passport).

verification_document_manipulated

The document was identified as altered or falsified.

verification_document_missing_back

The uploaded file was missing the back of the document. Upload a complete scan of the document.

verification_document_missing_front

The uploaded file was missing the front of the document. Upload a complete scan of the document.

verification_document_name_mismatch

The name on the document did not match the name on the account. Upload a document with a matching name or update the name on the account.

verification_document_name_missing

The company name was missing on the document. Upload a document that includes the company name.

verification_document_nationality_mismatch

The nationality on the document did not match the person’s stated nationality. Update the person’s stated nationality, or upload a document that matches it.

verification_document_not_readable

The document could not be read. Ensure that the document follows the guidelines for document uploads.

verification_document_not_uploaded

No document was uploaded. Upload the document again.

verification_document_photo_mismatch

The document was identified as altered or falsified.

verification_document_too_large

The uploaded file exceeded the 10 MB size limit. Resize the document and upload the new file.

verification_document_type_not_supported

The provided document type was not accepted as proof of identity. Upload an acceptable ID document (e.g., ID card or passport).

verification_failed_address_match

The address on the account could not be verified. Correct any errors in the address field or upload a document that includes the address.

verification_failed_business_iec_number

The Importer Exporter Code (IEC) number could not be verified. Correct any errors in the company’s IEC number field. (India only)

verification_failed_document_match

The document could not be verified. Upload a document that includes the company name, ID number, and address fields.

verification_failed_id_number_match

The company ID number on the account could not be verified. Correct any errors in the ID number field or upload a document that includes the ID number.

verification_failed_keyed_identity

The person’s keyed-in identity information could not be verified. Correct any errors or upload a document that matches the identity fields (e.g., name and date of birth) entered.

verification_failed_keyed_match

The keyed-in information on the account could not be verified. Correct any errors in the company name, ID number, or address fields. You can also upload a document that includes those fields.

verification_failed_name_match

The company name on the account could not be verified. Correct any errors in the company name field or upload a document that includes the company name.

verification_failed_other

Verification failed for an unknown reason. Correct any errors and resubmit the required fields.

reason
requirement

eventually_due array containing strings

Fields that need to be collected assuming all volume thresholds are reached. As fields are needed, they are moved to currently_due and the account’s current_deadline is set.

past_due array containing strings

Fields that weren’t collected by the account’s current_deadline. These fields need to be collected to enable payouts for the person’s account.

pending_verification array containing strings

Fields that may become required depending on the results of verification or review. An empty array unless an asynchronous verification is pending. If verification fails, the fields in this array become required and move to currently_due or past_due.

API SAMPLE

{
  "id": "person_fake123456789",
  "object": "person",
  "account": "acct_fake123456789",
  "created": 1571602397,
  "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.