Applications

Note

To enable testing this Applications API on Sandbox, please contact Unit.

Unit offers a short, low-friction, non-documentary application process - most applications will be approved in under five seconds. In some cases Unit detects an exception in the application process (e.g. a phone number mismatch), and certain documents are required in order to make a decision.

Unit will let you know exactly what documents to require from the customer, and once they are provided (via an API call), the application will either be approved automatically or manually reviewed by us (under an SLA of two business hours).

For more information on applications including specific details about application statuses and flow, see our End-Customer Applications Guide

Create Individual Application

Create an application for an individual end-customer.

Suggestion

The SSN (or passport number, for non US citizens) is used as the unique identifier for an individual on Unit. The same identifier cannot be used to submit multiple applications. If an application for a certain individual has been denied, canceled or archived, they may use their SSN/passport number to reapply. Otherwise, duplicate applications will result in an HTTP error (400).

This functionality can be enabled/disabled on Unit dashboard at: Settings -> Org Settings -> General -> Prevent duplicate individual applications.

Verb	`POST`
URL	`https://api.s.unit.sh/applications`
Required Scope	`applications-write`
Data Type	`individualApplication`
Timeout (Seconds)	`120`

Attributes

Name	Type	Description
ssn	string	SSN (or ITIN) of the individual (numbers only). Either an `ssn` or `passport` is required.
passport	string	Passport number of the individual. Valid only for non-US persons. Either an `ssn` or `passport` number is required.
nationality	ISO31661-Alpha2 string	Required if a passport is used as the main ID. 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. Must be a US address.
phone	Phone	Phone number of the individual.
email	string	Email address of the individual.
evaluationParams	EvaluationParams	Optional. Evaluation Params for this entity.
ip	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.
tags	object	Optional. See Tags. Tags that will be copied to the customer that this application creates (see Tag Inheritance).
idempotencyKey	string	Optional. See Idempotency.
deviceFingerprints	Array of Device Fingerprint	Optional. A list of device fingerprints for fraud and risk prevention (See Device Fingerprints).
jwtSubject	string	Optional. See this section for more information.
banks	Array of Bank names	Optional. The name of the bank or banks that should be associated with this application. If not specified, the application will be associated with the Org's default bank (visible via Org Settings in the Dashboard).
accountPurpose	accountPurpose	The primary purpose of the account.
accountPurposeDetail	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 transaction volume of the business. One of `Between1KAnd5K`,`Between5KAnd15K`,`Between15KAnd30K`,`Between30KAnd60K`,`GreaterThan60K`
transactionVolumeDescription	string	Requried when `transactionVolume` is $30,001 or higher. Further detail around transaction volume selection.
profession	profession	The occupation of the individual.

Example Request:

curl -X POST 'https://api.s.unit.sh/applications'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "individualApplication",
    "attributes": {
      "ssn": "721074426",
      "fullName": {
        "first": "Peter",
        "last": "Parker"
      },
      "dateOfBirth": "2001-08-10",
      "address": {
        "street": "20 Ingram St",
        "city": "Forest Hills",
        "state": "NY",
        "postalCode": "11375",
        "country": "US"
      },
      "email": "peter@oscorp.com",
      "phone": {
        "countryCode": "1",
        "number": "5555555555"
      },
      "ip": "127.0.0.2",
      "profession": "Farmer",
      "transactionVolume": "Between1KAnd5K",
      "sourceOfFunds": "SalaryOrWages",
      "accountPurpose": "PayrollOrDirectDeposit",
      "tags": {
        "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
      },
      "idempotencyKey": "3a1a33be-4e12-4603-9ed0-820922389fb8"
    }
  }
}'

Response

Response is a JSON:API document.

201 Created

Field	Type	Description
data	IndividualApplication	The newly created resource.
included	Array of ApplicationDocument Resource	Required documents for this application. Each document resource includes the document status.

