Types

FullName

first

string

Individual first name.

last

string

Individual last name.

Example FullName type:

{
  "first": "Peter",
  "last": "Parker"
}

Address

street

string

First line of an address.

street2Optional

string

Optional. Second line of an address.

city

string

City.

state

string

State. For US and CA addresses, two letters representing the state (US) or province (CA).

postalCode

string

Postal code.

country

ISO31661-Alpha2 string

Two letters representing the country.

Example Address type:

{
  "street": "20 Ingram St",
  "city": "Forest Hills",
  "state": "NY",
  "postalCode": "11375",
  "country": "US"
}

Phone

countryCode

string

Country code of the phone number, e.g. "1" for US.

numberRequired

string

The phone number without the country code, e.g. "4151193497". For US phone numbers, 10 digits are required.

Example US Phone type:

{
  "countryCode": "1",
  "number": "1555555555"
}

Example Non-US Phone type:

{
  "countryCode": "972",
  "number": "505555555"
}

CreateOfficer

fullName

FullName

Full name of the officer.

title

string

One of CEO, COO, CFO, President, BenefitsAdministrationOfficer, CIO, VP, AVP, Treasurer, Secretary, Controller, Manager, Partner or Member.

ssnOptional

string

SSN of the officer (numbers only). One of ssn or passport is required. It is optional to provide only last 4 SSN digits.

passportRequired

string

Passport of the officer. One of ssn or passport is required.

nationalityOptional

ISO31661-Alpha2 string

Always when Passport is populated and optional when SSN is populated. Two letters representing the officer's nationality.

dateOfBirth

RFC3339 Date string

Date only (e.g. "2001-08-15").

address

Address

The officer's address.

phone

Phone

The officer's phone number.

email

string

The officer's email address.

evaluationParamsOptional

EvaluationParams

Optional. Evaluation Params for this entity.

occupationRequired

Occupation

Required if any of the officer / BeneficialOwner of the business have a non US nationality. Occupation of the officer.

annualIncomeRequired

AnnualIncome

Required if any of the officer / BeneficialOwner of the business have a non US nationality. Annual income of the officer.

sourceOfIncomeRequired

SourceOfIncome

Required if any of the officer / BeneficialOwner of the business have a non US nationality. Source of income of the officer.

Example CreateOfficer type:

{
  "fullName": {
    "first": "Richard",
    "last": "Hendricks"
  },
  "dateOfBirth": "2001-08-15",
  "ssn": "721074426",
  "email": "richard@piedpiper.com",
  "phone": {
    "countryCode": "1",
    "number": "5555555555"
  },
  "address": {
    "street": "5230 Newell Rd",
    "city": "Palo Alto",
    "state": "CA",
    "postalCode": "94303",
    "country": "US"
  },
  "occupation": "ArchitectOrEngineer",
  "annualIncome": "Between50kAnd100k",
  "sourceOfIncome": "EmploymentOrPayrollIncome"
}

Officer

status

string

One of Approved, Denied or PendingReview.

fullName

FullName

Full name of the officer.

title

string

One of CEO, COO, CFO, President, BenefitsAdministrationOfficer, CIO, VP, AVP, Treasurer, Secretary, Controller, Manager, Partner or Member.

ssnRequired

string

SSN of the officer (numbers only). One of ssn or passport is required.

passportRequired

string

Passport of the officer. One of ssn or passport is required.

nationalityOptional

ISO31661-Alpha2 string

Always when Passport is populated and optional when SSN is populated. Two letters representing the officer's nationality.

dateOfBirth

RFC3339 Date string

Date only (e.g. "2001-08-15").

address

Address

The officer's address.

phone

Phone

The officer's phone number.

email

string

The officer's email address.

idTheftScoreOptional

number

Optional. Score (0-1000) for ID theft verification, >900 is auto rejected as default (threshold is configurable).

occupationOptional

Occupation

Optional. Occupation of the officer.

annualIncomeOptional

AnnualIncome

Optional. Annual income of the officer.

sourceOfIncomeOptional

SourceOfIncome

Optional. Source of income of the officer.

Example Officer type:

{
  "status": "Approved",
  "fullName": {
    "first": "Richard",
    "last": "Hendricks"
  },
  "dateOfBirth": "2001-08-15",
  "ssn": "721074426",
  "email": "richard@piedpiper.com",
  "phone": {
    "countryCode": "1",
    "number": "5555555555"
  },
  "address": {
    "street": "5230 Newell Rd",
    "city": "Palo Alto",
    "state": "CA",
    "postalCode": "94303",
    "country": "US"
  },
  "occupation": "ArchitectOrEngineer",
  "annualIncome": "Between50kAnd100k",
  "sourceOfIncome": "EmploymentOrPayrollIncome"
}

CreateBeneficialOwner

fullName

FullName

Full name of the beneficial owner.

ssnOptional

string

SSN of the beneficial owner (numbers only). One of ssn or passport is required. It is optional to provide only last 4 SSN digits.

passportRequired

string

