curl --request POST \
--url https://api-staging.scorethebusiness.com/partner-api/v1/applications \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-bs-sk: x-bs-sk-from-partner-dashboard' \
--data '
{
"company": {
"address": {
"house_number": "1",
"line_1": "line_1",
"country_code": "UK"
},
"registered_name": "Acme LTD",
"registered_number": "12345",
"type": "ltd",
"formation_date": "2020-07-10 15:00:00.000",
"trading_from_date": "2020-07-10 15:00:00.000",
"region": "GB"
},
"applicant": {
"addresses": [
{
"house_number": "1",
"line_1": "line_1",
"city": "London",
"postcode": "EC2A 4HT",
"county": "London",
"country_code": "UK",
"start_date": "01/02/2012",
"status": "tenant",
"region": "UK",
"current": "true"
}
],
"first_name": "Elon",
"last_name": "Musk",
"email": "[email protected]",
"phone_number": "+4412321321",
"country_of_residence": "United Kingdom",
"date_of_birth": "2000-07-10"
},
"region": "UK"
}
'
After creating an application
You will receive the following response, persist the company.id in the case below f2f3bb23-22aa-4717-9631-8be772c4c4c8, as you will require this for subsequent requests.
{
"success": true,
"message": "The application has been successfully created.",
"data": {
"application_id": "130070b1-c2df-4541-a7d2-a9f81abec2b0",
"region": "UK",
"company": {
"id": "f2f3bb23-22aa-4717-9631-8be772c4c4c8",
...}
}
}
curl --request POST \
--url https://api-staging.scorethebusiness.com/partner-api/v1/companies/f2f3bb23-22aa-4717-9631-8be772c4c4c8/documents \
--header 'accept: application/json' \
--header 'content-type: multipart/form-data' \
--header 'x-bs-sk: x-bs-sk-from-partner-dashboard' \
--form [email protected] \
--form type=bank-statement
curl --request POST \
--url https://api-staging.scorethebusiness.com/partner-api/v1/companies/f2f3bb23-22aa-4717-9631-8be772c4c4c8/prequalification \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-bs-sk: x-bs-sk-from-partner-dashboard' \
--data '
{
"funding_amount": 20000,
"monthly_revenue": 5000,
"any_ccj": false
}
'
curl --request POST \
--url https://api-staging.scorethebusiness.com/partner-api/v1/applications/f2f3bb23-22aa-4717-9631-8be772c4c4c8/request-offers \
--header 'content-type: application/json' \
--header 'x-bs-sk: x-bs-sk-from-partner-dashboard' \
--data '
{
"credit_score_check_consent": true
}
'
Sample Credit check consent message
We plan to show you credit offers from carefully selected providers. In order to do this, we will need to share the data you have provided to Business Score with our providers. These providers will share your information with credit reference agencies to run soft credit and identity checks, but don't worry this will not affect your credit score. They will also share it with fraud prevention agencies - please be aware, if they do spot fraud, you or others could be refused services, finance, or employment.
curl --request POST \
--url https://api-staging.scorethebusiness.com/partner-api/v1/applications/auth \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-bs-sk: x-bs-sk-from-partner-dashboard' \
--data '
{
"company_id": "f2f3bb23-22aa-4717-9631-8be772c4c4c8",
"email": "[email protected]"
}
'
If the authenticate the user to the widget request is successful, you will receive an access_token which will be used to instantiate the widget.