Example Response:
{
  "data": {
    "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": "5555555555"
      },
      "status": "AwaitingDocuments",
      "ip": "127.0.0.2",
      "profession": "Farmer",
      "transactionVolume": "Between1KAnd5K",
      "sourceOfFunds": "SalaryOrWages",
      "accountPurpose": "PayrollOrDirectDeposit",
      "soleProprietorship": false,
      "tags": {
        "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
      },
      "archived": false
    },
    "relationships": {
      "org": {
        "data": {
          "type": "org",
          "id": "1"
        }
      },
      "documents": {
        "data": [
          {
            "type": "document",
            "id": "1"
          },
          {
            "type": "document",
            "id": "2"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "document",
      "id": "1",
      "attributes": {
        "documentType": "AddressVerification",
        "status": "Required",
        "name": "Peter Parker",
        "description": "Please provide a document to verify your address. Document may be a utility bill, bank statement, lease agreement or current pay stub.",
        "address": {
          "street": "20 Ingram St",
          "street2": null,
          "city": "Forest Hills",
          "state": "NY",
          "postalCode": "11375",
          "country": "US"
        }
      }
    },
    {
      "type": "document",
      "id": "2",
      "attributes": {
        "documentType": "IdDocument",
        "status": "Required",
        "name": "Peter Parker",
        "description": "Please provide a copy of your unexpired government issued photo ID which would include Drivers License or State ID.",
        "dateOfBirth": "2001-08-10"
      }
    }
  ]
}

Create Sole Proprietor Application

Create an application for a sole proprietor.

Suggestion

A sole proprietorship is a type of enterprise owned and run by one person, and in which there is no legal distinction between the owner and the business entity. As such, it is evaluated as an individual, with the soleProprietorship attribute set to true

Suggestion

This functionality can be enabled/disabled on Unit dashboard at: Settings -> Org Settings -> General -> Prevent duplicate individual applications.

Verb	`POST`
URL	`https://api.s.unit.sh/applications`
Required Scope	`applications-write`
Data Type	`individualApplication`
Timeout (Seconds)	`120`

Attributes

Name	Type	Description
ssn	string	SSN (or ITIN) of the individual (numbers only). Either an `ssn` or `passport` is required.
passport	string	Passport number of the individual. Valid only for non-US persons. Either an `ssn` or `passport` number is required.
nationality	ISO31661-Alpha2 string	Required if a passport is used as the main ID. 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. Must be a US address.
phone	Phone	Phone number of the individual.
email	string	Email address of the individual.
soleProprietorship	boolean	Set this to `true` in order to indicate that the individual is a sole proprietor.
ein	string	Optional. If the individual is a sole proprietor who has an Employer Identification Number, specify it here. Not all sole proprietors have an EIN, so this attribute is optional, even when `soleProprietorship` is set to `true`.
dba	string	Optional. If the individual is a sole proprietor who is doing business under a different name, specify it here. This attribute is optional, even when `soleProprietorship` is set to `true`.
evaluationParams	EvaluationParams	Optional. Evaluation Params for this entity.
website	string	A Valid website URL. Providing a `null` value is indicative of the business customer attesting that they do not have a website.
ip	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.
tags	object	Optional. See Tags. Tags that will be copied to the customer that this application creates (see Tag Inheritance).
idempotencyKey	string	Optional. See Idempotency.
deviceFingerprints	Array of Device Fingerprint	Optional. A list of device fingerprints for fraud and risk prevention (See Device Fingerprints).
jwtSubject	string	Optional. See this section for more information.
banks	Array of Bank names	Optional. The name of the bank or banks that should be associated with this application. If not specified, the application will be associated with the Org's default bank (visible via Org Settings in the Dashboard).
sourceOfFunds	sourceOfFunds	The primary source of funds of the business.
sourceOfFundsDescription	string	Required If `sourceOfFunds` is one of `importExportRevenue`,`donationsOrFundraising`
businessIndustry	businessIndustry	The industry of the sole propriotor
isIncorporated	boolean	Is the business incorporated
stateOfIncorporation	string	Required if `isIncorporated` is `true`. Two letters representing a US state.
yearOfIncorporation	Year string	Required if `isIncorporated` is `true`. Year of incorporation of the business.
countriesOfOperation	Array of ISO31661-Alpha2 strings
usNexus	array of usNexus	A list of the nature of the business's ties to the U.S.
transactionVolume	transactionVolume	The expected monthly transaction volume of the business.
transactionVolumeDescription	string	Requried when `transactionVolume` is $150,001 or higher. Further detail around transaction volume selection.
accountPurpose	accountPurpose	The primary purpose of the account.
accountPurposeDetail	string	Required if `accountPurpose` is one of `cashHeavyIncomeAndOperations`,`professionalServicesHandlingFunds`, `charitableOrNonProfitOrganizationOperations`,`commercialCashOperations`,`thirdPartyPaymentProcessing`.

Example Request:

curl -X POST 'https://api.s.unit.sh/applications'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "individualApplication",
    "attributes": {
      "ssn": "721074426",
      "fullName": {
        "first": "Peter",
        "last": "Parker"
      },
      "dateOfBirth": "2001-08-10",
      "address": {
        "street": "20 Ingram St",
        "city": "Forest Hills",
        "state": "NY",
        "postalCode": "11375",
        "country": "US"
      },
      "email": "peter@oscorp.com",
      "phone": {
        "countryCode": "1",
        "number": "5555555555"
      },
      "ip": "127.0.0.2",
      "soleProprietorship": true,
      "ein": "123456789",
      "dba": "Piedpiper Inc",
      "website": "https://www.piedpiper.com",
      "accountPurpose": "EcommerceSales",
      "transactionVolume": "LessThan5K",
      "usNexus": [
        "NotAvailable"
      ],
      "countriesOfOperation": [
        "US",
        "CA"
      ],
      "isIncorporated": false,
      "businessIndustry": "GroceryStoresOrSupermarkets",
      "tags": {
        "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
      },
      "idempotencyKey": "3a1a33be-4e12-4603-9ed0-820922389fb8"
    }
  }
}'