Passport of the beneficial owner. One of ssn or passport is required.

nationalityOptional

ISO31661-Alpha2 string

Always when Passport is populated and optional when SSN is populated. Two letters representing the beneficial owner's nationality.

dateOfBirth

RFC3339 Date string

Date only (e.g. "2001-08-15").

address

Address

The beneficial owner's address.

phone

Phone

The beneficial owner's phone number.

email

string

The beneficial owner's email address.

percentage

integer

The beneficial owner percentage of ownership at the business (between 25 and 100).

evaluationParamsOptional

EvaluationParams

Optional. Evaluation Params for this entity.

occupationRequired

Occupation

Required if any of the officer / BeneficialOwner of the business have a non US nationality. Occupation of the beneficial owner.

annualIncomeRequired

AnnualIncome

Required if any of the officer / BeneficialOwner of the business have a non US nationality. Annual income of the beneficial owner.

sourceOfIncomeRequired

SourceOfIncome

Required if any of the officer / BeneficialOwner of the business have a non US nationality. Source of income of the beneficial owner.

Example CreateBeneficialOwner type:

{
  "fullName": {
    "first": "Richard",
    "last": "Hendricks"
  },
  "dateOfBirth": "2001-08-15",
  "ssn": "721074426",
  "email": "richard@piedpiper.com",
  "percentage": 25,
  "phone": {
    "countryCode": "1",
    "number": "5555555555"
  },
  "address": {
    "street": "5230 Newell Rd",
    "city": "Palo Alto",
    "state": "CA",
    "postalCode": "94303",
    "country": "US"
  },
  "occupation": "ArchitectOrEngineer",
  "annualIncome": "Between50kAnd100k",
  "sourceOfIncome": "EmploymentOrPayrollIncome"
}

BeneficialOwner

status

string

One of Approved, Denied or PendingReview.

fullName

FullName

Full name of the beneficial owner.

ssnRequired

string

SSN of the beneficial owner (numbers only). One of ssn or passport is required.

passportRequired

string

Passport of the beneficial owner. One of ssn or passport is required.

nationalityOptional

ISO31661-Alpha2 string

Always when Passport is populated and optional when SSN is populated. Two letters representing the beneficial owner's nationality.

dateOfBirth

RFC3339 Date string

Date only (e.g. "2001-08-15").

address

Address

The beneficial owner's address.

phone

Phone

The beneficial owner's phone number.

email

string

The beneficial owner's email address.

percentage

integer

The beneficial owner percentage of ownership at the business (between 25 and 100).

idTheftScoreOptional

number

Optional. Score (0-1000) for ID theft verification, >900 is auto rejected as default (threshold is configurable).

occupationOptional

Occupation

Optional. Occupation of the beneficial owner.

annualIncomeOptional

AnnualIncome

Optional. Annual income of the beneficial owner.

sourceOfIncomeOptional

SourceOfIncome

Optional. Source of income of the beneficial owner.

Example BeneficialOwner type:

{
  "status": "Approved",
  "fullName": {
    "first": "Richard",
    "last": "Hendricks"
  },
  "percentage": 25,
  "dateOfBirth": "2001-08-15",
  "ssn": "721074426",
  "email": "richard@piedpiper.com",
  "phone": {
    "countryCode": "1",
    "number": "5555555555"
  },
  "address": {
    "street": "5230 Newell Rd",
    "city": "Palo Alto",
    "state": "CA",
    "postalCode": "94303",
    "country": "US"
  },
  "occupation": "ArchitectOrEngineer",
  "annualIncome": "Between50kAnd100k",
  "sourceOfIncome": "EmploymentOrPayrollIncome"
}

BusinessContact

fullName

FullName

Full name of the contact.

email

string

The contact's email address.

phone

Phone

The contact's phone number.

jwtSubjectOptional

string

Optional. See this section for more information.

Example BusinessContact type:

{
  "fullName": {
    "first": "Richard",
    "last": "Hendricks"
  },
  "email": "richard@piedpiper.com",
  "phone": {
    "countryCode": "1",
    "number": "5555555555"
  }
}

ApplicationFormPrefill

