Applications APIs

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

ssnOptional

string

SSN (or ITIN) of the individual (numbers only). Either an ssn or passport is required. It is optional to provide only last 4 SSN digits.

passportRequired

string

Passport number of the individual. Valid only for non-US persons. Either an ssn or passport number is required.

nationalityRequired

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.

evaluationParamsOptional

EvaluationParams

Optional. Evaluation Params for this entity.

occupation

Occupation

Occupation of the individual.

annualIncomeRequired

AnnualIncome

Required if nationality is not US. Annual income of the individual.

sourceOfIncomeRequired

SourceOfIncome

Required if nationality is not US. Source of income of the individual.

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.

tagsOptional

object

Optional. See Tags. Tags that will be copied to the customer that this application creates (see Tag Inheritance).

idempotencyKeyOptional

string

Optional. See Idempotency.

deviceFingerprintsOptional

Array of Device Fingerprint

Optional. A list of device fingerprints for fraud and risk prevention (See Device Fingerprints).

jwtSubjectOptional

string

Optional. See this section for more information.

banksOptional

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

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",
      "occupation": "ArchitectOrEngineer",
      "annualIncome": "Between50kAnd100k",
      "sourceOfIncome": "EmploymentOrPayrollIncome",
      "tags": {
        "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
      },
      "idempotencyKey": "3a1a33be-4e12-4603-9ed0-820922389fb8"
    }
  }
}'

Response

Response is a JSON:API document.

201 Created

data

IndividualApplication

The newly created resource.

includedRequired

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",
      "occupation": "ArchitectOrEngineer",
      "annualIncome": "Between50kAnd100k",
      "sourceOfIncome": "EmploymentOrPayrollIncome",
      "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

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

ssnRequired

string

SSN (or ITIN) of the individual (numbers only). Either an ssn or passport is required.

passportRequired

string

Passport number of the individual. Valid only for non-US persons. Either an ssn or passport number is required.

nationalityRequired

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.

einOptional

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.

dbaOptional

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.

evaluationParamsOptional

EvaluationParams

Optional. Evaluation Params for this entity.

annualRevenueRequired

AnnualRevenue

Required if nationality is not US. For sole proprietors, specify the annual revenue here.

numberOfEmployeesRequired

NumberOfEmployees

Required if nationality is not US. For sole proprietors, specify the number of employees here.

businessVertical

BusinessVertical

For sole proprietors, specify the business vertical here.

website

string

A Valid website Url. Providing a null value is indicative of the business customer attesting that they do not have a website.

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.

tagsOptional

object

Optional. See Tags. Tags that will be copied to the customer that this application creates (see Tag Inheritance).

idempotencyKeyOptional

string

Optional. See Idempotency.

deviceFingerprintsOptional

Array of Device Fingerprint

Optional. A list of device fingerprints for fraud and risk prevention (See Device Fingerprints).

jwtSubjectOptional

string

Optional. See this section for more information.

banksOptional

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

requestedProductsOptional

Array of Product

Optional. The product being applied for. Contact Unit to enable BillPay and Capital products.

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",
      "businessVertical": "TechnologyMediaOrTelecom",
      "numberOfEmployees": "Between5And10",
      "website": "https://www.piedpiper.com",
      "tags": {
        "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
      },
      "idempotencyKey": "3a1a33be-4e12-4603-9ed0-820922389fb8"
    }
  }
}'

Response

Response is a JSON:API document.

201 Created

data

IndividualApplication

The newly created resource.

includedRequired

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",
      "occupation": "ArchitectOrEngineer",
      "annualIncome": "Between50kAnd100k",
      "sourceOfIncome": "EmploymentOrPayrollIncome",
      "annualRevenue": "Between100kAnd200k",
      "numberOfEmployees": "Between5And10",
      "businessVertical": "TechnologyMediaOrTelecom",
      "website": "https://www.piedpiper.com",
      "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"
      }
    }
  ]
}

