Skip to main content

Types

FullName#

FieldTypeDescription
firststringIndividual first name.
laststringIndividual last name.
Example FullName type:
{  "first": "Peter",  "last": "Parker"}

Address#

FieldTypeDescription
streetstringFirst line of an address.
street2stringOptional. Second line of an address.
citystringCity.
statestringState. For US addresses, two letters representing the state.
postalCodestringPostal code.
countryISO31661-Alpha2 stringTwo letters representing the country.
Example Address type:
{  "street": "20 Ingram St",  "street2": "Apt #10",  "city": "Forest Hills",  "state": "NY",  "postalCode": "11375",  "country": "US"}

Phone#

FieldTypeDescription
countryCodestringCountry code of the phone number, e.g. "1" for US.
numberstringThe 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"}

Officer#

FieldTypeDescription
statusstringOne of Approved, Denied or PendingReview.
fullNameFullNameFull name of the officer.
titlestringOne of CEO, COO, CFO, President, BenefitsAdministrationOfficer, CIO, VP, AVP, Treasurer, Secretary, Controller, Manager, Partner or Member.
ssnstringSSN of the officer (numbers only). One of ssn or passport is required.
passportstringPassport of the officer. One of ssn or passport is required.
nationalityISO31661-Alpha2 stringOnly when Passport is populated. Two letters representing the officer's nationality.
dateOfBirthRFC3339 Date stringDate only (e.g. "2001-08-15").
addressAddressThe officer's address.
phonePhoneThe officer's phone number.
emailstringThe officer's email address.
evaluationParamsEvaluationParamsOptional. Evaluation Params for this entity.
Example Officer 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"  }}

BeneficialOwner#

FieldTypeDescription
statusstringOne of Approved, Denied or PendingReview.
fullNameFullNameFull name of the beneficial owner.
ssnstringSSN of the beneficial owner (numbers only). One of ssn or passport is required.
passportstringPassport of the beneficial owner. One of ssn or passport is required.
nationalityISO31661-Alpha2 stringOnly when Passport is populated. Two letters representing the beneficial owner's nationality.
dateOfBirthRFC3339 Date stringDate only (e.g. "2001-08-15").
addressAddressThe beneficial owner's address.
phonePhoneThe beneficial owner's phone number.
emailstringThe beneficial owner's email address.
percentageintegerThe beneficial owner percentage of ownership at the business (between 25 and 100).
evaluationParamsEvaluationParamsOptional. Evaluation Params for this entity.
Example BeneficialOwner 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"  }}

BusinessContact#

FieldTypeDescription
fullNameFullNameFull name of the contact.
emailstringThe contact's email address.
phonePhoneThe contact's phone number.
jwtSubjectstringOptional. See this section for more information.
Example BusinessContact type:
{  "fullName": {    "first": "Richard",    "last": "Hendricks"  },  "email": "richard@piedpiper.com",  "phone": {    "countryCode": "1",    "number": "5555555555"  }}

TrustContact#

FieldTypeDescription
fullNameFullNameFull name of the contact.
emailstringThe contact's email address.
phonePhoneThe contact's phone number.
addressAddressAddress of the contact.
jwtSubjectstringOptional. See this section for more information.
Example TrustContact type:
{  "fullName": {    "first": "Richard",    "last": "Hendricks"  },  "email": "richard@piedpiper.com",  "phone": {    "countryCode": "1",    "number": "5555555555"  },  "address": {    "street": "5230 Newell Rd",    "street2": null,    "city": "Palo Alto",    "state": "CA",    "postalCode": "94303",    "country": "US"  }}

Grantor#

FieldTypeDescription
fullNameFullNameFull name of the grantor.
dateOfBirthRFC3339 Date stringOptional. Date only (e.g. "2001-08-15").
ssnstringIndividual
emailstringThe grantor's email address.
phonePhoneThe grantor's phone number.
addressAddressAddress of the grantor.
Example Grantor type:
{  "fullName": {    "first": "Richard",    "last": "Hendricks"  },  "dateOfBirth": "2001-08-10",  "ssn": "721074426",  "email": "richard@piedpiper.com",  "phone": {    "countryCode": "1",    "number": "5555555555"  },  "address": {    "street": "5230 Newell Rd",    "street2": null,    "city": "Palo Alto",    "state": "CA",    "postalCode": "94303",    "country": "US"  }}