Field	Type	entity	Description
applicationType	string	All	Optional. For application form V1, One of Individual, Business or SoleProprietorship. For application form V2, One of Individual, SoleProprietorship, SingleMemberBusiness, or MultipleMemberBusiness
fullName	FullName	Individual	Optional. Full name of the individual.
ssn	string	Individual / Sole Proprietorship	Optional. SSN of the individual (numbers only). Either an SSN or a passport number is required.
passport	string	Individual / Sole Proprietorship	Optional. Passport number of the individual. Either an SSN or a passport is required.
nationality	ISO31661-Alpha2 string	Individual / Sole Proprietorship	Optional. Two letters representing the individual nationality. (e.g. "US").
dateOfBirth	RFC3339 Date string	Individual / Sole Proprietorship	Optional. Date only (e.g. "2001-08-15").
email	string	Individual / Sole Proprietorship	Optional. Email address of the individual.
name	string	Business	Optional. Name of the business.
stateOfIncorporation	string	Business	Optional. Two letters representing a US state.
entityType	string	Business	Optional. One of LLC, Partnership, PubliclyTradedCorporation, PrivatelyHeldCorporation or NotForProfitOrganization.
contact	BusinessContact	Business	Optional. Primary contact of the business.
officer	Officer	Business	Optional. Officer representing the business (must be the CEO, COO, CFO, President, BenefitsAdministrationOfficer, CIO, VP, AVP, Treasurer, Secretary, Controller, Manager, Partner or Member). To onboard a business successfully, you must provide the officer's personal details.
beneficialOwners	Array of BeneficialOwner	Business	Optional. Array of beneficial owners in the business. Beneficial owners are all people that, directly or indirectly, own 25% or more of the business. To onboard a business successfully, you must provide each beneficial owner's personal details.
website	string	Sole Proprietorship / Business	Optional. Business's website.
dba	string	Sole Proprietorship / Business	Optional. "Doing business as". If the individual is a sole proprietor who is doing business under a different name, specify it here.
ein	string	Sole Proprietorship / Business	Optional. If the individual is a sole proprietor who has an Employer Identification Number, specify it here. / Business EIN (numbers only).
address	Address	All	Optional. Address of the individual / Address of the business.
phone	Phone	All	Optional. Phone number of the individual / Phone number of the business.
jwtSubject	string	All	Optional. See this section for more information.
occupation	Occupation	Individual / Sole Proprietorship	Optional. Occupation of the individual / sole proprietor.
annualIncome	AnnualIncome	Individual / Sole Proprietorship	Optional. Annual income of the individual / sole proprietor.
sourceOfIncome	SourceOfIncome	Individual / Sole Proprietorship	Optional. Source of income of the individual / sole proprietor.
businessVertical	BusinessVertical	Sole Proprietorship / Business	Optional. The business vertical of the sole proprietor / business.
annualRevenue	AnnualRevenue	Sole Proprietorship / Business	Optional. Annual revenue of the sole proprietor / business.
numberOfEmployees	NumberOfEmployees	Sole Proprietorship / Business	Optional. Number of employees of the sole proprietor / business.
cashFlow	CashFlow	Business	Optional. Cash flow of the business.
yearOfIncorporation	Year string	Business	Optional. Year of incorporation of the business.
countriesOfOperation	Array of ISO31661-Alpha2 strings	Business	Optional. An array of two letter codes representing the countries of operation of the business.
stockSymbol	string	Business	Optional. The stock symbol (ticker) of the business.
hasNonUsEntities	boolean	Business	Optional. Indicates if any of the officer / BeneficialOwner of the business have a non US nationality.

Example ApplicationFormPrefill type:

{
  "applicationType": "MultipleMemberBusiness",
  "fullName": {
    "first": "Peter",
    "last": "Parker"
  },
  "ssn": "721074426",
  "passport": "12345678",
  "nationality": "US",
  "dateOfBirth": "2001-08-10",
  "email": "peter@oscorp.com",
  "name": "Pied Piper",
  "stateOfIncorporation": "DE",
  "entityType": "Corporation",
  "contact": {
    "fullName": {
      "first": "Richard",
      "last": "Hendricks"
    },
    "email": "richard@piedpiper.com",
    "phone": {
      "countryCode": "1",
      "number": "5555555555"
    }
  },
  "officer": {
    "fullName": {
      "first": "Richard",
      "last": "Hendricks"
    },
    "dateOfBirth": "2001-08-10",
    "title": "CEO",
    "ssn": "721074426",
    "email": "richard@piedpiper.com",
    "phone": {
      "countryCode": "1",
      "number": "5555555555"
    },
    "address": {
      "street": "5230 Newell Rd",
      "city": "Palo Alto",
      "state": "CA",
      "postalCode": "94303",
      "country": "US"
    }
  },
  "beneficialOwners": [
    {
      "fullName": {
        "first": "Richard",
        "last": "Hendricks"
      },
      "dateOfBirth": "2001-08-10",
      "ssn": "123456789",
      "email": "richard@piedpiper.com",
      "percentage": 75,
      "phone": {
        "countryCode": "1",
        "number": "5555555555"
      },
      "address": {
        "street": "5230 Newell Rd",
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94303",
        "country": "US"
      }
    }
  ],
  "website": "https://www.piedpiper.com",
  "dba": "Piedpiper Inc",
  "ein": "123456789",
  "address": {
    "street": "5230 Newell Rd",
    "city": "Palo Alto",
    "state": "CA",
    "postalCode": "94303",
    "country": "US"
  },
  "phone": {
    "countryCode": "1",
    "number": "5555555555"
  },
  "occupation": "Doctor",
  "sourceOfIncome": "EmploymentOrPayrollIncome",
  "annualIncome": "Between10kAnd25k",
  "businessVertical": "TechnologyMediaOrTelecom",
  "annualRevenue": "Between500kAnd1m",
  "numberOfEmployees": "Between50And100",
  "cashFlow": "Predictable",
  "yearOfIncorporation": "2014",
  "countriesOfOperation": [
    "US",
    "CA"
  ],
  "stockSymbol": "PPI",
  "hasNonUsEntities": false
}

