The Businesses API from Lemon Markets — 5 operation(s) for businesses.
openapi: 3.1.0
info:
title: "lemon.markets Brokerage API \uD83C\uDF4B Accounts: General Businesses API"
version: 0.1.0
servers:
- url: https://sandbox.api.lemon.markets/v1
description: Sandbox
security:
- bearerAuth: []
tags:
- name: Businesses
paths:
/businesses:
get:
summary: List Businesses
operationId: list_businesses
tags:
- Businesses
parameters:
- name: cursor
in: query
required: false
schema:
type: string
title: Cursor
description: 'A pagination cursor. When you receive a paginated response containing the property `pagination.next_cursor`, you can pass its value here to get the next page of results for your query.
A cursor will include filter parameters, so there is not need to specify both the `cursor` and any other filter parameter.
'
- name: limit
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
default: 100
title: Limit
description: 'In order to customize the number of elements returned, you can provide a limit here. The service will not return more elements than specified.
'
- name: LMG-Data-Privacy-Access-Principal
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Principal
- name: LMG-Data-Privacy-Access-Justification
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Justification
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/EncodedPaginatedCollectionResponse_BusinessResponse_'
example:
data:
- currency: EUR
expected_annual_revenue: '123456.78'
fatca_relevant: false
id: le_3a0baf04657b4fb9bcaa03d8120b5e9e
industry:
nace_rev: '2.1'
code: T.96.22
legal_entity_identifier: null
name: Beeswax UG (haftungsbeschränkt)
nfe_type: active
registered_address:
city: Musterstadt
country: DE
line_1: Mustergasse 1a
line_2: null
postal_code: '12345'
registration:
court: Musterstadt
id: HRB 123456
incorporation_country: DE
incorporation_date: '2024-01-02'
legal_form: ug
single_tier_ownership: true
taxation_countries:
- country: DE
business_identification_number: null
tax_number: 123/456/78901
vat_id: DE0815
pagination:
next_cursor: null
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unprocessable Entity
5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server Error
post:
summary: Create Business
operationId: create_business
tags:
- Businesses
parameters:
- name: LMG-Data-Privacy-Access-Principal
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Principal
- name: LMG-Data-Privacy-Access-Justification
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Justification
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BusinessRequest'
example:
currency: EUR
expected_annual_revenue: '123456.78'
fatca_relevant: false
industry:
nace_rev: '2.1'
code: T.96.22
name: Beeswax UG (haftungsbeschränkt)
nfe_type: active
registered_address:
city: Musterstadt
country: DE
line_1: Mustergasse 1a
postal_code: '12345'
registration:
court: Musterstadt
id: HRB 123456
incorporation_country: DE
incorporation_date: '2024-01-02'
legal_form: ug
single_tier_ownership: true
taxation_countries:
- country: DE
business_identification_number: null
tax_number: 123/456/78901
vat_id: DE0815
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/BusinessResponse'
example:
currency: EUR
expected_annual_revenue: '123456.78'
fatca_relevant: false
id: le_3a0baf04657b4fb9bcaa03d8120b5e9e
industry:
nace_rev: '2.1'
code: T.96.22
legal_entity_identifier: null
name: Beeswax UG (haftungsbeschränkt)
nfe_type: active
registered_address:
city: Musterstadt
country: DE
line_1: Mustergasse 1a
line_2: null
postal_code: '12345'
registration:
court: Musterstadt
id: HRB 123456
incorporation_country: DE
incorporation_date: '2024-01-02'
legal_form: ug
single_tier_ownership: true
taxation_countries:
- country: DE
business_identification_number: null
tax_number: 123/456/78901
vat_id: DE0815
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unprocessable Entity
5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server Error
/businesses/{business_id}:
get:
summary: Get Business
operationId: get_business
tags:
- Businesses
parameters:
- name: business_id
in: path
required: true
schema:
type: string
title: Business Identifier
description: 'A business identifier.
'
example: le_3a0baf04657b4fb9bcaa03d8120b5e9e
- name: LMG-Data-Privacy-Access-Principal
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Principal
- name: LMG-Data-Privacy-Access-Justification
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Justification
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/BusinessResponse'
example:
currency: EUR
expected_annual_revenue: '123456.78'
fatca_relevant: false
id: le_3a0baf04657b4fb9bcaa03d8120b5e9e
industry:
nace_rev: '2.1'
code: T.96.22
legal_entity_identifier: null
name: Beeswax UG (haftungsbeschränkt)
nfe_type: active
registered_address:
city: Musterstadt
country: DE
line_1: Mustergasse 1a
line_2: null
postal_code: '12345'
registration:
court: Musterstadt
id: HRB 123456
incorporation_country: DE
incorporation_date: '2024-01-02'
legal_form: ug
single_tier_ownership: true
taxation_countries:
- country: DE
business_identification_number: null
tax_number: 123/456/78901
vat_id: DE0815
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unprocessable Entity
5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server Error
/businesses/{business_id}/beneficial_owners:
get:
summary: List Beneficial Owners
operationId: list_beneficial_owners
tags:
- Businesses
parameters:
- name: business_id
in: path
required: true
schema:
type: string
title: Business Identifier
description: 'A business identifier.
'
- name: cursor
in: query
required: false
schema:
type: string
title: Cursor
description: 'A pagination cursor. When you receive a paginated response containing the property `pagination.next_cursor`, you can pass its value here to get the next page of results for your query.
A cursor will include filter parameters, so there is not need to specify both the `cursor` and any other filter parameter.
'
- name: limit
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
default: 100
title: Limit
description: 'In order to customize the number of elements returned, you can provide a limit here. The service will not return more elements than specified.
'
- name: LMG-Data-Privacy-Access-Principal
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Principal
- name: LMG-Data-Privacy-Access-Justification
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Justification
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/EncodedPaginatedCollectionResponse_BeneficialOwnerResponse_'
example:
data:
- id: ubo_ea20564620af48a4af367aca2ade4d91
shares_pct: '100'
voting_rights_pct: '100'
person: pers_310212a629b2429cacfdc09d212fa87a
type: real
pagination:
next_cursor: null
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unprocessable Entity
5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server Error
post:
summary: Add Beneficial Owner
operationId: add_beneficial_owner
tags:
- Businesses
parameters:
- name: business_id
in: path
required: true
schema:
type: string
title: Business Identifier
description: 'A business identifier.
'
- name: LMG-Data-Privacy-Access-Principal
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Principal
- name: LMG-Data-Privacy-Access-Justification
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Justification
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BeneficialOwnerRequest'
example:
shares_pct: '100'
voting_rights_pct: '100'
person: pers_310212a629b2429cacfdc09d212fa87a
type: real
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/BeneficialOwnerResponse'
example:
id: ubo_ea20564620af48a4af367aca2ade4d91
shares_pct: '100'
voting_rights_pct: '100'
person: pers_310212a629b2429cacfdc09d212fa87a
nature: real
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unprocessable Entity
5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server Error
/businesses/{business_id}/submit_document:
post:
summary: Submit Document
deprecated: true
operationId: submit_document
tags:
- Businesses
description: '**⚠️ DEPRECATED**: This endpoint is deprecated. Please use the new unified `/submit_document` endpoint instead, which supports both person and business documents through a discriminated union approach.
See [Submit Document](/reference/submit_document_upload) for the replacement endpoint.
'
parameters:
- name: business_id
in: path
required: true
schema:
type: string
title: Business Identifier
description: 'A business identifier.
'
- name: LMG-Data-Privacy-Access-Principal
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Principal
- name: LMG-Data-Privacy-Access-Justification
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Justification
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BusinessDocumentUploadRequest'
example:
document: shareholder_list
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/BusinessDocumentUploadResponse'
example:
expires_at: '2024-11-18T13:36:09.478814+00:00'
document: shareholder_list
upload_url: https://example.com/upload-document-url-12345
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unprocessable Entity
5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server Error
/businesses/{business_id}/legal_representatives:
get:
summary: List Legal Representatives
operationId: list_legal_representatives
tags:
- Businesses
parameters:
- name: business_id
in: path
required: true
schema:
type: string
title: Business Identifier
description: 'A business identifier.
'
- name: cursor
required: false
schema:
title: Cursor
type: string
description: 'A pagination cursor. When you receive a paginated response containing the property `pagination.next_cursor`, you can pass its value here to get the next page of results for your query.
A cursor will include filter parameters, so there is not need to specify both the `cursor` and any other filter parameter.
'
in: query
- name: limit
required: false
schema:
title: Limit
maximum: 100
minimum: 1
default: 100
type: integer
in: query
description: 'In order to customize the number of elements returned, you can provide a limit here. The service will not return more elements than specified.
'
- name: LMG-Data-Privacy-Access-Principal
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Principal
- name: LMG-Data-Privacy-Access-Justification
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Justification
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/EncodedPaginatedCollectionResponse_LegalRepresentativeResponse_'
example:
data:
- id: rep_b4831949b797401bbc037a03f9a64d79
person: pers_310212a629b2429cacfdc09d212fa87a
representation_rule: sole_representation
pagination:
next_cursor: null
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unprocessable Entity
5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server Error
post:
summary: Add Legal Representative
operationId: add_legal_representative
tags:
- Businesses
parameters:
- name: business_id
in: path
required: true
schema:
type: string
title: Business Identifier
description: 'A business identifier.
'
- name: LMG-Data-Privacy-Access-Principal
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Principal
- name: LMG-Data-Privacy-Access-Justification
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Justification
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LegalRepresentativeRequest'
example:
person: pers_310212a629b2429cacfdc09d212fa87a
representation_rule: sole_representation
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LegalRepresentativeResponse'
example:
id: rep_b4831949b797401bbc037a03f9a64d79
person: pers_310212a629b2429cacfdc09d212fa87a
representation_rule: sole_representation
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unprocessable Entity
5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server Error
components:
schemas:
LegalRepresentativeRequest:
properties:
person:
type: string
maxLength: 255
minLength: 1
title: Person
description: 'A person identifier. This field represents the person being a legal representative.
'
representation_rule:
$ref: '#/components/schemas/RepresentationRule'
type: object
required:
- person
- representation_rule
title: LegalRepresentativeRequest
AddressRequest:
properties:
line_1:
type: string
maxLength: 128
minLength: 1
title: Line 1
example: Heidestraße 17
description: 'The first line of the address. For most German addresses, this will be the street name and house number. If there is only a street name or a house number, provide that one without the other.
'
line_2:
type: string
maxLength: 128
minLength: 1
title: Line 2
example: null
description: 'The second line of the address. This field is optional, and it won''t be needed for most German addresses. For care-of addresses (℅) like the following, this is likely to be the actual street name and house number: <br/>
* Erika Mustermann<br/>℅ Max Müller<br/>**Mustergasse 14**<br/>12345 Musterstadt<br/>Germany
'
postal_code:
type: string
maxLength: 50
minLength: 1
title: Postal Code
example: '51147'
description: 'The postal code for the address.
'
city:
type: string
maxLength: 150
minLength: 1
title: City
example: Köln
description: 'The city/municipality of the address.
'
country:
type: string
maxLength: 2
minLength: 2
title: Country
example: DE
description: 'An ISO 3166-1 alpha-2 code, representing the country of the address.
'
type: object
required:
- line_1
- postal_code
- city
- country
title: AddressRequest
BeneficialOwnerNature:
type: string
enum:
- real
- notional
title: BeneficialOwnerNature
description: 'A category describing the nature of a UBO:
<ul> <li><code>real</code> <li><code>notional</code> </ul>
'
BusinessDocumentUploadResponse:
properties:
document:
$ref: '#/components/schemas/BusinessDocumentType'
upload_url:
type: string
title: Upload URL
description: 'A URL to upload the business document.
Use this URL to upload a document with the HTTP method `PUT` and the content type header set to `application/pdf`.
'
expires_at:
type: string
format: date-time
title: Expires At
description: 'The expiry date for the upload link. Please only create upload links for immediate uploads.
'
type: object
required:
- document
- upload_url
- expires_at
title: BusinessDocumentUploadResponse
BusinessIndustryCodeEnumTwoOne:
type: string
enum:
- A.1.11
- A.1.12
- A.1.13
- A.1.14
- A.1.15
- A.1.16
- A.1.19
- A.1.21
- A.1.22
- A.1.23
- A.1.24
- A.1.25
- A.1.26
- A.1.27
- A.1.28
- A.1.29
- A.1.30
- A.1.41
- A.1.42
- A.1.43
- A.1.44
- A.1.45
- A.1.46
- A.1.47
- A.1.48
- A.1.50
- A.1.61
- A.1.62
- A.1.63
- A.1.70
- A.2.10
- A.2.20
- A.2.30
- A.2.40
- A.3.11
- A.3.12
- A.3.21
- A.3.22
- A.3.30
- B.5.10
- B.5.20
- B.6.10
- B.6.20
- B.7.10
- B.7.21
- B.7.29
- B.8.11
- B.8.12
- B.8.91
- B.8.92
- B.8.93
- B.8.99
- B.9.10
- B.9.90
- C.10.11
- C.10.12
- C.10.13
- C.10.20
- C.10.31
- C.10.32
- C.10.39
- C.10.41
- C.10.42
- C.10.51
- C.10.52
- C.10.61
- C.10.62
- C.10.71
- C.10.72
- C.10.73
- C.10.81
- C.10.82
- C.10.83
- C.10.84
- C.10.85
- C.10.86
- C.10.89
- C.10.91
- C.10.92
- C.11.01
- C.11.02
- C.11.03
- C.11.04
- C.11.05
- C.11.06
- C.11.07
- C.12.00
- C.13.10
- C.13.20
- C.13.30
- C.13.91
- C.13.92
- C.13.93
- C.13.94
- C.13.95
- C.13.96
- C.13.99
- C.14.10
- C.14.21
- C.14.22
- C.14.23
- C.14.24
- C.14.29
- C.15.11
- C.15.12
- C.15.20
- C.16.11
- C.16.12
- C.16.21
- C.16.22
- C.16.23
- C.16.24
- C.16.25
- C.16.26
- C.16.27
- C.16.28
- C.17.11
- C.17.12
- C.17.21
- C.17.22
- C.17.23
- C.17.24
- C.17.25
- C.18.11
- C.18.12
- C.18.13
- C.18.14
- C.18.20
- C.19.10
- C.19.20
- C.20.11
- C.20.12
- C.20.13
- C.20.14
- C.20.15
- C.20.16
- C.20.17
- C.20.20
- C.20.30
- C.20.41
- C.20.42
- C.20.51
- C.20.59
- C.20.60
- C.21.10
- C.21.20
- C.22.11
- C.22.12
- C.22.21
- C.22.22
- C.22.23
- C.22.24
- C.22.25
- C.22.26
- C.23.11
- C.23.12
- C.23.13
- C.23.14
- C.23.15
- C.23.20
- C.23.31
- C.23.32
- C.23.41
- C.23.42
- C.23.43
- C.23.44
- C.23.45
- C.23.51
- C.23.52
- C.23.61
- C.23.62
- C.23.63
- C.23.64
- C.23.65
- C.23.66
- C.23.70
- C.23.91
- C.23.99
- C.24.10
- C.24.20
- C.24.31
- C.24.32
- C.24.33
- C.24.34
- C.24.41
- C.24.42
- C.24.43
- C.24.44
- C.24.45
- C.24.46
- C.24.51
- C.24.52
- C.24.53
- C.24.54
- C.25.11
- C.25.12
- C.25.21
- C.25.22
- C.25.30
- C.25.40
- C.25.51
- C.25.52
- C.25.53
- C.25.61
- C.25.62
- C.25.63
- C.25.91
- C.25.92
- C.25.93
- C.25.94
- C.25.99
- C.26.11
- C.26.12
- C.26.20
- C.26.30
- C.26.40
- C.26.51
- C.26.52
- C.26.60
- C.26.70
- C.27.11
- C.27.12
- C.27.20
- C.27.31
- C.27.32
- C.27.33
- C.27.40
- C.27.51
- C.27.52
- C.27.90
- C.28.11
- C.28.12
- C.28.13
- C.28.14
- C.28.15
- C.28.21
- C.28.22
- C.28.23
- C.28.24
- C.28.25
- C.28.29
- C.28.30
- C.28.41
- C.28.42
- C.28.91
- C.28.92
- C.28.93
- C.28.94
- C.28.95
- C.28.96
- C.28.97
- C.28.99
- C.29.10
- C.29.20
- C.29.31
- C.29.32
- C.30.11
- C.30.12
- C.30.13
- C.30.20
- C.30.31
- C.30.32
- C.30.40
- C.30.91
- C.30.92
- C.30.99
- C.31.00
- C.32.11
- C.32.12
- C.32.13
- C.32.20
- C.32.30
- C.32.40
- C.32.50
- C.32.91
- C.32.99
- C.33.11
- C.33.12
- C.33.13
- C.33.14
- C.33.15
- C.33.16
- C.33.17
- C.33.18
- C.33.19
- C.33.20
- D.35.11
- D.35.12
- D.35.13
- D.35.14
- D.35.15
- D.35.16
- D.35.21
- D.35.22
- D.35.23
- D.35.24
- D.35.30
- D.35.40
- E.36.00
- E.37.00
- E.38.11
- E.38.12
- E.38.21
- E.38.22
- E.38.23
- E.38.31
- E.38.32
- E.38.33
- E.39.00
- F.41.00
- F.42.11
- F.42.12
- F.42.13
- F.42.21
- F.42.22
# --- truncated at 32 KB (69 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lemon-markets/refs/heads/main/openapi/lemon-markets-businesses-api-openapi.yml