Response

Response is a JSON:API document.

201 Created

Field	Type	Description
data	IndividualApplication	The newly created resource.
included	Array of ApplicationDocument Resource	Required documents for this application. Each document resource includes the document status.

Example Response:
{
  "data": {
    "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": "5555555555"
      },
      "status": "AwaitingDocuments",
      "ip": "127.0.0.2",
      "soleProprietorship": true,
      "ein": "123456789",
      "dba": "Piedpiper Inc",
      "website": "https://www.piedpiper.com",
      "accountPurpose": "EcommerceSales",
      "transactionVolume": "LessThan5K",
      "usNexus": [
        "NotAvailable"
      ],
      "countriesOfOperation": [
        "US",
        "CA"
      ],
      "isIncorporated": false,
      "businessIndustry": "GroceryStoresOrSupermarkets",
      "tags": {
        "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
      },
      "archived": false
    },
    "relationships": {
      "org": {
        "data": {
          "type": "org",
          "id": "1"
        }
      },
      "documents": {
        "data": [
          {
            "type": "document",
            "id": "1"
          },
          {
            "type": "document",
            "id": "2"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "document",
      "id": "1",
      "attributes": {
        "documentType": "AddressVerification",
        "status": "Required",
        "name": "Peter Parker",
        "description": "Please provide a document to verify your address. Document may be a utility bill, bank statement, lease agreement or current pay stub.",
        "address": {
          "street": "20 Ingram St",
          "street2": null,
          "city": "Forest Hills",
          "state": "NY",
          "postalCode": "11375",
          "country": "US"
        }
      }
    },
    {
      "type": "document",
      "id": "2",
      "attributes": {
        "documentType": "IdDocument",
        "status": "Required",
        "name": "Peter Parker",
        "description": "Please provide a copy of your unexpired government issued photo ID which would include Drivers License or State ID.",
        "dateOfBirth": "2001-08-10"
      }
    }
  ]
}

Create Business Application

Create an application for a business end-customer.

Suggestion

Companies that are publicly traded in a major US stock exchange are subject to lighter onboarding requirements. If your customer base includes publicly traded companies, please reach out to Unit for additional information.

Verb	`POST`
URL	`https://api.s.unit.sh/applications`
Required Scope	`applications-write`
Data Type	`businessApplication`
Timeout (Seconds)	`120`

Attributes

Name	Type	Description
name	string	Name of the business.
dba	string	Optional. "Doing business as".
address	Address	Address of the business. Must be a US address
operatingAddress	Address	Optional. The physical location of the business. Required if `address` is associated with a registered agent, or if a beneficial owner of officer are non-US.
phone	Phone	Phone number of the business.
stateOfIncorporation	string	Two letters representing a US state.
ein	string	Business EIN (numbers only).
website	string	A Valid website URL. Providing a `null` value is indicative of the business customer attesting that they do not have a website.
contact	BusinessContact	Primary contact of the business. This person is the one that will have access to the account.
officer	Officer	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	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. If the business has no beneficial owners, the array should be empty.
ip	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.
tags	object	Optional. See Tags. Tags that will be copied to the customer that this application creates (see Tag Inheritance).
idempotencyKey	string	Optional. See Idempotency.
deviceFingerprints	Array of Device Fingerprint	Optional. A list of device fingerprints for fraud and risk prevention (See Device Fingerprints).
banks	Array of Bank names	Optional. The name of the bank or banks that should be associated with this application. If not specified, the application will be associated with the Org's default bank (visible via Org Settings in the Dashboard).
sourceOfFunds	sourceOfFunds	The primary source of funds of the business.
sourceOfFundsDescription	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?
regulatorName	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.
accountPurpose	accountPurpose	The primary purpose of the account.
accountPurposeDetail	string	Required if `accountPurpose` is one of `cashHeavyIncomeAndOperations`,`professionalServicesHandlingFunds`, `charitableOrNonProfitOrganizationOperations`,`commercialCashOperations`,`thirdPartyPaymentProcessing`.
transactionVolume	transactionVolume	The expected monthly trasactioin volume of the business.
transactionVolumeDescription	string	Requried when `transactionVolume` is $1,000,001 or higher. Further detail around transaction volume selection.
stockExchangeName	string	Required if `entityType` is `PubliclyTradedCorporation`. The name of the stock exchange where the business's stock is traded.
stockSymbol	string	Required if `entityType` is `PubliclyTradedCorporation` . The stock symbol (ticker) 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`.

Example Request:

curl -X POST 'https://api.s.unit.sh/applications'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "businessApplication",
    "attributes": {
      "name": "Pied Piper",
      "address": {
        "street": "5230 Newell Rd",
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94303",
        "country": "US"
      },
      "phone": {
        "countryCode": "1",
        "number": "5555555555"
      },
      "stateOfIncorporation": "DE",
      "businessIndustry": "TechnologyMediaOrTelecom",
      "website": "www.piedpiper.com",
      "accountPurpose": "RetailSalesInPerson",
      "sourceOfFunds": "salesOfGoods",
      "transactionVolume": "Between1KAnd5K",
      "usNexus": [
        "NotAvailable"
      ],
      "countriesOfOperation": [
        "US",
        "CA"
      ],
      "yearOfIncorporation": "2014",
      "entityType": "Corporation",
      "isRegulated": false,
      "businessDescription": "We are a technology company that sells technology products to our customers.",
      "ein": "123456789",
      "ip": "127.0.0.2",
      "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"
          }
        }
      ],
      "tags": {
        "userId": "2ab1f266-04b9-41fb-b728-cd1962bca52c"
      },
      "idempotencyKey": "3a1a33be-4e12-4603-9ed0-820922389fb8"
    }
  }
}'

Response

Response is a JSON:API document.

201 Created

Field	Type	Description
data	BusinessApplication	The newly created resource.
relationships	JSON:API Relationships	Describes relationships between the application resource and other resources (beneficial owners).
included	Array of ApplicationDocument Resource or BeneficialOwner Resource	Required documents for this application. Each document resource includes the document status. List of the application's beneficial owners.

Example Response:
{
  "data": {
    "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": "5555555555"
      },
      "isIncorporated": true,
      "stateOfIncorporation": "DE",
      "yearOfIncorporation": "2014",
      "businessIndustry": "TechnologyMediaOrTelecom",
      "accountPurpose": "RetailSalesInPerson",
      "sourceOfFunds": "SalesOfGoods",
      "transactionVolume": "Between1KAnd5K",
      "usNexus": [
        "NotAvailable"
      ],
      "countriesOfOperation": [
        "US",
        "CA"
      ],
      "entityType": "Corporation",
      "isRegulated": false,
      "website": "www.piedpiper.com",
      "businessDescription": "We are a technology company that sells technology products to our customers.",
      "contact": {
        "fullName": {
          "first": "Richard",
          "last": "Hendricks"
        },
        "email": "richard@piedpiper.com",
        "phone": {
          "countryCode": "1",
          "number": "5555555555"
        }
      },
      "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",
        "title": "CEO",
        "email": "richard@piedpiper.com",
        "phone": {
          "countryCode": "1",
          "number": "5555555555"
        },
        "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": "5555555555"
          },
          "email": "richard@piedpiper.com",
          "percentage": 75,
          "status": "Approved"
        }
      ],
      "tags": {
        "userId": "2ab1f266-04b9-41fb-b728-cd1962bca52c"
      },
      "archived": false,
      "status": "AwaitingDocuments"
    },
    "relationships": {
      "org": {
        "data": {
          "type": "org",
          "id": "1"
        }
      },
      "documents": {
        "data": [
          {
            "type": "document",
            "id": "1"
          },
          {
            "type": "document",
            "id": "2"
          },
          {
            "type": "document",
            "id": "3"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "document",
      "id": "1",
      "attributes": {
        "documentType": "CertificateOfIncorporation",
        "status": "Required",
        "name": "Pied Piper",
        "description": "For Corporation: Please provide a certified copy of the Articles of Incorporation or Certificate of Incorporation..."
      }
    },
    {
      "type": "document",
      "id": "2",
      "attributes": {
        "documentType": "AddressVerification",
        "status": "Required",
        "name": "Richard Hendricks",
        "description": "Please provide a document to verify your address. Document may be a utility bill, bank statement, lease agreement or current pay stub.",
        "address": {
          "street": "5230 Newell Rd",
          "street2": null,
          "city": "Palo Alto",
          "state": "CA",
          "postalCode": "94303",
          "country": "US"
        }
      }
    },
    {
      "type": "document",
      "id": "3",
      "attributes": {
        "documentType": "IdDocument",
        "status": "Required",
        "name": "Richard Hendricks",
        "description": "Please provide a copy of your unexpired government issued photo ID which would include Drivers License or State ID."
      }
    }
  ]
}

Update Business

Update a business application.

Note

Tags that are updated after the application has been approved will not be inherited by the corresponded customer resource.

Verb	`PATCH`
URL	`https://api.s.unit.sh/applications/:id`
Required Scope	`applications-write`
Timeout (Seconds)	`5`

Attributes

Name	Type	Description
tags	object	See Updating Tags.

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	BusinessApplication	The updated BusinessApplication resource.
relationships	JSON:API Relationships	Describes relationships between the application resource and other resources (beneficial owners).
included	Array of ApplicationDocument Resource or BeneficialOwner Resource	Required documents for this application. Each document resource includes the document status. List of the application's beneficial owners.

Update business application:

curl -X PATCH 'https://api.s.unit.sh/application/:id'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "businessApplication",
    "attributes": {
      "tags": {
        "by": "Richard Hendricks",
        "id": "23033b64-38f8-4dbc-91a1-313ff0156d02"
      }
    }
  }
}'

