{ "openapi": "3.1.0", "info": { "title": "Capvant Partner API", "version": "1.0.0", "description": "The Partner API is for introducers: accountants, brokers, platforms and embedded partners who send a business to Capvant and want to follow what happens next without leaving their own product.\n\nThe shape follows the resource the work actually has. A lead is opened, filled in progressively, given its directors and its documents, and then submitted. From there it matches funding options, receives offers, and one of those offers is accepted. Every step has an endpoint and every state change has a webhook event.\n\nTwo rules hold throughout. A band stays a band: where a figure is derived from a band the response says so through a `_basis` field, so a bucket is never mistaken for a reported number. And unknown never passes as known: a field we do not hold is `null`, never a default and never inferred.\n\nFunding options are described structurally and never named. Capvant selects the panel; the partner keeps the client relationship.\n\nEnvironments are chosen by the credential, not the request. A sandbox key creates leads that are never routed, never emailed, and never seen by a funding provider, and it can exercise every endpoint end to end. Two hosts serve the same API: sandbox.capvant.com accepts sandbox keys only, so nothing live can happen there; api.capvant.com is production and accepts both kinds of key.", "contact": { "name": "Capvant Partnerships", "email": "partnerships@capvant.com", "url": "https://capvant.com/partners" } }, "servers": [ { "url": "https://sandbox.capvant.com/partner/v1", "description": "Sandbox" }, { "url": "https://api.capvant.com/partner/v1", "description": "Production" } ], "security": [ { "BearerAuth": [] }, { "ApiKeyAuth": [] } ], "tags": [ { "name": "Partner: Authentication" }, { "name": "Partner: Reference data" }, { "name": "Partner: Prequalification", "description": "Check a business against the panel before you submit it." }, { "name": "Partner: Leads" }, { "name": "Partner: Documents" }, { "name": "Partner: Offers" }, { "name": "Partner: Renewals" }, { "name": "Partner: Webhooks", "description": "Register endpoints to receive referral events." } ], "paths": { "/oauth/token": { "post": { "tags": [ "Partner: Authentication" ], "operationId": "createAccessToken", "summary": "Exchange an API key for an access token", "description": "client_id is the key prefix shown in your portal; client_secret is the key itself. The environment is decided by the key, so a sandbox key can only ever mint a sandbox token. Send either application/x-www-form-urlencoded or application/json.", "security": [], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "grant_type": { "type": "string", "enum": [ "client_credentials" ] }, "client_id": { "type": "string", "description": "The key prefix, for example cv_pk_test_ab." }, "client_secret": { "type": "string", "description": "The full API key." } }, "required": [ "grant_type", "client_id", "client_secret" ] } }, "application/json": { "schema": { "type": "object", "properties": { "grant_type": { "type": "string", "enum": [ "client_credentials" ] }, "client_id": { "type": "string", "description": "" }, "client_secret": { "type": "string", "description": "" } }, "required": [ "grant_type", "client_id", "client_secret" ] } } } }, "responses": { "200": { "description": "A bearer token valid for one hour.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } } }, "400": { "description": "The grant type is not supported, or the body could not be read.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/me": { "get": { "tags": [ "Partner: Authentication" ], "operationId": "getIdentity", "summary": "Who this key belongs to", "description": "The first call to make. It proves the credential works and says which environment it acts in, before anything real is attempted.", "responses": { "200": { "description": "The caller and its environment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Identity" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/enums": { "get": { "tags": [ "Partner: Reference data" ], "operationId": "listEnums", "summary": "The catalogue of reference lists", "description": "Read this once, then read each list you need. Building your dropdowns from the API means they stay correct the day we open a market.", "responses": { "200": { "description": "Every reference list and where to read it.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnumCatalogue" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/enums/{name}": { "get": { "tags": [ "Partner: Reference data" ], "operationId": "getEnum", "summary": "One reference list", "description": "company-types, funding-amount-bands and revenue-bands differ by market and require ?country=. The rest are global.", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "countries", "currencies", "company-types", "industries", "purposes", "product-families", "funding-amount-bands", "revenue-bands", "time-in-business-bands", "credit-score-bands", "document-types", "lead-states", "webhook-events" ] } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "GB", "US", "CA", "AU", "IE", "ES", "NL", "BE", "DK", "SE", "PL", "FR" ], "x-enum-labels": { "GB": "United Kingdom", "US": "United States", "CA": "Canada", "AU": "Australia", "IE": "Ireland", "ES": "Spain", "NL": "Netherlands", "BE": "Belgium", "DK": "Denmark", "SE": "Sweden", "PL": "Poland", "FR": "France" }, "description": "Market, alpha-2.", "x-enum-flags": { "GB": "🇬🇧", "US": "🇺🇸", "CA": "🇨🇦", "AU": "🇦🇺", "IE": "🇮🇪", "ES": "🇪🇸", "NL": "🇳🇱", "BE": "🇧🇪", "DK": "🇩🇰", "SE": "🇸🇪", "PL": "🇵🇱", "FR": "🇫🇷" }, "x-enum-meta": { "GB": { "code": "UK", "alpha3": "GBR", "currency": "GBP", "local_currency": "GBP", "instant_matching": true, "register_number": "Company number", "register_number_example": "07538765", "launch": "open", "requires": [ "company_number", "entity_type", "monthly_revenue", "time_in_business" ] }, "US": { "code": "US", "alpha3": "USA", "currency": "USD", "local_currency": "USD", "instant_matching": true, "register_number": "Employer Identification Number", "register_number_example": "12-3456789", "launch": "open", "requires": [ "credit_score_band", "monthly_revenue", "time_in_business" ] }, "CA": { "code": "CA", "alpha3": "CAN", "currency": "CAD", "local_currency": "CAD", "instant_matching": true, "register_number": "Corporation number or business number", "register_number_example": "1234567-8", "launch": "open", "requires": [ "credit_score_band", "monthly_revenue", "time_in_business" ] }, "AU": { "code": "AU", "alpha3": "AUS", "currency": "AUD", "local_currency": "AUD", "instant_matching": false, "register_number": "Australian Business Number", "register_number_example": "51 824 753 556", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "IE": { "code": "IE", "alpha3": "IRL", "currency": "EUR", "local_currency": "EUR", "instant_matching": false, "register_number": "CRO number", "register_number_example": "123456", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "ES": { "code": "ES", "alpha3": "ESP", "currency": "EUR", "local_currency": "EUR", "instant_matching": false, "register_number": "NIF", "register_number_example": "B12345678", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "NL": { "code": "NL", "alpha3": "NLD", "currency": "EUR", "local_currency": "EUR", "instant_matching": false, "register_number": "KVK number", "register_number_example": "12345678", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "BE": { "code": "BE", "alpha3": "BEL", "currency": "EUR", "local_currency": "EUR", "instant_matching": false, "register_number": "Enterprise number", "register_number_example": "0403.170.701", "launch": "integrated", "requires": [ "monthly_revenue", "time_in_business" ] }, "DK": { "code": "DK", "alpha3": "DNK", "currency": "EUR", "local_currency": "DKK", "instant_matching": false, "register_number": "CVR number", "register_number_example": "25313763", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "SE": { "code": "SE", "alpha3": "SWE", "currency": "EUR", "local_currency": "SEK", "instant_matching": false, "register_number": "Organisationsnummer", "register_number_example": "556036-0793", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "PL": { "code": "PL", "alpha3": "POL", "currency": "EUR", "local_currency": "PLN", "instant_matching": false, "register_number": "KRS number", "register_number_example": "0000123456", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "FR": { "code": "FR", "alpha3": "FRA", "currency": "EUR", "local_currency": "EUR", "instant_matching": false, "register_number": "SIREN", "register_number_example": "306 138 900", "launch": "integrated", "requires": [ "monthly_revenue", "time_in_business" ] } } }, "description": "Market code, alpha-2 or alpha-3. Required for the country-scoped lists." } ], "responses": { "200": { "description": "The requested list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnumList" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/prequalification": { "post": { "tags": [ "Partner: Prequalification" ], "operationId": "prequalify", "summary": "Indicative appetite, without creating anything", "description": "Answers whether there is appetite for a request, using the same matcher production routing uses. No lead is created, no credit search is run, and no contact details are needed or stored. Safe to call on a browsing client.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrequalificationRequest" } } } }, "responses": { "200": { "description": "The indicative answer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrequalificationResult" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/MarketNotOpen" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/leads": { "get": { "tags": [ "Partner: Leads" ], "operationId": "listLeads", "summary": "Your leads", "description": "Scoped to your account and to the environment of the credential. Keyset pagination through an opaque cursor.", "parameters": [ { "name": "state", "in": "query", "schema": { "$ref": "#/components/schemas/LeadState" }, "description": "Filter by state." }, { "name": "market", "in": "query", "schema": { "type": "string", "enum": [ "GB", "US", "CA", "AU", "IE", "ES", "NL", "BE", "DK", "SE", "PL", "FR" ], "x-enum-labels": { "GB": "United Kingdom", "US": "United States", "CA": "Canada", "AU": "Australia", "IE": "Ireland", "ES": "Spain", "NL": "Netherlands", "BE": "Belgium", "DK": "Denmark", "SE": "Sweden", "PL": "Poland", "FR": "France" }, "description": "Market to filter by.", "x-enum-flags": { "GB": "🇬🇧", "US": "🇺🇸", "CA": "🇨🇦", "AU": "🇦🇺", "IE": "🇮🇪", "ES": "🇪🇸", "NL": "🇳🇱", "BE": "🇧🇪", "DK": "🇩🇰", "SE": "🇸🇪", "PL": "🇵🇱", "FR": "🇫🇷" }, "x-enum-meta": { "GB": { "code": "UK", "alpha3": "GBR", "currency": "GBP", "local_currency": "GBP", "instant_matching": true, "register_number": "Company number", "register_number_example": "07538765", "launch": "open", "requires": [ "company_number", "entity_type", "monthly_revenue", "time_in_business" ] }, "US": { "code": "US", "alpha3": "USA", "currency": "USD", "local_currency": "USD", "instant_matching": true, "register_number": "Employer Identification Number", "register_number_example": "12-3456789", "launch": "open", "requires": [ "credit_score_band", "monthly_revenue", "time_in_business" ] }, "CA": { "code": "CA", "alpha3": "CAN", "currency": "CAD", "local_currency": "CAD", "instant_matching": true, "register_number": "Corporation number or business number", "register_number_example": "1234567-8", "launch": "open", "requires": [ "credit_score_band", "monthly_revenue", "time_in_business" ] }, "AU": { "code": "AU", "alpha3": "AUS", "currency": "AUD", "local_currency": "AUD", "instant_matching": false, "register_number": "Australian Business Number", "register_number_example": "51 824 753 556", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "IE": { "code": "IE", "alpha3": "IRL", "currency": "EUR", "local_currency": "EUR", "instant_matching": false, "register_number": "CRO number", "register_number_example": "123456", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "ES": { "code": "ES", "alpha3": "ESP", "currency": "EUR", "local_currency": "EUR", "instant_matching": false, "register_number": "NIF", "register_number_example": "B12345678", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "NL": { "code": "NL", "alpha3": "NLD", "currency": "EUR", "local_currency": "EUR", "instant_matching": false, "register_number": "KVK number", "register_number_example": "12345678", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "BE": { "code": "BE", "alpha3": "BEL", "currency": "EUR", "local_currency": "EUR", "instant_matching": false, "register_number": "Enterprise number", "register_number_example": "0403.170.701", "launch": "integrated", "requires": [ "monthly_revenue", "time_in_business" ] }, "DK": { "code": "DK", "alpha3": "DNK", "currency": "EUR", "local_currency": "DKK", "instant_matching": false, "register_number": "CVR number", "register_number_example": "25313763", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "SE": { "code": "SE", "alpha3": "SWE", "currency": "EUR", "local_currency": "SEK", "instant_matching": false, "register_number": "Organisationsnummer", "register_number_example": "556036-0793", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "PL": { "code": "PL", "alpha3": "POL", "currency": "EUR", "local_currency": "PLN", "instant_matching": false, "register_number": "KRS number", "register_number_example": "0000123456", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "FR": { "code": "FR", "alpha3": "FRA", "currency": "EUR", "local_currency": "EUR", "instant_matching": false, "register_number": "SIREN", "register_number_example": "306 138 900", "launch": "integrated", "requires": [ "monthly_revenue", "time_in_business" ] } } }, "description": "Filter by market. Alpha-2, alpha-3 and names are all accepted." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "The next_cursor from the previous page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "A page of leads.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadList" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "post": { "tags": [ "Partner: Leads" ], "operationId": "createLead", "summary": "Open a lead", "description": "Creates the lead and returns it in full. Send an Idempotency-Key header to make a retry safe; without one, the same contact from the same partner within thirty minutes returns the existing lead rather than a duplicate. A lead may be created before every field is known and filled in afterwards with PATCH.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Replays the same lead on a retry instead of creating a second one." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadCreate" } } } }, "responses": { "200": { "description": "An existing lead was replayed, because of an Idempotency-Key or the dedupe window.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Lead" } } } }, "201": { "description": "The lead was created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Lead" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/MarketNotOpen" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/leads/{id}": { "get": { "tags": [ "Partner: Leads" ], "operationId": "getLead", "summary": "Read a lead", "description": "The full state: fields, market block, step checklist, matched options, offers, documents and timeline.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The lead id returned by POST /leads." } ], "responses": { "200": { "description": "The lead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Lead" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "patch": { "tags": [ "Partner: Leads" ], "operationId": "updateLead", "summary": "Fill in a lead", "description": "Sends any subset of the create body. Only the fields present change. Refused with 409 once the lead has been submitted, because the panel was asked about the figures as they were.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The lead id returned by POST /leads." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadPatch" } } } }, "responses": { "200": { "description": "The updated lead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Lead" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/leads/{id}/significant-persons": { "put": { "tags": [ "Partner: Leads" ], "operationId": "putSignificantPersons", "summary": "Set the directors and owners", "description": "Replaces the whole list. Who controls a business is a set, so correcting one entry must not leave the old one behind.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The lead id returned by POST /leads." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignificantPersonsRequest" } } } }, "responses": { "200": { "description": "The stored list and the updated step checklist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "" }, "significant_persons": { "type": "array", "items": { "$ref": "#/components/schemas/SignificantPerson" } }, "steps": { "type": [ "object", "null" ], "additionalProperties": true } }, "required": [ "id", "significant_persons" ] } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/leads/{id}/submit": { "post": { "tags": [ "Partner: Leads" ], "operationId": "submitLead", "summary": "Submit the lead for matching", "description": "Idempotent: a second call does not route the lead again and answers with the same state. Refused whole with 422 when a field the market makes mandatory is missing, naming each one, so you can fix and retry. In the sandbox this matches locally and stops: no funding provider is ever contacted from a sandbox key.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The lead id returned by POST /leads." } ], "responses": { "200": { "description": "The lead was already submitted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitResult" } } } }, "202": { "description": "The lead was submitted and matching has started.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitResult" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/MarketNotOpen" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/leads/{id}/documents": { "get": { "tags": [ "Partner: Documents" ], "operationId": "listLeadDocuments", "summary": "Documents on a lead", "description": "Everything attached, and everything refused with the reason it was refused.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The lead id returned by POST /leads." } ], "responses": { "200": { "description": "The documents held.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentList" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/leads/{id}/documents/{type}": { "post": { "tags": [ "Partner: Documents" ], "operationId": "uploadLeadDocument", "summary": "Attach a document", "description": "multipart/form-data with one or more parts named file. bank-statements is the classified lane: every file is read before anything is stored, and a batch containing something that is not a statement is refused whole with the reason. Up to 6 files, each up to 10MB.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The lead id returned by POST /leads." }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "bank-statements", "management_accounts", "debt_schedule", "aged_debtors", "filed_accounts", "proof_of_id", "other" ] }, "description": "Document type from /enums/document-types. Hyphens and underscores are both accepted." } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "One or more files." } }, "required": [ "file" ] } } } }, "responses": { "201": { "description": "The documents were accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentUploadResult" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/leads/{id}/offers": { "get": { "tags": [ "Partner: Offers" ], "operationId": "listLeadOffers", "summary": "Offers on a lead", "description": "Figures, term and a structural label for each option. Sandbox offers are computed for integration testing and say so.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The lead id returned by POST /leads." } ], "responses": { "200": { "description": "The offers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfferList" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/leads/{id}/offers/{offerId}/acceptance": { "post": { "tags": [ "Partner: Offers" ], "operationId": "acceptLeadOffer", "summary": "Accept an offer", "description": "The business has chosen this option. No body: accepting is a choice, not a payload. A live acceptance runs through the same path the business would use from its own account, so the handover happens exactly once.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The lead id returned by POST /leads." }, { "name": "offerId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The offer id from GET /leads/{id}/offers." } ], "responses": { "201": { "description": "The acceptance was recorded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptanceResult" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/leads/{id}/renewal-eligibility": { "get": { "tags": [ "Partner: Renewals" ], "operationId": "getRenewalEligibility", "summary": "Whether a funded business can renew", "description": "Currently a documented stub: Capvant receives no renewal feed from the panel, so this answers not_available with the reason rather than a guess. The shape is final.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The lead id returned by POST /leads." } ], "responses": { "200": { "description": "The renewal answer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenewalEligibility" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/webhook-events": { "get": { "tags": [ "Partner: Webhooks" ], "operationId": "listWebhookEvents", "summary": "The event catalogue", "description": "Every event, plus how a delivery is signed and how it is retried. Everything needed to verify a payload is on this one page.", "responses": { "200": { "description": "The catalogue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEventCatalogue" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/webhook-subscriptions": { "get": { "tags": [ "Partner: Webhooks" ], "operationId": "listWebhookSubscriptions", "summary": "Your subscriptions", "description": "The signing secret is never listed. It is shown once, when the subscription is created.", "responses": { "200": { "description": "Your subscriptions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscriptionList" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "post": { "tags": [ "Partner: Webhooks" ], "operationId": "createWebhookSubscription", "summary": "Subscribe an endpoint", "description": "Returns the signing secret exactly once. The URL must be a public https endpoint; loopback and private ranges are refused.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscriptionCreate" } } } }, "responses": { "201": { "description": "The subscription and its secret.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscriptionCreated" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } }, "callbacks": { "partnerEvent": { "{$request.body#/url}": { "post": { "summary": "A signed event delivered to your endpoint", "description": "Verify X-Capvant-Signature over the exact bytes received before trusting the body. Answer 2xx within five seconds; anything else is retried on the schedule in GET /webhook-events.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDelivery" } } } }, "responses": { "200": { "description": "Received. Any 2xx stops the retries." }, "500": { "description": "Anything other than a 2xx is retried." } } } } } } } }, "/webhook-subscriptions/{id}": { "get": { "tags": [ "Partner: Webhooks" ], "operationId": "getWebhookSubscription", "summary": "Read a subscription", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "The subscription.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscription" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "put": { "tags": [ "Partner: Webhooks" ], "operationId": "updateWebhookSubscription", "summary": "Change a subscription", "description": "Send url, events or active. Omitted fields keep their current value. The secret cannot be changed; delete and recreate to rotate it.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": [ "string", "null" ], "description": "Public https endpoint." }, "events": { "type": "array", "items": { "type": "string", "enum": [ "lead.created", "lead.updated", "lead.submitted", "lead.option_matched", "lead.offer_received", "lead.offer_accepted", "lead.declined", "lead.funded", "document.received", "document.rejected" ], "x-enum-labels": { "lead.created": "lead.created", "lead.updated": "lead.updated", "lead.submitted": "lead.submitted", "lead.option_matched": "lead.option_matched", "lead.offer_received": "lead.offer_received", "lead.offer_accepted": "lead.offer_accepted", "lead.declined": "lead.declined", "lead.funded": "lead.funded", "document.received": "document.received", "document.rejected": "document.rejected" }, "description": "Event name." }, "description": "" }, "active": { "type": "boolean", "description": "" } } } } } }, "responses": { "200": { "description": "The updated subscription.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscription" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "delete": { "tags": [ "Partner: Webhooks" ], "operationId": "deleteWebhookSubscription", "summary": "Remove a subscription", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "The subscription was removed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletedSubscription" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } } } }, "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "An access token from POST /oauth/token. Valid for one hour. Preferred, because a leaked request log then exposes an hour rather than a permanent credential." }, "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-Key", "description": "The raw Partner API key. Live keys start with cv_pk_, sandbox keys with cv_pk_test_. Supported for the first version alongside bearer tokens." } }, "parameters": {}, "responses": { "Unauthorized": { "description": "The credential is missing, unknown, expired or revoked.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "Forbidden": { "description": "The credential is valid but not permitted to do this, or it is a live credential used on sandbox.capvant.com (code environment_mismatch).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "NotFound": { "description": "No such resource for this partner in this environment.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "Conflict": { "description": "The resource is in a state that does not allow this.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "ValidationFailed": { "description": "The request could not be accepted as sent. `errors[]` names each field and why.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "CountryNotServed": { "description": "The country is not a market Capvant serves.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "MarketNotOpen": { "description": "Refused as sent (code validation_failed, errors[] names each field), or the market is integrated but not open for live requests yet (code market_not_open; sandbox credentials are not affected). GET /enums/countries carries the launch state per market.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "RateLimited": { "description": "Too many requests. Retry after the number of seconds in the Retry-After header.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "UnsupportedMediaType": { "description": "The request body is not in an accepted format.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "PayloadTooLarge": { "description": "The request body or an uploaded file is too large.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "InternalError": { "description": "Something went wrong on our side. Retry; the request is safe to repeat when it carried an Idempotency-Key.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "schemas": { "Registry": { "type": "object", "description": "Public register facts as filed, from the official company register of the market. Present for every served country: status not_fetched until the first lookup has run, and null only where no register is connected for the country. Every field is null when the register does not carry it; status says whether a section was read. The record carries facts and a status, never where or how they were obtained.", "properties": { "source": { "type": "string", "enum": [ "official_register" ], "x-enum-labels": { "official_register": "The official company register of the market" }, "description": "Always official_register: the facts come from the market’s official company register." }, "status": { "type": "string", "enum": [ "available", "partial", "unavailable", "not_fetched" ], "description": "available: every section was read. partial: at least one section is incomplete. unavailable: the company profile could not be read. not_fetched: the register is connected for this country but we hold no snapshot for this lead yet." }, "incorporated_on": { "type": [ "string", "null" ] }, "company_age_months": { "type": [ "integer", "null" ], "description": "Completed months since incorporation. Company age, not trading duration." }, "company_status": { "type": [ "string", "null" ] }, "company_type": { "type": [ "string", "null" ] }, "sic_codes": { "type": [ "array", "null" ], "description": "Null when the profile section could not be read; an empty array means none are filed.", "items": { "type": "string" } }, "registered_office": { "anyOf": [ { "$ref": "#/components/schemas/RegistryAddress" }, { "type": "null" } ] }, "directors": { "type": [ "array", "null" ], "description": "Directors only, not every officer. Null when the officers section could not be read.", "items": { "$ref": "#/components/schemas/RegistryDirector" } }, "psc_count": { "type": [ "integer", "null" ], "description": "Persons with significant control on the register." }, "accounts": { "anyOf": [ { "$ref": "#/components/schemas/RegistryDueDate" }, { "type": "null" } ] }, "confirmation_statement": { "anyOf": [ { "$ref": "#/components/schemas/RegistryDueDate" }, { "type": "null" } ] }, "charges_count": { "type": [ "integer", "null" ], "description": "Registered charges. Null means the charges register could not be read, which is not the same as none registered." }, "has_insolvency_history": { "type": [ "boolean", "null" ], "description": "False only when the insolvency register returned no record. Null when it could not be read." }, "filed_financials": { "anyOf": [ { "$ref": "#/components/schemas/RegistryFiledFinancials" }, { "type": "null" } ] }, "registers": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Statutory registers the company elected to keep on the public record instead of at its office. Empty when the register was read and none is held there; null when it could not be read." }, "exemptions": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Exemptions the company claims, for example from keeping a PSC register because it is listed. Empty when read and none claimed; null when it could not be read." }, "uk_establishments_count": { "type": [ "integer", "null" ], "description": "Number of UK establishments an overseas company has registered." }, "disqualified_directors_count": { "type": [ "integer", "null" ], "description": "How many current directors matched the disqualified officers register. Zero when it was searched and none matched; null when it could not be searched." }, "registered_name": { "type": [ "string", "null" ], "description": "The legal name exactly as the register spells it." }, "identifiers": { "$ref": "#/components/schemas/RegistryIdentifiers" }, "activity_codes": { "type": [ "array", "null" ], "description": "Activity codes with the scheme the register uses. sic_codes keeps the bare codes.", "items": { "$ref": "#/components/schemas/RegistryActivityCode" } }, "officers": { "type": [ "array", "null" ], "description": "Every officer role the register exposes, not only directors. Null when the register exposes none.", "items": { "$ref": "#/components/schemas/RegistryOfficer" } }, "filings": { "type": [ "array", "null" ], "description": "Filings and published accounts, newest first, at most ten.", "items": { "$ref": "#/components/schemas/RegistryFiling" } }, "share_capital": { "type": [ "object", "null" ], "description": "Share capital where the register publishes it (Spain).", "properties": { "amount": { "type": "number" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] }, "business_description": { "type": [ "string", "null" ], "description": "The objects clause or business description where the register carries one (Sweden, Spain)." }, "sections": { "type": "object", "description": "Every section of the register record, keyed by what it holds (profile, officers, filings, accounts, vat_check, and so on), so nothing the register said is lost. The normalised fields above are the same everywhere; these keys differ per register.", "additionalProperties": { "$ref": "#/components/schemas/RegistrySectionRecord" } }, "checked_at": { "type": [ "string", "null" ], "description": "When the register was read for this record, ISO 8601.", "format": "date-time" } }, "required": [ "source", "status", "incorporated_on", "company_age_months", "company_status", "company_type", "sic_codes", "registered_office", "directors", "psc_count", "accounts", "confirmation_statement", "charges_count", "has_insolvency_history", "filed_financials", "registers", "exemptions", "uk_establishments_count", "disqualified_directors_count", "registered_name", "identifiers", "activity_codes", "officers", "filings", "share_capital", "business_description", "sections", "checked_at" ] }, "RegistryDirector": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "role": { "type": [ "string", "null" ], "description": "Officer role as filed, for example \"director\"." }, "appointed_on": { "type": [ "string", "null" ] }, "resigned_on": { "type": [ "string", "null" ], "description": "Null while the appointment is current." }, "other_active_appointments": { "type": [ "integer", "null" ], "description": "Live directorships at other companies, from the officer's own record. Null when the follow-up was not run or failed." }, "other_resigned_appointments": { "type": [ "integer", "null" ] }, "dissolved_companies": { "type": [ "integer", "null" ], "description": "How many of the director's other companies are dissolved." }, "disqualified": { "type": [ "boolean", "null" ], "description": "True only on an exact name and birth-month match on the disqualified officers register; false when searched with no match; null when it could not be searched." } } }, "RegistryAddress": { "type": "object", "description": "Registered office address exactly as filed.", "properties": { "line1": { "type": [ "string", "null" ] }, "line2": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "region": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] } } }, "RegistryDueDate": { "type": "object", "properties": { "next_due": { "type": [ "string", "null" ], "description": "Next filing date on the register." }, "overdue": { "type": [ "boolean", "null" ] } } }, "RegistryFiledFinancials": { "type": "object", "description": "Figures from the latest filed accounts, annual, in the register’s currency. basis says whether they were read from the accounts the company itself filed (filed_accounts) or from the register’s own summary figures (register_summary), which carry the balance sheet but not always turnover.", "properties": { "period_start": { "type": [ "string", "null" ] }, "period_end": { "type": [ "string", "null" ] }, "turnover": { "type": [ "number", "null" ], "description": "Only present when the filed accounts disclose it; companies filing under the small-company exemptions usually do not." }, "gross_profit": { "type": [ "number", "null" ] }, "operating_profit": { "type": [ "number", "null" ] }, "profit_loss": { "type": [ "number", "null" ], "description": "Profit or loss for the period after tax; negative is a loss." }, "equity": { "type": [ "number", "null" ] }, "net_assets": { "type": [ "number", "null" ] }, "net_current_assets": { "type": [ "number", "null" ] }, "cash": { "type": [ "number", "null" ] }, "current_liabilities": { "type": [ "number", "null" ] }, "average_employees": { "type": [ "integer", "null" ] }, "accounts_type": { "type": [ "string", "null" ], "description": "The register's own code and description for the accounts filed, for example \"AA (accounts-with-accounts-type-full)\"." }, "basis": { "type": [ "string", "null" ], "enum": [ "filed_accounts", "register_summary", null ], "x-enum-labels": { "filed_accounts": "Filed accounts", "register_summary": "Register summary figures" }, "description": "filed_accounts: read from the accounts the company filed, in structured form. register_summary: the register’s summary figures. Null when no figures are held." } } }, "RegistryIdentifiers": { "type": "object", "description": "The register’s own identifiers for the company: the keys that exist in this market (the same keys as market.identifiers) plus lei. A key that is present and null is not on record.", "additionalProperties": { "type": [ "string", "null" ] }, "properties": { "vat_number": { "type": [ "string", "null" ], "description": "VAT number as the VAT register returned it or the applicant gave it, without country prefix." }, "lei": { "type": [ "string", "null" ], "description": "Legal Entity Identifier where the company has one." }, "nip": { "type": [ "string", "null" ], "description": "Tax identification number, ten digits." }, "krs": { "type": [ "string", "null" ], "description": "National Court Register number, ten digits." }, "regon": { "type": [ "string", "null" ], "description": "Statistical number." }, "nif": { "type": [ "string", "null" ], "description": "Tax identification number, once the VAT check has confirmed it." }, "ein": { "type": [ "string", "null" ], "description": "Employer identification number, XX-XXXXXXX, as the applicant gave it or the state file carries it." }, "business_number": { "type": [ "string", "null" ], "description": "Nine-digit business number." }, "state_entity_number": { "type": [ "string", "null" ], "description": "The state register’s own entity number." }, "registry_sheet": { "type": [ "string", "null" ], "description": "The commercial register sheet reference." }, "siren": { "type": [ "string", "null" ], "description": "SIREN, nine digits: the register number." }, "siret": { "type": [ "string", "null" ], "description": "SIRET of the head office, fourteen digits." }, "abn": { "type": [ "string", "null" ], "description": "Australian Business Number, eleven digits." } }, "x-keys-by-market": { "GB": [ "vat_number", "lei" ], "US": [ "ein", "state_entity_number", "state", "lei" ], "CA": [ "business_number", "lei" ], "AU": [ "abn", "lei" ], "IE": [ "vat_number", "lei" ], "ES": [ "nif", "registry_sheet", "vat_number", "lei" ], "NL": [ "vat_number", "lei" ], "BE": [ "vat_number", "lei" ], "DK": [ "vat_number", "lei" ], "SE": [ "vat_number", "lei" ], "PL": [ "nip", "krs", "regon", "vat_number", "lei" ], "FR": [ "siren", "siret", "vat_number", "lei" ] } }, "RegistryActivityCode": { "type": "object", "properties": { "scheme": { "type": [ "string", "null" ], "description": "The classification the register uses: SIC 2007, NACE-BEL 2025, PKD 2007, SNI 2007, NAICS, DB07, ANZSIC, SBI, CNAE, NAF." }, "code": { "type": "string" }, "description": { "type": [ "string", "null" ], "description": "The register’s wording for the code, where it gives one." }, "classification": { "type": [ "string", "null" ], "description": "main or secondary where the register distinguishes." } }, "required": [ "scheme", "code", "description", "classification" ] }, "RegistryOfficer": { "type": "object", "properties": { "name": { "type": [ "string", "null" ], "description": "Null where the register masks names (Poland)." }, "role": { "type": [ "string", "null" ], "description": "The role in the register’s own words." }, "appointed_on": { "type": [ "string", "null" ], "description": "", "format": "date" }, "resigned_on": { "type": [ "string", "null" ], "description": "", "format": "date" } }, "required": [ "name", "role", "appointed_on", "resigned_on" ] }, "RegistryFiling": { "type": "object", "properties": { "type": { "type": [ "string", "null" ], "description": "The register’s filing type code." }, "description": { "type": [ "string", "null" ], "description": "" }, "date": { "type": [ "string", "null" ], "description": "Filed or published on.", "format": "date" }, "period_start": { "type": [ "string", "null" ], "description": "", "format": "date" }, "period_end": { "type": [ "string", "null" ], "description": "", "format": "date" } }, "required": [ "type", "description", "date", "period_start", "period_end" ] }, "RegistrySectionRecord": { "type": "object", "description": "One section of the register record: the register’s status for it and the facts it returned.", "properties": { "status": { "type": [ "string", "null" ], "description": "available, partial, unavailable or not_found." }, "data": { "description": "The facts the register holds for this section. Shape differs per register; null when the section was not available." } }, "required": [ "status", "data" ] }, "Vat": { "type": "object", "description": "The VAT registration check: the EU markets against the EU VAT register, the UK against the national VAT register. Present on the market object only where such a check exists.", "properties": { "number": { "type": [ "string", "null" ], "description": "VAT number with country prefix, for example BE0203201340 or GB123456789." }, "valid": { "type": [ "boolean", "null" ], "description": "true: the VAT register confirms the number. false: it refuses it. null: not checked yet, or the check did not answer." }, "checked_at": { "type": [ "string", "null" ], "description": "When the VAT register was checked, ISO 8601.", "format": "date-time" }, "source": { "type": "string", "enum": [ "vat_validation" ], "description": "Always vat_validation: the number was checked against the VAT register." }, "registered_name": { "type": [ "string", "null" ], "description": "Legal name as the VAT register returns it. Spain masks it, so it is null there." }, "registered_address": { "type": [ "string", "null" ], "description": "Registered address as the VAT register returns it. Spain masks it." }, "reason": { "type": [ "string", "null" ], "enum": [ "no_number", "not_checked", "service_unavailable", null ], "x-enum-labels": { "no_number": "No VAT number to check yet", "not_checked": "Not checked yet", "service_unavailable": "The check did not answer" }, "description": "Why valid is null. Null once the check has answered." } }, "required": [ "number", "valid", "checked_at", "source", "registered_name", "registered_address", "reason" ] }, "Problem": { "type": "object", "description": "Every failure, in one shape. `type` is a stable URI naming the error class, and `errors[]` carries the per-field detail.", "properties": { "type": { "type": "string", "description": "Absolute URI naming the error class, for example https://docs.capvant.com/partner-api/errors/validation_failed." }, "title": { "type": "string", "description": "Short human summary of the error class." }, "status": { "type": "integer", "description": "The HTTP status, repeated in the body." }, "detail": { "type": "string", "description": "What went wrong with this particular request." }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ProblemFieldError" } }, "request_id": { "type": "string", "description": "The id of this request. Quote it in a support thread." } }, "required": [ "type", "title", "status", "detail", "errors", "request_id" ] }, "ProblemFieldError": { "type": "object", "properties": { "field": { "type": "string", "description": "Dotted path into the request body, for example business.company_number, or significant_persons[0].date_of_birth." }, "code": { "type": "string", "enum": [ "required", "invalid_type", "invalid_format", "invalid_value", "out_of_range", "too_long", "unknown_enum_value", "required_in_market", "not_eligible_in_market", "consent_missing", "immutable" ], "description": "Stable machine-readable reason. Branch on this, not on the prose." }, "detail": { "type": "string", "description": "Human explanation of this one field." } }, "required": [ "field", "code", "detail" ] }, "TokenResponse": { "type": "object", "properties": { "access_token": { "type": "string", "description": "Send as Authorization: Bearer." }, "token_type": { "type": "string", "enum": [ "Bearer" ] }, "expires_in": { "type": "integer", "description": "Seconds until the token expires." }, "scope": { "type": "string", "description": "Space-separated scopes granted." }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "Decided by the key, never by the request." } }, "required": [ "access_token", "token_type", "expires_in", "environment" ] }, "Identity": { "type": "object", "properties": { "partner": { "type": "object", "properties": { "id": { "type": "string", "description": "Partner account id." }, "slug": { "type": "string", "description": "Partner slug." }, "name": { "type": "string", "description": "Display name." } }, "required": [ "id", "slug", "name" ] }, "environment": { "type": "string", "enum": [ "live", "sandbox" ] }, "credential": { "type": "string", "enum": [ "bearer", "api_key" ] }, "markets": { "type": "array", "items": { "type": "string", "enum": [ "UK", "US", "CA", "AU", "IE", "ES", "NL", "BE", "DK", "SE", "PL", "FR" ], "x-enum-labels": { "UK": "United Kingdom", "US": "United States", "CA": "Canada", "AU": "Australia", "IE": "Ireland", "ES": "Spain", "NL": "Netherlands", "BE": "Belgium", "DK": "Denmark", "SE": "Sweden", "PL": "Poland", "FR": "France" }, "description": "Stored market code.", "x-enum-flags": { "UK": "🇬🇧", "US": "🇺🇸", "CA": "🇨🇦", "AU": "🇦🇺", "IE": "🇮🇪", "ES": "🇪🇸", "NL": "🇳🇱", "BE": "🇧🇪", "DK": "🇩🇰", "SE": "🇸🇪", "PL": "🇵🇱", "FR": "🇫🇷" } }, "description": "The markets this API accepts." }, "api_version": { "type": "string", "description": "The version of this API." }, "request_id": { "type": "string", "description": "The id of this request." } }, "required": [ "partner", "environment", "credential", "markets" ] }, "EnumCatalogue": { "type": "object", "properties": { "enums": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Reference list name." }, "country_scoped": { "type": "boolean", "description": "True when the list differs by market and ?country= is required." }, "path": { "type": "string", "description": "Where to read it." } }, "required": [ "name", "country_scoped", "path" ] } } }, "required": [ "enums" ] }, "EnumList": { "type": "object", "properties": { "name": { "type": "string", "description": "The reference list requested." }, "country": { "type": [ "string", "null" ], "description": "The market this answer is scoped to, or null for a global list." }, "country_scoped": { "type": "boolean", "description": "Whether this list differs by market." }, "values": { "type": "array", "description": "Each entry always carries value and label; country-specific lists add fields such as currency, fundable or midpoint.", "items": { "type": "object", "properties": { "value": { "type": "string", "description": "Send this." }, "label": { "type": "string", "description": "Show this." } }, "required": [ "value", "label" ] } } }, "required": [ "name", "values" ] }, "PrequalificationRequest": { "type": "object", "description": "No contact details, no consent, no lead. Everything here is about the request, not the person.", "properties": { "country": { "type": "string", "enum": [ "GB", "US", "CA", "AU", "IE", "ES", "NL", "BE", "DK", "SE", "PL", "FR" ], "x-enum-labels": { "GB": "United Kingdom", "US": "United States", "CA": "Canada", "AU": "Australia", "IE": "Ireland", "ES": "Spain", "NL": "Netherlands", "BE": "Belgium", "DK": "Denmark", "SE": "Sweden", "PL": "Poland", "FR": "France" }, "description": "Market, as ISO 3166-1 alpha-2 (GB, US, NL). Alpha-3 codes and plain country names are also accepted. Germany and Italy are refused.", "x-enum-flags": { "GB": "🇬🇧", "US": "🇺🇸", "CA": "🇨🇦", "AU": "🇦🇺", "IE": "🇮🇪", "ES": "🇪🇸", "NL": "🇳🇱", "BE": "🇧🇪", "DK": "🇩🇰", "SE": "🇸🇪", "PL": "🇵🇱", "FR": "🇫🇷" }, "x-enum-meta": { "GB": { "code": "UK", "alpha3": "GBR", "currency": "GBP", "local_currency": "GBP", "instant_matching": true, "register_number": "Company number", "register_number_example": "07538765", "launch": "open", "requires": [ "company_number", "entity_type", "monthly_revenue", "time_in_business" ] }, "US": { "code": "US", "alpha3": "USA", "currency": "USD", "local_currency": "USD", "instant_matching": true, "register_number": "Employer Identification Number", "register_number_example": "12-3456789", "launch": "open", "requires": [ "credit_score_band", "monthly_revenue", "time_in_business" ] }, "CA": { "code": "CA", "alpha3": "CAN", "currency": "CAD", "local_currency": "CAD", "instant_matching": true, "register_number": "Corporation number or business number", "register_number_example": "1234567-8", "launch": "open", "requires": [ "credit_score_band", "monthly_revenue", "time_in_business" ] }, "AU": { "code": "AU", "alpha3": "AUS", "currency": "AUD", "local_currency": "AUD", "instant_matching": false, "register_number": "Australian Business Number", "register_number_example": "51 824 753 556", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "IE": { "code": "IE", "alpha3": "IRL", "currency": "EUR", "local_currency": "EUR", "instant_matching": false, "register_number": "CRO number", "register_number_example": "123456", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "ES": { "code": "ES", "alpha3": "ESP", "currency": "EUR", "local_currency": "EUR", "instant_matching": false, "register_number": "NIF", "register_number_example": "B12345678", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "NL": { "code": "NL", "alpha3": "NLD", "currency": "EUR", "local_currency": "EUR", "instant_matching": false, "register_number": "KVK number", "register_number_example": "12345678", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "BE": { "code": "BE", "alpha3": "BEL", "currency": "EUR", "local_currency": "EUR", "instant_matching": false, "register_number": "Enterprise number", "register_number_example": "0403.170.701", "launch": "integrated", "requires": [ "monthly_revenue", "time_in_business" ] }, "DK": { "code": "DK", "alpha3": "DNK", "currency": "EUR", "local_currency": "DKK", "instant_matching": false, "register_number": "CVR number", "register_number_example": "25313763", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "SE": { "code": "SE", "alpha3": "SWE", "currency": "EUR", "local_currency": "SEK", "instant_matching": false, "register_number": "Organisationsnummer", "register_number_example": "556036-0793", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "PL": { "code": "PL", "alpha3": "POL", "currency": "EUR", "local_currency": "PLN", "instant_matching": false, "register_number": "KRS number", "register_number_example": "0000123456", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "FR": { "code": "FR", "alpha3": "FRA", "currency": "EUR", "local_currency": "EUR", "instant_matching": false, "register_number": "SIREN", "register_number_example": "306 138 900", "launch": "integrated", "requires": [ "monthly_revenue", "time_in_business" ] } } }, "business": { "type": "object", "properties": { "industry": { "type": [ "string", "null" ], "enum": [ "ecommerce", "restaurant", "construction", "medical", "trucking", "retail", "manufacturing", "saas", "landscaping", "auto_repair", "real_estate", "professional", "hospitality", "pet_care", "pharmacy", "funeral", "liquor", "cbd", "firearms", "vape", "other", null ], "x-enum-labels": { "ecommerce": "E-Commerce / Online Retail", "restaurant": "Restaurant / Food & Beverage", "construction": "Construction / Trades (HVAC, Plumbing, Electrical)", "medical": "Medical / Healthcare", "trucking": "Trucking / Transportation / Logistics", "retail": "Retail / Convenience / Grocery", "manufacturing": "Manufacturing", "saas": "IT Services / Software / SaaS", "landscaping": "Landscaping / Lawn Care", "auto_repair": "Auto Repair / Auto Services", "real_estate": "Real Estate / Property Management", "professional": "Professional Services (Accounting, Marketing, etc.)", "hospitality": "Hospitality / Hotels", "pet_care": "Pet Care / Veterinary", "pharmacy": "Pharmacy", "funeral": "Funeral Services", "liquor": "Liquor Stores", "cbd": "CBD / Cannabis", "firearms": "Guns & Ammo / Firearms", "vape": "Vape / Tobacco / Nicotine", "other": "Other" }, "description": "Industry, from /enums/industries." } } }, "funding": { "type": "object", "properties": { "amount": { "type": [ "number", "null" ], "description": "Amount in major units of the market currency." }, "amount_band": { "type": [ "string", "null" ], "enum": [ "under_25k", "25k_50k", "50k_100k", "100k_250k", "250k_500k", "500k_1m", "1m_2m", "2m_5m", "5m_15m", "15m_50m", null ], "x-enum-labels": { "under_25k": "Under 25K", "25k_50k": "25K – 50K", "50k_100k": "50K – 100K", "100k_250k": "100K – 250K", "250k_500k": "250K – 500K", "500k_1m": "500K – 1M", "1m_2m": "1M – 2M", "2m_5m": "2M – 5M", "5m_15m": "5M – 15M", "15m_50m": "15M – 50M" }, "description": "Band from /enums/funding-amount-bands, as an alternative to amount. Figures are in the market currency." }, "purpose": { "type": "string", "enum": [ "Working Capital", "Equipment Purchase", "Inventory", "Expansion / Growth", "Debt Refinancing", "Hiring / Payroll", "Marketing", "Other", "Unpaid invoices / late-paying customers", "Acquisition or property" ], "x-enum-labels": { "Working Capital": "Working Capital", "Equipment Purchase": "Equipment Purchase", "Inventory": "Inventory", "Expansion / Growth": "Expansion / Growth", "Debt Refinancing": "Debt Refinancing", "Hiring / Payroll": "Hiring / Payroll", "Marketing": "Marketing", "Other": "Other", "Unpaid invoices / late-paying customers": "Unpaid invoices / late-paying customers", "Acquisition or property": "Acquisition or property" }, "description": "Purpose, from /enums/purposes." } }, "required": [ "purpose" ] }, "trading": { "type": "object", "properties": { "monthly_revenue": { "type": [ "number", "null" ], "description": "Monthly figure in major units." }, "monthly_revenue_band": { "type": [ "string", "null" ], "enum": [ "under_10k", "10k_20k", "20k_50k", "50k_75k", "75k_100k", "100k_250k", "250k_plus", null ], "x-enum-labels": { "under_10k": "Under 10K", "10k_20k": "10K – 20K", "20k_50k": "20K – 50K", "50k_75k": "50K – 75K", "75k_100k": "75K – 100K", "100k_250k": "100K – 250K", "250k_plus": "250K+" }, "description": "Band from /enums/revenue-bands." }, "annual_turnover": { "type": [ "number", "null" ], "description": "Annual figure. Used only when monthly revenue is absent." }, "tib_months": { "type": [ "number", "null" ], "description": "Months trading." }, "time_in_business_band": { "type": [ "string", "null" ], "enum": [ "under_6m", "6_12m", "1_2y", "2y_plus", null ], "x-enum-labels": { "under_6m": "Under 6 months", "6_12m": "6 – 12 months", "1_2y": "1 – 2 years", "2y_plus": "2+ years" }, "description": "Band from /enums/time-in-business-bands." } } } }, "required": [ "country", "funding" ] }, "PrequalificationResult": { "type": "object", "properties": { "country": { "type": "string", "enum": [ "UK", "US", "CA", "AU", "IE", "ES", "NL", "BE", "DK", "SE", "PL", "FR" ], "x-enum-labels": { "UK": "United Kingdom", "US": "United States", "CA": "Canada", "AU": "Australia", "IE": "Ireland", "ES": "Spain", "NL": "Netherlands", "BE": "Belgium", "DK": "Denmark", "SE": "Sweden", "PL": "Poland", "FR": "France" }, "description": "The market the answer is for, as the stored market code.", "x-enum-flags": { "UK": "🇬🇧", "US": "🇺🇸", "CA": "🇨🇦", "AU": "🇦🇺", "IE": "🇮🇪", "ES": "🇪🇸", "NL": "🇳🇱", "BE": "🇧🇪", "DK": "🇩🇰", "SE": "🇸🇪", "PL": "🇵🇱", "FR": "🇫🇷" } }, "currency": { "type": "string", "enum": [ "GBP", "USD", "CAD", "AUD", "EUR" ], "x-enum-labels": { "GBP": "Pound sterling (£)", "USD": "US dollar ($)", "CAD": "Canadian dollar (C$)", "AUD": "Australian dollar (A$)", "EUR": "Euro (€)" }, "description": "The currency the figures are in." }, "eligible": { "type": "boolean", "description": "Whether there is a route forward, instant or worked by a person." }, "decision": { "type": "string", "enum": [ "options_available", "advisory_referral", "manual_review", "no_options", "market_not_routed" ], "description": "options_available: funding options matched. advisory_referral: handled as a bespoke mandate with a named adviser. manual_review: no instant match, but large enough that a person will work it. no_options: nothing covers this request. market_not_routed: the market is accepted for intake but has no instant matching yet." }, "matched_options": { "type": "integer", "description": "How many funding options matched." }, "product_families": { "type": "array", "items": { "type": "object", "properties": { "product_family": { "type": "string", "enum": [ "asset_finance", "bridging", "business_line_of_credit", "invoice_finance", "merchant_cash_advance", "property_development_finance", "term_loan", "trade_finance", "working_capital" ], "x-enum-labels": { "asset_finance": "Asset finance", "bridging": "Bridging finance", "business_line_of_credit": "Business line of credit", "invoice_finance": "Invoice finance", "merchant_cash_advance": "Revenue-based funding", "property_development_finance": "Property development finance", "term_loan": "Term loan", "trade_finance": "Trade finance", "working_capital": "Working capital" }, "description": "Family, from /enums/product-families." }, "label": { "type": "string", "description": "Reader-facing name." }, "options": { "type": "integer" } }, "required": [ "product_family", "label", "options" ] } }, "indicative_amount": { "type": [ "object", "null" ], "description": "The range the matched options fund between. A range stays a range; it is never narrowed to a single number.", "properties": { "min": { "type": [ "number", "null" ], "description": "Lower bound, or null when unbounded." }, "max": { "type": [ "number", "null" ], "description": "Upper bound, or null when unbounded." }, "currency": { "type": "string", "enum": [ "GBP", "USD", "CAD", "AUD", "EUR" ], "x-enum-labels": { "GBP": "Pound sterling (£)", "USD": "US dollar ($)", "CAD": "Canadian dollar (C$)", "AUD": "Australian dollar (A$)", "EUR": "Euro (€)" }, "description": "Currency of the bounds." }, "basis": { "type": "string", "enum": [ "panel_limits" ] } } }, "reasons": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "amount_below_minimum", "amount_above_maximum", "revenue_below_minimum", "revenue_above_maximum", "trading_history_too_short", "industry_not_served", "purpose_not_served", "market_not_served", "ownership_requirements_not_met", "account_type_not_accepted", "criteria_not_met" ] }, "detail": { "type": "string", "description": "What the code means in words." } }, "required": [ "code", "detail" ] } }, "supported_countries": { "type": "array", "items": { "type": "string", "enum": [ "UK", "US", "CA", "AU", "IE", "ES", "NL", "BE", "DK", "SE", "PL", "FR" ], "x-enum-labels": { "UK": "United Kingdom", "US": "United States", "CA": "Canada", "AU": "Australia", "IE": "Ireland", "ES": "Spain", "NL": "Netherlands", "BE": "Belgium", "DK": "Denmark", "SE": "Sweden", "PL": "Poland", "FR": "France" }, "description": "Stored market code.", "x-enum-flags": { "UK": "🇬🇧", "US": "🇺🇸", "CA": "🇨🇦", "AU": "🇦🇺", "IE": "🇮🇪", "ES": "🇪🇸", "NL": "🇳🇱", "BE": "🇧🇪", "DK": "🇩🇰", "SE": "🇸🇪", "PL": "🇵🇱", "FR": "🇫🇷" } } }, "disclaimer": { "type": "string", "description": "Indicative only. Not an offer of finance." } }, "required": [ "country", "currency", "eligible", "decision", "matched_options", "product_families", "reasons", "disclaimer" ] }, "Consent": { "type": "object", "description": "Proof that the business agreed to be introduced to funding providers. Required to create a lead and required again before it can be submitted.", "properties": { "obtained": { "type": "boolean", "enum": [ true ], "description": "Must be true." }, "timestamp": { "type": "string", "description": "ISO 8601 instant at which consent was given." }, "text": { "type": [ "string", "null" ], "description": "The wording the business agreed to. Stored as evidence." } }, "required": [ "obtained", "timestamp" ] }, "LeadCreate": { "type": "object", "properties": { "country": { "type": "string", "enum": [ "GB", "US", "CA", "AU", "IE", "ES", "NL", "BE", "DK", "SE", "PL", "FR" ], "x-enum-labels": { "GB": "United Kingdom", "US": "United States", "CA": "Canada", "AU": "Australia", "IE": "Ireland", "ES": "Spain", "NL": "Netherlands", "BE": "Belgium", "DK": "Denmark", "SE": "Sweden", "PL": "Poland", "FR": "France" }, "description": "Market, as ISO 3166-1 alpha-2 (GB, US, NL). Alpha-3 codes and plain country names are also accepted.", "x-enum-flags": { "GB": "🇬🇧", "US": "🇺🇸", "CA": "🇨🇦", "AU": "🇦🇺", "IE": "🇮🇪", "ES": "🇪🇸", "NL": "🇳🇱", "BE": "🇧🇪", "DK": "🇩🇰", "SE": "🇸🇪", "PL": "🇵🇱", "FR": "🇫🇷" }, "x-enum-meta": { "GB": { "code": "UK", "alpha3": "GBR", "currency": "GBP", "local_currency": "GBP", "instant_matching": true, "register_number": "Company number", "register_number_example": "07538765", "launch": "open", "requires": [ "company_number", "entity_type", "monthly_revenue", "time_in_business" ] }, "US": { "code": "US", "alpha3": "USA", "currency": "USD", "local_currency": "USD", "instant_matching": true, "register_number": "Employer Identification Number", "register_number_example": "12-3456789", "launch": "open", "requires": [ "credit_score_band", "monthly_revenue", "time_in_business" ] }, "CA": { "code": "CA", "alpha3": "CAN", "currency": "CAD", "local_currency": "CAD", "instant_matching": true, "register_number": "Corporation number or business number", "register_number_example": "1234567-8", "launch": "open", "requires": [ "credit_score_band", "monthly_revenue", "time_in_business" ] }, "AU": { "code": "AU", "alpha3": "AUS", "currency": "AUD", "local_currency": "AUD", "instant_matching": false, "register_number": "Australian Business Number", "register_number_example": "51 824 753 556", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "IE": { "code": "IE", "alpha3": "IRL", "currency": "EUR", "local_currency": "EUR", "instant_matching": false, "register_number": "CRO number", "register_number_example": "123456", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "ES": { "code": "ES", "alpha3": "ESP", "currency": "EUR", "local_currency": "EUR", "instant_matching": false, "register_number": "NIF", "register_number_example": "B12345678", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "NL": { "code": "NL", "alpha3": "NLD", "currency": "EUR", "local_currency": "EUR", "instant_matching": false, "register_number": "KVK number", "register_number_example": "12345678", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "BE": { "code": "BE", "alpha3": "BEL", "currency": "EUR", "local_currency": "EUR", "instant_matching": false, "register_number": "Enterprise number", "register_number_example": "0403.170.701", "launch": "integrated", "requires": [ "monthly_revenue", "time_in_business" ] }, "DK": { "code": "DK", "alpha3": "DNK", "currency": "EUR", "local_currency": "DKK", "instant_matching": false, "register_number": "CVR number", "register_number_example": "25313763", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "SE": { "code": "SE", "alpha3": "SWE", "currency": "EUR", "local_currency": "SEK", "instant_matching": false, "register_number": "Organisationsnummer", "register_number_example": "556036-0793", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "PL": { "code": "PL", "alpha3": "POL", "currency": "EUR", "local_currency": "PLN", "instant_matching": false, "register_number": "KRS number", "register_number_example": "0000123456", "launch": "open", "requires": [ "monthly_revenue", "time_in_business" ] }, "FR": { "code": "FR", "alpha3": "FRA", "currency": "EUR", "local_currency": "EUR", "instant_matching": false, "register_number": "SIREN", "register_number_example": "306 138 900", "launch": "integrated", "requires": [ "monthly_revenue", "time_in_business" ] } } }, "reference": { "type": [ "string", "null" ], "description": "Your own identifier for this case. Echoed back on every read." }, "business": { "type": "object", "properties": { "name": { "type": "string", "description": "Registered or trading name." }, "company_number": { "type": [ "string", "null" ], "description": "Company registration number. Required before submit in the UK." }, "entity_type": { "type": [ "string", "null" ], "enum": [ "private_limited_company", "public_limited_company", "limited_liability_partnership", "community_interest_company", "sole_trader", "general_partnership", "other_not_yet_incorporated", "limited_liability_company", "c_corporation", "s_corporation", "partnership", "sole_proprietorship", "nonprofit_corporation", "corporation", "federal_corporation", "provincial_corporation", "cooperative", "proprietary_limited_company", "public_company", "trust", "private_company_limited_by_shares", "designated_activity_company", "company_limited_by_guarantee", "sociedad_limitada", "sociedad_anonima", "sociedad_cooperativa", "sociedad_civil", "comunidad_de_bienes", "autonomo", "besloten_vennootschap", "naamloze_vennootschap", "vennootschap_onder_firma", "commanditaire_vennootschap", "cooperatie", "maatschap", "stichting", "eenmanszaak", "bv_srl", "nv_sa", "cv_sc", "commv_scomm", "vof_snc", "eenmanszaak_entreprise_individuelle", "anpartsselskab", "aktieselskab", "partnerselskab", "interessentskab", "kommanditselskab", "enkeltmandsvirksomhed", "personligt_ejet_mindre_virksomhed", "aktiebolag", "handelsbolag", "kommanditbolag", "ekonomisk_forening", "enskild_firma", "spolka_z_ograniczona_odpowiedzialnoscia", "spolka_akcyjna", "prosta_spolka_akcyjna", "spolka_jawna", "spolka_komandytowa", "spolka_cywilna", "jednoosobowa_dzialalnosc_gospodarcza", "sas", "sasu", "sarl", "eurl", "sa", "snc", "sci", "entreprise_individuelle", "association", null ], "x-enum-labels": { "private_limited_company": "Private limited company (Ltd)", "public_limited_company": "Public limited company (PLC)", "limited_liability_partnership": "Limited liability partnership (LLP)", "community_interest_company": "Community interest company (CIC)", "sole_trader": "Sole trader (Sole trader)", "general_partnership": "General partnership (Partnership)", "other_not_yet_incorporated": "Other or not yet incorporated (Other)", "limited_liability_company": "Limited liability company (LLC)", "c_corporation": "C corporation (Inc.)", "s_corporation": "S corporation (S corp)", "partnership": "Partnership (LP)", "sole_proprietorship": "Sole proprietorship (Sole prop.)", "nonprofit_corporation": "Nonprofit corporation (501(c))", "corporation": "Corporation", "federal_corporation": "Federal corporation (Inc.)", "provincial_corporation": "Provincial corporation (Inc.)", "cooperative": "Cooperative (Co-op)", "proprietary_limited_company": "Proprietary limited company (Pty Ltd)", "public_company": "Public company (Ltd)", "trust": "Trading trust (Trust)", "private_company_limited_by_shares": "Private company limited by shares (LTD)", "designated_activity_company": "Designated activity company (DAC)", "company_limited_by_guarantee": "Company limited by guarantee (CLG)", "sociedad_limitada": "Limited liability company (SL)", "sociedad_anonima": "Public limited company (SA)", "sociedad_cooperativa": "Cooperative (S. Coop.)", "sociedad_civil": "Civil partnership (SC)", "comunidad_de_bienes": "Joint ownership (CB)", "autonomo": "Sole trader (Autonomo)", "besloten_vennootschap": "Private limited company (BV)", "naamloze_vennootschap": "Public limited company (NV)", "vennootschap_onder_firma": "General partnership (VOF)", "commanditaire_vennootschap": "Limited partnership (CV)", "cooperatie": "Cooperative (Coop.)", "maatschap": "Professional partnership (Maatschap)", "stichting": "Foundation (Stichting)", "eenmanszaak": "Sole proprietorship (Eenmanszaak)", "bv_srl": "Private limited company (BV / SRL)", "nv_sa": "Public limited company (NV / SA)", "cv_sc": "Cooperative company (CV / SC)", "commv_scomm": "Limited partnership (CommV / SComm)", "vof_snc": "General partnership (VOF / SNC)", "eenmanszaak_entreprise_individuelle": "Sole trader (Eenmanszaak)", "anpartsselskab": "Private limited company (ApS)", "aktieselskab": "Public limited company (A/S)", "partnerselskab": "Limited partnership company (P/S)", "interessentskab": "General partnership (I/S)", "kommanditselskab": "Limited partnership (K/S)", "enkeltmandsvirksomhed": "Sole proprietorship (Enkeltmandsvirksomhed)", "personligt_ejet_mindre_virksomhed": "Small personally owned business (PMV)", "aktiebolag": "Limited company (AB)", "handelsbolag": "General partnership (HB)", "kommanditbolag": "Limited partnership (KB)", "ekonomisk_forening": "Economic association (Ek. for.)", "enskild_firma": "Sole trader (Enskild firma)", "spolka_z_ograniczona_odpowiedzialnoscia": "Limited liability company (Sp. z o.o.)", "spolka_akcyjna": "Joint-stock company (S.A.)", "prosta_spolka_akcyjna": "Simple joint-stock company (P.S.A.)", "spolka_jawna": "General partnership (Sp. j.)", "spolka_komandytowa": "Limited partnership (Sp. k.)", "spolka_cywilna": "Civil law partnership (S.C.)", "jednoosobowa_dzialalnosc_gospodarcza": "Sole proprietorship (JDG)", "sas": "Simplified joint-stock company (SAS)", "sasu": "Single-shareholder simplified joint-stock company (SASU)", "sarl": "Limited liability company (SARL)", "eurl": "Single-member limited liability company (EURL)", "sa": "Public limited company (SA)", "snc": "General partnership (SNC)", "sci": "Civil property company (SCI)", "entreprise_individuelle": "Sole trader (EI)", "association": "Association (Association)" }, "description": "Legal form, from /enums/company-types?country=. The list depends on the country; each market names its own forms (Ltd, BV, ApS, AB, SL, Sp. z o.o.).", "x-enum-by-country": { "GB": [ { "value": "private_limited_company", "label": "Private limited company", "native_label": "Private company limited by shares", "abbreviation": "Ltd", "fundable": true }, { "value": "public_limited_company", "label": "Public limited company", "native_label": "Public limited company", "abbreviation": "PLC", "fundable": true }, { "value": "limited_liability_partnership", "label": "Limited liability partnership", "native_label": "Limited liability partnership", "abbreviation": "LLP", "fundable": true }, { "value": "community_interest_company", "label": "Community interest company", "native_label": "Community interest company", "abbreviation": "CIC", "fundable": true }, { "value": "sole_trader", "label": "Sole trader", "native_label": "Sole trader", "abbreviation": "Sole trader", "fundable": false }, { "value": "general_partnership", "label": "General partnership", "native_label": "Partnership", "abbreviation": "Partnership", "fundable": false }, { "value": "other_not_yet_incorporated", "label": "Other or not yet incorporated", "native_label": "Other or not yet incorporated", "abbreviation": "Other", "fundable": false } ], "US": [ { "value": "limited_liability_company", "label": "Limited liability company", "native_label": "Limited liability company", "abbreviation": "LLC", "fundable": true }, { "value": "c_corporation", "label": "C corporation", "native_label": "C corporation", "abbreviation": "Inc.", "fundable": true }, { "value": "s_corporation", "label": "S corporation", "native_label": "S corporation", "abbreviation": "S corp", "fundable": true }, { "value": "partnership", "label": "Partnership", "native_label": "General or limited partnership", "abbreviation": "LP", "fundable": true }, { "value": "sole_proprietorship", "label": "Sole proprietorship", "native_label": "Sole proprietorship", "abbreviation": "Sole prop.", "fundable": false }, { "value": "nonprofit_corporation", "label": "Nonprofit corporation", "native_label": "Nonprofit corporation", "abbreviation": "501(c)", "fundable": false } ], "CA": [ { "value": "federal_corporation", "label": "Federal corporation", "native_label": "Corporation (CBCA)", "abbreviation": "Inc.", "fundable": true }, { "value": "provincial_corporation", "label": "Provincial corporation", "native_label": "Provincial corporation", "abbreviation": "Inc.", "fundable": true }, { "value": "partnership", "label": "Partnership", "native_label": "General or limited partnership", "abbreviation": "LP", "fundable": true }, { "value": "cooperative", "label": "Cooperative", "native_label": "Cooperative", "abbreviation": "Co-op", "fundable": true }, { "value": "sole_proprietorship", "label": "Sole proprietorship", "native_label": "Sole proprietorship", "abbreviation": "Sole prop.", "fundable": false } ], "AU": [ { "value": "proprietary_limited_company", "label": "Proprietary limited company", "native_label": "Proprietary limited company", "abbreviation": "Pty Ltd", "fundable": true }, { "value": "public_company", "label": "Public company", "native_label": "Public company limited by shares", "abbreviation": "Ltd", "fundable": true }, { "value": "trust", "label": "Trading trust", "native_label": "Discretionary or unit trust with a corporate trustee", "abbreviation": "Trust", "fundable": true }, { "value": "partnership", "label": "Partnership", "native_label": "Partnership", "abbreviation": "Partnership", "fundable": false }, { "value": "sole_trader", "label": "Sole trader", "native_label": "Sole trader", "abbreviation": "Sole trader", "fundable": false } ], "IE": [ { "value": "private_company_limited_by_shares", "label": "Private company limited by shares", "native_label": "Private company limited by shares", "abbreviation": "LTD", "fundable": true }, { "value": "designated_activity_company", "label": "Designated activity company", "native_label": "Designated activity company", "abbreviation": "DAC", "fundable": true }, { "value": "public_limited_company", "label": "Public limited company", "native_label": "Public limited company", "abbreviation": "PLC", "fundable": true }, { "value": "company_limited_by_guarantee", "label": "Company limited by guarantee", "native_label": "Company limited by guarantee", "abbreviation": "CLG", "fundable": false }, { "value": "partnership", "label": "Partnership", "native_label": "Partnership", "abbreviation": "Partnership", "fundable": false }, { "value": "sole_trader", "label": "Sole trader", "native_label": "Sole trader", "abbreviation": "Sole trader", "fundable": false } ], "ES": [ { "value": "sociedad_limitada", "label": "Limited liability company", "native_label": "Sociedad de Responsabilidad Limitada", "abbreviation": "SL", "fundable": true }, { "value": "sociedad_anonima", "label": "Public limited company", "native_label": "Sociedad Anonima", "abbreviation": "SA", "fundable": true }, { "value": "sociedad_cooperativa", "label": "Cooperative", "native_label": "Sociedad Cooperativa", "abbreviation": "S. Coop.", "fundable": true }, { "value": "sociedad_civil", "label": "Civil partnership", "native_label": "Sociedad Civil", "abbreviation": "SC", "fundable": false }, { "value": "comunidad_de_bienes", "label": "Joint ownership", "native_label": "Comunidad de Bienes", "abbreviation": "CB", "fundable": false }, { "value": "autonomo", "label": "Sole trader", "native_label": "Empresario Individual (Autonomo)", "abbreviation": "Autonomo", "fundable": false } ], "NL": [ { "value": "besloten_vennootschap", "label": "Private limited company", "native_label": "Besloten Vennootschap", "abbreviation": "BV", "fundable": true }, { "value": "naamloze_vennootschap", "label": "Public limited company", "native_label": "Naamloze Vennootschap", "abbreviation": "NV", "fundable": true }, { "value": "vennootschap_onder_firma", "label": "General partnership", "native_label": "Vennootschap onder Firma", "abbreviation": "VOF", "fundable": true }, { "value": "commanditaire_vennootschap", "label": "Limited partnership", "native_label": "Commanditaire Vennootschap", "abbreviation": "CV", "fundable": true }, { "value": "cooperatie", "label": "Cooperative", "native_label": "Cooperatie", "abbreviation": "Coop.", "fundable": true }, { "value": "maatschap", "label": "Professional partnership", "native_label": "Maatschap", "abbreviation": "Maatschap", "fundable": false }, { "value": "stichting", "label": "Foundation", "native_label": "Stichting", "abbreviation": "Stichting", "fundable": false }, { "value": "eenmanszaak", "label": "Sole proprietorship", "native_label": "Eenmanszaak", "abbreviation": "Eenmanszaak", "fundable": false } ], "BE": [ { "value": "bv_srl", "label": "Private limited company", "native_label": "Besloten Vennootschap / Societe a Responsabilite Limitee", "abbreviation": "BV / SRL", "fundable": true }, { "value": "nv_sa", "label": "Public limited company", "native_label": "Naamloze Vennootschap / Societe Anonyme", "abbreviation": "NV / SA", "fundable": true }, { "value": "cv_sc", "label": "Cooperative company", "native_label": "Cooperatieve Vennootschap / Societe Cooperative", "abbreviation": "CV / SC", "fundable": true }, { "value": "commv_scomm", "label": "Limited partnership", "native_label": "Commanditaire Vennootschap / Societe en Commandite", "abbreviation": "CommV / SComm", "fundable": true }, { "value": "vof_snc", "label": "General partnership", "native_label": "Vennootschap onder Firma / Societe en Nom Collectif", "abbreviation": "VOF / SNC", "fundable": true }, { "value": "eenmanszaak_entreprise_individuelle", "label": "Sole trader", "native_label": "Eenmanszaak / Entreprise Individuelle", "abbreviation": "Eenmanszaak", "fundable": false } ], "DK": [ { "value": "anpartsselskab", "label": "Private limited company", "native_label": "Anpartsselskab", "abbreviation": "ApS", "fundable": true }, { "value": "aktieselskab", "label": "Public limited company", "native_label": "Aktieselskab", "abbreviation": "A/S", "fundable": true }, { "value": "partnerselskab", "label": "Limited partnership company", "native_label": "Partnerselskab", "abbreviation": "P/S", "fundable": true }, { "value": "interessentskab", "label": "General partnership", "native_label": "Interessentskab", "abbreviation": "I/S", "fundable": true }, { "value": "kommanditselskab", "label": "Limited partnership", "native_label": "Kommanditselskab", "abbreviation": "K/S", "fundable": true }, { "value": "enkeltmandsvirksomhed", "label": "Sole proprietorship", "native_label": "Enkeltmandsvirksomhed", "abbreviation": "Enkeltmandsvirksomhed", "fundable": false }, { "value": "personligt_ejet_mindre_virksomhed", "label": "Small personally owned business", "native_label": "Personligt ejet mindre virksomhed", "abbreviation": "PMV", "fundable": false } ], "SE": [ { "value": "aktiebolag", "label": "Limited company", "native_label": "Aktiebolag", "abbreviation": "AB", "fundable": true }, { "value": "handelsbolag", "label": "General partnership", "native_label": "Handelsbolag", "abbreviation": "HB", "fundable": true }, { "value": "kommanditbolag", "label": "Limited partnership", "native_label": "Kommanditbolag", "abbreviation": "KB", "fundable": true }, { "value": "ekonomisk_forening", "label": "Economic association", "native_label": "Ekonomisk forening", "abbreviation": "Ek. for.", "fundable": true }, { "value": "enskild_firma", "label": "Sole trader", "native_label": "Enskild naringsverksamhet", "abbreviation": "Enskild firma", "fundable": false } ], "PL": [ { "value": "spolka_z_ograniczona_odpowiedzialnoscia", "label": "Limited liability company", "native_label": "Spolka z ograniczona odpowiedzialnoscia", "abbreviation": "Sp. z o.o.", "fundable": true }, { "value": "spolka_akcyjna", "label": "Joint-stock company", "native_label": "Spolka akcyjna", "abbreviation": "S.A.", "fundable": true }, { "value": "prosta_spolka_akcyjna", "label": "Simple joint-stock company", "native_label": "Prosta spolka akcyjna", "abbreviation": "P.S.A.", "fundable": true }, { "value": "spolka_jawna", "label": "General partnership", "native_label": "Spolka jawna", "abbreviation": "Sp. j.", "fundable": true }, { "value": "spolka_komandytowa", "label": "Limited partnership", "native_label": "Spolka komandytowa", "abbreviation": "Sp. k.", "fundable": true }, { "value": "spolka_cywilna", "label": "Civil law partnership", "native_label": "Spolka cywilna", "abbreviation": "S.C.", "fundable": false }, { "value": "jednoosobowa_dzialalnosc_gospodarcza", "label": "Sole proprietorship", "native_label": "Jednoosobowa dzialalnosc gospodarcza", "abbreviation": "JDG", "fundable": false } ], "FR": [ { "value": "sas", "label": "Simplified joint-stock company", "native_label": "Societe par actions simplifiee", "abbreviation": "SAS", "fundable": true }, { "value": "sasu", "label": "Single-shareholder simplified joint-stock company", "native_label": "Societe par actions simplifiee unipersonnelle", "abbreviation": "SASU", "fundable": true }, { "value": "sarl", "label": "Limited liability company", "native_label": "Societe a responsabilite limitee", "abbreviation": "SARL", "fundable": true }, { "value": "eurl", "label": "Single-member limited liability company", "native_label": "Entreprise unipersonnelle a responsabilite limitee", "abbreviation": "EURL", "fundable": true }, { "value": "sa", "label": "Public limited company", "native_label": "Societe anonyme", "abbreviation": "SA", "fundable": true }, { "value": "snc", "label": "General partnership", "native_label": "Societe en nom collectif", "abbreviation": "SNC", "fundable": true }, { "value": "sci", "label": "Civil property company", "native_label": "Societe civile immobiliere", "abbreviation": "SCI", "fundable": false }, { "value": "entreprise_individuelle", "label": "Sole trader", "native_label": "Entreprise individuelle (dont micro-entrepreneur)", "abbreviation": "EI", "fundable": false }, { "value": "association", "label": "Association", "native_label": "Association loi 1901", "abbreviation": "Association", "fundable": false } ] }, "x-enum-depends-on": "country", "x-enum-deprecated": [ "corporation", "limited_liability_company", "private_limited_company", "public_limited_company", "partnership", "sole_trader" ] }, "industry": { "type": [ "string", "null" ], "enum": [ "ecommerce", "restaurant", "construction", "medical", "trucking", "retail", "manufacturing", "saas", "landscaping", "auto_repair", "real_estate", "professional", "hospitality", "pet_care", "pharmacy", "funeral", "liquor", "cbd", "firearms", "vape", "other", null ], "x-enum-labels": { "ecommerce": "E-Commerce / Online Retail", "restaurant": "Restaurant / Food & Beverage", "construction": "Construction / Trades (HVAC, Plumbing, Electrical)", "medical": "Medical / Healthcare", "trucking": "Trucking / Transportation / Logistics", "retail": "Retail / Convenience / Grocery", "manufacturing": "Manufacturing", "saas": "IT Services / Software / SaaS", "landscaping": "Landscaping / Lawn Care", "auto_repair": "Auto Repair / Auto Services", "real_estate": "Real Estate / Property Management", "professional": "Professional Services (Accounting, Marketing, etc.)", "hospitality": "Hospitality / Hotels", "pet_care": "Pet Care / Veterinary", "pharmacy": "Pharmacy", "funeral": "Funeral Services", "liquor": "Liquor Stores", "cbd": "CBD / Cannabis", "firearms": "Guns & Ammo / Firearms", "vape": "Vape / Tobacco / Nicotine", "other": "Other" }, "description": "Industry, from /enums/industries." }, "website_url": { "type": [ "string", "null" ], "description": "http:// or https:// URL." } }, "required": [ "name" ] }, "contact": { "type": "object", "properties": { "first_name": { "type": "string", "description": "" }, "last_name": { "type": "string", "description": "" }, "email": { "type": "string", "description": "Valid email address." }, "phone": { "type": [ "string", "null" ], "description": "" } }, "required": [ "first_name", "last_name", "email" ] }, "funding": { "type": "object", "properties": { "amount": { "type": [ "number", "null" ], "description": "Amount in major units." }, "amount_band": { "type": [ "string", "null" ], "enum": [ "under_25k", "25k_50k", "50k_100k", "100k_250k", "250k_500k", "500k_1m", "1m_2m", "2m_5m", "5m_15m", "15m_50m", null ], "x-enum-labels": { "under_25k": "Under 25K", "25k_50k": "25K – 50K", "50k_100k": "50K – 100K", "100k_250k": "100K – 250K", "250k_500k": "250K – 500K", "500k_1m": "500K – 1M", "1m_2m": "1M – 2M", "2m_5m": "2M – 5M", "5m_15m": "5M – 15M", "15m_50m": "15M – 50M" }, "description": "Band, as an alternative to amount." }, "currency": { "type": [ "string", "null" ], "enum": [ "GBP", "USD", "CAD", "AUD", "EUR", null ], "x-enum-labels": { "GBP": "Pound sterling (£)", "USD": "US dollar ($)", "CAD": "Canadian dollar (C$)", "AUD": "Australian dollar (A$)", "EUR": "Euro (€)" }, "description": "Must match the market currency when sent. Filled in from the market when omitted." }, "purpose": { "type": "string", "enum": [ "Working Capital", "Equipment Purchase", "Inventory", "Expansion / Growth", "Debt Refinancing", "Hiring / Payroll", "Marketing", "Other", "Unpaid invoices / late-paying customers", "Acquisition or property" ], "x-enum-labels": { "Working Capital": "Working Capital", "Equipment Purchase": "Equipment Purchase", "Inventory": "Inventory", "Expansion / Growth": "Expansion / Growth", "Debt Refinancing": "Debt Refinancing", "Hiring / Payroll": "Hiring / Payroll", "Marketing": "Marketing", "Other": "Other", "Unpaid invoices / late-paying customers": "Unpaid invoices / late-paying customers", "Acquisition or property": "Acquisition or property" }, "description": "Purpose, from /enums/purposes." }, "product_family": { "type": [ "string", "null" ], "enum": [ "asset_finance", "bridging", "business_line_of_credit", "invoice_finance", "merchant_cash_advance", "property_development_finance", "term_loan", "trade_finance", "working_capital", null ], "x-enum-labels": { "asset_finance": "Asset finance", "bridging": "Bridging finance", "business_line_of_credit": "Business line of credit", "invoice_finance": "Invoice finance", "merchant_cash_advance": "Revenue-based funding", "property_development_finance": "Property development finance", "term_loan": "Term loan", "trade_finance": "Trade finance", "working_capital": "Working capital" }, "description": "Family, when the business already knows what it wants." } }, "required": [ "purpose" ] }, "trading": { "type": "object", "properties": { "monthly_revenue": { "type": [ "number", "null" ], "description": "Monthly figure in major units." }, "monthly_revenue_band": { "type": [ "string", "null" ], "enum": [ "under_10k", "10k_20k", "20k_50k", "50k_75k", "75k_100k", "100k_250k", "250k_plus", null ], "x-enum-labels": { "under_10k": "Under 10K", "10k_20k": "10K – 20K", "20k_50k": "20K – 50K", "50k_75k": "50K – 75K", "75k_100k": "75K – 100K", "100k_250k": "100K – 250K", "250k_plus": "250K+" }, "description": "Band, as an alternative to monthly_revenue." }, "annual_turnover": { "type": [ "number", "null" ], "description": "Annual figure. Never a monthly one." }, "tib_months": { "type": [ "number", "null" ], "description": "Months trading." }, "time_in_business_band": { "type": [ "string", "null" ], "enum": [ "under_6m", "6_12m", "1_2y", "2y_plus", null ], "x-enum-labels": { "under_6m": "Under 6 months", "6_12m": "6 – 12 months", "1_2y": "1 – 2 years", "2y_plus": "2+ years" }, "description": "Band, as an alternative to tib_months." }, "credit_score_band": { "type": [ "string", "null" ], "enum": [ "below_500", "500_549", "550_599", "600_649", "650_699", "700_plus", null ], "x-enum-labels": { "below_500": "Below 500", "500_549": "500 – 549", "550_599": "550 – 599", "600_649": "600 – 649", "650_699": "650 – 699", "700_plus": "700+" }, "description": "Self-reported band. Required before submit in the US and Canada." } } }, "location": { "type": "object", "properties": { "region": { "type": [ "string", "null" ], "description": "US state or Canadian province." } } }, "consent": { "$ref": "#/components/schemas/Consent" } }, "required": [ "country", "business", "contact", "funding", "consent" ] }, "LeadPatch": { "type": "object", "description": "Any subset of the create body. Only the fields present are changed. Refused once the lead is submitted.", "additionalProperties": true }, "Lead": { "type": "object", "description": "The full lead: a common core plus exactly one market block (uk, us, ca or other), the options matched, the offers received, the documents held, and a timeline.", "properties": { "id": { "type": "string", "description": "Lead id." }, "reference": { "type": "string", "description": "Short quotable reference, for example CV-3F2A1B4C." }, "partner_reference": { "type": [ "string", "null" ], "description": "Your own identifier, as sent." }, "state": { "$ref": "#/components/schemas/LeadState" }, "environment": { "type": "string", "enum": [ "live", "sandbox" ] }, "country": { "type": [ "string", "null" ], "enum": [ "UK", "US", "CA", "AU", "IE", "ES", "NL", "BE", "DK", "SE", "PL", "FR", null ], "x-enum-labels": { "UK": "United Kingdom", "US": "United States", "CA": "Canada", "AU": "Australia", "IE": "Ireland", "ES": "Spain", "NL": "Netherlands", "BE": "Belgium", "DK": "Denmark", "SE": "Sweden", "PL": "Poland", "FR": "France" }, "description": "Stored market code.", "x-enum-flags": { "UK": "🇬🇧", "US": "🇺🇸", "CA": "🇨🇦", "AU": "🇦🇺", "IE": "🇮🇪", "ES": "🇪🇸", "NL": "🇳🇱", "BE": "🇧🇪", "DK": "🇩🇰", "SE": "🇸🇪", "PL": "🇵🇱", "FR": "🇫🇷" } }, "currency": { "type": [ "string", "null" ], "enum": [ "GBP", "USD", "CAD", "AUD", "EUR", null ], "x-enum-labels": { "GBP": "Pound sterling (£)", "USD": "US dollar ($)", "CAD": "Canadian dollar (C$)", "AUD": "Australian dollar (A$)", "EUR": "Euro (€)" }, "description": "Currency every figure is quoted in." }, "channel": { "type": "object", "description": "The brand the client applied through: your own channel name and domain. Address the client by it.", "properties": { "name": { "type": [ "string", "null" ], "description": "The channel name the client knows." }, "domain": { "type": [ "string", "null" ], "description": "The domain the client used." } } }, "business": { "type": "object", "properties": { "name": { "type": [ "string", "null" ], "description": "" }, "company_number": { "type": [ "string", "null" ], "description": "" }, "entity_type": { "type": [ "string", "null" ], "enum": [ "private_limited_company", "public_limited_company", "limited_liability_partnership", "community_interest_company", "sole_trader", "general_partnership", "other_not_yet_incorporated", "limited_liability_company", "c_corporation", "s_corporation", "partnership", "sole_proprietorship", "nonprofit_corporation", "corporation", "federal_corporation", "provincial_corporation", "cooperative", "proprietary_limited_company", "public_company", "trust", "private_company_limited_by_shares", "designated_activity_company", "company_limited_by_guarantee", "sociedad_limitada", "sociedad_anonima", "sociedad_cooperativa", "sociedad_civil", "comunidad_de_bienes", "autonomo", "besloten_vennootschap", "naamloze_vennootschap", "vennootschap_onder_firma", "commanditaire_vennootschap", "cooperatie", "maatschap", "stichting", "eenmanszaak", "bv_srl", "nv_sa", "cv_sc", "commv_scomm", "vof_snc", "eenmanszaak_entreprise_individuelle", "anpartsselskab", "aktieselskab", "partnerselskab", "interessentskab", "kommanditselskab", "enkeltmandsvirksomhed", "personligt_ejet_mindre_virksomhed", "aktiebolag", "handelsbolag", "kommanditbolag", "ekonomisk_forening", "enskild_firma", "spolka_z_ograniczona_odpowiedzialnoscia", "spolka_akcyjna", "prosta_spolka_akcyjna", "spolka_jawna", "spolka_komandytowa", "spolka_cywilna", "jednoosobowa_dzialalnosc_gospodarcza", "sas", "sasu", "sarl", "eurl", "sa", "snc", "sci", "entreprise_individuelle", "association", null ], "x-enum-labels": { "private_limited_company": "Private limited company (Ltd)", "public_limited_company": "Public limited company (PLC)", "limited_liability_partnership": "Limited liability partnership (LLP)", "community_interest_company": "Community interest company (CIC)", "sole_trader": "Sole trader (Sole trader)", "general_partnership": "General partnership (Partnership)", "other_not_yet_incorporated": "Other or not yet incorporated (Other)", "limited_liability_company": "Limited liability company (LLC)", "c_corporation": "C corporation (Inc.)", "s_corporation": "S corporation (S corp)", "partnership": "Partnership (LP)", "sole_proprietorship": "Sole proprietorship (Sole prop.)", "nonprofit_corporation": "Nonprofit corporation (501(c))", "corporation": "Corporation", "federal_corporation": "Federal corporation (Inc.)", "provincial_corporation": "Provincial corporation (Inc.)", "cooperative": "Cooperative (Co-op)", "proprietary_limited_company": "Proprietary limited company (Pty Ltd)", "public_company": "Public company (Ltd)", "trust": "Trading trust (Trust)", "private_company_limited_by_shares": "Private company limited by shares (LTD)", "designated_activity_company": "Designated activity company (DAC)", "company_limited_by_guarantee": "Company limited by guarantee (CLG)", "sociedad_limitada": "Limited liability company (SL)", "sociedad_anonima": "Public limited company (SA)", "sociedad_cooperativa": "Cooperative (S. Coop.)", "sociedad_civil": "Civil partnership (SC)", "comunidad_de_bienes": "Joint ownership (CB)", "autonomo": "Sole trader (Autonomo)", "besloten_vennootschap": "Private limited company (BV)", "naamloze_vennootschap": "Public limited company (NV)", "vennootschap_onder_firma": "General partnership (VOF)", "commanditaire_vennootschap": "Limited partnership (CV)", "cooperatie": "Cooperative (Coop.)", "maatschap": "Professional partnership (Maatschap)", "stichting": "Foundation (Stichting)", "eenmanszaak": "Sole proprietorship (Eenmanszaak)", "bv_srl": "Private limited company (BV / SRL)", "nv_sa": "Public limited company (NV / SA)", "cv_sc": "Cooperative company (CV / SC)", "commv_scomm": "Limited partnership (CommV / SComm)", "vof_snc": "General partnership (VOF / SNC)", "eenmanszaak_entreprise_individuelle": "Sole trader (Eenmanszaak)", "anpartsselskab": "Private limited company (ApS)", "aktieselskab": "Public limited company (A/S)", "partnerselskab": "Limited partnership company (P/S)", "interessentskab": "General partnership (I/S)", "kommanditselskab": "Limited partnership (K/S)", "enkeltmandsvirksomhed": "Sole proprietorship (Enkeltmandsvirksomhed)", "personligt_ejet_mindre_virksomhed": "Small personally owned business (PMV)", "aktiebolag": "Limited company (AB)", "handelsbolag": "General partnership (HB)", "kommanditbolag": "Limited partnership (KB)", "ekonomisk_forening": "Economic association (Ek. for.)", "enskild_firma": "Sole trader (Enskild firma)", "spolka_z_ograniczona_odpowiedzialnoscia": "Limited liability company (Sp. z o.o.)", "spolka_akcyjna": "Joint-stock company (S.A.)", "prosta_spolka_akcyjna": "Simple joint-stock company (P.S.A.)", "spolka_jawna": "General partnership (Sp. j.)", "spolka_komandytowa": "Limited partnership (Sp. k.)", "spolka_cywilna": "Civil law partnership (S.C.)", "jednoosobowa_dzialalnosc_gospodarcza": "Sole proprietorship (JDG)", "sas": "Simplified joint-stock company (SAS)", "sasu": "Single-shareholder simplified joint-stock company (SASU)", "sarl": "Limited liability company (SARL)", "eurl": "Single-member limited liability company (EURL)", "sa": "Public limited company (SA)", "snc": "General partnership (SNC)", "sci": "Civil property company (SCI)", "entreprise_individuelle": "Sole trader (EI)", "association": "Association (Association)" }, "description": "Legal form, as sent.", "x-enum-by-country": { "GB": [ { "value": "private_limited_company", "label": "Private limited company", "native_label": "Private company limited by shares", "abbreviation": "Ltd", "fundable": true }, { "value": "public_limited_company", "label": "Public limited company", "native_label": "Public limited company", "abbreviation": "PLC", "fundable": true }, { "value": "limited_liability_partnership", "label": "Limited liability partnership", "native_label": "Limited liability partnership", "abbreviation": "LLP", "fundable": true }, { "value": "community_interest_company", "label": "Community interest company", "native_label": "Community interest company", "abbreviation": "CIC", "fundable": true }, { "value": "sole_trader", "label": "Sole trader", "native_label": "Sole trader", "abbreviation": "Sole trader", "fundable": false }, { "value": "general_partnership", "label": "General partnership", "native_label": "Partnership", "abbreviation": "Partnership", "fundable": false }, { "value": "other_not_yet_incorporated", "label": "Other or not yet incorporated", "native_label": "Other or not yet incorporated", "abbreviation": "Other", "fundable": false } ], "US": [ { "value": "limited_liability_company", "label": "Limited liability company", "native_label": "Limited liability company", "abbreviation": "LLC", "fundable": true }, { "value": "c_corporation", "label": "C corporation", "native_label": "C corporation", "abbreviation": "Inc.", "fundable": true }, { "value": "s_corporation", "label": "S corporation", "native_label": "S corporation", "abbreviation": "S corp", "fundable": true }, { "value": "partnership", "label": "Partnership", "native_label": "General or limited partnership", "abbreviation": "LP", "fundable": true }, { "value": "sole_proprietorship", "label": "Sole proprietorship", "native_label": "Sole proprietorship", "abbreviation": "Sole prop.", "fundable": false }, { "value": "nonprofit_corporation", "label": "Nonprofit corporation", "native_label": "Nonprofit corporation", "abbreviation": "501(c)", "fundable": false } ], "CA": [ { "value": "federal_corporation", "label": "Federal corporation", "native_label": "Corporation (CBCA)", "abbreviation": "Inc.", "fundable": true }, { "value": "provincial_corporation", "label": "Provincial corporation", "native_label": "Provincial corporation", "abbreviation": "Inc.", "fundable": true }, { "value": "partnership", "label": "Partnership", "native_label": "General or limited partnership", "abbreviation": "LP", "fundable": true }, { "value": "cooperative", "label": "Cooperative", "native_label": "Cooperative", "abbreviation": "Co-op", "fundable": true }, { "value": "sole_proprietorship", "label": "Sole proprietorship", "native_label": "Sole proprietorship", "abbreviation": "Sole prop.", "fundable": false } ], "AU": [ { "value": "proprietary_limited_company", "label": "Proprietary limited company", "native_label": "Proprietary limited company", "abbreviation": "Pty Ltd", "fundable": true }, { "value": "public_company", "label": "Public company", "native_label": "Public company limited by shares", "abbreviation": "Ltd", "fundable": true }, { "value": "trust", "label": "Trading trust", "native_label": "Discretionary or unit trust with a corporate trustee", "abbreviation": "Trust", "fundable": true }, { "value": "partnership", "label": "Partnership", "native_label": "Partnership", "abbreviation": "Partnership", "fundable": false }, { "value": "sole_trader", "label": "Sole trader", "native_label": "Sole trader", "abbreviation": "Sole trader", "fundable": false } ], "IE": [ { "value": "private_company_limited_by_shares", "label": "Private company limited by shares", "native_label": "Private company limited by shares", "abbreviation": "LTD", "fundable": true }, { "value": "designated_activity_company", "label": "Designated activity company", "native_label": "Designated activity company", "abbreviation": "DAC", "fundable": true }, { "value": "public_limited_company", "label": "Public limited company", "native_label": "Public limited company", "abbreviation": "PLC", "fundable": true }, { "value": "company_limited_by_guarantee", "label": "Company limited by guarantee", "native_label": "Company limited by guarantee", "abbreviation": "CLG", "fundable": false }, { "value": "partnership", "label": "Partnership", "native_label": "Partnership", "abbreviation": "Partnership", "fundable": false }, { "value": "sole_trader", "label": "Sole trader", "native_label": "Sole trader", "abbreviation": "Sole trader", "fundable": false } ], "ES": [ { "value": "sociedad_limitada", "label": "Limited liability company", "native_label": "Sociedad de Responsabilidad Limitada", "abbreviation": "SL", "fundable": true }, { "value": "sociedad_anonima", "label": "Public limited company", "native_label": "Sociedad Anonima", "abbreviation": "SA", "fundable": true }, { "value": "sociedad_cooperativa", "label": "Cooperative", "native_label": "Sociedad Cooperativa", "abbreviation": "S. Coop.", "fundable": true }, { "value": "sociedad_civil", "label": "Civil partnership", "native_label": "Sociedad Civil", "abbreviation": "SC", "fundable": false }, { "value": "comunidad_de_bienes", "label": "Joint ownership", "native_label": "Comunidad de Bienes", "abbreviation": "CB", "fundable": false }, { "value": "autonomo", "label": "Sole trader", "native_label": "Empresario Individual (Autonomo)", "abbreviation": "Autonomo", "fundable": false } ], "NL": [ { "value": "besloten_vennootschap", "label": "Private limited company", "native_label": "Besloten Vennootschap", "abbreviation": "BV", "fundable": true }, { "value": "naamloze_vennootschap", "label": "Public limited company", "native_label": "Naamloze Vennootschap", "abbreviation": "NV", "fundable": true }, { "value": "vennootschap_onder_firma", "label": "General partnership", "native_label": "Vennootschap onder Firma", "abbreviation": "VOF", "fundable": true }, { "value": "commanditaire_vennootschap", "label": "Limited partnership", "native_label": "Commanditaire Vennootschap", "abbreviation": "CV", "fundable": true }, { "value": "cooperatie", "label": "Cooperative", "native_label": "Cooperatie", "abbreviation": "Coop.", "fundable": true }, { "value": "maatschap", "label": "Professional partnership", "native_label": "Maatschap", "abbreviation": "Maatschap", "fundable": false }, { "value": "stichting", "label": "Foundation", "native_label": "Stichting", "abbreviation": "Stichting", "fundable": false }, { "value": "eenmanszaak", "label": "Sole proprietorship", "native_label": "Eenmanszaak", "abbreviation": "Eenmanszaak", "fundable": false } ], "BE": [ { "value": "bv_srl", "label": "Private limited company", "native_label": "Besloten Vennootschap / Societe a Responsabilite Limitee", "abbreviation": "BV / SRL", "fundable": true }, { "value": "nv_sa", "label": "Public limited company", "native_label": "Naamloze Vennootschap / Societe Anonyme", "abbreviation": "NV / SA", "fundable": true }, { "value": "cv_sc", "label": "Cooperative company", "native_label": "Cooperatieve Vennootschap / Societe Cooperative", "abbreviation": "CV / SC", "fundable": true }, { "value": "commv_scomm", "label": "Limited partnership", "native_label": "Commanditaire Vennootschap / Societe en Commandite", "abbreviation": "CommV / SComm", "fundable": true }, { "value": "vof_snc", "label": "General partnership", "native_label": "Vennootschap onder Firma / Societe en Nom Collectif", "abbreviation": "VOF / SNC", "fundable": true }, { "value": "eenmanszaak_entreprise_individuelle", "label": "Sole trader", "native_label": "Eenmanszaak / Entreprise Individuelle", "abbreviation": "Eenmanszaak", "fundable": false } ], "DK": [ { "value": "anpartsselskab", "label": "Private limited company", "native_label": "Anpartsselskab", "abbreviation": "ApS", "fundable": true }, { "value": "aktieselskab", "label": "Public limited company", "native_label": "Aktieselskab", "abbreviation": "A/S", "fundable": true }, { "value": "partnerselskab", "label": "Limited partnership company", "native_label": "Partnerselskab", "abbreviation": "P/S", "fundable": true }, { "value": "interessentskab", "label": "General partnership", "native_label": "Interessentskab", "abbreviation": "I/S", "fundable": true }, { "value": "kommanditselskab", "label": "Limited partnership", "native_label": "Kommanditselskab", "abbreviation": "K/S", "fundable": true }, { "value": "enkeltmandsvirksomhed", "label": "Sole proprietorship", "native_label": "Enkeltmandsvirksomhed", "abbreviation": "Enkeltmandsvirksomhed", "fundable": false }, { "value": "personligt_ejet_mindre_virksomhed", "label": "Small personally owned business", "native_label": "Personligt ejet mindre virksomhed", "abbreviation": "PMV", "fundable": false } ], "SE": [ { "value": "aktiebolag", "label": "Limited company", "native_label": "Aktiebolag", "abbreviation": "AB", "fundable": true }, { "value": "handelsbolag", "label": "General partnership", "native_label": "Handelsbolag", "abbreviation": "HB", "fundable": true }, { "value": "kommanditbolag", "label": "Limited partnership", "native_label": "Kommanditbolag", "abbreviation": "KB", "fundable": true }, { "value": "ekonomisk_forening", "label": "Economic association", "native_label": "Ekonomisk forening", "abbreviation": "Ek. for.", "fundable": true }, { "value": "enskild_firma", "label": "Sole trader", "native_label": "Enskild naringsverksamhet", "abbreviation": "Enskild firma", "fundable": false } ], "PL": [ { "value": "spolka_z_ograniczona_odpowiedzialnoscia", "label": "Limited liability company", "native_label": "Spolka z ograniczona odpowiedzialnoscia", "abbreviation": "Sp. z o.o.", "fundable": true }, { "value": "spolka_akcyjna", "label": "Joint-stock company", "native_label": "Spolka akcyjna", "abbreviation": "S.A.", "fundable": true }, { "value": "prosta_spolka_akcyjna", "label": "Simple joint-stock company", "native_label": "Prosta spolka akcyjna", "abbreviation": "P.S.A.", "fundable": true }, { "value": "spolka_jawna", "label": "General partnership", "native_label": "Spolka jawna", "abbreviation": "Sp. j.", "fundable": true }, { "value": "spolka_komandytowa", "label": "Limited partnership", "native_label": "Spolka komandytowa", "abbreviation": "Sp. k.", "fundable": true }, { "value": "spolka_cywilna", "label": "Civil law partnership", "native_label": "Spolka cywilna", "abbreviation": "S.C.", "fundable": false }, { "value": "jednoosobowa_dzialalnosc_gospodarcza", "label": "Sole proprietorship", "native_label": "Jednoosobowa dzialalnosc gospodarcza", "abbreviation": "JDG", "fundable": false } ], "FR": [ { "value": "sas", "label": "Simplified joint-stock company", "native_label": "Societe par actions simplifiee", "abbreviation": "SAS", "fundable": true }, { "value": "sasu", "label": "Single-shareholder simplified joint-stock company", "native_label": "Societe par actions simplifiee unipersonnelle", "abbreviation": "SASU", "fundable": true }, { "value": "sarl", "label": "Limited liability company", "native_label": "Societe a responsabilite limitee", "abbreviation": "SARL", "fundable": true }, { "value": "eurl", "label": "Single-member limited liability company", "native_label": "Entreprise unipersonnelle a responsabilite limitee", "abbreviation": "EURL", "fundable": true }, { "value": "sa", "label": "Public limited company", "native_label": "Societe anonyme", "abbreviation": "SA", "fundable": true }, { "value": "snc", "label": "General partnership", "native_label": "Societe en nom collectif", "abbreviation": "SNC", "fundable": true }, { "value": "sci", "label": "Civil property company", "native_label": "Societe civile immobiliere", "abbreviation": "SCI", "fundable": false }, { "value": "entreprise_individuelle", "label": "Sole trader", "native_label": "Entreprise individuelle (dont micro-entrepreneur)", "abbreviation": "EI", "fundable": false }, { "value": "association", "label": "Association", "native_label": "Association loi 1901", "abbreviation": "Association", "fundable": false } ] }, "x-enum-depends-on": "country", "x-enum-deprecated": [ "corporation", "limited_liability_company", "private_limited_company", "public_limited_company", "partnership", "sole_trader" ] }, "industry": { "type": [ "string", "null" ], "enum": [ "ecommerce", "restaurant", "construction", "medical", "trucking", "retail", "manufacturing", "saas", "landscaping", "auto_repair", "real_estate", "professional", "hospitality", "pet_care", "pharmacy", "funeral", "liquor", "cbd", "firearms", "vape", "other", null ], "x-enum-labels": { "ecommerce": "E-Commerce / Online Retail", "restaurant": "Restaurant / Food & Beverage", "construction": "Construction / Trades (HVAC, Plumbing, Electrical)", "medical": "Medical / Healthcare", "trucking": "Trucking / Transportation / Logistics", "retail": "Retail / Convenience / Grocery", "manufacturing": "Manufacturing", "saas": "IT Services / Software / SaaS", "landscaping": "Landscaping / Lawn Care", "auto_repair": "Auto Repair / Auto Services", "real_estate": "Real Estate / Property Management", "professional": "Professional Services (Accounting, Marketing, etc.)", "hospitality": "Hospitality / Hotels", "pet_care": "Pet Care / Veterinary", "pharmacy": "Pharmacy", "funeral": "Funeral Services", "liquor": "Liquor Stores", "cbd": "CBD / Cannabis", "firearms": "Guns & Ammo / Firearms", "vape": "Vape / Tobacco / Nicotine", "other": "Other" }, "description": "Industry, as sent." }, "registry": { "anyOf": [ { "$ref": "#/components/schemas/Registry" }, { "type": "null" } ], "description": "Public register facts for the business, the same object the Lender API returns on a deal. Null where no register is connected for the country; status not_fetched until the first lookup has run." }, "vat": { "anyOf": [ { "$ref": "#/components/schemas/Vat" }, { "type": "null" } ], "description": "The VAT registration check: the EU register check for EU markets, the national check for the UK when the applicant gave a VAT number. Number with country prefix, validity, when it was checked, and the registered name and address the VAT register returned (Spain masks both). Null where no VAT register check applies (US, CA, AU) or no VAT number is known yet." } } }, "contact": { "type": "object", "properties": { "first_name": { "type": [ "string", "null" ], "description": "" }, "last_name": { "type": [ "string", "null" ], "description": "" }, "email": { "type": [ "string", "null" ], "description": "" }, "phone": { "type": [ "string", "null" ], "description": "" } } }, "funding": { "type": "object", "properties": { "amount": { "type": [ "number", "null" ], "description": "" }, "amount_band": { "type": [ "string", "null" ], "enum": [ "under_25k", "25k_50k", "50k_100k", "100k_250k", "250k_500k", "500k_1m", "1m_2m", "2m_5m", "5m_15m", "15m_50m", null ], "x-enum-labels": { "under_25k": "Under 25K", "25k_50k": "25K – 50K", "50k_100k": "50K – 100K", "100k_250k": "100K – 250K", "250k_500k": "250K – 500K", "500k_1m": "500K – 1M", "1m_2m": "1M – 2M", "2m_5m": "2M – 5M", "5m_15m": "5M – 15M", "15m_50m": "15M – 50M" }, "description": "" }, "amount_basis": { "type": [ "string", "null" ], "enum": [ "band_midpoint", "reported", null ], "description": "band_midpoint: the midpoint of the band that was selected, not a reported figure." }, "currency": { "type": [ "string", "null" ], "enum": [ "GBP", "USD", "CAD", "AUD", "EUR", null ], "x-enum-labels": { "GBP": "Pound sterling (£)", "USD": "US dollar ($)", "CAD": "Canadian dollar (C$)", "AUD": "Australian dollar (A$)", "EUR": "Euro (€)" }, "description": "" }, "purpose": { "type": [ "string", "null" ], "enum": [ "Working Capital", "Equipment Purchase", "Inventory", "Expansion / Growth", "Debt Refinancing", "Hiring / Payroll", "Marketing", "Other", "Unpaid invoices / late-paying customers", "Acquisition or property", null ], "x-enum-labels": { "Working Capital": "Working Capital", "Equipment Purchase": "Equipment Purchase", "Inventory": "Inventory", "Expansion / Growth": "Expansion / Growth", "Debt Refinancing": "Debt Refinancing", "Hiring / Payroll": "Hiring / Payroll", "Marketing": "Marketing", "Other": "Other", "Unpaid invoices / late-paying customers": "Unpaid invoices / late-paying customers", "Acquisition or property": "Acquisition or property" }, "description": "" }, "product_family": { "type": [ "string", "null" ], "enum": [ "asset_finance", "bridging", "business_line_of_credit", "invoice_finance", "merchant_cash_advance", "property_development_finance", "term_loan", "trade_finance", "working_capital", null ], "x-enum-labels": { "asset_finance": "Asset finance", "bridging": "Bridging finance", "business_line_of_credit": "Business line of credit", "invoice_finance": "Invoice finance", "merchant_cash_advance": "Revenue-based funding", "property_development_finance": "Property development finance", "term_loan": "Term loan", "trade_finance": "Trade finance", "working_capital": "Working capital" }, "description": "" } } }, "trading": { "type": "object", "properties": { "monthly_revenue": { "type": [ "number", "null" ], "description": "Monthly figure; read monthly_revenue_basis." }, "monthly_revenue_band": { "type": [ "string", "null" ], "enum": [ "under_10k", "10k_20k", "20k_50k", "50k_75k", "75k_100k", "100k_250k", "250k_plus", null ], "x-enum-labels": { "under_10k": "Under 10K", "10k_20k": "10K – 20K", "20k_50k": "20K – 50K", "50k_75k": "50K – 75K", "75k_100k": "75K – 100K", "100k_250k": "100K – 250K", "250k_plus": "250K+" }, "description": "" }, "monthly_revenue_basis": { "type": [ "string", "null" ], "enum": [ "statements", "band_midpoint", "reported", null ], "description": "statements: the parsed statements average once they are in. band_midpoint: the midpoint of the band sent. reported: the figure sent." }, "annual_turnover": { "type": [ "number", "null" ], "description": "Annual figure. The latest filed accounts where the register carries them, else the figure sent. Never a monthly one." }, "annual_turnover_basis": { "type": [ "string", "null" ], "enum": [ "filed_accounts", "reported", null ], "description": "filed_accounts: from the latest filed accounts on the register. reported: the figure sent." }, "time_in_business_band": { "type": [ "string", "null" ], "enum": [ "under_6m", "6_12m", "1_2y", "2y_plus", null ], "x-enum-labels": { "under_6m": "Under 6 months", "6_12m": "6 – 12 months", "1_2y": "1 – 2 years", "2y_plus": "2+ years" }, "description": "" }, "tib_months": { "type": [ "number", "null" ], "description": "Months trading. From the register incorporation date where the register is connected; read tib_months_basis." }, "tib_months_basis": { "type": [ "string", "null" ], "enum": [ "register", "band_midpoint", "reported", null ], "description": "register: from the incorporation date on the company register, which wins whenever it holds a date. band_midpoint: the midpoint of the band sent. reported: an exact start date or figure sent." }, "credit_score_band": { "type": [ "string", "null" ], "enum": [ "below_500", "500_549", "550_599", "600_649", "650_699", "700_plus", null ], "x-enum-labels": { "below_500": "Below 500", "500_549": "500 – 549", "550_599": "550 – 599", "600_649": "600 – 649", "650_699": "650 – 699", "700_plus": "700+" }, "description": "" } } }, "consent": { "type": "object", "properties": { "obtained": { "type": "boolean", "description": "" }, "obtained_at": { "type": [ "string", "null" ], "description": "" } } }, "significant_persons": { "type": "array", "items": { "$ref": "#/components/schemas/SignificantPerson" } }, "steps": { "type": "object", "description": "A checklist alongside the state, so an integration can show progress without interpreting the state machine.", "properties": { "organisation_details_complete": { "type": "boolean", "description": "" }, "significant_persons_complete": { "type": "boolean", "description": "" }, "documents_complete": { "type": "boolean", "description": "" }, "offer_step_complete": { "type": "boolean", "description": "" } } }, "matched_options": { "type": "integer", "description": "How many funding options matched." }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/MatchedOption" } }, "offers": { "type": "array", "items": { "$ref": "#/components/schemas/Offer" } }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/Document" } }, "statements": { "type": "object", "properties": { "has_statements": { "type": "boolean", "description": "" }, "uploaded_at": { "type": [ "string", "null" ], "description": "" }, "account_kind": { "type": [ "string", "null" ], "enum": [ "bank", "fintech", "unknown", null ] } } }, "funding_outcome": { "type": "object", "properties": { "funded_at": { "type": [ "string", "null" ], "description": "" }, "funded_amount": { "type": [ "number", "null" ], "description": "" } } }, "timeline": { "type": "array", "items": { "type": "object", "properties": { "event": { "type": "string", "description": "" }, "occurred_at": { "type": "string", "description": "" } }, "required": [ "event", "occurred_at" ] } }, "upload_url": { "type": [ "string", "null" ], "description": "A link the business can use to upload statements itself." }, "submitted_at": { "type": [ "string", "null" ], "description": "" }, "created_at": { "type": "string", "description": "" }, "updated_at": { "type": "string", "description": "" }, "uk": { "anyOf": [ { "$ref": "#/components/schemas/LeadUkBlock" }, { "type": "null" } ] }, "us": { "anyOf": [ { "$ref": "#/components/schemas/LeadMarketBlock" }, { "type": "null" } ] }, "ca": { "anyOf": [ { "$ref": "#/components/schemas/LeadMarketBlock" }, { "type": "null" } ] }, "other": { "anyOf": [ { "$ref": "#/components/schemas/LeadOtherBlock" }, { "type": "null" } ] } }, "required": [ "id", "reference", "state", "environment", "business", "contact", "funding", "trading", "created_at", "updated_at" ] }, "LeadState": { "type": "string", "enum": [ "draft", "submitted", "matched", "offers_available", "offer_accepted", "funded", "declined", "out_of_scope" ], "description": "draft: still collecting what the market requires. submitted: handed to the panel. matched: at least one option matched. offers_available: one or more offers are on the lead. offer_accepted: the business chose one. funded: drawn. declined: nothing remains. out_of_scope: outside every market or sector we serve." }, "LeadUkBlock": { "type": "object", "description": "Present only for UK leads; null otherwise.", "properties": { "companies_house_number": { "type": [ "string", "null" ], "description": "" }, "entity_type": { "type": [ "string", "null" ], "enum": [ "private_limited_company", "public_limited_company", "limited_liability_partnership", "community_interest_company", "sole_trader", "general_partnership", "other_not_yet_incorporated", "limited_liability_company", "c_corporation", "s_corporation", "partnership", "sole_proprietorship", "nonprofit_corporation", "corporation", "federal_corporation", "provincial_corporation", "cooperative", "proprietary_limited_company", "public_company", "trust", "private_company_limited_by_shares", "designated_activity_company", "company_limited_by_guarantee", "sociedad_limitada", "sociedad_anonima", "sociedad_cooperativa", "sociedad_civil", "comunidad_de_bienes", "autonomo", "besloten_vennootschap", "naamloze_vennootschap", "vennootschap_onder_firma", "commanditaire_vennootschap", "cooperatie", "maatschap", "stichting", "eenmanszaak", "bv_srl", "nv_sa", "cv_sc", "commv_scomm", "vof_snc", "eenmanszaak_entreprise_individuelle", "anpartsselskab", "aktieselskab", "partnerselskab", "interessentskab", "kommanditselskab", "enkeltmandsvirksomhed", "personligt_ejet_mindre_virksomhed", "aktiebolag", "handelsbolag", "kommanditbolag", "ekonomisk_forening", "enskild_firma", "spolka_z_ograniczona_odpowiedzialnoscia", "spolka_akcyjna", "prosta_spolka_akcyjna", "spolka_jawna", "spolka_komandytowa", "spolka_cywilna", "jednoosobowa_dzialalnosc_gospodarcza", "sas", "sasu", "sarl", "eurl", "sa", "snc", "sci", "entreprise_individuelle", "association", null ], "x-enum-labels": { "private_limited_company": "Private limited company (Ltd)", "public_limited_company": "Public limited company (PLC)", "limited_liability_partnership": "Limited liability partnership (LLP)", "community_interest_company": "Community interest company (CIC)", "sole_trader": "Sole trader (Sole trader)", "general_partnership": "General partnership (Partnership)", "other_not_yet_incorporated": "Other or not yet incorporated (Other)", "limited_liability_company": "Limited liability company (LLC)", "c_corporation": "C corporation (Inc.)", "s_corporation": "S corporation (S corp)", "partnership": "Partnership (LP)", "sole_proprietorship": "Sole proprietorship (Sole prop.)", "nonprofit_corporation": "Nonprofit corporation (501(c))", "corporation": "Corporation", "federal_corporation": "Federal corporation (Inc.)", "provincial_corporation": "Provincial corporation (Inc.)", "cooperative": "Cooperative (Co-op)", "proprietary_limited_company": "Proprietary limited company (Pty Ltd)", "public_company": "Public company (Ltd)", "trust": "Trading trust (Trust)", "private_company_limited_by_shares": "Private company limited by shares (LTD)", "designated_activity_company": "Designated activity company (DAC)", "company_limited_by_guarantee": "Company limited by guarantee (CLG)", "sociedad_limitada": "Limited liability company (SL)", "sociedad_anonima": "Public limited company (SA)", "sociedad_cooperativa": "Cooperative (S. Coop.)", "sociedad_civil": "Civil partnership (SC)", "comunidad_de_bienes": "Joint ownership (CB)", "autonomo": "Sole trader (Autonomo)", "besloten_vennootschap": "Private limited company (BV)", "naamloze_vennootschap": "Public limited company (NV)", "vennootschap_onder_firma": "General partnership (VOF)", "commanditaire_vennootschap": "Limited partnership (CV)", "cooperatie": "Cooperative (Coop.)", "maatschap": "Professional partnership (Maatschap)", "stichting": "Foundation (Stichting)", "eenmanszaak": "Sole proprietorship (Eenmanszaak)", "bv_srl": "Private limited company (BV / SRL)", "nv_sa": "Public limited company (NV / SA)", "cv_sc": "Cooperative company (CV / SC)", "commv_scomm": "Limited partnership (CommV / SComm)", "vof_snc": "General partnership (VOF / SNC)", "eenmanszaak_entreprise_individuelle": "Sole trader (Eenmanszaak)", "anpartsselskab": "Private limited company (ApS)", "aktieselskab": "Public limited company (A/S)", "partnerselskab": "Limited partnership company (P/S)", "interessentskab": "General partnership (I/S)", "kommanditselskab": "Limited partnership (K/S)", "enkeltmandsvirksomhed": "Sole proprietorship (Enkeltmandsvirksomhed)", "personligt_ejet_mindre_virksomhed": "Small personally owned business (PMV)", "aktiebolag": "Limited company (AB)", "handelsbolag": "General partnership (HB)", "kommanditbolag": "Limited partnership (KB)", "ekonomisk_forening": "Economic association (Ek. for.)", "enskild_firma": "Sole trader (Enskild firma)", "spolka_z_ograniczona_odpowiedzialnoscia": "Limited liability company (Sp. z o.o.)", "spolka_akcyjna": "Joint-stock company (S.A.)", "prosta_spolka_akcyjna": "Simple joint-stock company (P.S.A.)", "spolka_jawna": "General partnership (Sp. j.)", "spolka_komandytowa": "Limited partnership (Sp. k.)", "spolka_cywilna": "Civil law partnership (S.C.)", "jednoosobowa_dzialalnosc_gospodarcza": "Sole proprietorship (JDG)", "sas": "Simplified joint-stock company (SAS)", "sasu": "Single-shareholder simplified joint-stock company (SASU)", "sarl": "Limited liability company (SARL)", "eurl": "Single-member limited liability company (EURL)", "sa": "Public limited company (SA)", "snc": "General partnership (SNC)", "sci": "Civil property company (SCI)", "entreprise_individuelle": "Sole trader (EI)", "association": "Association (Association)" }, "description": "", "x-enum-by-country": { "GB": [ { "value": "private_limited_company", "label": "Private limited company", "native_label": "Private company limited by shares", "abbreviation": "Ltd", "fundable": true }, { "value": "public_limited_company", "label": "Public limited company", "native_label": "Public limited company", "abbreviation": "PLC", "fundable": true }, { "value": "limited_liability_partnership", "label": "Limited liability partnership", "native_label": "Limited liability partnership", "abbreviation": "LLP", "fundable": true }, { "value": "community_interest_company", "label": "Community interest company", "native_label": "Community interest company", "abbreviation": "CIC", "fundable": true }, { "value": "sole_trader", "label": "Sole trader", "native_label": "Sole trader", "abbreviation": "Sole trader", "fundable": false }, { "value": "general_partnership", "label": "General partnership", "native_label": "Partnership", "abbreviation": "Partnership", "fundable": false }, { "value": "other_not_yet_incorporated", "label": "Other or not yet incorporated", "native_label": "Other or not yet incorporated", "abbreviation": "Other", "fundable": false } ], "US": [ { "value": "limited_liability_company", "label": "Limited liability company", "native_label": "Limited liability company", "abbreviation": "LLC", "fundable": true }, { "value": "c_corporation", "label": "C corporation", "native_label": "C corporation", "abbreviation": "Inc.", "fundable": true }, { "value": "s_corporation", "label": "S corporation", "native_label": "S corporation", "abbreviation": "S corp", "fundable": true }, { "value": "partnership", "label": "Partnership", "native_label": "General or limited partnership", "abbreviation": "LP", "fundable": true }, { "value": "sole_proprietorship", "label": "Sole proprietorship", "native_label": "Sole proprietorship", "abbreviation": "Sole prop.", "fundable": false }, { "value": "nonprofit_corporation", "label": "Nonprofit corporation", "native_label": "Nonprofit corporation", "abbreviation": "501(c)", "fundable": false } ], "CA": [ { "value": "federal_corporation", "label": "Federal corporation", "native_label": "Corporation (CBCA)", "abbreviation": "Inc.", "fundable": true }, { "value": "provincial_corporation", "label": "Provincial corporation", "native_label": "Provincial corporation", "abbreviation": "Inc.", "fundable": true }, { "value": "partnership", "label": "Partnership", "native_label": "General or limited partnership", "abbreviation": "LP", "fundable": true }, { "value": "cooperative", "label": "Cooperative", "native_label": "Cooperative", "abbreviation": "Co-op", "fundable": true }, { "value": "sole_proprietorship", "label": "Sole proprietorship", "native_label": "Sole proprietorship", "abbreviation": "Sole prop.", "fundable": false } ], "AU": [ { "value": "proprietary_limited_company", "label": "Proprietary limited company", "native_label": "Proprietary limited company", "abbreviation": "Pty Ltd", "fundable": true }, { "value": "public_company", "label": "Public company", "native_label": "Public company limited by shares", "abbreviation": "Ltd", "fundable": true }, { "value": "trust", "label": "Trading trust", "native_label": "Discretionary or unit trust with a corporate trustee", "abbreviation": "Trust", "fundable": true }, { "value": "partnership", "label": "Partnership", "native_label": "Partnership", "abbreviation": "Partnership", "fundable": false }, { "value": "sole_trader", "label": "Sole trader", "native_label": "Sole trader", "abbreviation": "Sole trader", "fundable": false } ], "IE": [ { "value": "private_company_limited_by_shares", "label": "Private company limited by shares", "native_label": "Private company limited by shares", "abbreviation": "LTD", "fundable": true }, { "value": "designated_activity_company", "label": "Designated activity company", "native_label": "Designated activity company", "abbreviation": "DAC", "fundable": true }, { "value": "public_limited_company", "label": "Public limited company", "native_label": "Public limited company", "abbreviation": "PLC", "fundable": true }, { "value": "company_limited_by_guarantee", "label": "Company limited by guarantee", "native_label": "Company limited by guarantee", "abbreviation": "CLG", "fundable": false }, { "value": "partnership", "label": "Partnership", "native_label": "Partnership", "abbreviation": "Partnership", "fundable": false }, { "value": "sole_trader", "label": "Sole trader", "native_label": "Sole trader", "abbreviation": "Sole trader", "fundable": false } ], "ES": [ { "value": "sociedad_limitada", "label": "Limited liability company", "native_label": "Sociedad de Responsabilidad Limitada", "abbreviation": "SL", "fundable": true }, { "value": "sociedad_anonima", "label": "Public limited company", "native_label": "Sociedad Anonima", "abbreviation": "SA", "fundable": true }, { "value": "sociedad_cooperativa", "label": "Cooperative", "native_label": "Sociedad Cooperativa", "abbreviation": "S. Coop.", "fundable": true }, { "value": "sociedad_civil", "label": "Civil partnership", "native_label": "Sociedad Civil", "abbreviation": "SC", "fundable": false }, { "value": "comunidad_de_bienes", "label": "Joint ownership", "native_label": "Comunidad de Bienes", "abbreviation": "CB", "fundable": false }, { "value": "autonomo", "label": "Sole trader", "native_label": "Empresario Individual (Autonomo)", "abbreviation": "Autonomo", "fundable": false } ], "NL": [ { "value": "besloten_vennootschap", "label": "Private limited company", "native_label": "Besloten Vennootschap", "abbreviation": "BV", "fundable": true }, { "value": "naamloze_vennootschap", "label": "Public limited company", "native_label": "Naamloze Vennootschap", "abbreviation": "NV", "fundable": true }, { "value": "vennootschap_onder_firma", "label": "General partnership", "native_label": "Vennootschap onder Firma", "abbreviation": "VOF", "fundable": true }, { "value": "commanditaire_vennootschap", "label": "Limited partnership", "native_label": "Commanditaire Vennootschap", "abbreviation": "CV", "fundable": true }, { "value": "cooperatie", "label": "Cooperative", "native_label": "Cooperatie", "abbreviation": "Coop.", "fundable": true }, { "value": "maatschap", "label": "Professional partnership", "native_label": "Maatschap", "abbreviation": "Maatschap", "fundable": false }, { "value": "stichting", "label": "Foundation", "native_label": "Stichting", "abbreviation": "Stichting", "fundable": false }, { "value": "eenmanszaak", "label": "Sole proprietorship", "native_label": "Eenmanszaak", "abbreviation": "Eenmanszaak", "fundable": false } ], "BE": [ { "value": "bv_srl", "label": "Private limited company", "native_label": "Besloten Vennootschap / Societe a Responsabilite Limitee", "abbreviation": "BV / SRL", "fundable": true }, { "value": "nv_sa", "label": "Public limited company", "native_label": "Naamloze Vennootschap / Societe Anonyme", "abbreviation": "NV / SA", "fundable": true }, { "value": "cv_sc", "label": "Cooperative company", "native_label": "Cooperatieve Vennootschap / Societe Cooperative", "abbreviation": "CV / SC", "fundable": true }, { "value": "commv_scomm", "label": "Limited partnership", "native_label": "Commanditaire Vennootschap / Societe en Commandite", "abbreviation": "CommV / SComm", "fundable": true }, { "value": "vof_snc", "label": "General partnership", "native_label": "Vennootschap onder Firma / Societe en Nom Collectif", "abbreviation": "VOF / SNC", "fundable": true }, { "value": "eenmanszaak_entreprise_individuelle", "label": "Sole trader", "native_label": "Eenmanszaak / Entreprise Individuelle", "abbreviation": "Eenmanszaak", "fundable": false } ], "DK": [ { "value": "anpartsselskab", "label": "Private limited company", "native_label": "Anpartsselskab", "abbreviation": "ApS", "fundable": true }, { "value": "aktieselskab", "label": "Public limited company", "native_label": "Aktieselskab", "abbreviation": "A/S", "fundable": true }, { "value": "partnerselskab", "label": "Limited partnership company", "native_label": "Partnerselskab", "abbreviation": "P/S", "fundable": true }, { "value": "interessentskab", "label": "General partnership", "native_label": "Interessentskab", "abbreviation": "I/S", "fundable": true }, { "value": "kommanditselskab", "label": "Limited partnership", "native_label": "Kommanditselskab", "abbreviation": "K/S", "fundable": true }, { "value": "enkeltmandsvirksomhed", "label": "Sole proprietorship", "native_label": "Enkeltmandsvirksomhed", "abbreviation": "Enkeltmandsvirksomhed", "fundable": false }, { "value": "personligt_ejet_mindre_virksomhed", "label": "Small personally owned business", "native_label": "Personligt ejet mindre virksomhed", "abbreviation": "PMV", "fundable": false } ], "SE": [ { "value": "aktiebolag", "label": "Limited company", "native_label": "Aktiebolag", "abbreviation": "AB", "fundable": true }, { "value": "handelsbolag", "label": "General partnership", "native_label": "Handelsbolag", "abbreviation": "HB", "fundable": true }, { "value": "kommanditbolag", "label": "Limited partnership", "native_label": "Kommanditbolag", "abbreviation": "KB", "fundable": true }, { "value": "ekonomisk_forening", "label": "Economic association", "native_label": "Ekonomisk forening", "abbreviation": "Ek. for.", "fundable": true }, { "value": "enskild_firma", "label": "Sole trader", "native_label": "Enskild naringsverksamhet", "abbreviation": "Enskild firma", "fundable": false } ], "PL": [ { "value": "spolka_z_ograniczona_odpowiedzialnoscia", "label": "Limited liability company", "native_label": "Spolka z ograniczona odpowiedzialnoscia", "abbreviation": "Sp. z o.o.", "fundable": true }, { "value": "spolka_akcyjna", "label": "Joint-stock company", "native_label": "Spolka akcyjna", "abbreviation": "S.A.", "fundable": true }, { "value": "prosta_spolka_akcyjna", "label": "Simple joint-stock company", "native_label": "Prosta spolka akcyjna", "abbreviation": "P.S.A.", "fundable": true }, { "value": "spolka_jawna", "label": "General partnership", "native_label": "Spolka jawna", "abbreviation": "Sp. j.", "fundable": true }, { "value": "spolka_komandytowa", "label": "Limited partnership", "native_label": "Spolka komandytowa", "abbreviation": "Sp. k.", "fundable": true }, { "value": "spolka_cywilna", "label": "Civil law partnership", "native_label": "Spolka cywilna", "abbreviation": "S.C.", "fundable": false }, { "value": "jednoosobowa_dzialalnosc_gospodarcza", "label": "Sole proprietorship", "native_label": "Jednoosobowa dzialalnosc gospodarcza", "abbreviation": "JDG", "fundable": false } ], "FR": [ { "value": "sas", "label": "Simplified joint-stock company", "native_label": "Societe par actions simplifiee", "abbreviation": "SAS", "fundable": true }, { "value": "sasu", "label": "Single-shareholder simplified joint-stock company", "native_label": "Societe par actions simplifiee unipersonnelle", "abbreviation": "SASU", "fundable": true }, { "value": "sarl", "label": "Limited liability company", "native_label": "Societe a responsabilite limitee", "abbreviation": "SARL", "fundable": true }, { "value": "eurl", "label": "Single-member limited liability company", "native_label": "Entreprise unipersonnelle a responsabilite limitee", "abbreviation": "EURL", "fundable": true }, { "value": "sa", "label": "Public limited company", "native_label": "Societe anonyme", "abbreviation": "SA", "fundable": true }, { "value": "snc", "label": "General partnership", "native_label": "Societe en nom collectif", "abbreviation": "SNC", "fundable": true }, { "value": "sci", "label": "Civil property company", "native_label": "Societe civile immobiliere", "abbreviation": "SCI", "fundable": false }, { "value": "entreprise_individuelle", "label": "Sole trader", "native_label": "Entreprise individuelle (dont micro-entrepreneur)", "abbreviation": "EI", "fundable": false }, { "value": "association", "label": "Association", "native_label": "Association loi 1901", "abbreviation": "Association", "fundable": false } ] }, "x-enum-depends-on": "country", "x-enum-deprecated": [ "corporation", "limited_liability_company", "private_limited_company", "public_limited_company", "partnership", "sole_trader" ] }, "annual_turnover": { "type": [ "number", "null" ], "description": "Annual figure." }, "significant_persons": { "type": "array", "items": { "$ref": "#/components/schemas/SignificantPerson" } } } }, "LeadMarketBlock": { "type": "object", "description": "Present for US and Canadian leads. Bands with their derived figures, each carrying its basis.", "properties": { "region": { "type": [ "string", "null" ], "description": "US state or Canadian province, as sent. Null when we did not capture it, and never inferred." }, "monthly_revenue_band": { "type": [ "string", "null" ], "enum": [ "under_10k", "10k_20k", "20k_50k", "50k_75k", "75k_100k", "100k_250k", "250k_plus", null ], "x-enum-labels": { "under_10k": "Under 10K", "10k_20k": "10K – 20K", "20k_50k": "20K – 50K", "50k_75k": "50K – 75K", "75k_100k": "75K – 100K", "100k_250k": "100K – 250K", "250k_plus": "250K+" }, "description": "" }, "monthly_revenue": { "type": [ "number", "null" ], "description": "" }, "monthly_revenue_basis": { "type": [ "string", "null" ], "enum": [ "band_midpoint", "reported", null ] }, "time_in_business_band": { "type": [ "string", "null" ], "enum": [ "under_6m", "6_12m", "1_2y", "2y_plus", null ], "x-enum-labels": { "under_6m": "Under 6 months", "6_12m": "6 – 12 months", "1_2y": "1 – 2 years", "2y_plus": "2+ years" }, "description": "" }, "tib_months": { "type": [ "number", "null" ], "description": "" }, "credit_score_band": { "type": [ "string", "null" ], "enum": [ "below_500", "500_549", "550_599", "600_649", "650_699", "700_plus", null ], "x-enum-labels": { "below_500": "Below 500", "500_549": "500 – 549", "550_599": "550 – 599", "600_649": "600 – 649", "650_699": "650 – 699", "700_plus": "700+" }, "description": "" }, "currency": { "type": [ "string", "null" ], "enum": [ "GBP", "USD", "CAD", "AUD", "EUR", null ], "x-enum-labels": { "GBP": "Pound sterling (£)", "USD": "US dollar ($)", "CAD": "Canadian dollar (C$)", "AUD": "Australian dollar (A$)", "EUR": "Euro (€)" }, "description": "" } } }, "LeadOtherBlock": { "type": "object", "description": "Present for AU and EU leads. Bands only, in the local currency, with no derived numbers.", "properties": { "region": { "type": [ "string", "null" ], "description": "" }, "monthly_revenue_band": { "type": [ "string", "null" ], "enum": [ "under_10k", "10k_20k", "20k_50k", "50k_75k", "75k_100k", "100k_250k", "250k_plus", null ], "x-enum-labels": { "under_10k": "Under 10K", "10k_20k": "10K – 20K", "20k_50k": "20K – 50K", "50k_75k": "50K – 75K", "75k_100k": "75K – 100K", "100k_250k": "100K – 250K", "250k_plus": "250K+" }, "description": "" }, "time_in_business_band": { "type": [ "string", "null" ], "enum": [ "under_6m", "6_12m", "1_2y", "2y_plus", null ], "x-enum-labels": { "under_6m": "Under 6 months", "6_12m": "6 – 12 months", "1_2y": "1 – 2 years", "2y_plus": "2+ years" }, "description": "" }, "currency": { "type": [ "string", "null" ], "enum": [ "GBP", "USD", "CAD", "AUD", "EUR", null ], "x-enum-labels": { "GBP": "Pound sterling (£)", "USD": "US dollar ($)", "CAD": "Canadian dollar (C$)", "AUD": "Australian dollar (A$)", "EUR": "Euro (€)" }, "description": "" } } }, "LeadSummary": { "type": "object", "description": "The list projection. The contact email is not on a list surface.", "properties": { "id": { "type": "string", "description": "" }, "reference": { "type": "string", "description": "" }, "partner_reference": { "type": [ "string", "null" ], "description": "" }, "state": { "$ref": "#/components/schemas/LeadState" }, "environment": { "type": "string", "enum": [ "live", "sandbox" ] }, "country": { "type": [ "string", "null" ], "enum": [ "UK", "US", "CA", "AU", "IE", "ES", "NL", "BE", "DK", "SE", "PL", "FR", null ], "x-enum-labels": { "UK": "United Kingdom", "US": "United States", "CA": "Canada", "AU": "Australia", "IE": "Ireland", "ES": "Spain", "NL": "Netherlands", "BE": "Belgium", "DK": "Denmark", "SE": "Sweden", "PL": "Poland", "FR": "France" }, "description": "Stored market code.", "x-enum-flags": { "UK": "🇬🇧", "US": "🇺🇸", "CA": "🇨🇦", "AU": "🇦🇺", "IE": "🇮🇪", "ES": "🇪🇸", "NL": "🇳🇱", "BE": "🇧🇪", "DK": "🇩🇰", "SE": "🇸🇪", "PL": "🇵🇱", "FR": "🇫🇷" } }, "currency": { "type": [ "string", "null" ], "enum": [ "GBP", "USD", "CAD", "AUD", "EUR", null ], "x-enum-labels": { "GBP": "Pound sterling (£)", "USD": "US dollar ($)", "CAD": "Canadian dollar (C$)", "AUD": "Australian dollar (A$)", "EUR": "Euro (€)" }, "description": "Currency every figure is quoted in." }, "business": { "type": "object", "properties": { "name": { "type": [ "string", "null" ], "description": "" }, "company_number": { "type": [ "string", "null" ], "description": "" } } }, "contact": { "type": "object", "properties": { "first_name": { "type": [ "string", "null" ], "description": "" }, "last_name": { "type": [ "string", "null" ], "description": "" } } }, "funding": { "type": "object", "properties": { "amount": { "type": [ "number", "null" ], "description": "" }, "amount_band": { "type": [ "string", "null" ], "enum": [ "under_25k", "25k_50k", "50k_100k", "100k_250k", "250k_500k", "500k_1m", "1m_2m", "2m_5m", "5m_15m", "15m_50m", null ], "x-enum-labels": { "under_25k": "Under 25K", "25k_50k": "25K – 50K", "50k_100k": "50K – 100K", "100k_250k": "100K – 250K", "250k_500k": "250K – 500K", "500k_1m": "500K – 1M", "1m_2m": "1M – 2M", "2m_5m": "2M – 5M", "5m_15m": "5M – 15M", "15m_50m": "15M – 50M" }, "description": "" } } }, "statements_available": { "type": "boolean", "description": "" }, "created_at": { "type": "string", "description": "" }, "updated_at": { "type": "string", "description": "" } }, "required": [ "id", "reference", "state", "created_at", "updated_at" ] }, "LeadList": { "type": "object", "properties": { "leads": { "type": "array", "items": { "$ref": "#/components/schemas/LeadSummary" } }, "next_cursor": { "type": [ "string", "null" ], "description": "Pass back as ?cursor= for the next page. Null on the last page." } }, "required": [ "leads" ] }, "MatchedOption": { "type": "object", "description": "A count of funding options by product family. Capvant selects the panel, so an option is described by its structure and never by its provider.", "properties": { "product_family": { "type": "string", "enum": [ "asset_finance", "bridging", "business_line_of_credit", "invoice_finance", "merchant_cash_advance", "property_development_finance", "term_loan", "trade_finance", "working_capital" ], "x-enum-labels": { "asset_finance": "Asset finance", "bridging": "Bridging finance", "business_line_of_credit": "Business line of credit", "invoice_finance": "Invoice finance", "merchant_cash_advance": "Revenue-based funding", "property_development_finance": "Property development finance", "term_loan": "Term loan", "trade_finance": "Trade finance", "working_capital": "Working capital" }, "description": "" }, "label": { "type": "string", "description": "" }, "options": { "type": "integer" } }, "required": [ "product_family", "label", "options" ] }, "SignificantPerson": { "type": "object", "description": "A director or beneficial owner.", "properties": { "full_name": { "type": "string", "description": "" }, "date_of_birth": { "type": "string", "description": "YYYY-MM-DD." }, "residential_address": { "type": "object", "properties": { "line1": { "type": "string", "description": "" }, "line2": { "type": [ "string", "null" ], "description": "" }, "city": { "type": [ "string", "null" ], "description": "" }, "region": { "type": [ "string", "null" ], "description": "" }, "postal_code": { "type": "string", "description": "" }, "country": { "type": [ "string", "null" ], "description": "" } }, "required": [ "line1", "postal_code" ] }, "residency_status": { "type": [ "string", "null" ], "enum": [ "homeowner", "tenant", null ] }, "ownership_percent": { "type": [ "number", "null" ], "description": "0 to 100." } }, "required": [ "full_name", "date_of_birth", "residential_address" ] }, "SignificantPersonsRequest": { "type": "object", "description": "The whole list, every time. This replaces what is held rather than adding to it.", "properties": { "significant_persons": { "type": "array", "minItems": 1, "maxItems": 10, "items": { "$ref": "#/components/schemas/SignificantPerson" } } }, "required": [ "significant_persons" ] }, "SubmitResult": { "type": "object", "properties": { "id": { "type": "string", "description": "" }, "reference": { "type": [ "string", "null" ], "description": "" }, "state": { "$ref": "#/components/schemas/LeadState" }, "matched_options": { "type": "integer" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/MatchedOption" } }, "already_submitted": { "type": "boolean", "description": "True when this call found the lead already submitted. Submit is idempotent." }, "submitted_at": { "type": [ "string", "null" ], "description": "" } }, "required": [ "id", "state", "matched_options", "already_submitted" ] }, "Offer": { "type": "object", "description": "An offer on the lead. Figures, term and a structural label. The provider is not named, and no application link or internal reference is exposed.", "properties": { "id": { "type": "string", "description": "" }, "label": { "type": "string", "description": "Reader-facing name for this option." }, "state": { "type": "string", "enum": [ "presented", "accepted" ] }, "amount": { "type": [ "number", "null" ], "description": "" }, "currency": { "type": [ "string", "null" ], "enum": [ "GBP", "USD", "CAD", "AUD", "EUR", null ], "x-enum-labels": { "GBP": "Pound sterling (£)", "USD": "US dollar ($)", "CAD": "Canadian dollar (C$)", "AUD": "Australian dollar (A$)", "EUR": "Euro (€)" }, "description": "" }, "annual_rate_pct": { "type": [ "number", "null" ], "description": "" }, "factor_rate": { "type": [ "number", "null" ], "description": "" }, "term_months": { "type": [ "number", "null" ], "description": "" }, "fees": { "type": [ "number", "null" ], "description": "" }, "total_repayment": { "type": [ "number", "null" ], "description": "" }, "expires_at": { "type": [ "string", "null" ], "description": "" }, "created_at": { "type": "string", "description": "" } }, "required": [ "id", "label", "state", "created_at" ] }, "OfferList": { "type": "object", "properties": { "lead_id": { "type": "string", "description": "" }, "offers": { "type": "array", "items": { "$ref": "#/components/schemas/Offer" } }, "simulated": { "type": "boolean", "description": "True in the sandbox: offers there are computed for integration testing, not priced by a funding provider." }, "note": { "type": [ "string", "null" ], "description": "Present when the offers are simulated." } }, "required": [ "lead_id", "offers", "simulated" ] }, "AcceptanceResult": { "type": "object", "properties": { "lead_id": { "type": "string", "description": "" }, "offer_id": { "type": "string", "description": "" }, "state": { "type": "string", "enum": [ "accepted" ] }, "simulated": { "type": "boolean", "description": "True in the sandbox." } }, "required": [ "lead_id", "offer_id", "state", "simulated" ] }, "Document": { "type": "object", "properties": { "id": { "type": "string", "description": "" }, "document_type": { "type": "string", "enum": [ "bank_statements", "management_accounts", "debt_schedule", "aged_debtors", "filed_accounts", "proof_of_id", "other" ], "x-enum-labels": { "bank_statements": "Bank statements", "management_accounts": "Management accounts", "debt_schedule": "Debt schedule", "aged_debtors": "Aged debtors report", "filed_accounts": "Filed accounts", "proof_of_id": "Proof of identity", "other": "Other supporting document" }, "description": "Document type, from /enums/document-types." }, "filename": { "type": "string", "description": "" }, "byte_size": { "type": "integer" }, "state": { "type": "string", "enum": [ "accepted", "rejected" ] }, "reason": { "type": [ "string", "null" ], "description": "Why a document was refused." }, "received_at": { "type": "string", "description": "" } }, "required": [ "id", "document_type", "filename", "state", "received_at" ] }, "DocumentList": { "type": "object", "properties": { "documents": { "type": "array", "items": { "$ref": "#/components/schemas/Document" } }, "accepted_types": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "required": [ "documents" ] }, "DocumentUploadResult": { "type": "object", "properties": { "lead_id": { "type": "string", "description": "" }, "document_type": { "type": "string", "enum": [ "bank_statements", "management_accounts", "debt_schedule", "aged_debtors", "filed_accounts", "proof_of_id", "other" ], "x-enum-labels": { "bank_statements": "Bank statements", "management_accounts": "Management accounts", "debt_schedule": "Debt schedule", "aged_debtors": "Aged debtors report", "filed_accounts": "Filed accounts", "proof_of_id": "Proof of identity", "other": "Other supporting document" }, "description": "" }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/Document" } } }, "required": [ "lead_id", "document_type", "documents" ] }, "RenewalEligibility": { "type": "object", "description": "A documented stub. Renewal eligibility is a fact only a funding provider holds, and Capvant has no renewal feed yet, so this answers not_available with the reason rather than inventing an answer. The shape is final; only the values will change.", "properties": { "lead_id": { "type": "string", "description": "" }, "status": { "type": "string", "enum": [ "not_available", "eligible", "not_eligible" ] }, "eligible": { "type": [ "boolean", "null" ] }, "reason": { "type": "string", "description": "no_renewal_feed while no feed exists." }, "detail": { "type": "string", "description": "" }, "max_fundable_amount": { "type": [ "number", "null" ], "description": "" }, "currency": { "type": [ "string", "null" ], "enum": [ "GBP", "USD", "CAD", "AUD", "EUR", null ], "x-enum-labels": { "GBP": "Pound sterling (£)", "USD": "US dollar ($)", "CAD": "Canadian dollar (C$)", "AUD": "Australian dollar (A$)", "EUR": "Euro (€)" }, "description": "" }, "checked_at": { "type": "string", "description": "" } }, "required": [ "lead_id", "status", "eligible", "reason", "checked_at" ] }, "WebhookEventCatalogue": { "type": "object", "properties": { "events": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "description": "" }, "label": { "type": "string", "description": "" }, "description": { "type": "string", "description": "" } }, "required": [ "value", "label", "description" ] } }, "signature": { "type": "object", "properties": { "header": { "type": "string", "description": "" }, "event_header": { "type": "string", "description": "" }, "delivery_header": { "type": "string", "description": "" }, "algorithm": { "type": "string", "description": "" }, "encoding": { "type": "string", "description": "" }, "format": { "type": "string", "description": "" }, "signed_payload": { "type": "string", "description": "" } } }, "delivery": { "type": "object", "properties": { "method": { "type": "string", "description": "" }, "content_type": { "type": "string", "description": "" }, "expected_response": { "type": "string", "description": "" }, "max_attempts": { "type": "integer" }, "retry_delays_seconds": { "type": "array", "items": { "type": "integer" } } } } }, "required": [ "events", "signature", "delivery" ] }, "WebhookSubscription": { "type": "object", "properties": { "id": { "type": "string", "description": "" }, "url": { "type": "string", "description": "" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "lead.created", "lead.updated", "lead.submitted", "lead.option_matched", "lead.offer_received", "lead.offer_accepted", "lead.declined", "lead.funded", "document.received", "document.rejected" ], "x-enum-labels": { "lead.created": "lead.created", "lead.updated": "lead.updated", "lead.submitted": "lead.submitted", "lead.option_matched": "lead.option_matched", "lead.offer_received": "lead.offer_received", "lead.offer_accepted": "lead.offer_accepted", "lead.declined": "lead.declined", "lead.funded": "lead.funded", "document.received": "document.received", "document.rejected": "document.rejected" }, "description": "Event name." }, "description": "" }, "active": { "type": "boolean", "description": "" }, "created_at": { "type": "string", "description": "" }, "last_success_at": { "type": [ "string", "null" ], "description": "" }, "last_failure_at": { "type": [ "string", "null" ], "description": "" }, "failure_count": { "type": "integer" } }, "required": [ "id", "url", "events", "active", "created_at" ] }, "WebhookSubscriptionCreate": { "type": "object", "properties": { "url": { "type": "string", "description": "Public https endpoint. Loopback and private ranges are refused." }, "events": { "type": "array", "items": { "type": "string", "enum": [ "lead.created", "lead.updated", "lead.submitted", "lead.option_matched", "lead.offer_received", "lead.offer_accepted", "lead.declined", "lead.funded", "document.received", "document.rejected" ], "x-enum-labels": { "lead.created": "lead.created", "lead.updated": "lead.updated", "lead.submitted": "lead.submitted", "lead.option_matched": "lead.option_matched", "lead.offer_received": "lead.offer_received", "lead.offer_accepted": "lead.offer_accepted", "lead.declined": "lead.declined", "lead.funded": "lead.funded", "document.received": "document.received", "document.rejected": "document.rejected" }, "description": "Event name." }, "description": "Defaults to every event in the catalogue." }, "active": { "type": "boolean", "description": "Defaults to true." } }, "required": [ "url" ] }, "WebhookSubscriptionCreated": { "allOf": [ { "$ref": "#/components/schemas/WebhookSubscription" }, { "type": "object", "properties": { "secret": { "type": "string", "description": "Shown once, here, and never again. Store it now." }, "signature_header": { "type": "string", "description": "" }, "note": { "type": "string", "description": "" } }, "required": [ "secret" ] } ] }, "WebhookSubscriptionList": { "type": "object", "properties": { "webhook_subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookSubscription" } } }, "required": [ "webhook_subscriptions" ] }, "WebhookDelivery": { "type": "object", "description": "The body POSTed to a subscribed endpoint. Verify X-Capvant-Signature over the exact bytes received before trusting it. Delivered events: lead.created, lead.updated, lead.submitted, lead.option_matched, lead.offer_received, lead.offer_accepted, lead.declined, lead.funded, document.received, document.rejected.", "properties": { "id": { "type": "string", "description": "Delivery id, repeated in the X-Capvant-Delivery-Id header." }, "event": { "type": "string", "enum": [ "lead.created", "lead.updated", "lead.submitted", "lead.option_matched", "lead.offer_received", "lead.offer_accepted", "lead.declined", "lead.funded", "document.received", "document.rejected" ], "x-enum-labels": { "lead.created": "lead.created", "lead.updated": "lead.updated", "lead.submitted": "lead.submitted", "lead.option_matched": "lead.option_matched", "lead.offer_received": "lead.offer_received", "lead.offer_accepted": "lead.offer_accepted", "lead.declined": "lead.declined", "lead.funded": "lead.funded", "document.received": "document.received", "document.rejected": "document.rejected" }, "description": "Event name." }, "created_at": { "type": "string", "description": "" }, "environment": { "type": "string", "enum": [ "live", "sandbox" ] }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "id", "event", "created_at", "environment", "data" ] }, "DeletedSubscription": { "type": "object", "properties": { "id": { "type": "string", "description": "" }, "deleted": { "type": "boolean", "description": "" } }, "required": [ "id", "deleted" ] } } } }