Check Registered Agent Address

Checks if an address is a registered agent address.

Verb	POST
URL	https://api.s.unit.sh/applications/check-registered-agent-address
Data Type	checkRegisteredAgentAddress
Timeout (Seconds)	120

Attributes

address

Address

The address to check. Must be a US address

Example Request:

curl -X POST 'https://api.s.unit.sh/applications/check-registered-agent-address'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "checkRegisteredAgentAddress",
    "attributes": {
      "address": {
        "street": "13 Jewel Avenue",
        "city": "New York",
        "state": "NY",
        "postalCode": "12345",
        "country": "US"
      }
    }
  }
}'

Response

Response is a JSON:API document.

200 OK

data

Check Registered Agent Address

Checks whether an address is a Registered Agent address.

Example Response:

{
  "data": {
    "type": "checkRegisteredAgentAddress",
    "attributes": {
      "isRegisteredAgentAddress": false
    }
  }
}

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

string

Name of the business.

dbaOptional

string

Optional. "Doing business as".

address

Address

Address of the business. Must be a US address

phone

Phone

Phone number of the business.

stateOfIncorporation

string

Two letters representing a US state.

ein

string

Business EIN (numbers only).

entityType

string

One of LLC, Partnership, PubliclyTradedCorporation, PrivatelyHeldCorporation or NotForProfitOrganization.

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.

annualRevenueRequired

AnnualRevenue

Required if any of the officer / BeneficialOwner of the business have a non US nationality. Annual revenue of the business.

numberOfEmployeesRequired

NumberOfEmployees

Required if any of the officer / BeneficialOwner of the business have a non US nationality. Number of employees of the business.

cashFlowRequired

CashFlow

Required if any of the officer / BeneficialOwner of the business have a non US nationality. Cash flow of the business.

yearOfIncorporation

Year string

Year of incorporation of the business.

countriesOfOperationRequired

Array of ISO31661-Alpha2 strings

Required if any of the officer / BeneficialOwner of the business have a non US nationality. An array of two letter codes representing the countries of operation of the business.

stockSymbolOptional

string

Optional. The stock symbol (ticker) of the business.

businessVertical

BusinessVertical

The business vertical of the business.

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.

tagsOptional

object

Optional. See Tags. Tags that will be copied to the customer that this application creates (see Tag Inheritance).

idempotencyKeyOptional

string

Optional. See Idempotency.

deviceFingerprintsOptional

Array of Device Fingerprint

Optional. A list of device fingerprints for fraud and risk prevention (See Device Fingerprints).

banksOptional

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

requestedProductsOptional

Array of Product

Optional. The product being applied for. Contact Unit to enable BillPay and Capital products.

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",
      "ein": "123456789",
      "entityType": "Corporation",
      "ip": "127.0.0.2",
      "annualRevenue": "Between500kAnd1m",
      "numberOfEmployees": "Between50And100",
      "cashFlow": "Predictable",
      "yearOfIncorporation": "2014",
      "countriesOfOperation": [
        "US",
        "CA"
      ],
      "stockSymbol": "PPI",
      "businessVertical": "TechnologyMediaOrTelecom",
      "website": "https://www.piedpiper.com",
      "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"
        },
        "occupation": "ArchitectOrEngineer",
        "annualIncome": "Between50kAnd100k",
        "sourceOfIncome": "EmploymentOrPayrollIncome"
      },
      "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"
          },
          "occupation": "ArchitectOrEngineer",
          "annualIncome": "Between50kAnd100k",
          "sourceOfIncome": "EmploymentOrPayrollIncome"
        }
      ],
      "tags": {
        "userId": "2ab1f266-04b9-41fb-b728-cd1962bca52c"
      },
      "idempotencyKey": "3a1a33be-4e12-4603-9ed0-820922389fb8"
    }
  }
}'

Response

Response is a JSON:API document.

201 Created

data

BusinessApplication