Update Business Beneficial Owner

Update a business application's beneficial owner. The application id associated with the beneficial owner must be passed as a relationship in the request body.

Verb	`PATCH`
URL	`https://api.s.unit.sh/beneficial-owner/:id`
Required Scope	`applications-write`
Timeout (Seconds)	`5`

Attributes

Name	Type	Description
percentage	integer	Optional. The beneficial owner percentage of ownership at the business (between 25 and 100).

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	BeneficialOwner	The updated BeneficialOwner resource.

Update business application beneficial owner:

curl -X PATCH 'https://api.s.unit.sh/beneficial-owner/:id'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "beneficialOwner",
    "attributes": {
      "percentage": 25
    },
    "relationships": {
      "application": {
        "data": {
          "type": "businessApplication",
          "id": "10001"
        }
      }
    }
  }
}'

Update Individual

Update an individual application.

Note

Tags that are updated after the application has been approved will not be inherited by the corresponded customer resource.

Verb	`PATCH`
URL	`https://api.s.unit.sh/applications/:id`
Required Scope	`applications-write`
Timeout (Seconds)	`5`

Attributes

Name	Type	Description
tags	object	See Updating Tags.

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	IndividualApplication	The updated IndividualApplication resource.

Update individual application:

curl -X PATCH 'https://api.s.unit.sh/application/:id'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "individualApplication",
    "attributes": {
      "tags": {
        "by": "Richard Hendricks",
        "id": "23033b64-38f8-4dbc-91a1-313ff0156d02"
      }
    }
  }
}'

