Types

FullName#

Field	Type	Description
first	string	Individual first name.
last	string	Individual last name.

Example FullName type:

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

Address#

Field	Type	Description
street	string	First line of an address.
street2	string	Optional. Second line of an address.
city	string	City.
state	string	Two letters representing the state. Only required for US addresses.
postalCode	string	Postal code.
country	ISO31661-Alpha2 string	Two letters representing the country.

Example Address type:

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

Phone#

Field	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"`.

Example Phone type:

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

Officer#

Field	Type	Description
status	string	One of `Approved`, `Denied` or `PendingReview`.
fullName	FullName	Full name of the officer.
title	string	One of `CEO`, `COO`, `CFO` or `President`.
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.
email	string	The officer's email address.

Example Officer type:

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

BeneficialOwner#

Field	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.
email	string	The beneficial owner's email address.
percentage	integer	The beneficial owner percentage of ownership at the business (between 0 and 100).

Example BeneficialOwner type:

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

BusinessContact#

Field	Type	Description
fullName	FullName	Full name of the contact.
email	string	The contact's email address.
phone	Phone	The contact's phone number.

Example BusinessContact type:

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

ApplicationFormPrefill#

Field	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"`).
email	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 `"Corporation"`, `"LLC"` or `"Partnership"`.
contact	BusinessContact	Business	Optional. Primary contact of the business.
officer	Officer	Business	Optional. Officer representing the business (must be the CEO, COO, CFO, President or BenefitsAdministrationOfficer). 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).
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.

Example BusinessContact 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"  }}

AuthorizedUser#

Field	Type	Description
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.

Example AuthorizedUser type:

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

Counterparty#

Field	Type	Description
routingNumber	string	Valid 9-digit ABA routing transit number.
accountNumber	string	Bank account number.
accountType	string	Either `Checking` or `Savings`.
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#

Field	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 beneficiary counterparty.

Example Wire Counterparty type:

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

Coordinates#

Field	Type	Description
longitude	number	The longitude value.
latitude	number	The latitude value.

Example Coordinates type:

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

DeviceFingerprint#

Field	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.

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="}