POST /v1/tokens

Creates a single-use token that represents a bank account’s details. You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a connected account where controller.requirement_collection is application, which includes Custom accounts.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
account Object No

Information for the account this token represents.

account.business_type String No

Possible values:

  • "company"
  • "non_profit"
  • "government_entity"
  • "individual"
account.individual Object No
account.individual.last_name_kana String No
account.individual.full_name_aliases No
account.individual.first_name String No
account.individual.metadata No
account.individual.relationship Object No
account.individual.relationship.percent_ownership No
account.individual.relationship.executive Boolean No
account.individual.relationship.title String No
account.individual.relationship.director Boolean No
account.individual.relationship.owner Boolean No
account.individual.dob No
account.individual.id_number String No
account.individual.first_name_kana String No
account.individual.id_number_secondary String No
account.individual.political_exposure String No

Possible values:

  • "existing"
  • "none"
account.individual.last_name_kanji String No
account.individual.email String No
account.individual.gender String No
account.individual.address_kanji Object No
account.individual.address_kanji.line2 String No
account.individual.address_kanji.line1 String No
account.individual.address_kanji.town String No
account.individual.address_kanji.postal_code String No
account.individual.address_kanji.country String No
account.individual.address_kanji.state String No
account.individual.address_kanji.city String No
account.individual.last_name String No
account.individual.maiden_name String No
account.individual.ssn_last_4 String No
account.individual.address_kana Object No
account.individual.address_kana.line2 String No
account.individual.address_kana.line1 String No
account.individual.address_kana.town String No
account.individual.address_kana.postal_code String No
account.individual.address_kana.country String No
account.individual.address_kana.state String No
account.individual.address_kana.city String No
account.individual.verification Object No
account.individual.verification.additional_document Object No
account.individual.verification.additional_document.back String No
account.individual.verification.additional_document.front String No
account.individual.verification.document Object No
account.individual.verification.document.back String No
account.individual.verification.document.front String No
account.individual.phone String No
account.individual.registered_address Object No
account.individual.registered_address.line2 String No
account.individual.registered_address.line1 String No
account.individual.registered_address.postal_code String No
account.individual.registered_address.country String No
account.individual.registered_address.state String No
account.individual.registered_address.city String No
account.individual.first_name_kanji String No
account.individual.address Object No
account.individual.address.line2 String No
account.individual.address.line1 String No
account.individual.address.postal_code String No
account.individual.address.country String No
account.individual.address.state String No
account.individual.address.city String No
account.company Object No
account.company.tax_id String No
account.company.directors_provided Boolean No
account.company.ownership_exemption_reason String No

Possible values:

  • ""
  • "qualified_entity_exceeds_ownership_threshold"
  • "qualifies_as_financial_institution"
account.company.export_license_id String No
account.company.owners_provided Boolean No
account.company.registration_number String No
account.company.registration_date No
account.company.vat_id String No
account.company.ownership_declaration Object No
account.company.ownership_declaration.user_agent String No
account.company.ownership_declaration.ip String No
account.company.ownership_declaration.date Integer No
account.company.ownership_declaration_shown_and_signed Boolean No
account.company.name String No
account.company.address_kanji Object No
account.company.address_kanji.line2 String No
account.company.address_kanji.line1 String No
account.company.address_kanji.town String No
account.company.address_kanji.postal_code String No
account.company.address_kanji.country String No
account.company.address_kanji.state String No
account.company.address_kanji.city String No
account.company.address_kana Object No
account.company.address_kana.line2 String No
account.company.address_kana.line1 String No
account.company.address_kana.town String No
account.company.address_kana.postal_code String No
account.company.address_kana.country String No
account.company.address_kana.state String No
account.company.address_kana.city String No
account.company.name_kana String No
account.company.structure String No

Possible values:

  • ""
  • "free_zone_llc"
  • "private_company"
  • "limited_liability_partnership"
  • "unincorporated_partnership"
  • "public_corporation"
  • "registered_charity"
  • "governmental_unit"
  • "sole_establishment"
  • "unincorporated_non_profit"
  • "incorporated_non_profit"
  • "private_corporation"
  • "free_zone_establishment"
  • "government_instrumentality"
  • "multi_member_llc"
  • "llc"
  • "private_partnership"
  • "sole_proprietorship"
  • "unincorporated_association"
  • "public_partnership"
  • "public_company"
  • "single_member_llc"
  • "tax_exempt_government_instrumentality"
  • "incorporated_partnership"