ApplicationFormSettingsOverride

redirectUrlOptional

string

Optional. URL that is presented to the user when an application has been submitted

privacyPolicyUrlOptional

string

Optional. Privacy Policy

electronicDisclosuresUrlOptional

string

Optional. Consent to Electronic Disclosures

depositTermsUrlOptional

string

Optional. Deposit Terms & Conditions

clientTermsUrlOptional

string

Optional. Client Terms of Service

cardholderTermsUrlOptional

string

Optional. Cardholder Terms and Conditions

cashAdvancedTermsUrlOptional

string

Optional. Cash Advance Terms and Conditions

debitCardDisclosureUrlOptional

string

Optional. Debit Card Disclosure

additionalDisclosuresOptional

Array of {title, url} objects

Optional. Array of additional disclosures that were not covered by the above links

useSelfieVerificationOptional

boolean

Optional. If true, the applicant will be required to complete the selfie verification process when an ID document is required.

disablePassportApplicationOptional

boolean

Optional. If true, the applicant will not be able to apply using a passport (SSN only).

Example ApplicationFormSettingsOverride type:

{
  "redirectUrl": "https://www.unit.co",
  "privacyPolicyUrl": "https://www.unit.co",
  "electronicDisclosuresUrl": "https://www.unit.co",
  "depositTermsUrl": "https://www.unit.co",
  "clientTermsUrl": "https://www.unit.co",
  "cardholderTermsUrl": "https://www.unit.co",
  "cashAdvancedTermsUrl": "https://www.unit.co",
  "debitCardDisclosureUrl": "https://www.unit.co",
  "additionalDisclosures": [
    {
      "title": "My org additional terms",
      "url": "https://www.unit.co"
    }
  ],
  "useSelfieVerification": false,
  "disablePassportApplication": false
}

AuthorizedUser

fullName

FullName

Full name of the authorized user.

email

string

The authorized user's email address.

phone

Phone

The authorized user's phone number. This number will be used for One Time Password (OTP) authentication.

jwtSubjectOptional

string

Optional. See this section for more information.

canConnectWithAuthVendorOptional

boolean

Optional. Default is true. When set to false, the authorized user cannot authenticate through exchange networks such as Plaid. See Plaid Exchange for more information.

Example AuthorizedUser type:

{
  "fullName": {
    "first": "Richard",
    "last": "Hendricks"
  },
  "email": "richard@piedpiper.com",
  "phone": {
    "countryCode": "1",
    "number": "5555555555"
  },
  "canConnectWithAuthVendor": true
}

Counterparty

routingNumber

string

Valid 9-digit ABA routing transit number.

accountNumber

string

Bank account number.

accountType

string

Either Checking, Savings or Loan.

name

string

Name of the person or company that owns the bank account.

Example Counterparty type:

{
  "counterparty": {
    "routingNumber": "812345678",
    "accountNumber": "12345569",
    "accountType": "Checking",
    "name": "Jane Doe"
  }
}

Wire Counterparty

routingNumber

string

Valid 9-digit ABA routing transit number.

accountNumber

string

Bank account number.

name

string

Name of the person or company that owns the bank account.

address

Address

Address of the counterparty account owner.

Example Wire Counterparty type:

{
  "counterparty": {
    "name": "April Oneil",
    "routingNumber": "812345678",
    "accountNumber": "1000000001",
    "address": {
      "street": "20 Ingram St",
      "city": "Forest Hills",
      "state": "CA",
      "postalCode": "11375",
      "country": "US"
    }
  }
}

Check Counterparty

routingNumber

string

Valid 9-digit ABA routing transit number.

accountNumber

string

Bank account number.

name

string

Name of the person or company that owns the bank account.

Example Check Counterparty type:

{
  "counterparty": {
    "name": "April Oneil",
    "routingNumber": "812345678",
    "accountNumber": "1000000001"
  }
}

Check Payment Counterparty

name

string

The name of the person or company that owns the bank account.

address

Address

The payee's address. The length of street and street2 combined cannot exceed 50 characters.

counterpartyMovedOptional

boolean

Optional. True if the counterparty's address has been modified to correspond with a National Change of Address applied on the address. See guide for further information.

Example Check Payment Counterparty type:

{
  "counterparty": {
    "name": "John Doe",
    "counterpartyMoved": true,
    "address": {
      "street": "20 Ingram St",
      "street2": "Apt #10",
      "city": "Forest Hills",
      "state": "NY",
      "postalCode": "11375",
      "country": "US"
    }
  }
}

Coordinates

longitude

number

The longitude value.

latitude

number

The latitude value.

Example Coordinates type:

{
  "longitude": -77.0364,
  "latitude": 38.8951
}

DeviceFingerprint

provider

string