The newly created resource.

relationships

JSON:API Relationships

Describes relationships between the application resource and other resources (beneficial owners).

includedRequired

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"
      },
      "stateOfIncorporation": "DE",
      "ein": "123456789",
      "entityType": "Corporation",
      "ip": "127.0.0.2",
      "website": "https://www.piedpiper.com",
      "annualRevenue": "Between500kAnd1m",
      "numberOfEmployees": "Between50And100",
      "cashFlow": "Predictable",
      "yearOfIncorporation": "2014",
      "countriesOfOperation": [
        "US",
        "CA"
      ],
      "stockSymbol": "PPI",
      "businessVertical": "TechnologyMediaOrTelecom",
      "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"
        },
        "occupation": "ArchitectOrEngineer",
        "annualIncome": "Between50kAnd100k",
        "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": "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."
      }
    }
  ]
}

Cancel Application

Cancel an Application under PendingReview or AwaitingDocuments status. The application.canceled webhook event will be fired.

Verb	POST
URL	https://api.s.unit.sh/applications/{id}/cancel
Data Type	applicationCancel
Timeout (Seconds)	5

Example Request:

curl -X POST 'https://api.s.unit.sh/applications/{id}/cancel'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "applicationCancel",
    "attributes": {
      "reason": "By Org"
    }
  }
}'

Response

Response is a JSON:API document.

201 Created

data

IndividualApplication or BusinessApplication

Application resource. Can be business or individual.

includedRequired

Array of ApplicationDocument Resource

Application required documents, each document object also includes the document status.

Get by Id

Get an application resource by id.

Verb	GET
URL	https://api.s.unit.sh/applications/{id}
Required Scope	applications
Timeout (Seconds)	5

Response

Response is a JSON:API document.

200 OK

data

IndividualApplication or BusinessApplication

Application resource. Can be business or individual, as indicated by the type field.

includedRequired

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.

curl -X GET 'https://api.s.unit.sh/applications/43' \
-H "Authorization: Bearer ${TOKEN}"

List

List application resources. Paging can be applied.

Verb	GET
URL	https://api.s.unit.sh/applications
Required Scope	applications
Timeout (Seconds)	5

Query Parameters

Name	Type	Default	Description
page[limit]	integer	100	Optional. Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
page[offset]	integer	0	Optional. Number of resources to skip. See Pagination.
filter[query]	string	(empty)	Optional. Search term according to the Full-Text Search Rules.
filter[status][]	string	(empty)	Optional. Filter applications by Application Status. Usage example: filter[status][0]=Pending&filter[status][1]=Approved
filter[email]	string	(empty)	Optional. Filter applications by email address (case sensitive).
filter[tags]	Tags (JSON)	(empty)	Optional. Filter Applications by Tags.
sort	string	sort=-createdAt	Optional. sort=createdAt for ascending order or sort=-createdAt (leading minus sign) for descending order.

curl -X GET 'https://api.s.unit.sh/applications?page[limit]=20&page[offset]=10' \
-H "Authorization: Bearer ${TOKEN}"

Response

Response is a JSON:API document.

200 OK

data

Array of IndividualApplication or BusinessApplication

Array of application resources. Each resource can be business or individual, as indicated by the type field.

meta

JSON object that contains pagination data

Pagination data includes offset, limit and total (estimated total items).

Example Response:

{
  "data": [
    {
      "type": "individualApplication",
      "id": "1",
      "attributes": {
        "createdAt": "2020-01-15T13:47:36.098Z",
        "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",
        "archived": false,
        "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": "businessApplication",
      "id": "2",
      "attributes": {
        "createdAt": "2020-01-15T13:48:38.527Z",
        "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"
        },
        "stateOfIncorporation": "DE",
        "ein": "123456789",
        "entityType": "Corporation",
        "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",
          "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",
            "status": "Approved"
          }
        ],
        "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"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 2,
      "limit": 100,
      "offset": 0
    }
  }
}

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