Trustee#

FieldTypeDescription
fullNameFullNameFull name of the trustee.
dateOfBirthRFC3339 Date stringOptional. Date only (e.g. "2001-08-15").
ssnstringIndividual
emailstringThe trustee's email address.
phonePhoneThe trustee's phone number.
addressAddressAddress of the trustee.
Example Trustee type:
{  "fullName": {    "first": "Richard",    "last": "Hendricks"  },  "dateOfBirth": "2001-08-10",  "ssn": "721074426",  "email": "richard@piedpiper.com",  "phone": {    "countryCode": "1",    "number": "5555555555"  },  "address": {    "street": "5230 Newell Rd",    "street2": null,    "city": "Palo Alto",    "state": "CA",    "postalCode": "94303",    "country": "US"  }}

Beneficiary#

FieldTypeDescription
fullNameFullNameFull name of the beneficiary.
dateOfBirthRFC3339 Date stringOptional. Date only (e.g. "2001-08-15").
Example Beneficiary type:
{  "fullName": {    "first": "Richard",    "last": "Hendricks"  },  "dateOfBirth": "2001-08-10"}

ApplicationFormPrefill#

FieldTypeentityDescription
applicationTypestringAllOptional. One of "Individual", "Business" or "SoleProprietorship".
fullNameFullNameIndividualOptional. Full name of the individual.
ssnstringIndividualOptional. SSN of the individual (numbers only). Either an SSN or a passport number is required.
passportstringIndividualOptional. Passport number of the individual. Either an SSN or a passport is required.
nationalityISO31661-Alpha2 stringIndividualOptional. Two letters representing the individual nationality. (e.g. "US").
dateOfBirthRFC3339 Date stringIndividualOptional. Date only (e.g. "2001-08-15").
emailstringIndividualOptional. Email address of the individual.
namestringBusinessOptional. Name of the business.
stateOfIncorporationstringBusinessOptional. Two letters representing a US state.
entityTypestringBusinessOptional. One of "Corporation", "LLC" or "Partnership".
contactBusinessContactBusinessOptional. Primary contact of the business.
officerOfficerBusinessOptional. 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.
beneficialOwnersArray of BeneficialOwnerBusinessOptional. 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.
websitestringBusinessOptional. Business's website.
dbastringIndividual / BusinessOptional. "Doing business as". If the individual is a sole proprietor who is doing business under a different name, specify it here.
einstringIndividual / BusinessOptional. If the individual is a sole proprietor who has an Employer Identification Number, specify it here. / Business EIN (numbers only).
industryIndustryIndividual / BusinessOptional. If the individual is a sole proprietor, specify the industry / Business industry.
addressAddressIndividual / BusinessOptional. Address of the individual / Address of the business.
phonePhoneIndividual / BusinessOptional. Phone number of the individual / Phone number of the business.
jwtSubjectstringIndividual / BusinessOptional. See this section for more information.
Example ApplicationFormPrefill type:
{  "applicationType": "Business",  "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"  }}

ApplicationFormSettingsOverride#

FieldTypeDescription
redirectUrlstringURL that is presented to the user when an application has been submitted
privacyPolicyUrlstringPrivacy Policy
electronicDisclosuresUrlstringConsent to Electronic Disclosures
depositTermsUrlstringDeposit Terms & Conditions
clientTermsUrlstringClient Terms of Service
cardholderTermsUrlstringCardholder Terms and Conditions
cashAdvancedTermsUrlstringCash Advance Terms and Conditions
debitCardDisclosureUrlstringDebit Card Disclosure
additionalDisclosuresArray of {title, url} objectsArray of additional disclosures that were not covered by the above links
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"    }  ]}

AuthorizedUser#

FieldTypeDescription
fullNameFullNameFull name of the authorized user.
emailstringThe authorized user's email address.
phonePhoneThe authorized user's phone number. This number will be used for One Time Password (OTP) authentication.
jwtSubjectstringOptional. See this section for more information.
Example AuthorizedUser type:
{  "fullName": {    "first": "Richard",    "last": "Hendricks"  },  "email": "richard@piedpiper.com",  "phone": {    "countryCode": "1",    "number": "5555555555"  }}

Counterparty#

