In an effort to standardize and allow for easier access to the Unit API, we offer a OpenAPI 3.0.2 specification of our API. You may use this along with the approprite generator to auto-generate client libraries in your the coding language of your choice. Note that there is no gurantee that the generated SDK will be fully compatible with our API and may need some alterations or modifications to become operational.
Below, we have included some examples of applications of this specification in some of the more common languages, along with some tweaks we found useful.
We encourage our SDK community to share feedback of experience with our specification to help identify and address any potential issues. Any feedback will play a crucial role in improving and refining our OpenAPI schema.
The project is wrapped with npm, we strongly advice to install Node LTS to access preconfigured commands, install packages and the overall ease of usage
Below you can find examples for generating client libraries using OpenAPI generator.
The following examples are with the use of openapi-generator-cli.
Bundles the open api specification into one file inside the dist folder
Runs the bundle command and generates java sdk inside the dist folder.
Runs the bundle command and generates node sdk inside the dist folder.
Runs the bundle command and generates ruby sdk inside the dist folder.
Runs the bundle command and generates python sdk inside the dist folder.
Runs redocly lint for schemas to detect any potential issues
Applies prettier formatting to the schemas
String access_token = "access_token";
ApiClient cl = new ApiClient();
ObjectMapper mapper = cl.getObjectMapper();
mapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false); // To allow certain requests with empty bodies
cl.setObjectMapper(mapper);
cl.setRequestInterceptor(r -> {
r.header("Authorization", "Bearer " + access_token);
});
UnitApi unitApi = new UnitApi(cl);
CreateBusinessApplication createBusinessApplication = new CreateBusinessApplication();
CreateBusinessApplicationAttributes attr = new CreateBusinessApplicationAttributes();
attr.setName("Peter Parker");
Address address = new Address();
address.setStreet("20 Ingram St");
address.setCity("Forest Hills");
address.setPostalCode("11375");
address.setCountry("US");
address.setState("NY");
attr.setAddress(address);
Phone p = new Phone();
p.setNumber("5555555555");
p.setCountryCode("1");
attr.setPhone(p);
attr.setStateOfIncorporation("DE");
attr.setEin("123456789");
attr.setEntityType(EntityType.CORPORATION);
attr.setIp("127.0.0.1");
attr.setAnnualRevenue(BusinessAnnualRevenue.BETWEEN250K_AND500K);
attr.setNumberOfEmployees(BusinessNumberOfEmployees.BETWEEN100_AND500);
attr.setCashFlow(CashFlow.PREDICTABLE);
attr.setYearOfIncorporation("1999");
List<String> countriesOfOperation = new ArrayList<String>();
countriesOfOperation.add("US");
countriesOfOperation.add("CA");
attr.setCountriesOfOperation(countriesOfOperation);
attr.setWebsite(null);
String email = "richard@piedpiper.com";
Contact contact = new Contact();
contact.setEmail(email);
contact.setPhone(p);
FullName fn = new FullName();
fn.setFirst("Peter");
fn.setLast("Parker");
contact.setFullName(fn);
attr.setContact(contact);
CreateOfficer officer = new CreateOfficer();
officer.setAnnualIncome(AnnualIncome.BETWEEN50K_AND100K);
officer.setFullName(fn);
officer.setAddress(address);
officer.setEmail(email);
officer.setPhone(p);
LocalDate dateOfBirh = LocalDate.of(1997, 11, 1);
officer.setDateOfBirth(dateOfBirh);
officer.setTitle(CreateOfficer.TitleEnum.CEO);
officer.setOccupation(Occupation.ARCHITECT_OR_ENGINEER);
officer.setSourceOfIncome(SourceOfIncome.BUSINESS_OWNERSHIP_INTERESTS);
officer.setSsn("123456789");
attr.setOfficer(officer);
attr.setBusinessVertical(BusinessVertical.ARTS_ENTERTAINMENT_AND_RECREATION);
List<CreateBeneficialOwner> beneficialOwners = new ArrayList<CreateBeneficialOwner>();
CreateBeneficialOwner beneficialOwner = new CreateBeneficialOwner();
beneficialOwner.setAddress(address);
beneficialOwner.setFullName(fn);
beneficialOwner.setDateOfBirth(dateOfBirh);
beneficialOwner.setSsn("721074426");
beneficialOwner.setEmail(email);
beneficialOwner.setPhone(p);
beneficialOwner.setOccupation(Occupation.ARCHITECT_OR_ENGINEER);
beneficialOwner.setAnnualIncome(AnnualIncome.BETWEEN100K_AND250K);
beneficialOwner.setSourceOfIncome(SourceOfIncome.BUSINESS_OWNERSHIP_INTERESTS);
beneficialOwners.add(beneficialOwner);
attr.setBeneficialOwners(beneficialOwners);
createBusinessApplication.setAttributes(attr);
CreateApplicationRequest ca = new CreateApplicationRequest();
ca.data(new CreateApplicationRequestData(createBusinessApplication));
UnitCreateApplicationResponse res = unitApi.createApplication(ca)you can find more examples in the unit/e2e_tests/java directory
import {
Address,
AnnualIncome,
BusinessAnnualRevenue,
BusinessNumberOfEmployees,
BusinessVertical,
CashFlow,
CreateApplicationRequest,
EntityType,
FullName,
Occupation,
OfficerTitleEnum,
Phone,
SourceOfIncome,
UnitApi,
} from "./api";
import { Configuration } from "./configuration";
const config: Configuration = new Configuration({
accessToken: "access_token",
});
const unitApi: UnitApi = new UnitApi(config);
const address: Address = {
street: "20 Ingram St",
city: "Forest Hills",
postalCode: "11375",
country: "US",
state: "NY",
};
const phone: Phone = {
number: "5555555555",
countryCode: "1",
};
const fullName: FullName = {
first: "Peter",
last: "Parker",
};
const email = "richard@piedpiper.com";
const dateOfBirth = "1997-11-01";
const today = new Date();
const req: CreateApplicationRequest = {
data: {
type: "businessApplication",
attributes: {
name: "Peter Parker",
address,
phone,
stateOfIncorporation: "DE",
ein: "123456789",
entityType: EntityType.Corporation,
ip: "127.0.0.1",
annualRevenue: BusinessAnnualRevenue.Between1mAnd5m,
numberOfEmployees: BusinessNumberOfEmployees.Between100And500,
cashFlow: CashFlow.Predictable,
countriesOfOperation: ["US", "CA"],
businessVertical:
BusinessVertical.AgricultureForestryFishingOrHunting,
yearOfIncorporation: (today.getFullYear() - 2).toString(),
contact: {
email,
fullName,
phone,
},
officer: {
annualIncome: AnnualIncome.Between100kAnd250k,
fullName,
address,
email,
phone,
dateOfBirth,
title: OfficerTitleEnum.Ceo,
occupation: Occupation.ArchitectOrEngineer,
sourceOfIncome: SourceOfIncome.BusinessOwnershipInterests,
ssn: "123456789",
},
beneficialOwners: [
{
address,
fullName,
dateOfBirth,
ssn: "721074426",
email,
phone,
occupation: Occupation.ArchitectOrEngineer,
sourceOfIncome: SourceOfIncome.BusinessOwnershipInterests,
},
],
},
},
};
let res = await unitApi.createApplication(req);import unit_python_sdk
from unit_python_sdk.rest import ApiException
# Defining the host is optional and defaults to https://api.s.unit.sh
# See configuration.py for a list of all supported configuration parameters.
configuration = unit_python_sdk.Configuration(
host = "https://api.s.unit.sh"
)
# Enter a context with an instance of the API client
with unit_python_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_client.set_default_header("Authorization", "Bearer access_token");
api_instance = unit_python_sdk.UnitApi(api_client)
try:
full_name = unit_python_sdk.FullName(first="Peter", last="Parker");
address = unit_python_sdk.Address(street="20 Ingram St", street2=None, city="Forest Hills", state="NY", postalCode="11375", country="US");
ssn = "721074426"
date_of_birth = "2001-08-10";
email = "peter@oscorp.com";
phone = unit_python_sdk.Phone(countryCode="1", number="5555555555");
occupation = unit_python_sdk.Occupation.ARCHITECTORENGINEER;
attributes: unit_python_sdk.CreateIndividualApplicationAttributes = unit_python_sdk.CreateIndividualApplicationAttributes(fullName=full_name, email=email, phone=phone, ssn=ssn, dateOfBirth=date_of_birth, address=address, occupation=occupation);
createIndividualApplication: unit_python_sdk.CreateIndividualApplication = unit_python_sdk.CreateIndividualApplication(type="individualApplication", attributes=attributes);
data = unit_python_sdk.CreateApplicationRequestData(createIndividualApplication);
req = unit_python_sdk.CreateApplicationRequest(data=data);
res = api_instance.create_application(req);
except ApiException as e:
print("Exception when calling UnitApi->create_application: %s\n" % e)token = "your_token"
@configuration = UnitOpenapiRubySdk::Configuration.new.tap do |config|
config.access_token = token
access_t = config.access_token
config.api_key['Authorization'] = access_t
config.api_key_prefix['Authorization'] = 'Bearer'
end
let(:api_instance) { UnitOpenapiRubySdk::UnitApi.new(UnitOpenapiRubySdk::ApiClient.new(configuration)) }
email = 'jone.doe@unit-finance.com'
address = UnitOpenapiRubySdk::Address.new(street: '123 Main St', city: 'San Francisco', state: 'CA', postal_code: '94205', country: 'US')
phone = UnitOpenapiRubySdk::Phone.new(country_code: '380', number: '555123222')
request = { data: UnitOpenapiRubySdk::CreateIndividualApplication
.new(type: 'individualApplication',
attributes: UnitOpenapiRubySdk::CreateIndividualApplicationAttributes
.new(ssn: '123456789',
full_name: UnitOpenapiRubySdk::FullName.new({ first: 'John', last: 'Kenn' }), date_of_birth: Date.new(1989, 2, 1),
address: address,
email: email,
phone: phone,
occupation: 'ArchitectOrEngineer',
annual_income: 'UpTo10k',
source_of_income: 'EmploymentOrPayrollIncome')).to_hash }
response = api_instance.create_application(request)We are using Java native as a library template during generation of the java sdk and there are issues with types in responses containing raw text or binary files.
In order to fix that we have a custom script in place. If you would generate a library yourself you should call the fix-java-file-get-requests script from package.json providing the --path=./dist/java-sdk/src/main/java/unit/java/sdk/api/UnitApi.java argument to fix the errors after the generation.
Use the follow command to check the openapi-generator-cli version:
openapi-generator-cli version
We recommend using v7.9.0, you can change the version with the command:
openapi-generator-cli version-manager set 7.9.0
All of the info listed below is related to the legacy functionality and will be deprecated or updated soon
We recommend using our script which can be found in this repository:
python "./generate.py"
Or generate by yourself with swagger-codegen-cli:
java -jar swagger-codegen-cli-3.0.47.jar generate -i openapi.json -l python -o unit