tags

object

See Updating Tags.

annualRevenueOptional

AnnualRevenue

Optional. Annual revenue of the business.

numberOfEmployeesOptional

NumberOfEmployees

Optional. Number of employees of the business.

cashFlowOptional

CashFlow

Optional. Cash flow of the business.

yearOfIncorporationOptional

Year string

Optional. Year of incorporation of the business.

countriesOfOperationOptional

Array of ISO31661-Alpha2 strings

Optional. An array of two letter codes representing the countries of operation of the business.

stockSymbolOptional

string

Optional. The stock symbol (ticker) of the business.

websiteOptional

string

Optional. A Valid website Url.

businessVerticalOptional

BusinessVertical

Optional. The business vertical of the business.

Response

Response is a JSON:API document.

200 OK

data

BusinessApplication

The updated BusinessApplication resource.

relationships

JSON:API Relationships

Describes relationships between the application resource and other resources (beneficial owners).

includedRequired

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"
      },
      "annualRevenue": "Between500kAnd1m",
      "numberOfEmployees": "Between50And100",
      "cashFlow": "Predictable",
      "yearOfIncorporation": "2014",
      "countriesOfOperation": [
        "US",
        "CA"
      ],
      "stockSymbol": "PPI",
      "businessVertical": "TechnologyMediaOrTelecom"
    }
  }
}'

Update Business Officer

Update a business application's officer.

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

Attributes

officer.occupationOptional

Occupation

Optional. Occupation of the officer.

officer.annualIncomeOptional

AnnualIncome

Optional. Annual income of the officer.

officer.sourceOfIncomeOptional

SourceOfIncome

Optional. Source of income of the officer.

Response

Response is a JSON:API document.

200 OK

data

BusinessApplication

The updated BusinessApplication resource.

relationships

JSON:API Relationships

Describes relationships between the application resource and other resources (beneficial owners).

includedRequired

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 officer:

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": {
      "officer": {
        "occupation": "ArchitectOrEngineer",
        "annualIncome": "Between10kAnd25k",
        "sourceOfIncome": "EmploymentOrPayrollIncome"
      }
    }
  }
}'

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

occupationOptional

Occupation

Optional. Occupation of the beneficial owner.

annualIncomeOptional

AnnualIncome

Optional. Annual income of the beneficial owner.

sourceOfIncomeOptional

SourceOfIncome

Optional. Source of income of the beneficial owner.

percentageOptional

integer

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

Response

Response is a JSON:API document.

200 OK

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": {
      "occupation": "ArchitectOrEngineer",
      "annualIncome": "Between10kAnd25k",
      "sourceOfIncome": "EmploymentOrPayrollIncome"
    },
    "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

tags

object

See Updating Tags.

occupationOptional

Occupation

Optional. Occupation of the individual.

annualIncomeOptional

AnnualIncome

Optional. Annual income of the individual.

sourceOfIncomeOptional

SourceOfIncome

Optional. Source of income of the individual.

Response

Response is a JSON:API document.

200 OK

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"
      },
      "occupation": "ArchitectOrEngineer",
      "annualIncome": "Between10kAnd25k",
      "sourceOfIncome": "EmploymentOrPayrollIncome"
    }
  }
}'

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

tags

object

See Updating Tags.

annualRevenueOptional

AnnualRevenue

Optional. Specify the annual revenue here.

numberOfEmployeesOptional

NumberOfEmployees

Optional. Specify the number of employees here.

businessVerticalOptional

BusinessVertical

Optional. Specify the business vertical here.

websiteOptional

string

Optional. Specify the business website here.

Response

Response is a JSON:API document.

200 OK

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"
      },
      "annualRevenue": "UpTo50k",
      "numberOfEmployees": "Between2And5",
      "businessVertical": "BusinessSupportOrBuildingServices",
      "website": "https://unit.co"
    }
  }
}'