Partner API documentation

Version: beta

/partner-api/v1/companies/{company_id}/prequalification

POST

Summary

Prequalify company

Parameters

Name	Located in	Description	Required	Schema
x-bs-sk	header	Partner secret key	Yes	string
company_id	path		Yes	string
host	header		Yes	string

Responses

Code	Description
201	Prequalification for given company run successfully.

/partner-api/v1/companies/{company_id}/documents

POST

Summary

Upload company documents

Parameters

Name	Located in	Description	Required	Schema
x-bs-sk	header	Partner secret key	Yes	string
company_id	path		Yes	string

Responses

Code	Description
201	Documents uploaded successfully.

/partner-api/v1/companies/{company_id}/application-status

GET

Summary

Get application status

Parameters

Name	Located in	Description	Required	Schema
x-bs-sk	header	Partner secret key	Yes	string
company_id	path		Yes	string

Responses

Code	Description
200	Successfully fetched application status

/partner-api/v1/companies/document-types

GET

Summary

Get valid document types

Parameters

Name	Located in	Description	Required	Schema
x-bs-sk	header	Partner secret key	Yes	string

Responses

Code	Description
200	Successfully fetched valid document types

/partner-api/v1/companies/application-statuses

GET

Summary

Get valid application statuses

Parameters

Name	Located in	Description	Required	Schema
x-bs-sk	header	Partner secret key	Yes	string

Responses

Code	Description
200	Successfully fetched valid application statuses

/partner-api/v1/applications

POST

Summary

Create application

Parameters

Name	Located in	Description	Required	Schema
x-bs-sk	header	Partner secret key	Yes	string

Responses

Code	Description
201	The application has been successfully created.

GET

Summary

Get list of applications with offers

Parameters

Name	Located in	Description	Required	Schema
x-bs-sk	header	Partner secret key	Yes	string
start	query		No	string
end	query		No	string
partner_id	query		No	string
orderColumn	query		No	string
orderDirection	query		No	string

Responses

Code	Description
200	Applications with offers retrieved successfully

/partner-api/v1/applications/{company_id}/request-offers

POST

Summary

Send application to lenders

Parameters

Name	Located in	Description	Required	Schema
x-bs-sk	header	Partner secret key	Yes	string
company_id	path		Yes	string

Responses

Code	Description
201	The application has been successfully sent to lenders.

/partner-api/v1/applications/auth

POST

Summary

Pre-authenticate an applicant to the front-end widget

Parameters

Name	Located in	Description	Required	Schema
x-bs-sk	header	Partner secret key	Yes	string

Responses

Code	Description
201	User has been successfully authenticated.

/partner-api/v1/applications/{application_id}/followup

GET

Summary

Get followup information

Parameters

Name	Located in	Description	Required	Schema
x-bs-sk	header	Partner secret key	Yes	string
application_id	path		Yes	string
offer_id	query		No	string

Responses

Code	Description
200	Successfully fetched followup information

/partner-api/v1/applications/{application_id}/offers

GET

Summary

Get application offers information

Parameters

Name	Located in	Description	Required	Schema
x-bs-sk	header	Partner secret key	Yes	string
application_id	path		Yes	string

Responses

Code	Description
200	Successfully fetched application offers information

/partner-api/v1/applications/offer/{offer_id}

GET

Summary

Get offer details

Parameters

Name	Located in	Description	Required	Schema
x-bs-sk	header	Partner secret key	Yes	string
offer_id	path		Yes	string

Responses

Code	Description
200	Successfully fetched offer details

/partner-api/v1/applications/{application_id}/ccj

PUT

Summary

Save application company CCJ details

Parameters

Name	Located in	Description	Required	Schema
x-bs-sk	header	Partner secret key	Yes	string
application_id	path		Yes	string

Responses

Code	Description
200	Application company CCJ saved successfully

Models

CompanyCCJDto