account.company.verification Object No
account.company.verification.document Object No
account.company.verification.document.back String No
account.company.verification.document.front String No
account.company.name_kanji String No
account.company.phone String No
account.company.directorship_declaration Object No
account.company.directorship_declaration.user_agent String No
account.company.directorship_declaration.ip String No
account.company.directorship_declaration.date Integer No
account.company.executives_provided Boolean No
account.company.export_purpose_code String No
account.company.tax_id_registrar String No
account.company.address Object No
account.company.address.line2 String No
account.company.address.line1 String No
account.company.address.postal_code String No
account.company.address.country String No
account.company.address.state String No
account.company.address.city String No
account.tos_shown_and_accepted Boolean No
customer String No

Create a token for the customer, which is owned by the application's account. You can only use this with an OAuth access token or Stripe-Account header. Learn more about cloning saved payment methods.

pii Object No

The PII this token represents.

pii.id_number String No
expand[] Array No

Specifies which fields in the response should be expanded.

person Object No

Information for the person this token represents.

person.full_name_aliases No
person.first_name String No
person.metadata No
person.relationship Object No
person.relationship.percent_ownership No
person.relationship.authorizer Boolean No
person.relationship.representative Boolean No
person.relationship.executive Boolean No
person.relationship.title String No
person.relationship.director Boolean No
person.relationship.owner Boolean No
person.relationship.legal_guardian Boolean No
person.documents Object No
person.documents.passport Object No
person.documents.passport.files[] Array No
person.documents.visa Object No
person.documents.visa.files[] Array No
person.documents.company_authorization Object No
person.documents.company_authorization.files[] Array No
person.first_name_kana String No
person.political_exposure String No

Possible values:

  • "existing"
  • "none"
person.last_name_kanji String No
person.email String No
person.us_cfpb_data Object No
person.us_cfpb_data.ethnicity_details Object No
person.us_cfpb_data.ethnicity_details.ethnicity_other String No
person.us_cfpb_data.ethnicity_details.ethnicity[] Array No
person.us_cfpb_data.self_identified_gender String No
person.us_cfpb_data.race_details Object No
person.us_cfpb_data.race_details.race[] Array No
person.us_cfpb_data.race_details.race_other String No
person.address_kanji Object No
person.address_kanji.line2 String No
person.address_kanji.line1 String No
person.address_kanji.town String No
person.address_kanji.postal_code String No
person.address_kanji.country String No
person.address_kanji.state String No
person.address_kanji.city String No
person.ssn_last_4 String No
person.address_kana Object No
person.address_kana.line2 String No
person.address_kana.line1 String No
person.address_kana.town String No
person.address_kana.postal_code String No
person.address_kana.country String No
person.address_kana.state String No
person.address_kana.city String No
person.verification Object No
person.verification.additional_document Object No
person.verification.additional_document.back String No
person.verification.additional_document.front String No
person.verification.document Object No
person.verification.document.back String No
person.verification.document.front String No
person.additional_tos_acceptances Object No
person.additional_tos_acceptances.account Object No
person.additional_tos_acceptances.account.user_agent No
person.additional_tos_acceptances.account.ip String No
person.additional_tos_acceptances.account.date Integer No
person.registered_address Object No
person.registered_address.line2 String No
person.registered_address.line1 String No
person.registered_address.postal_code String No
person.registered_address.country String No
person.registered_address.state String No
person.registered_address.city String No
person.last_name_kana String No
person.dob No
person.id_number String No
person.id_number_secondary String No
person.gender String No
person.last_name String No
person.maiden_name String No
person.phone String No
person.nationality String No
person.first_name_kanji String No
person.address Object No
person.address.line2 String No
person.address.line1 String No
person.address.postal_code String No
person.address.country String No
person.address.state String No
person.address.city String No
bank_account Object No

The bank account this token will represent.

bank_account.routing_number String No
bank_account.account_number String Yes
bank_account.account_holder_name String No
bank_account.payment_method String No
bank_account.country String Yes
bank_account.account_holder_type String No

Possible values:

  • "company"
  • "individual"
bank_account.currency String No
bank_account.account_type String No

Possible values:

  • "futsu"
  • "toza"
  • "checking"
  • "savings"
card No

The card this token will represent. If you also pass in a customer, the card must be the ID of a card belonging to the customer. Otherwise, if you do not pass in a customer, this is a dictionary containing a user's credit card details, with the options described below.

cvc_update Object No

The updated CVC value this token represents.

cvc_update.cvc String Yes

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.