Provider of the device fingerprint fraud and risk prevention. The value is always iovation

value

string

The device fingerprint blackbox value.

Example DeviceFingerprint type:

{
  "provider": "iovation",
  "value": "0400bpNfiPCR/AUNf94lis1ztpaNnzv+lNq30Hfp5ie720z/CiIC8ERuu3YpPgQiEVyiFhADfeGQZO28FbUrrO5N6T/KhUgGeNqKfeXqFvOptJMkxZw+Y9UPy+f0N3IyJgvEw8TWskb/j+GHTKUkZ8zWbl1IO8WxD1Kht8TqEibpebBOV3otSIldf1zxXVkhYr77KTMIYGWCBwYibAjilOCqFmMCwwZ2fQOGTEVdGJlxBwCc8acbcKqAuWf7gouzBPJaEMCy0s3hRLlX3uHnT/mMq7bvVoECdF71JNfXVRZenju64Ouq7Dncq6Dl1FsZY8jwYa/hFBBVErqVT31SgfbGSd1k0e/YM3Dtt6SI2G2F/ThwR+CXcWdbH3hXufQCF6M4Dpgq27WF46865RaUe/IZRl+rdsbATajAyMeRup82fY15RZwU9zPDpHaSwVqaWdUNw+E1ob+/FRCJ3uese38lURah37+pYGav2UwkTNot/DgwZ8YN8wmMva0q3Wpvwm165E+YRS8maek+P03Li8QHdLmZnC9N+MV7Pw1IrivGG+SXG7Fg5ZExEZyxlgiYsdKgDX8icOWPZcy4Xo6JR+o8uNh2BeaMmRyXBtJlds64QOcTfWwKrqPu/ordrByteUo8YUcRNcJsz+1j3aE1Kav6TbwSyw9pfmqz7J9hKqYUy8nou5GL7lS1H1jks3/PBPSgsZBfgyIR+XyE6hsi11FUlhkwfCqvl92YChvQ5GutOWzcgAlm5C655YuD71qCKcmZqa+c5UMfdLNXqLz+1vlqUAr9dE2jcfl0wgroQBfpyuI++K9SiDi/XDMkV0rONHETVTw2C4oQ2p6vWc20/w4QKST/riUqiozfAOitx40UDzaLaxNWMM2S8Us77dixCJm6Q57yZdeR90iPaqS7dmS/Ocl5HQBNDFBWeVaYJEF00M2y5rEDAARtF2ONlKQFMFWIfGA9WPh4380ZhZzwCZq88ApXlgSYdPkGU/BN8NSHlLSYTdGrUGXc9xYjcWtBi6X2zTt76b5csU1EK0+sD0E3ZqRPV+2/f5evS5h4cLbW2EYqYNCw25rZJOp9wXDoTKUQQlPiadkVLXwMpOFU/WEDIOxhmgTkbsvKHRH29E2Pl68vN0XpeFtRx/cjdbgHxEkRmgkRq1Qs48sbX9QC8nOTD0ntb6FcJyEOEOVzmJtDqimkzDq+SXR1/7oj0f6YtJc05sdrzcINkHr+mxLg5xX0cvFOwbohKb3xCPSKMsCJXe4s152+pJeKAyZP60EH4fIPPSI7lrfThjSC+ZC/uhKlHiPzk7Wcbftiipgbt5tQ5DBgOa5eE3shSuCUuzjuYSvn4NHYYO+c6svSooIPnW146zqeKNiPJcgsVSaircwUTU6esiGRHxaLYuc0891K2c1Zd7VesgONPiXcBur/JCDJyOWRcJ2nAB+S9dSneRnhcIA="
}

Healthcare Amounts

dentalAmount

integer

Dental expense (cents).

transitAmount

integer

Transit expense (cents).

visionOpticalAmount

integer

Vision expense (cents).

prescriptionRXAmount

integer

Prescription drugs expense (cents).

clinicOtherQualifiedMedicalAmount

integer

Misc medical expense (cents).

totalHealthcareAmount

integer

Total medical expense (cents).

Example Healthcare Amounts type:

{
  "dentalAmount": 0,
  "transitAmount": 0,
  "visionOpticalAmount": 2000,
  "prescriptionRXAmount": 0,
  "clinicOtherQualifiedMedicalAmount": 0,
  "totalHealthcareAmount": 2000
}

Industry

The business industry. One of: Retail, Wholesale, Restaurants, Hospitals, Construction, Insurance, Unions, RealEstate, FreelanceProfessional, OtherProfessionalServices, OnlineRetailer, OtherEducationServices.

Create Schedule

startTimeOptional

RFC3339 Date string

Optional. Start time of the recurring payment. Date only (e.g. "2022-06-29")

endTimeOptional

RFC3339 Date string

Optional. End time of the recurring payment. Date only (e.g. "2022-10-29 ")

interval

string

Interval of the schedule. Can be Monthly or Weekly.

dayOfMonthRequired

integer