Name	Type	Description	Required
type	string	Enum: "ACTIVE", "HISTORIC"	Yes
description	string		Yes

PrequalificationRequestDto

Name	Type	Description	Required
funding_amount	number		Yes
funding_date	dateTime		No
funding_reasons	[ string ]		Yes
monthly_revenue	number		Yes
year_to_date_revenue	number		No
online_sales_revenue_percentage	number		No
repeat_customers_revenue_percentage	number		No
any_ccj	boolean		Yes
ccjs	[ object ]		Yes

PrequalificationResponseDto

Name	Type	Description	Required
approved	boolean		Yes
credit_limit	number		Yes
unmet_criteria	object		Yes

CreateCompanyDocumentRequestDto

Name	Type	Description	Required
file	binary		Yes
type	string	Enum: "bank-statement", "management-accounts", "filed-accounts", "vat-return", "payment-data", "identity-document", "email-attachments"	Yes
offer_id	string		No

CompanyDocumentResponseDto

Name	Type	Description	Required
id	string		Yes
type	string		Yes
name	string		Yes

ApplicationResponseDto

Name	Type	Description	Required
application_status	string	Enum: "PENDING", "RECEIVED_OFFERS", "REJECTED", "OFFER_ACCEPTED", "FUNDS_DISBURSED", "CLOSED", "OFFERS_REQUESTED"	Yes
application_id	string		Yes
company_id	string		Yes
offers_count	number		Yes

DocumentTypeResponseDto

Name	Type	Description	Required
type	string		Yes
name	string		Yes

ApplicationStatusResponseDto

Name	Type	Description	Required
status	string		Yes
name	string		Yes

CreateCompanyAddressDto

Name	Type	Description	Required
house_number	string		Yes
line_1	string		Yes
line_2	string		No
city	string		No
county	string		No
postcode	string		No
country_code	string		Yes
country	string		No
region	string		No
start_date	dateTime		No
current	boolean		No
property_equity	number		No
status	string	Enum: "tenant", "owner_with_mortgage", "owner_no_mortgage", "rent_free"	No

CreateCompanyRequestDto

Name	Type	Description	Required
registered_name	string		Yes
trading_name	string		No
registered_number	string		Yes
type	string	Enum: "llc", "ltd", "llp", "sole_trader", "plc", "limited_partnership", "EEIG", "northern_ireland", "northern_ireland_other", "oversea-company", "OTHER"	Yes
website	string		No
description	string		No
formation_date	string		Yes
trading_from_date	string		Yes
region	string	Enum: "GB", "IE", "AE", "other"	Yes
address	object		Yes
vat_registered	boolean		No
vat_number	string		No
vat_registration_date	dateTime		No
sic_codes	[ string ]		No

CreatePersonAddressDto

Name	Type	Description	Required
house_number	string		Yes
line_1	string		Yes
line_2	string		No
city	string		Yes
county	string		No
postcode	string		Yes
country_code	string		Yes
country	string		No
region	string		No
start_date	dateTime		Yes
current	boolean		No
property_equity	number		No
status	string	Enum: "tenant", "owner_with_mortgage", "owner_no_mortgage", "rent_free"	No

CreateCompanyPersonRequestDto

Name	Type	Description	Required
first_name	string		Yes
last_name	string		Yes
email	string		Yes
phone_number	string		Yes
date_of_birth	string		Yes
nationality	string		No
country_of_residence	string		No
role	string		No
director	boolean		No
occupation	string		No
appointed_on	string		No
resigned_on	string		No
addresses	[ object ]		Yes

CreateApplicationRequestDto

Name	Type	Description	Required
company	object		Yes
applicant	object		Yes
directors	[ object ]		No
online_sales_revenue_percentage	number		No

AddressResponseDto

Name	Type	Description	Required
id	string		Yes
line_1	string		Yes
city	string		No
postcode	string		No
house_number	string		No
line_2	string		No
county	string		No
region	string		No
country_code	string		No
start_date	string		No
current	boolean		No
property_equity	number		No
status	string	Enum: "tenant", "owner_with_mortgage", "owner_no_mortgage", "rent_free"	No

