Skip to main content
Ready-to-LaunchCustom Builds
Start Building Now

Resources

IndividualApplication​

IndividualApplication is a JSON:API resource, top-level fields:

id
string
Identifier of the application resource.
type
string
Type of the application resource. For individual application the value is always individualApplication.
attributes
JSON Object
JSON object representing the application data.
relationships
JSON:API Relationships
Describes relationships between the application resource and other resources (documents).

Attributes​

status
string
One of AwaitingDocuments, PendingReview, Approved, Denied or Pending, see Application Statuses.
message
string
A message describing the IndividualApplication status.
createdAt
RFC3339 Date string
The date the resource was created.
updatedAtOptional
RFC3339 Date string
Optional. The date the resource was updated.
ssn
string
SSN of the individual (numbers only). Either ssn or passport will be populated.
passport
string
Individual passport number. Either ssn or passport will be populated.
nationalityOptional
ISO31661-Alpha2 string
Always when Passport is populated and optional when SSN is populated. Two letters representing the individual nationality (e.g. "US").
fullName
FullName
Full name of the individual.
dateOfBirth
RFC3339 Date string
Date only (e.g. "2001-08-15").
address
Address
Address of the individual.
phone
Phone
Phone of the individual.
email
string
Email address of the individual.
ip
string
IP address of the end-customer creating the application, if specified.
soleProprietorshipOptional
boolean
Optional. Indicates whether the individual is a sole proprietor, if specified.
einOptional
string
Optional. Indicates if the individual is a sole proprietor who has an Employer Identification Number, if specified.
dbaOptional
string
Optional. Indicates if the individual is a sole proprietor who is doing business under a different name, if specified.
archived
boolean
Indicates whether the application has been archived. Archived applications are read-only and no changes can be made to them. Once an application has been archived, a new application with the same SSN (or Passport) may be submitted. An application becomes archived once the corresponding customer is archived.
idTheftScoreOptional
number
Optional. Score (0-1000) for ID theft verification, >900 is auto rejected as default (threshold is configurable).
tags
object
See Tags.
accountPurpose
accountPurpose
The primary purpose of the account.
accountPurposeDetailRequired
string
Required if accountPurpose is one of Cryptocurrency,CashHeavyPersonalIncome, InternationalRemittances
sourceOfFunds
sourceOfFunds
The primary source of funds of the business. One of SalaryOrWages,BusinessIncome,InvestmentIncome,RetirementSavings,Inheritance,Gift,SaleOfAssets,LegalSettlement,LoanProceeds
transactionVolume
transactionVolume
The expected monthly trasactioin volume of the business. One of Between1KAnd5K,Between5KAnd15K,Between15KAnd30K,Between30KAnd60K,GreaterThan60K
profession
profession
The occupation of the individual.

Relationships​

documentsOptional
Array of JSON:API Relationship
Optional. Application's documents.
customerOptional
JSON:API Relationship
Optional. The created Customer in case of approved application.
applicationFormOptional
JSON:API Relationship
Optional. The ApplicationForm through which the application has been submitted.
Example IndividualApplication resource:
{
  "type": "individualApplication",
  "id": "53",
  "attributes": {
    "createdAt": "2020-01-14T14:05:04.718Z",
    "fullName": {
      "first": "Peter",
      "last": "Parker"
    },
    "ssn": "721074426",
    "address": {
      "street": "20 Ingram St",
      "street2": null,
      "city": "Forest Hills",
      "state": "NY",
      "postalCode": "11375",
      "country": "US"
    },
    "dateOfBirth": "2001-08-10",
    "email": "peter@oscorp.com",
    "phone": {
      "countryCode": "1",
      "number": "1555555578"
    },
    "status": "AwaitingDocuments",
    "message": "Waiting for you to upload the required documents.",
    "archived": false,
    "tags": {
      "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
    }
  },
  "relationships": {
    "org": {
      "data": {
        "type": "org",
        "id": "1"
      }
    },
    "documents": {
      "data": [
        {
          "type": "document",
          "id": "1"
        },
        {
          "type": "document",
          "id": "2"
        }
      ]
    },
    "applicationForm": {
      "data": {
        "type": "applicationForm",
        "id": "3"
      }
    }
  }
}

