Types
#
FullNameField | Type | Description |
---|---|---|
first | string | Individual first name. |
last | string | Individual last name. |
{ "first": "Peter", "last": "Parker"}
#
AddressField | Type | Description |
---|---|---|
street | string | First line of an address. |
street2 | 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. |
{ "street": "20 Ingram St", "street2": "Apt #10", "city": "Forest Hills", "state": "NY", "postalCode": "11375", "country": "US"}
#
PhoneField | Type | Description |
---|---|---|
countryCode | string | Country code of the phone number, e.g. "1" for US. |
number | string | The phone number without the country code, e.g. "4151193497" . For US phone numbers, 10 digits are required. |
{ "countryCode": "1", "number": "1555555555"}
{ "countryCode": "972", "number": "505555555"}
#
CreateOfficerField | Type | Description |
---|---|---|
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 . |
ssn | string | SSN of the officer (numbers only). One of ssn or passport is required. It is optional to provide only last 4 SSN digits. |
passport | string | Passport of the officer. One of ssn or passport is required. |
nationality | ISO31661-Alpha2 string | Only when Passport 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. |
string | The officer's email address. | |
evaluationParams | EvaluationParams | Optional. Evaluation Params for this entity. |
{ "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"}
#
OfficerField | Type | Description |
---|---|---|
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 . |
ssn | string | SSN of the officer (numbers only). One of ssn or passport is required. |
passport | string | Passport of the officer. One of ssn or passport is required. |
nationality | ISO31661-Alpha2 string | Only when Passport 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. |
string | The officer's email address. | |
idTheftScore | number | Optional. Score (0-1000) for ID theft verification, >900 is auto rejected as default (threshold is configurable). |
{ "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"}
#
CreateBeneficialOwnerField | Type | Description |
---|---|---|
fullName | FullName | Full name of the beneficial owner. |
ssn | 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. |
passport | string | Passport of the beneficial owner. One of ssn or passport is required. |
nationality | ISO31661-Alpha2 string | Only when Passport 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. |
string | The beneficial owner's email address. | |
percentage | integer | The beneficial owner percentage of ownership at the business (between 25 and 100). |
evaluationParams | EvaluationParams | Optional. Evaluation Params for this entity. |
occupation | Occupation | Optional. Occupation of the beneficial owner. |
annualIncome | AnnualIncome | Optional. Annual income of the beneficial owner. |
sourceOfIncome | SourceOfIncome | Optional. Source of income of the beneficial owner. |
{ "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"}
#
BeneficialOwnerField | Type | Description |
---|---|---|
status | string | One of Approved , Denied or PendingReview . |
fullName | FullName | Full name of the beneficial owner. |
ssn | string | SSN of the beneficial owner (numbers only). One of ssn or passport is required. |
passport | string | Passport of the beneficial owner. One of ssn or passport is required. |
nationality | ISO31661-Alpha2 string | Only when Passport 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. |
string | The beneficial owner's email address. | |
percentage | integer | The beneficial owner percentage of ownership at the business (between 25 and 100). |
idTheftScore | number | Optional. Score (0-1000) for ID theft verification, >900 is auto rejected as default (threshold is configurable). |
occupation | Occupation | Optional. Occupation of the beneficial owner. |
annualIncome | AnnualIncome | Optional. Annual income of the beneficial owner. |
sourceOfIncome | SourceOfIncome | Optional. Source of income of the beneficial owner. |
{ "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"}
#
BusinessContactField | Type | Description |
---|---|---|
fullName | FullName | Full name of the contact. |
string | The contact's email address. | |
phone | Phone | The contact's phone number. |
jwtSubject | string | Optional. See this section for more information. |
{ "fullName": { "first": "Richard", "last": "Hendricks" }, "email": "richard@piedpiper.com", "phone": { "countryCode": "1", "number": "5555555555" }}
#
TrustContactField | Type | Description |
---|---|---|
fullName | FullName | Full name of the contact. |
string | The contact's email address. | |
phone | Phone | The contact's phone number. |
address | Address | Address of the contact. |
jwtSubject | string | Optional. See this section for more information. |
{ "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" }}
#
GrantorField | Type | Description |
---|---|---|
fullName | FullName | Full name of the grantor. |
dateOfBirth | RFC3339 Date string | Optional. Date only (e.g. "2001-08-15" ). |
ssn | string | Individual |
string | The grantor's email address. | |
phone | Phone | The grantor's phone number. |
address | Address | Address of the grantor. |
{ "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" }}
#
TrusteeField | Type | Description |
---|---|---|
fullName | FullName | Full name of the trustee. |
dateOfBirth | RFC3339 Date string | Optional. Date only (e.g. "2001-08-15" ). |
ssn | string | Individual |
string | The trustee's email address. | |
phone | Phone | The trustee's phone number. |
address | Address | Address of the trustee. |
{ "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" }}
#
BeneficiaryField | Type | Description |
---|---|---|
fullName | FullName | Full name of the beneficiary. |
dateOfBirth | RFC3339 Date string | Optional. Date only (e.g. "2001-08-15" ). |
{ "fullName": { "first": "Richard", "last": "Hendricks" }, "dateOfBirth": "2001-08-10"}
#
ApplicationFormPrefillField | Type | entity | Description |
---|---|---|---|
applicationType | string | All | Optional. One of Individual , Business or SoleProprietorship . |
fullName | FullName | Individual | Optional. Full name of the individual. |
ssn | string | Individual | Optional. SSN of the individual (numbers only). Either an SSN or a passport number is required. |
passport | string | Individual | Optional. Passport number of the individual. Either an SSN or a passport is required. |
nationality | ISO31661-Alpha2 string | Individual | Optional. Two letters representing the individual nationality. (e.g. "US"). |
dateOfBirth | RFC3339 Date string | Individual | Optional. Date only (e.g. "2001-08-15" ). |
string | Individual | 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 | Business | Optional. Business's website. |
dba | string | Individual / 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 | Individual / Business | Optional. If the individual is a sole proprietor who has an Employer Identification Number, specify it here. / Business EIN (numbers only). |
industry | Industry | Individual / Business | Optional. If the individual is a sole proprietor, specify the industry / Business industry. |
address | Address | Individual / Business | Optional. Address of the individual / Address of the business. |
phone | Phone | Individual / Business | Optional. Phone number of the individual / Phone number of the business. |
jwtSubject | string | Individual / Business | Optional. See this section for more information. |
{ "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" }}
#
ApplicationFormSettingsOverrideField | Type | Description |
---|---|---|
redirectUrl | string | Optional. URL that is presented to the user when an application has been submitted |
privacyPolicyUrl | string | Optional. Privacy Policy |
electronicDisclosuresUrl | string | Optional. Consent to Electronic Disclosures |
depositTermsUrl | string | Optional. Deposit Terms & Conditions |
clientTermsUrl | string | Optional. Client Terms of Service |
cardholderTermsUrl | string | Optional. Cardholder Terms and Conditions |
cashAdvancedTermsUrl | string | Optional. Cash Advance Terms and Conditions |
debitCardDisclosureUrl | string | Optional. Debit Card Disclosure |
additionalDisclosures | Array of {title, url} objects | Optional. Array of additional disclosures that were not covered by the above links |
{ "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" } ]}
#
AuthorizedUserField | Type | Description |
---|---|---|
fullName | FullName | Full name of the authorized user. |
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. |
jwtSubject | string | Optional. See this section for more information. |
{ "fullName": { "first": "Richard", "last": "Hendricks" }, "email": "richard@piedpiper.com", "phone": { "countryCode": "1", "number": "5555555555" }}
#
CounterpartyField | Type | Description |
---|---|---|
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. |
{ "counterparty": { "routingNumber": "812345678", "accountNumber": "12345569", "accountType": "Checking", "name": "Jane Doe" }}
#
Wire CounterpartyField | Type | Description |
---|---|---|
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. |
{ "counterparty": { "name": "April Oneil", "routingNumber": "812345678", "accountNumber": "1000000001", "address": { "street": "20 Ingram St", "city": "Forest Hills", "state": "CA", "postalCode": "11375", "country": "US" } }}
#
Check CounterpartyField | Type | Description |
---|---|---|
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. |
{ "counterparty": { "name": "April Oneil", "routingNumber": "812345678", "accountNumber": "1000000001" }}
#
CoordinatesField | Type | Description |
---|---|---|
longitude | number | The longitude value. |
latitude | number | The latitude value. |
{ "longitude": -77.0364, "latitude": 38.8951}
#
DeviceFingerprintField | Type | Description |
---|---|---|
provider | string | Provider of the device fingerprint fraud and risk prevention. The value is always iovation |
value | string | The device fingerprint blackbox value. |
{ "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 AmountsField | Type | Description |
---|---|---|
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). |
{ "dentalAmount": 0, "transitAmount": 0, "visionOpticalAmount": 2000, "prescriptionRXAmount": 0, "clinicOtherQualifiedMedicalAmount": 0, "totalHealthcareAmount": 2000}
#
AgentField | Type | Description |
---|---|---|
status | string | One of Approved , Denied or PendingReview . |
fullName | FullName | Agent name. |
ssn | string | SSN of the agent (numbers only). One of ssn or passport is required. |
passport | string | Passport of the agent. One of ssn or passport is required. |
nationality | ISO31661-Alpha2 string | Only when Passport is populated. Two letters representing the agent's nationality. |
dateOfBirth | RFC3339 Date string | Date only (e.g. "2001-08-15" ). |
address | Address | The agent's address. |
phone | Phone | Phone number of the agent. |
string | Email address of the agent. | |
jwtSubject | string | Optional. See this section for more information. |
{ "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"}
#
IndustryThe business industry. One of: Retail
, Wholesale
, Restaurants
, Hospitals
, Construction
, Insurance
, Unions
, RealEstate
, FreelanceProfessional
, OtherProfessionalServices
, OnlineRetailer
, OtherEducationServices
.
#
Create ScheduleField | Type | Description |
---|---|---|
startTime | RFC3339 Date string | Optional. Start time of the recurring payment. Date only (e.g. "2022-06-29" ) |
endTime | 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 . |
dayOfMonth | 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. |
dayOfWeek | string | Scheduled day of the week. Required when Weekly interval is specified. Valid values are Sunday , Monday , Tuesday , Wednesday , Thursday , Friday , Saturday . |
totalNumberOfPayments | integer | Optional. Total number of payment repetitions. Positive integers only. |
{ "schedule": { "startTime": "2022-06-29", "endTime": "2022-10-29", "interval": "Monthly", "dayOfMonth": 3, "totalNumberOfPayments": 4 }}
#
ScheduleField | Type | Description |
---|---|---|
startTime | RFC3339 Date string | Start time of the recurring payment. Date only (e.g. "2022-06-29" ) |
endTime | 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 . |
dayOfMonth | 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. |
dayOfWeek | string | Scheduled day of the week. Required when Weekly interval is specified. Valid values are Sunday , Monday , Tuesday , Wednesday , Thursday , Friday , Saturday . |
totalNumberOfPayments | integer | Optional. Total number of payment repetitions. Positive integers only. |
nextScheduledAction | string | The next scheduled date of the action. |
{ "schedule": { "startTime": "2022-06-29", "endTime": "2022-10-29", "interval": "Monthly", "dayOfMonth": 3, "totalNumberOfPayments": 4, "nextScheduledAction": "2022-07-03" }}
{ "schedule": { "startTime": "2022-06-29", "endTime": "2022-10-29", "interval": "Weekly", "dayOfWeek": "Monday", "totalNumberOfPayments": 4, "nextScheduledAction": "2022-07-03" }}
#
Evaluation ParamsField | Type | Description |
---|---|---|
useSelfieVerification | One of: Never , ReplaceIdentification | Optional. Decide when to request a selfie verification document |
requireIdVerification | boolean | Optional, default to false. Decide whether to require an ID verification regardless of evaluation response |
{ "evaluationParams": { "useSelfieVerification": "ReplaceIdentification", "requireIdVerification": true }}
#
Require Id VerificationField | Type | Description |
---|---|---|
individual | Boolean | Optional. Decide whether to require an ID verification from an individual |
officer | Boolean | Optional. Decide whether to require an ID verification from an officer |
beneficialOwners | Boolean | Optional. Decide whether to require an ID verification from all beneficial owners |
{ "requireIdVerification": { "individual": false, "officer": false, "beneficialOwners": true }}
#
Rich Merchant DataField | Type | Description |
---|---|---|
name | string | Name of the merchant. |
website | string | Optional. URL of the merchant's website. |
logo | string | Optional. URL of the merchant's logo. |
phone | string | Optional. Phone number of the merchant. |
categories | Array of {name, icon} objects | Optional. Array of categories the merchant belongs to (from the least specific to the most specific). |
address | {city, state, country and optionally street} object | Optional. Address of the merchant. |
coordinates | Coordinates | Optional. Coordinates (latitude, longitude) of the merchant. |
facilitators | Array of Facilitators | Optional. The transaction facilitators. |
{ "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 FacilitatorField | Type | Description |
---|---|---|
name | string | Name of the facilitator. |
type | string | Optional. Type of the facilitator. One of BuyNowPayLater , DeliveryService , Marketplace , PaymentProcessor , Platform , PointOfSale . |
logo | string | Optional. Url of the facilitator. |
{ "name": "DoorDash", "type": "DeliveryService", "logo": "https://static.v2.spadeapi.com/logos/ded0433236783236b3e715ac59c66b9d/light.png"}
#
Currency ConversionField | Type | Description |
---|---|---|
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) |
fxRate | string | Optional. The conversion rate for the currency conversion to USD. |
{ "originalCurrency": "EUR", "amountInOriginalCurrency": 5000, "fxRate": "1.164"}
#
OccupationThe 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
#
Annual IncomeThe 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 IncomeThe source of income of an individual. One of: EmploymentOrPayrollIncome
, PartTimeOrContractorIncome
, InheritancesAndGifts
, PersonalInvestments
, BusinessOwnershipInterests
, GovernmentBenefits
.
#
Business VerticalThe business vertical/industry of a sole proprietor or a business.
Value |
---|
AdultEntertainmentDatingOrEscortServices |
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 RevenueThe 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 EmployeesThe 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 FlowThe 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 ConfigurationThe Astra push to card configuration
Value | Description |
---|---|
authToken | A token that represents a user that successfully completed authentication with Astra |
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 | Optional. Additional payment information to help with connecting the PushToCard payment recourse with internal resources from your system |