CompanyResponseDto

Name	Type	Description	Required
id	string		Yes
trading_name	string		Yes
registered_name	string		Yes
registered_number	string		Yes
type	string	Enum: "llc", "ltd", "llp", "sole_trader", "plc", "limited_partnership", "EEIG", "northern_ireland", "northern_ireland_other", "oversea-company", "OTHER"	Yes
region	string		Yes
formation_date	string		Yes
trading_from_date	string		No
website	string		No
description	string		No
address	object		Yes
vat_number	string		No
vat_registration_date	dateTime		No

CompanyPersonWithAddressesResponseDto

Name	Type	Description	Required
addresses	[ object ]		Yes
id	string		Yes
first_name	string		Yes
last_name	string		Yes
email	string		Yes
phone_number	string		Yes
date_of_birth	string		Yes
director	boolean		Yes
applicant	boolean		Yes
company_id	string		Yes

CompanyWithApplicantResponseDto

Name	Type	Description	Required
company	object		Yes
applicant	object		Yes

SendApplicationToLendersRequestDto

Name	Type	Description	Required
credit_score_check_consent	boolean	Customer needs to give the consent before sending the application to lenders	Yes

ApplicationAuthRequestDto

Name	Type	Description	Required
company_id	string		Yes
email	string		Yes

ApplicationAuthResponseDto

Name	Type	Description	Required
access_token	string		Yes

RequestedAdditionalDetailsResponseDto

Name	Type	Description	Required
id	string		Yes
application_id	string		Yes
offer_id	string		No
documents_requested	[ string ]		Yes
notes	string		No
resolved	boolean		No
admin_email	string		No

DetailsRequestedDto

Name	Type	Description	Required
document_types	[ string ]		Yes
notes	string		No
resolved	boolean		Yes

OfferResponseDto

Name	Type	Description	Required
rates	[ string ]		No
revenueRepayments	[ string ]		No
id	string		Yes
product_type	string	Enum: "REVENUE_BASED", "CREDIT_LINE", "REVOLVING_CREDIT_FACILITY", "TERM_LOAN", "UNKNOWN"	Yes
application_id	string		Yes
lender_name	string		Yes
lender_logo	string		No
status	string	Enum: "PENDING", "DEFERRED", "DECLINED", "ADDITIONAL_DETAILS_REQUESTED", "OFFERED", "ACCEPTED", "CANCELLED", "LENDER_CALL_FAILED", "RULES_DECLINED", "APPLICANT_DECLINED"	Yes
type	string	Enum: "API", "MANUAL"	Yes
min_credit_offer	number		No
max_credit_offer	number		No
duration_in_months	number		No
monthly_repayment_type	string	Enum: "INTEREST_ONLY", "INTEREST_AND_CAPITAL"	No
monthly_repayment	number		No
total_repayment	number		No
currency	string		No
notes	string		No
rejection_reason	string		No
valid_until	string		No
created_at	string		Yes
updated_at	string		Yes
rejection_reason_tags	[ string ]		No
decline_reason	object		No
lender_raw_response	object		No
metadata	object		No
external_id	string		No
details_requested	object		No

ApplicationWithOffersListItemDto

Name	Type	Description	Required
id	string		Yes
status	string	Enum: "NEW", "PENDING", "PREQUALIFIED", "REJECTED", "OFFERS_REQUESTED", "OFFER_ACCEPTED", "FUNDS_DISBURSED", "CLOSED", "ADDITIONAL_DETAILS_REQUESTED"	Yes
offers	[ object ]		Yes

ApplicationsWithOffersListResponseDto

Name	Type	Description	Required
applications	[ object ]		Yes

SaveCompanyCCJRequestDto

Name	Type	Description	Required
details	object		Yes