BusinessApplication​

BusinessApplication is a JSON:API resource, top-level fields:

id
string
Identifier of the application resource.
type
string
Type of the application resource, for business application the value is always businessApplication.
attributes
JSON Object
JSON object representing the application data.
relationships
JSON:API Relationships
Describes relationships between the application resource and other resources (documents).

Attributes​

status
string
One of AwaitingDocuments, PendingReview, Approved, Denied or Pending, see Application Statuses.
message
string
A message describing the BusinessApplication status.
createdAt
RFC3339 Date string
The date the resource was created.
updatedAtOptional
RFC3339 Date string
Optional. The date the resource was updated.
name
string
Name of the business.
dbaOptional
string
Optional. "Doing business as".
address
Address
Address of the business.
operatingAddressOptional
Address
Optional. The operating address of the business. Required when the address is of a registered agent or if any beneficial owner or officer is non-US.
phone
Phone
Phone of the business.
stateOfIncorporation
string
Two letters representing a US state.
ein
string
Business EIN (numbers only).
websiteOptional
string
Optional. Business's website.
contact
BusinessContact
Primary contact of the business.
officer
Officer
Officer representing the business, must be the CEO, COO, CFO, President, BenefitsAdministrationOfficer, CIO, VP, AVP, Treasurer, Secretary, Controller, Manager, Partner or Member. The officer would need to go over KYC process and provide documents.
beneficialOwners
Array of BeneficialOwner
Array of beneficial owners of the business. Beneficial Owner is anyone with more than 25% ownership. Beneficial Owners would need to go over KYC process and provide documents.
ipOptional
string
Optional. IP address of the end-customer creating the application. Both IPv4 and IPv6 formats are supported. Highly recommended as a fraud prevention measure, if the information is available when submitting the application.
archived
boolean
Indicates whether the application has been archived. Archived applications are read-only and no changes can be made to them. An application becomes archived once the corresponding customer is archived.
tags
object
See Tags.
sourceOfFunds
sourceOfFunds
The primary source of funds of the business.
sourceOfFundsDescriptionRequired
string
Required If sourceOfFunds is one of importExportRevenue,donationsOrFundraising,
businessIndustry
businessIndustry
The industry of the business
businessDescription
string
A brief description of the business, including its main products or services and the customers.
isRegulated
boolean
Is the business regulated by a government agency or financial regulator?
regulatorNameRequired
string
Required if isRegulated is true. The name of the regulator if the business is regulated.
usNexus
array of usNexus
The nature of the business's ties to the U.S. Either NotAvailable or one or more of the other options.
businessDescription
string
A brief description of the business, including its main products or services and the customers.
accountPurpose
accountPurpose
The primary purpose of the account.
accountPurposeDetailRequired
string
Required if accountPurpose is one of cashHeavyIncomeAndOperations,professionalServicesHandlingFunds, charitableOrNonProfitOrganizationOperations,commercialCashOperations,thirdPartyPaymentProcessing.
transactionVolume
transactionVolume
The expected monthly trasactioin volume of the business.
stockExchangeNameRequired
string
Required if entityType is PubliclyTradedCorporation. The name of the stock exchange where the business's stock is traded.
stockSymbolRequired
string
Required if entityType is `PubliclyTradedCorporation. The stock symbol (ticker) of the business.
businessIndustry
businessIndustry
The industry of the business
countriesOfOperation
Array of ISO31661-Alpha2 strings
yearOfIncorporation
Year string
Year of incorporation of the business.
entityType
string
One of LLC, Partnership, PubliclyTradedCorporation, PrivatelyHeldCorporation or NotForProfitOrganization, Estate, Trust,ForeignFinancialInstitution, DomesticFinancialInstitution, GovernmentEntityOrAgency, ReligiousOrganization, Charity.

Relationships​

documentsOptional
Array of JSON:API Relationship
Optional. Application's documents.
customerOptional
JSON:API Relationship
Optional. The created Customer in case of approved application.
applicationFormOptional
JSON:API Relationship
Optional. The ApplicationForm through which the application has been submitted.
Example BusinessApplication resource:
{
  "type": "businessApplication",
  "id": "50",
  "attributes": {
    "createdAt": "2020-01-13T16:01:19.346Z",
    "name": "Pied Piper",
    "dba": null,
    "address": {
      "street": "5230 Newell Rd",
      "street2": null,
      "city": "Palo Alto",
      "state": "CA",
      "postalCode": "94303",
      "country": "US"
    },
    "phone": {
      "countryCode": "1",
      "number": "1555555578"
    },
    "stateOfIncorporation": "DE",
    "ein": "123456789",
    "entityType": "Corporation",
    "contact": {
      "fullName": {
        "first": "Richard",
        "last": "Hendricks"
      },
      "email": "richard@piedpiper.com",
      "phone": {
        "countryCode": "1",
        "number": "1555555578"
      }
    },
    "officer": {
      "fullName": {
        "first": "Richard",
        "last": "Hendricks"
      },
      "ssn": "123456789",
      "address": {
        "street": "5230 Newell Rd",
        "street2": null,
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94303",
        "country": "US"
      },
      "dateOfBirth": "2001-08-10",
      "email": "richard@piedpiper.com",
      "phone": {
        "countryCode": "1",
        "number": "1555555589"
      },
      "occupation": "ArchitectOrEngineer",
      "annualIncome": "Between10kAnd25k",
      "sourceOfIncome": "EmploymentOrPayrollIncome",
      "status": "Approved"
    },
    "beneficialOwners": [
      {
        "fullName": {
          "first": "Richard",
          "last": "Hendricks"
        },
        "ssn": "123456789",
        "address": {
          "street": "5230 Newell Rd",
          "street2": null,
          "city": "Palo Alto",
          "state": "CA",
          "postalCode": "94303",
          "country": "US"
        },
        "dateOfBirth": "2001-08-10",
        "phone": {
          "countryCode": "1",
          "number": "1555555589"
        },
        "email": "richard@piedpiper.com",
        "occupation": "ArchitectOrEngineer",
        "annualIncome": "Between10kAnd25k",
        "sourceOfIncome": "EmploymentOrPayrollIncome",
        "status": "Approved"
      }
    ],
    "tags": {
      "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
    },
    "archived": false,
    "status": "AwaitingDocuments",
    "message": "Waiting for you to upload the required documents."
  },
  "relationships": {
    "org": {
      "data": {
        "type": "org",
        "id": "1"
      }
    },
    "documents": {
      "data": [
        {
          "type": "document",
          "id": "1"
        },
        {
          "type": "document",
          "id": "2"
        },
        {
          "type": "document",
          "id": "3"
        }
      ]
    },
    "applicationForm": {
      "data": {
        "type": "applicationForm",
        "id": "3"
      }
    }
  }
}

BeneficialOwner​

BeneficialOwner is a JSON:API resource, top-level fields:

id
string
Identifier of the beneficial owner resource.
type
string
Always beneficialOwner.
attributes
JSON Object
JSON object representing the beneficial owner's data.

Attributes​

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.
Example BeneficialOwner resource:
{
  "type": "beneficialOwner",
  "id": "5",
  "attributes": {
    "address": {
      "street": "20 Ingram St",
      "street2": "Apt #10",
      "city": "Forest Hills",
      "state": "NY",
      "postalCode": "11375",
      "country": "US"
    },
    "dateOfBirth": "1990-04-05",
    "email": "erlich@piedpiper.com",
    "fullName": {
      "first": "Erlich",
      "last": "Bachman"
    },
    "phone": {
      "countryCode": "1",
      "number": "5555555555"
    },
    "ssn": "721074426",
    "status": "Approved"
  }
}