Scheduled day of the month. Required when Monthly interval is specified. Valid values can be between 1-28 or (-5)-(-1). Negative numbers represent relative day to the end of the month. -1 represents the last day of the month.

dayOfWeekRequired

string

Scheduled day of the week. Required when Weekly interval is specified. Valid values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.

totalNumberOfPaymentsOptional

integer

Optional. Total number of payment repetitions. Positive integers only.

Example Create Schedule type:

{
  "schedule": {
    "startTime": "2022-06-29",
    "endTime": "2022-10-29",
    "interval": "Monthly",
    "dayOfMonth": 3,
    "totalNumberOfPayments": 4
  }
}

Schedule

startTime

RFC3339 Date string

Start time of the recurring payment. Date only (e.g. "2022-06-29")

endTimeOptional

RFC3339 Date string

Optional. End time of the recurring payment. Date only (e.g. "2022-10-29 ")

interval

string

Interval of the schedule. Can be Monthly or Weekly.

dayOfMonthRequired

integer

Scheduled day of the month. Required when Monthly interval is specified. Valid values can be between 1-28 or (-5)-(-1). Negative numbers represent relative day to the end of the month. -1 represents the last day of the month.

dayOfWeekRequired

string

Scheduled day of the week. Required when Weekly interval is specified. Valid values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.

totalNumberOfPaymentsOptional

integer

Optional. Total number of payment repetitions. Positive integers only.

nextScheduledAction

string

The next scheduled date of the action.

Example Monthly schedule:

{
  "schedule": {
    "startTime": "2022-06-29",
    "endTime": "2022-10-29",
    "interval": "Monthly",
    "dayOfMonth": 3,
    "totalNumberOfPayments": 4,
    "nextScheduledAction": "2022-07-03"
  }
}

Example Weekly schedule:

{
  "schedule": {
    "startTime": "2022-06-29",
    "endTime": "2022-10-29",
    "interval": "Weekly",
    "dayOfWeek": "Monday",
    "totalNumberOfPayments": 4,
    "nextScheduledAction": "2022-07-03"
  }
}

Evaluation Params

useSelfieVerificationOptional

One of: Never, ReplaceIdentification

Optional. Decide when to request a selfie verification document

requireIdVerificationOptional

boolean

Optional, default to false. Decide whether to require an ID verification regardless of evaluation response

Example Evaluation Params type:

{
  "evaluationParams": {
    "useSelfieVerification": "ReplaceIdentification",
    "requireIdVerification": true
  }
}

Require Id Verification

individualOptional

Boolean

Optional. Decide whether to require an ID verification from an individual

officerOptional

Boolean

Optional. Decide whether to require an ID verification from an officer

beneficialOwnersOptional

Boolean

Optional. Decide whether to require an ID verification from all beneficial owners

Example Require Id Verification type:

{
  "requireIdVerification": {
    "individual": false,
    "officer": false,
    "beneficialOwners": true
  }
}

Rich Merchant Data

name

string

Name of the merchant.

websiteOptional

string

Optional. URL of the merchant's website.

logoOptional

string

Optional. URL of the merchant's logo.

phoneOptional

string

Optional. Phone number of the merchant.

categoriesOptional

Array of {name, icon} objects

Optional. Array of categories the merchant belongs to (from the least specific to the most specific).

addressOptional

{city, state, country and optionally street} object

Optional. Address of the merchant.

coordinatesOptional

Coordinates

Optional. Coordinates (latitude, longitude) of the merchant.

facilitatorsOptional

Array of Facilitators

Optional. The transaction facilitators.

Example Rich Merchant Data type:

{
  "richMerchantData": {
    "name": "7-Eleven",
    "website": "7-eleven.com",
    "logo": "https://v1.spadeapi.com/logos/verified/7eleven.png?size=large",
    "phone": "",
    "categories": [
      {
        "name": "Retail",
        "icon": "https://static.v2.spadeapi.com/categories/7bfa3240804440309d0f050b7509f509/light.png"
      },
      {
        "name": "Convenience Store",
        "icon": "https://static.v2.spadeapi.com/categories/7bfa3240804440309d0f050b7509f509/light.png"
      }
    ],
    "address": {
      "city": "Orlando",
      "state": "FL",
      "country": "USA"
    },
    "coordinates": null
  }
}

Rich Merchant Data Facilitator

name

string

Name of the facilitator.

typeOptional

string

Optional. Type of the facilitator. One of BuyNowPayLater, DeliveryService, Marketplace, PaymentProcessor, Platform, PointOfSale.

logoOptional

string

Optional. Url of the facilitator.

Example Rich Merchant Data Facilitator type:

{
  "name": "DoorDash",
  "type": "DeliveryService",
  "logo": "https://static.v2.spadeapi.com/logos/ded0433236783236b3e715ac59c66b9d/light.png"
}

Currency Conversion

originalCurrency

string

ISO 4217 currency code of original currency.

amountInOriginalCurrency

number

The amount in original currency in 'cents' (i.e. 50 euros will be written 5000)

fxRateOptional

string