Update Sole Proprietor

Update a sole-proprietorship application.

Note

Tags that are updated after the application has been approved will not be inherited by the corresponded customer resource.

Verb	`PATCH`
URL	`https://api.s.unit.sh/applications/:id`
Required Scope	`applications-write`
Timeout (Seconds)	`5`

Attributes

Name	Type	Description
tags	object	See Updating Tags.

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	IndividualApplication	The updated IndividualApplication resource.

Update sole-proprietor application:

curl -X PATCH 'https://api.s.unit.sh/application/:id'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "individualApplication",
    "attributes": {
      "tags": {
        "by": "Richard Hendricks",
        "id": "23033b64-38f8-4dbc-91a1-313ff0156d02"
      }
    }
  }
}'

Applications

Create Individual Application​

Attributes​

Response​

201 Created​

Create Sole Proprietor Application​

Attributes​

Response​

201 Created​

Create Business Application​

Attributes​

Response​

201 Created​

Update Business​

Attributes​

Response​

200 OK​

Update Business Beneficial Owner​

Attributes​

Response​

200 OK​

Update Individual​

Attributes​

Response​

200 OK​

Update Sole Proprietor​

Attributes​

Response​

200 OK​

Create Individual Application

Attributes

Response

201 Created

Create Sole Proprietor Application

Attributes

Response

201 Created

Create Business Application

Attributes

Response

201 Created

Update Business

Attributes

Response

200 OK

Update Business Beneficial Owner

Attributes

Response

200 OK

Update Individual

Attributes

Response

200 OK

Update Sole Proprietor

Attributes

Response

200 OK