FieldTypeDescription
routingNumberstringValid 9-digit ABA routing transit number.
accountNumberstringBank account number.
accountTypestringEither Checking or Savings.
namestringName 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#

FieldTypeDescription
routingNumberstringValid 9-digit ABA routing transit number.
accountNumberstringBank account number.
namestringName of the person or company that owns the bank account.
addressAddressAddress 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#

FieldTypeDescription
routingNumberstringValid 9-digit ABA routing transit number.
accountNumberstringBank account number.
namestringName of the person or company that owns the bank account.
Example Check Counterparty type:
{  "counterparty": {    "name": "April Oneil",    "routingNumber": "812345678",    "accountNumber": "1000000001"  }}

Coordinates#

FieldTypeDescription
longitudenumberThe longitude value.
latitudenumberThe latitude value.
Example Coordinates type:
{  "longitude": -77.0364,  "latitude": 38.8951}

DeviceFingerprint#

FieldTypeDescription
providerstringProvider of the device fingerprint fraud and risk prevention. The value is always iovation
valuestringThe 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#

FieldTypeDescription
dentalAmountintegerDental expense (cents).
transitAmountintegerTransit expense (cents).
visionOpticalAmountintegerVision expense (cents).
prescriptionRXAmountintegerPrescription drugs expense (cents).
clinicOtherQualifiedMedicalAmountintegerMisc medical expense (cents).
totalHealthcareAmountintegerTotal medical expense (cents).
Example Healthcare Amounts type:
{  "dentalAmount": 0,  "transitAmount": 0,  "visionOpticalAmount": 2000,  "prescriptionRXAmount": 0,  "clinicOtherQualifiedMedicalAmount": 0,  "totalHealthcareAmount": 2000}

Agent#

FieldTypeDescription
statusstringOne of Approved, Denied or PendingReview.
fullNameFullNameAgent name.
ssnstringSSN of the agent (numbers only). One of ssn or passport is required.
passportstringPassport of the agent. One of ssn or passport is required.
nationalityISO31661-Alpha2 stringOnly when Passport is populated. Two letters representing the agent's nationality.
dateOfBirthRFC3339 Date stringDate only (e.g. "2001-08-15").
addressAddressThe agent's address.
phonePhonePhone number of the agent.
emailstringEmail address of the agent.
jwtSubjectstringOptional. See this section for more information.
Example Power of attorney type:
{  "fullName": {    "first": "Peter",    "last": "Parker"  },  "ssn": "721074426",  "dateOfBirth": "2001-08-15",  "address": {    "street": "5230 Newell Rd",    "city": "Palo Alto",    "state": "CA",    "postalCode": "94303",    "country": "US"  },  "phone": {    "countryCode": "1",    "number": "5555555555"  },  "email": "peter@oscorp.com"}

Industry#

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

Create Schedule#

FieldTypeDescription
startTimeRFC3339 Date stringOptional. Start time of the recurring payment. Date only (e.g. "2022-06-29")
endTimeRFC3339 Date stringOptional. End time of the recurring payment. Date only (e.g. "2022-10-29 ")
intervalstringInterval of the schedule. Can be Monthly.
dayOfMonthintegerScheduled day time in the month. 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.
totalNumberOfPaymentsintegerOptional. 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#

FieldTypeDescription
startTimeRFC3339 Date stringStart time of the recurring payment. Date only (e.g. "2022-06-29")
endTimeRFC3339 Date stringOptional. End time of the recurring payment. Date only (e.g. "2022-10-29 ")
intervalstringInterval of the schedule. Can be Monthly.
dayOfMonthintegerOptional. Scheduled day time in the month. 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.
totalNumberOfPaymentsintegerOptional. Total number of payment repetitions. Positive integers only.
nextScheduledActionstringThe next scheduled date of the action.
Example Schedule type:
{  "schedule": {    "startTime": "2022-06-29",    "endTime": "2022-10-29",    "interval": "Monthly",    "dayOfMonth": 3,    "totalNumberOfPayments": 4,    "nextScheduledAction": "2022-07-03"  }}

Evaluation Params#

FieldTypeDescription
useSelfieVerificationOne of: Never, ReplaceIdentificationOptional. Decide when to request a selfie verification document
Example Evaluation Params type:
{  "evaluationParams": {    "useSelfieVerification": "ReplaceIdentification"  }}