Optional. The conversion rate for the currency conversion to USD.

Example Foreign Exchange Currency Information type:

{
  "originalCurrency": "EUR",
  "amountInOriginalCurrency": 5000,
  "fxRate": "1.164"
}

Occupation

The occupation of an individual. One of: ArchitectOrEngineer, BusinessAnalystAccountantOrFinancialAdvisor, CommunityAndSocialServicesWorker, ConstructionMechanicOrMaintenanceWorker, Doctor, Educator, EntertainmentSportsArtsOrMedia, ExecutiveOrManager, FarmerFishermanForester, FoodServiceWorker, GigWorker, HospitalityOfficeOrAdministrativeSupportWorker, HouseholdManager, JanitorHousekeeperLandscaper, Lawyer, ManufacturingOrProductionWorker, MilitaryOrPublicSafety, NurseHealthcareTechnicianOrHealthcareSupport, PersonalCareOrServiceWorker, PilotDriverOperator, SalesRepresentativeBrokerAgent, ScientistOrTechnologist, Student

Product

One of: Banking, BillPay, CapitalLineOfCredit.

Annual Income

The annual income of an individual.

Value	Description
UpTo10k	$0 - $10,000
Between10kAnd25k	$10,000 - $25,000
Between25kAnd50k	$25,000 - $50,000
Between50kAnd100k	$50,000 - $100,000
Between100kAnd250k	$100,000 - $250,000
Over250k	$250,000+

Source Of Income

The source of income of an individual. One of: EmploymentOrPayrollIncome, PartTimeOrContractorIncome, InheritancesAndGifts, PersonalInvestments, BusinessOwnershipInterests, GovernmentBenefits.

Business Vertical

The business vertical/industry of a sole proprietor or a business.

Value
AdultEntertainmentDatingOrEscortServices
AdvertisingOrMarketing
AgricultureForestryFishingOrHunting
ArtsEntertainmentAndRecreation
BusinessSupportOrBuildingServices
Cannabis
Construction
DirectMarketingOrTelemarketing
EducationalServices
FinancialServicesCryptocurrency
FinancialServicesDebitCollectionOrConsolidation
FinancialServicesMoneyServicesBusinessOrCurrencyExchange
FinancialServicesOther
FinancialServicesPaydayLending
GamingOrGambling
HealthCareAndSocialAssistance
HospitalityAccommodationOrFoodServices
LegalAccountingConsultingOrComputerProgramming
Manufacturing
Mining
Nutraceuticals
PersonalCareServices
PublicAdministration
RealEstate
ReligiousCivicAndSocialOrganizations
RepairAndMaintenance
RetailTrade
TechnologyMediaOrTelecom
TransportationOrWarehousing
Utilities
WholesaleTrade

Annual Revenue

The annual revenue of a sole proprietor or a business.

For businesses:

Value	Description
UpTo250k	$0 - $250,000
Between250kAnd500k	$250,000 - $500,000
Between500kAnd1m	$500,000 - $1 million
Between1mAnd5m	$1 million - $5 million
Over5m	$5+ million

For sole proprietors:

Value	Description
UpTo50k	$0 - $50,000
Between50kAnd100k	$50,000 - $100,000
Between100kAnd200k	$100,000 - $200,000
Between200kAnd500k	$200,000 - $500,000
Over500k	$500,000+

Number Of Employees

The number of employees of a sole proprietor or a business.

For businesses:

Value	Description
UpTo10	0 - 10
Between10And50	10 - 50
Between50And100	50 - 100
Between100And500	100 - 500
Over500	500+

For sole proprietors:

Value	Description
One	1 (only myself)
Between2And5	2 - 5
Between5And10	5 - 10
Over10	10+

Cash Flow

The cash flow of a business.

Value	Description
Unpredictable	I'm a new company / my cash flow fluctuates
Predictable	I'm an established company with predictable cash flows

Push to Card Configuration

The Astra push to card configuration

