Skip to main content
POST
Create a Supplier Submission

Authorizations

​
Authorization
string
header
required

Canonical form uses underscore only: tcs_test_<public_id> or tcs_live<public_id>_. Scopes: supplier_submissions:create:basic, supplier_submissions:create:application, supplier_submissions:read, supplier_submissions:correct, supplier_submissions:promote. Effective permission is account ∩ credential ∩ environment. HMAC pepper is SUPPLIER_API_KEY_PEPPER.

Headers

​
X-Request-Id
string

Optional caller correlation id. Tera always returns X-Request-Id; that header is the only correlation identifier.

Required string length: 1 - 128

Body

application/json
​
external_reference
string
required
Required string length: 1 - 128
​
level
string
required
Allowed value: "basic"
​
first_name
string
required
Required string length: 1 - 100
​
last_name
string
required
Required string length: 1 - 100
​
telephone
string
required
Required string length: 1 - 20
​
business_name
string
required
Required string length: 2 - 200
​
funding_amount
integer
required
Required range: 1000 <= x <= 10000000
​
funding_purpose
enum<string>
required
Available options:
working-capital,
equipment,
stock,
vehicles,
property,
tax-vat,
acquisition,
refinance,
other
​
contact_expectation
object
required
​
capture_timestamp
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
attribution
object
required
​
email
string
Required string length: 1 - 320
​
funding_purpose_detail
string
Required string length: 1 - 200
​
company_number
string
Required string length: 1 - 20
​
business_sector
enum<string>
Available options:
construction,
transport,
manufacturing,
motor-trade,
retail-wholesale,
hospitality,
professional-services,
healthcare,
agriculture,
beauty-wellness,
facilities,
technology-media,
education,
other
​
preferred_contact_method
enum<string>
Available options:
email,
phone,
either
​
funding_timeframe
enum<string>
Available options:
asap,
within-1-month,
within-3-months,
planning-ahead
​
trading_duration
enum<string>
Available options:
less-than-1,
1-2-years,
2-5-years,
5-plus-years
​
annual_turnover_range
enum<string>
Available options:
under-100k,
100k-250k,
250k-500k,
500k-1m,
1m-5m,
over-5m
​
notes
string
Required string length: 1 - 500
​
stated_collection_basis
object

Response

Current supplier-visible object. Used for identical create replay and GET.

​
environment
enum<string>
required
Available options:
sandbox,
production
​
submission_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
external_reference
string
required
Required string length: 1 - 128
​
level
enum<string>
required
Available options:
basic,
application
​
status
enum<string>
required
Available options:
received,
accepted,
duplicate_not_accepted,
rejected
​
received_at
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
decided_at
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
application_reference
string | null
required
​
application_created_at
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
billing
object
required