Value	Description
authToken	A token that represents a user that successfully completed authentication with Astra (called access_token in Astra's documentation). You need to refresh the token before creating a Push To Card payment.
debitFeePercent	Optional. The fee percentage will be used by Astra in order to calculate the fee amount that will be deducted from the sent amount. If not included, Astra will use the default fee percent that was defined for the account
institutionId	A unique identifier received from Astra to represent your organization
destinationCardId	A unique identifier received from Astra to represent the external debit card where the funds are pushed to
routingNumber	The routing number of the account with Astra where funds are processed through
accountNumber	The account number of the account with Astra where funds are processed through
referenceId	Additional payment information (maximum of 80 characters) to help with connecting the PushToCard payment recourse with internal resources from your system

White-label App end user config

allowedApplicationTypesOptional

Array of Individual, SoleProprietorship, SingleMemberBusiness, or MultipleMemberBusiness.

Optional. Restrict the available application type for this specific application.

applicantDetails

ApplicationFormPrefill

Data that is already known about the end-customer to be auto populated on the application form.

requestedProductsOptional

Array of Product

Optional. The product being applied for. Contact Unit to enable BillPay and Capital products.

Example whiteLabelAppEndUserConfig type:

{
  "data": {
    "type": "whiteLabelAppEndUserConfig",
    "attributes": {
      "allowedApplicationTypes": [
        "MultipleMemberBusiness"
      ],
      "requestedProducts": [
        "Banking",
        "BillPay"
      ],
      "applicantDetails": {
        "applicationType": "MultipleMemberBusiness",
        "fullName": {
          "first": "Peter",
          "last": "Parker"
        },
        "ssn": "721074426",
        "passport": "12345678",
        "nationality": "US",
        "dateOfBirth": "2001-08-10",
        "email": "peter@oscorp.com",
        "name": "Pied Piper",
        "stateOfIncorporation": "DE",
        "entityType": "Corporation",
        "contact": {
          "fullName": {
            "first": "Richard",
            "last": "Hendricks"
          },
          "email": "richard@piedpiper.com",
          "phone": {
            "countryCode": "1",
            "number": "2345789888"
          }
        },
        "officer": {
          "fullName": {
            "first": "Richard",
            "last": "Hendricks"
          },
          "occupation": "Doctor",
          "dateOfBirth": "2001-08-10",
          "title": "CEO",
          "ssn": "721074426",
          "email": "richard@piedpiper.com",
          "phone": {
            "countryCode": "1",
            "number": "2345789888"
          },
          "address": {
            "street": "5230 Newell Rd",
            "city": "Palo Alto",
            "state": "CA",
            "postalCode": "94303",
            "country": "US"
          }
        },
        "beneficialOwners": [
          {
            "fullName": {
              "first": "Richard",
              "last": "Hendricks"
            },
            "occupation": "Doctor",
            "dateOfBirth": "2001-08-10",
            "ssn": "123456789",
            "email": "richard@piedpiper.com",
            "percentage": 75,
            "phone": {
              "countryCode": "1",
              "number": "2345789888"
            },
            "address": {
              "street": "5230 Newell Rd",
              "city": "Palo Alto",
              "state": "CA",
              "postalCode": "94303",
              "country": "US"
            }
          }
        ],
        "website": "https://www.piedpiper.com",
        "dba": "Piedpiper Inc",
        "ein": "123456789",
        "address": {
          "street": "5230 Newell Rd",
          "city": "Palo Alto",
          "state": "CA",
          "postalCode": "94303",
          "country": "US"
        },
        "phone": {
          "countryCode": "1",
          "number": "2345789888"
        },
        "sourceOfIncome": "EmploymentOrPayrollIncome",
        "annualIncome": "Between10kAnd25k",
        "businessVertical": "TechnologyMediaOrTelecom",
        "annualRevenue": "Between500kAnd1m",
        "numberOfEmployees": "Between50And100",
        "cashFlow": "Predictable",
        "yearOfIncorporation": "2014",
        "countriesOfOperation": [
          "US",
          "CA"
        ],
        "stockSymbol": "PPI",
        "hasNonUsEntities": false
      }
    }
  }
}

Fraud Case Card Activity

Represents a card activity that is part of a TransactionCardFraudCase or AuthorizationCardFraudCase.

id

string

The id of the fraud case card activity.

createdAt

RFC3339 Date string

The date the activity was created.

activityType

string

The type of the activity. Can be either Authorization or Transaction.

cardActivityCreatedAt

RFC3339 Date string

The creation date of the original Authorization or Transaction the activity was created upon.

cardActivity

string

The id of the original Authorization or Transaction of the activity.

location

string

The location in which the activity occurred.

merchant

string

The name of the merchant of the activity.

amount

integer

The amount (in cents) of the activity.

decision

string

The decision made for the activity. Can be one of Pending, Fraud, NoFraud.

updatedAt

RFC3339 Date string

The date the activity was last updated.

Example Fraud Case Card Activity type:

{
  "id": "15",
  "createdAt": "2024-07-31T11:02:27.355Z",
  "activityType": "Authorization",
  "cardActivityCreatedAt": "2024-07-31T11:02:27.270Z",
  "cardActivity": "8082294",
  "location": "Cupertino, CA, US",
  "merchant": "Apple Inc.",
  "amount": 2500,
  "decision": "Fraud",
  "updatedAt": "2024-07-31T11:04:43.696Z"
}

Total Accrued Interest

Represents a sum of customer accrued interest for a given period of time

amount

integer

The total amount of customer accrued interest (in cents).

Example Total Accrued Interest type:

{
  "data": {
    "type": "totalAccruedInterest",
    "attributes": {
      "amount": 1108647
    }
  }
}

Check Registered Agent Address

Represents whether the provided address is a Registered Agent address.

isRegisteredAgentAddress

boolean

Returns whether the provided address is a Registered Agent address.

Example Total Accrued Interest type:

{
  "data": {
    "type": "checkRegisteredAgentAddress",
    "attributes": {
      "isRegisteredAgentAddress": true
    }
  }
}